3 * \file PreviewedInset.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 * lyx::graphics::PreviewedInset 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 PREVIEWEDINSET_H
17 #define PREVIEWEDINSET_H
19 #include <boost/signals/trackable.hpp>
20 #include <boost/signals/connection.hpp>
33 class PreviewedInset : public boost::signals::trackable {
35 /// a wrapper for Previews::activated()
36 static bool activated();
39 PreviewedInset(InsetOld & inset);
41 /** Find the PreviewLoader, add a LaTeX snippet to it and
42 * start the loading process.
44 void generatePreview(Buffer const &);
46 /** Add a LaTeX snippet to the PreviewLoader but do not start the
49 void addPreview(PreviewLoader & ploader);
51 /** Remove a snippet from the cache of previews.
52 * Useful if previewing the contents of a file that has changed.
56 /// The preview has been generated and is ready to use.
57 bool previewReady() const;
59 /// If !previewReady() returns 0.
60 PreviewImage const * pimage() const;
64 virtual ~PreviewedInset() {}
65 /// Allow the daughter classes to cast up to the parent inset.
66 InsetOld const & inset() const;
68 BufferView * view() const;
71 /// This method is connected to the PreviewLoader::imageReady signal.
72 void imageReady(PreviewImage const &) const;
74 /// Does the owning inset want a preview?
75 virtual bool previewWanted(Buffer const &) const = 0;
76 /// a wrapper to Inset::latex
77 virtual std::string const latexString(Buffer const &) const = 0;
84 /// We don't own this. Cached for efficiency reasons.
85 mutable PreviewImage const * pimage_;
87 boost::signals::connection connection_;
92 PreviewImage const * PreviewedInset::pimage() const
99 InsetOld const & PreviewedInset::inset() const
104 } // namespace graphics
107 #endif // PREVIEWEDINSET_H