X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fgraphics%2FGraphicsLoader.h;h=57328107085b7f86f9927fb93d0f84d83c372e16;hb=b63421b7dc65e0c721f8928d1330b9bb2cff43d8;hp=08f30fa69ac368db925596dafd1fdbd9583b66d0;hpb=f643df79a890ec4bc2eb05a3fd3d349ba3994f96;p=lyx.git diff --git a/src/graphics/GraphicsLoader.h b/src/graphics/GraphicsLoader.h index 08f30fa69a..5732810708 100644 --- a/src/graphics/GraphicsLoader.h +++ b/src/graphics/GraphicsLoader.h @@ -1,40 +1,38 @@ // -*- C++ -*- /** - * \file GraphicsLoader.h - * Copyright 2002 the LyX Team - * Read the file COPYING + * \file GraphicsLoader.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 public face of the graphics cache. + * Full author contact details are available in file CREDITS. + * + * The public face of the graphics cache. * * * The user supplies an image file and the display parameters. * * He can change the file or the display parameters through a reset() method. * * He must start the loading process explicitly with startLoading(). - * * He receives a statusChanged signal when the loading status changes. - * * When (status() == Ready), he uses image() to access the loaded image - * and passes it to the Painter. + * * If he is connected through the connect() method, then he'll be informed + * when the loading status changes. + * * When (status() == Ready), he can use image() to access the loaded image + * and pass it to the Painter. * - * What could be simpler? + * What could be simpler? */ #ifndef GRAPHICSLOADER_H #define GRAPHICSLOADER_H -#ifdef __GNUG__ -#pragma interface -#endif - #include "GraphicsTypes.h" -#include "LString.h" -#include -#include +#include + +namespace lyx { -class Inset; -class BufferView; +namespace support { class FileName; } -namespace grfx { +namespace graphics { class Image; class Params; @@ -44,33 +42,48 @@ public: /// Must use the reset methods to make this instance usable. Loader(); /// The image is not transformed, just displayed as-is. - Loader(string const & file_with_path, DisplayType = ColorDisplay); + Loader(support::FileName const & file_with_path, bool display = true); /// The image is transformed before display. - Loader(string const & file_with_path, Params const &); - - /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy. + Loader(support::FileName const & file_with_path, Params const &); + /// + Loader(Loader const &); + /// Needed for the pimpl ~Loader(); + Loader & operator=(Loader const &); + /// The file can be changed, or the display params, or both. - void reset(string const & file_with_path, - DisplayType = ColorDisplay) const; + void reset(support::FileName const & file_with_path, bool display = true) const; /// - void reset(string const & file_with_path, Params const &) const; + void reset(support::FileName const & file_with_path, Params const &) const; /// void reset(Params const &) const; /// Returns the absolute path of the loaded (loading?) file. - string const & filename() const; + support::FileName const & filename() const; /// - bool empty() const { return filename().empty(); } - /// We are explicit about when we begin the loading process. + /** starting loading of the image is done by a urgency-based + * decision. Here we only call LoaderQueue::touch to request it. + */ void startLoading() const; - /** starting loading of the image is conditional upon the - * inset being visible or not. + /** Tries to reload the image. + */ + void reload() const; + + /** Monitor any changes to the file. + * There is no point monitoring the file before startLoading() is + * invoked. */ - void startLoading(Inset const &, BufferView const &) const; + void startMonitoring() const; + /// + bool monitoring() const; + /** Returns the check checksum of filename() so that, for example, you can + * ascertain whether to output a new PostScript version of the file + * for a LaTeX run. + */ + unsigned long checksum() const; /// How far have we got in loading the image? ImageStatus status() const; @@ -78,7 +91,8 @@ public: /** Connect and you'll be informed when the loading status of the image * changes. */ - typedef boost::signal0::slot_type slot_type; + typedef boost::signal sig_type; + typedef sig_type::slot_type slot_type; /// boost::signals::connection connect(slot_type const &) const; @@ -87,13 +101,17 @@ public: */ Image const * image() const; + double displayPixelRatio() const; + void setDisplayPixelRatio(double scale); + private: /// 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 // GRAPHICSLOADER_H