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 * grfx::Previews is a singleton class that stores the grfx::PreviewLoader
12 * for each buffer requiring one.
19 #include <boost/utility.hpp>
20 #include <boost/scoped_ptr.hpp>
29 class Previews : boost::noncopyable {
31 /// a wrapper for lyxrc.preview
32 static bool activated();
34 /// This is a singleton class. Get the instance.
35 static Previews & get();
37 /** Returns the PreviewLoader for this buffer.
38 * Used by individual insets to update their own preview.
39 * We assert that (buffer != 0) but do not pass a Buffer &
40 * so that insets do not need to #include buffer.h
42 PreviewLoader & loader(Buffer const * buffer) const;
44 /** Called from the Buffer d-tor.
45 * If (buffer == 0), does nothing.
47 void removeLoader(Buffer const * buffer) const;
49 /** For a particular buffer, initiate the generation of previews
50 * for each and every snippetof LaTeX that's of interest with
51 * a single forked process.
52 * If (buffer == 0), does nothing.
54 void generateBufferPreviews(Buffer const & buffer) const;
57 /** Make the c-tor, d-tor private so we can control how many objects
64 /// Use the Pimpl idiom to hide the internals.
66 /// The pointer never changes although *pimpl_'s contents may.
67 boost::scoped_ptr<Impl> const pimpl_;
70 } // namespace graphics