lyx_mirror/src/graphics/Previews.h
Angus Leeming f68a2bfb91 Preview code
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@4538 a592a061-630c-0410-9148-cb99ea01b6c8
2002-07-05 21:24:15 +00:00

74 lines
1.6 KiB
C++

// -*- C++ -*-
/**
* \file Previews.h
* Copyright 2002 the LyX Team
* Read the file COPYING
*
* \author Angus Leeming <a.leeming@ic.ac.uk>
*
* grfx::Previews is a singleton class that stores the grfx::PreviewLoader
* for each buffer requiring one.
*/
#ifndef PREVIEWS_H
#define PREVIEWS_H
#ifdef __GNUG__
#pragma interface
#endif
#include "LString.h"
#include <boost/utility.hpp>
#include <boost/scoped_ptr.hpp>
class Buffer;
namespace grfx {
class PreviewLoader;
class Previews : boost::noncopyable {
public:
/// a wrapper for lyxrc.preview
static bool activated();
/// This is a singleton class. Get the instance.
static Previews & get();
/** Returns the PreviewLoader for this buffer.
* Used by individual insets to update their own preview.
* We assert that (buffer != 0) but do not pass a Buffer &
* so that insets do not need to #include buffer.h
*/
PreviewLoader & loader(Buffer * buffer);
/** Called from the Buffer d-tor.
* If (buffer == 0), does nothing.
*/
void removeLoader(Buffer * buffer);
/** For a particular buffer, initiate the generation of previews
* for each and every snippetof LaTeX that's of interest with
* a single forked process.
* If (buffer == 0), does nothing.
*/
void generateBufferPreviews(Buffer * buffer);
private:
/** Make the c-tor, d-tor private so we can control how many objects
* are instantiated.
*/
Previews();
///
~Previews();
/// Use the Pimpl idiom to hide the internals.
class Impl;
/// The pointer never changes although *pimpl_'s contents may.
boost::scoped_ptr<Impl> const pimpl_;
};
} // namespace grfx
#endif // PREVIEWS_H