3 * \file GraphicsConverter.h
4 * Copyright 2002 the LyX Team
5 * Read the file COPYING
7 * \author Angus Leeming <leeming@lyx.org>
9 * The controller of a conversion process from file AA of format A to
10 * file BB of format B.
11 * Once finished, the signal finishdConversion is emitted to inform the
12 * instigator where to find file BB.
13 * If the conversion is unsuccessful, then finishedConversion will pass
17 #ifndef GRAPHICSCONVERTER_H
18 #define GRAPHICSCONVERTER_H
25 #include <boost/signals/signal1.hpp>
26 #include <boost/scoped_ptr.hpp>
27 #include <boost/utility.hpp>
31 class Converter : boost::noncopyable {
33 /// Can the conversion be performed?
34 static bool isReachable(string const & from_format_name,
35 string const & to_format_name);
37 /** One Converter per conversion ensures that finishedConversion
38 * is always connected to the expected slot.
40 Converter(string const & from_file, string const & to_file_base,
41 string const & from_format, string const & to_format);
43 /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy.
46 /// We are explicit about when we begin the conversion process.
47 void startConversion();
49 /** At the end of the conversion process inform the outside world
50 * by emitting a signal.
52 typedef boost::signal1<void, bool> SignalType;
54 SignalType finishedConversion;
56 /** If the convsion is succesful (finishedConversion returns \c true),
57 * this returns the name of the resulting file.
58 * If conversion fails, however, it returns an empty string.
60 string const & convertedFile() const;
63 /// Use the Pimpl idiom to hide the internals.
66 /// The pointer never changes although *pimpl_'s contents may.
67 boost::scoped_ptr<Impl> const pimpl_;
72 #endif // GRAPHICSCONVERTER_H