X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fgraphics%2FGraphicsConverter.h;h=838b07bfc7d3e949958b9b3c9049ce4f8e2eb136;hb=3d4076b598deb18660e50ec9c327efc3b15f15d0;hp=e3bbe24bdb93cd76974e8cb339cc21b788ac4452;hpb=f643df79a890ec4bc2eb05a3fd3d349ba3994f96;p=lyx.git diff --git a/src/graphics/GraphicsConverter.h b/src/graphics/GraphicsConverter.h index e3bbe24bdb..838b07bfc7 100644 --- a/src/graphics/GraphicsConverter.h +++ b/src/graphics/GraphicsConverter.h @@ -1,46 +1,43 @@ // -*- 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 + * \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 + +namespace lyx { -#include "LString.h" -#include -#include -#include +namespace support { class FileName; } -namespace grfx { +namespace graphics { -class Converter : boost::noncopyable { +class Converter { public: /// Can the conversion be performed? - static bool isReachable(string const & from_format_name, - string const & to_format_name); + static bool isReachable(std::string const & from_format_name, + std::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, - string const & from_format, string const & to_format); + Converter(support::FileName const & from_file, std::string const & to_file_base, + std::string const & from_format, std::string const & to_format); - /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy. + /// Needed for the pimpl ~Converter(); /// We are explicit about when we begin the conversion process. @@ -48,27 +45,32 @@ public: /** Connect and you'll be informed when the conversion process has * finished. - * If the conversion is succesful, then the slot is passed \c true. + * If the conversion is successful, then the listener is passed \c true. */ - typedef boost::signal1::slot_type slot_type; + typedef boost::signal sig_type; + typedef sig_type::slot_type slot_type; /// boost::signals::connection connect(slot_type const &) const; - /** If the conversion is succesful, this returns the name of the + /** If the conversion is successful, 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; + support::FileName const & convertedFile() const; private: + /// noncopyable + Converter(Converter const &); + void operator=(Converter const &); + /// Use the Pimpl idiom to hide the internals. class Impl; - /// The pointer never changes although *pimpl_'s contents may. - boost::scoped_ptr const pimpl_; + Impl * const pimpl_; }; -} // namespace grfx +} // namespace graphics +} // namespace lyx #endif // GRAPHICSCONVERTER_H