src/insets/RenderPreview.h

   1 // -*- C++ -*-
   2 /**
   3  * \file RenderPreview.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  *
  11  * graphics::RenderPreview 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.
  14  */
  15
  16 #ifndef RENDERPREVIEW_H
  17 #define RENDERPREVIEW_H
  18
  19 #include "RenderBase.h"
  20
  21 #include "support/docstring.h"
  22 #include "support/FileMonitor.h"
  23
  24 #include <boost/signal.hpp>
  25 #include <boost/signals/trackable.hpp>
  26 #include <boost/signals/connection.hpp>
  27
  28 namespace lyx {
  29
  30 class Buffer;
  31 class LyXRC_PreviewStatus;
  32 class MetricsInfo;
  33 class PainterInfo;
  34
  35 namespace support { class FileName; }
  36
  37 namespace graphics {
  38
  39 class PreviewImage;
  40 class PreviewLoader;
  41
  42 } // namespace graphics
  43
  44
  45 class RenderPreview : public RenderBase, public boost::signals::trackable {
  46 public:
  47         /// a wrapper for Previews::status()
  48         static LyXRC_PreviewStatus status();
  49
  50         RenderPreview(Inset const *);
  51         RenderPreview(RenderPreview const &, Inset const *);
  52         ~RenderPreview();
  53         RenderBase * clone(Inset const *) const;
  54
  55         /// Compute the size of the object, returned in dim
  56         void metrics(MetricsInfo &, Dimension & dim) const;
  57         ///
  58         void draw(PainterInfo & pi, int x, int y) const;
  59
  60         /** Find the PreviewLoader and add a LaTeX snippet to it.
  61          *  Do not start the loading process.
  62          */
  63         void addPreview(docstring const & latex_snippet, Buffer const &);
  64
  65         /** Add a LaTeX snippet to the PreviewLoader.
  66          *  Do not start the loading process.
  67          */
  68         void addPreview(docstring const & latex_snippet,
  69                         graphics::PreviewLoader & ploader);
  70
  71         /// Begin the loading process.
  72         void startLoading(Buffer const & buffer) const;
  73
  74         /** Remove a snippet from the cache of previews.
  75          *  Useful if previewing the contents of a file that has changed.
  76          */
  77         void removePreview(Buffer const &);
  78
  79         /** \returns a pointer to the PreviewImage associated with this snippet
  80          *  of latex.
  81          */
  82         graphics::PreviewImage const *
  83         getPreviewImage(Buffer const & buffer) const;
  84
  85         /// equivalent to dynamic_cast
  86         virtual RenderPreview * asPreview() { return this; }
  87
  88 private:
  89         /// Not implemented.
  90         RenderPreview & operator=(RenderPreview const &);
  91
  92         /// This method is connected to the PreviewLoader::imageReady signal.
  93         void imageReady(graphics::PreviewImage const &);
  94
  95         /// The thing that we're trying to generate a preview of.
  96         std::string snippet_;
  97
  98         /** Store the connection to the preview loader so that we connect
  99          *  only once.
 100          */
 101         boost::signals::connection ploader_connection_;
 102
 103         /// Inform the core that the inset has changed.
 104         Inset const * parent_;
 105 };
 106
 107
 108 class RenderMonitoredPreview : public RenderPreview {
 109 public:
 110         RenderMonitoredPreview(Inset const *);
 111         ///
 112         void draw(PainterInfo & pi, int x, int y) const;
 113         ///
 114         void setAbsFile(support::FileName const & file);
 115         ///
 116         bool monitoring() const { return monitor_.monitoring(); }
 117         void startMonitoring() const { monitor_.start(); }
 118         void stopMonitoring() const { monitor_.stop(); }
 119
 120         /// Connect and you'll be informed when the file changes.
 121         typedef support::FileMonitor::slot_type slot_type;
 122         boost::signals::connection fileChanged(slot_type const &);
 123
 124         /// equivalent to dynamic_cast
 125         virtual RenderMonitoredPreview * asMonitoredPreview() { return this; }
 126
 127 private:
 128         ///
 129         mutable support::FileMonitor monitor_;
 130 };
 131
 132 } // namespace lyx
 133
 134 #endif // RENDERPREVIEW_H