3 * \file GraphicsConverter.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS.
11 * The controller of a conversion process from file AA of format A to
12 * file BB of format B.
13 * Once finished, a signal is emitted to inform any listeners (connected
14 * through the connect() method).
17 #ifndef GRAPHICSCONVERTER_H
18 #define GRAPHICSCONVERTER_H
20 #include <boost/signals/signal1.hpp>
21 #include <boost/scoped_ptr.hpp>
22 #include <boost/utility.hpp>
27 class Converter : boost::noncopyable {
29 /// Can the conversion be performed?
30 static bool isReachable(std::string const & from_format_name,
31 std::string const & to_format_name);
33 /** One Converter per conversion ensures that the (hidden) signal
34 * is always connected to the expected slot.
36 Converter(std::string const & from_file, std::string const & to_file_base,
37 std::string const & from_format, std::string const & to_format);
39 /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy.
42 /// We are explicit about when we begin the conversion process.
43 void startConversion() const;
45 /** Connect and you'll be informed when the conversion process has
47 * If the conversion is succesful, then the listener is passed \c true.
49 typedef boost::signal1<void, bool>::slot_type slot_type;
51 boost::signals::connection connect(slot_type const &) const;
53 /** If the conversion is succesful, this returns the name of the
55 * If conversion fails or has not been completed, however, it
56 * returns an empty string.
58 std::string const & convertedFile() const;
61 /// Use the Pimpl idiom to hide the internals.
64 /// The pointer never changes although *pimpl_'s contents may.
65 boost::scoped_ptr<Impl> const pimpl_;
68 } // namespace graphics
71 #endif // GRAPHICSCONVERTER_H