mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-28 12:26:59 +00:00
bdec44d614
As discussed on the devel list. See the subthread starting at http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg187916.html Soon to be replaced with the same strategy adopted in the stable branch.
143 lines
3.9 KiB
C++
143 lines
3.9 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/docstring.h"
|
|
#include "support/FileMonitor.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:
|
|
/// Return true if preview is enabled in text (from LyXRC::preview)
|
|
static bool previewText();
|
|
/// Return true if preview is enabled in mathed (from LyXRC::preview)
|
|
static bool previewMath();
|
|
|
|
RenderPreview(Inset const *);
|
|
RenderPreview(RenderPreview const &, Inset const *);
|
|
~RenderPreview();
|
|
RenderBase * clone(Inset const *) const;
|
|
|
|
/// Compute the size of the object, returned in dim
|
|
void 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.
|
|
* \param ignore_lyxrc: generate the preview no matter what LyXRC says
|
|
*/
|
|
void addPreview(docstring const & latex_snippet, Buffer const &,
|
|
bool ignore_lyxrc = false);
|
|
|
|
/** Add a LaTeX snippet to the PreviewLoader.
|
|
* Do not start the loading process.
|
|
* \param ignore_lyxrc: generate the preview no matter what LyXRC says
|
|
*/
|
|
void addPreview(docstring const & latex_snippet,
|
|
graphics::PreviewLoader & ploader,
|
|
bool ignore_lyxrc = false);
|
|
|
|
/// Begin the loading process.
|
|
/// \param forexport : whether this is intended for export. if so,
|
|
/// then we ignore LyXRC and wait for the image to be generated.
|
|
void startLoading(Buffer const & buffer, bool forexport = false) 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
|