lyx_mirror/src/insets/RenderPreview.h
André Pönitz ed858d73e5 use bald pointers in clone()
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@19920 a592a061-630c-0410-9148-cb99ea01b6c8
2007-08-30 18:03:17 +00:00

135 lines
3.4 KiB
C++

// -*- C++ -*-
/**
* \file RenderPreview.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
*
* Full author contact details are available in file CREDITS.
*
* graphics::RenderPreview is an abstract base class that can help
* insets to generate previews. The daughter class must instantiate two small
* methods. The Inset would own an instance of this daughter class.
*/
#ifndef RENDERPREVIEW_H
#define RENDERPREVIEW_H
#include "RenderBase.h"
#include "support/FileMonitor.h"
#include "support/docstring.h"
#include <boost/signal.hpp>
#include <boost/signals/trackable.hpp>
#include <boost/signals/connection.hpp>
namespace lyx {
class Buffer;
class LyXRC_PreviewStatus;
class MetricsInfo;
class PainterInfo;
namespace support { class FileName; }
namespace graphics {
class PreviewImage;
class PreviewLoader;
} // namespace graphics
class RenderPreview : public RenderBase, public boost::signals::trackable {
public:
/// a wrapper for Previews::status()
static LyXRC_PreviewStatus status();
RenderPreview(Inset const *);
RenderPreview(RenderPreview const &, Inset const *);
~RenderPreview();
RenderBase * clone(Inset const *) const;
/// Compute the size of the object, returned in dim
bool metrics(MetricsInfo &, Dimension & dim) const;
///
void draw(PainterInfo & pi, int x, int y) const;
/** Find the PreviewLoader and add a LaTeX snippet to it.
* Do not start the loading process.
*/
void addPreview(docstring const & latex_snippet, Buffer const &);
/** Add a LaTeX snippet to the PreviewLoader.
* Do not start the loading process.
*/
void addPreview(docstring const & latex_snippet,
graphics::PreviewLoader & ploader);
/// Begin the loading process.
void startLoading(Buffer const & buffer) const;
/** Remove a snippet from the cache of previews.
* Useful if previewing the contents of a file that has changed.
*/
void removePreview(Buffer const &);
/** \returns a pointer to the PreviewImage associated with this snippet
* of latex.
*/
graphics::PreviewImage const *
getPreviewImage(Buffer const & buffer) const;
/// equivalent to dynamic_cast
virtual RenderPreview * asPreview() { return this; }
private:
/// Not implemented.
RenderPreview & operator=(RenderPreview const &);
/// This method is connected to the PreviewLoader::imageReady signal.
void imageReady(graphics::PreviewImage const &);
/// The thing that we're trying to generate a preview of.
std::string snippet_;
/** Store the connection to the preview loader so that we connect
* only once.
*/
boost::signals::connection ploader_connection_;
/// Inform the core that the inset has changed.
Inset const * parent_;
};
class RenderMonitoredPreview : public RenderPreview {
public:
RenderMonitoredPreview(Inset const *);
///
void draw(PainterInfo & pi, int x, int y) const;
///
void setAbsFile(support::FileName const & file);
///
bool monitoring() const { return monitor_.monitoring(); }
void startMonitoring() const { monitor_.start(); }
void stopMonitoring() const { monitor_.stop(); }
/// Connect and you'll be informed when the file changes.
typedef support::FileMonitor::slot_type slot_type;
boost::signals::connection fileChanged(slot_type const &);
/// equivalent to dynamic_cast
virtual RenderMonitoredPreview * asMonitoredPreview() { return this; }
private:
///
mutable support::FileMonitor monitor_;
};
} // namespace lyx
#endif // RENDERPREVIEW_H