3 * \file RenderPreview.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 * graphics::RenderPreview is an abstract base class that can help
12 * insets to generate previews. The daughter class must instantiate two small
13 * methods. The Inset would own an instance of this daughter class.
16 #ifndef RENDERPREVIEW_H
17 #define RENDERPREVIEW_H
19 #include "RenderBase.h"
21 #include "support/docstring.h"
22 #include "support/FileMonitor.h"
24 #include <boost/signal.hpp>
25 #include <boost/signals/trackable.hpp>
26 #include <boost/signals/connection.hpp>
31 class LyXRC_PreviewStatus;
35 namespace support { class FileName; }
42 } // namespace graphics
45 class RenderPreview : public RenderBase, public boost::signals::trackable {
47 /// a wrapper for Previews::status()
48 static LyXRC_PreviewStatus status();
50 RenderPreview(Inset const *);
51 RenderPreview(RenderPreview const &, Inset const *);
53 RenderBase * clone(Inset const *) const;
55 /// Compute the size of the object, returned in dim
56 void metrics(MetricsInfo &, Dimension & dim) const;
58 void draw(PainterInfo & pi, int x, int y) const;
60 /** Find the PreviewLoader and add a LaTeX snippet to it.
61 * Do not start the loading process.
62 * \param ignore_lyxrc: generate the preview no matter what LyXRC says
64 void addPreview(docstring const & latex_snippet, Buffer const &,
65 bool ignore_lyxrc = false);
67 /** Add a LaTeX snippet to the PreviewLoader.
68 * Do not start the loading process.
69 * \param ignore_lyxrc: generate the preview no matter what LyXRC says
71 void addPreview(docstring const & latex_snippet,
72 graphics::PreviewLoader & ploader,
73 bool ignore_lyxrc = false);
75 /// Begin the loading process.
76 /// \param forexport : whether this is intended for export. if so,
77 /// then we ignore LyXRC and wait for the image to be generated.
78 void startLoading(Buffer const & buffer, bool forexport = false) const;
80 /** Remove a snippet from the cache of previews.
81 * Useful if previewing the contents of a file that has changed.
83 void removePreview(Buffer const &);
85 /** \returns a pointer to the PreviewImage associated with this snippet
88 graphics::PreviewImage const *
89 getPreviewImage(Buffer const & buffer) const;
91 /// equivalent to dynamic_cast
92 virtual RenderPreview * asPreview() { return this; }
96 RenderPreview & operator=(RenderPreview const &);
98 /// This method is connected to the PreviewLoader::imageReady signal.
99 void imageReady(graphics::PreviewImage const &);
101 /// The thing that we're trying to generate a preview of.
102 std::string snippet_;
104 /** Store the connection to the preview loader so that we connect
107 boost::signals::connection ploader_connection_;
109 /// Inform the core that the inset has changed.
110 Inset const * parent_;
114 class RenderMonitoredPreview : public RenderPreview {
116 RenderMonitoredPreview(Inset const *);
118 void draw(PainterInfo & pi, int x, int y) const;
120 void setAbsFile(support::FileName const & file);
122 bool monitoring() const { return monitor_.monitoring(); }
123 void startMonitoring() const { monitor_.start(); }
124 void stopMonitoring() const { monitor_.stop(); }
126 /// Connect and you'll be informed when the file changes.
127 typedef support::FileMonitor::slot_type slot_type;
128 boost::signals::connection fileChanged(slot_type const &);
130 /// equivalent to dynamic_cast
131 virtual RenderMonitoredPreview * asMonitoredPreview() { return this; }
135 mutable support::FileMonitor monitor_;
140 #endif // RENDERPREVIEW_H