// -*- C++ -*-
/**
- * \file GraphicsConverter.h
- * Copyright 2002 the LyX Team
- * Read the file COPYING
+ * \file GraphicsConverter.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * \author Angus Leeming <leeming@lyx.org>
+ * \author Angus Leeming
*
- * The controller of a conversion process from file AA of format A to
- * file BB of format B.
- * Once finished, the signal finishdConversion is emitted to inform the
- * instigator where to find file BB.
- * If the conversion is unsuccessful, then finishedConversion will pass
- * an empty string.
+ * Full author contact details are available in file CREDITS.
+ *
+ * The controller of a conversion process from file AA of format A to
+ * file BB of format B.
+ * Once finished, a signal is emitted to inform any listeners (connected
+ * through the connect() method).
*/
#ifndef GRAPHICSCONVERTER_H
#define GRAPHICSCONVERTER_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "LString.h"
+#include "support/std_string.h"
#include <boost/signals/signal1.hpp>
#include <boost/scoped_ptr.hpp>
#include <boost/utility.hpp>
-namespace grfx {
+namespace lyx {
+namespace graphics {
class Converter : boost::noncopyable {
public:
static bool isReachable(string const & from_format_name,
string const & to_format_name);
- /** One Converter per conversion ensures that finishedConversion
+ /** One Converter per conversion ensures that the (hidden) signal
* is always connected to the expected slot.
*/
Converter(string const & from_file, string const & to_file_base,
~Converter();
/// We are explicit about when we begin the conversion process.
- void startConversion();
+ void startConversion() const;
- /** At the end of the conversion process inform the outside world
- * by emitting a signal.
+ /** Connect and you'll be informed when the conversion process has
+ * finished.
+ * If the conversion is succesful, then the listener is passed \c true.
*/
- typedef boost::signal1<void, bool> SignalType;
+ typedef boost::signal1<void, bool>::slot_type slot_type;
///
- SignalType finishedConversion;
-
- /** If the convsion is succesful (finishedConversion returns \c true),
- * this returns the name of the resulting file.
- * If conversion fails, however, it returns an empty string.
+ boost::signals::connection connect(slot_type const &) const;
+
+ /** If the conversion is succesful, this returns the name of the
+ * resulting file.
+ * If conversion fails or has not been completed, however, it
+ * returns an empty string.
*/
string const & convertedFile() const;
/// The pointer never changes although *pimpl_'s contents may.
boost::scoped_ptr<Impl> const pimpl_;
};
-
-} // namespace grfx
+
+} // namespace graphics
+} // namespace lyx
#endif // GRAPHICSCONVERTER_H