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 /// Return true if preview is enabled in text (from LyXRC::preview)
48 static bool previewText();
49 /// Return true if preview is enabled in mathed (from LyXRC::preview)
50 static bool previewMath();
52 RenderPreview(Inset const *);
53 RenderPreview(RenderPreview const &, Inset const *);
55 RenderBase * clone(Inset const *) const;
57 /// Compute the size of the object, returned in dim
58 void metrics(MetricsInfo &, Dimension & dim) const;
60 void draw(PainterInfo & pi, int x, int y) const;
62 /** Find the PreviewLoader and add a LaTeX snippet to it.
63 * Do not start the loading process.
64 * \param ignore_lyxrc: generate the preview no matter what LyXRC says
66 void addPreview(docstring const & latex_snippet, Buffer const &,
67 bool ignore_lyxrc = false);
69 /** Add a LaTeX snippet to the PreviewLoader.
70 * Do not start the loading process.
71 * \param ignore_lyxrc: generate the preview no matter what LyXRC says
73 void addPreview(docstring const & latex_snippet,
74 graphics::PreviewLoader & ploader,
75 bool ignore_lyxrc = false);
77 /// Record math macro definitions added to the preview loader
78 void addMacroDef(docstring const & latex_snippet, Buffer const & buffer);
79 /// Has a math macro definition already been added to the preview loader?
80 bool hasMacroDef(docstring const & latex_snippet, Buffer const & buffer);
82 /// Begin the loading process.
83 /// \param forexport : whether this is intended for export. if so,
84 /// then we ignore LyXRC and wait for the image to be generated.
85 void startLoading(Buffer const & buffer, bool forexport = false) const;
87 /** Remove a snippet from the cache of previews.
88 * Useful if previewing the contents of a file that has changed.
90 void removePreview(Buffer const &);
92 /** \returns a pointer to the PreviewImage associated with this snippet
95 graphics::PreviewImage const *
96 getPreviewImage(Buffer const & buffer) const;
98 /// equivalent to dynamic_cast
99 virtual RenderPreview * asPreview() { return this; }
103 RenderPreview & operator=(RenderPreview const &);
105 /// This method is connected to the PreviewLoader::imageReady signal.
106 void imageReady(graphics::PreviewImage const &);
108 /// The thing that we're trying to generate a preview of.
109 std::string snippet_;
111 /** Store the connection to the preview loader so that we connect
114 boost::signals::connection ploader_connection_;
116 /// Inform the core that the inset has changed.
117 Inset const * parent_;
121 class RenderMonitoredPreview : public RenderPreview {
123 RenderMonitoredPreview(Inset const *);
125 void draw(PainterInfo & pi, int x, int y) const;
127 void setAbsFile(support::FileName const & file);
129 bool monitoring() const { return monitor_.monitoring(); }
130 void startMonitoring() const { monitor_.start(); }
131 void stopMonitoring() const { monitor_.stop(); }
133 /// Connect and you'll be informed when the file changes.
134 typedef support::FileMonitor::slot_type slot_type;
135 boost::signals::connection fileChanged(slot_type const &);
137 /// equivalent to dynamic_cast
138 virtual RenderMonitoredPreview * asMonitoredPreview() { return this; }
142 mutable support::FileMonitor monitor_;
147 #endif // RENDERPREVIEW_H