]> git.lyx.org Git - lyx.git/blobdiff - src/insets/render_preview.h
The speed patch: redraw only rows that have changed
[lyx.git] / src / insets / render_preview.h
index 391ff05955aebdb2142fbdb780dea916a4a1e5e5..ecec3237a0c163069703a006ff7cd60acc11f7b3 100644 (file)
 
 #include "support/FileMonitor.h"
 
-#include <boost/signals/signal0.hpp>
+#include <boost/signal.hpp>
 #include <boost/signals/trackable.hpp>
 #include <boost/signals/connection.hpp>
 
 class Buffer;
-class BufferView;
+class LyXRC_PreviewStatus;
 class MetricsInfo;
 class PainterInfo;
 
@@ -41,45 +41,49 @@ class PreviewLoader;
 
 class RenderPreview : public RenderBase, public boost::signals::trackable {
 public:
-       /// a wrapper for Previews::activated()
-       static bool activated();
+       /// a wrapper for Previews::status()
+       static LyXRC_PreviewStatus status();
 
-       RenderPreview();
-       RenderPreview(RenderPreview const &);
-       RenderBase * clone() const;
+       RenderPreview(InsetBase const *);
+       RenderPreview(RenderPreview const &, InsetBase const *);
+       std::auto_ptr<RenderBase> clone(InsetBase 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, add a LaTeX snippet to it and
-        *  start the loading process.
+       /** Find the PreviewLoader and add a LaTeX snippet to it.
+        *  Do not start the loading process.
         */
-       void generatePreview(std::string const & latex_snippet,
-                            Buffer const &);
+       void addPreview(std::string const & latex_snippet, Buffer const &);
 
-       /** Add a LaTeX snippet to the PreviewLoader but do not start the
-        *  loading process.
+       /** Add a LaTeX snippet to the PreviewLoader.
+        *  Do not start the loading process.
         */
        void addPreview(std::string const & latex_snippet,
                        lyx::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 &);
 
-       /// The preview has been generated and is ready to use.
-       bool previewReady() const;
+       /** \returns a pointer to the PreviewImage associated with this snippet
+        *  of latex.
+        */
+       lyx::graphics::PreviewImage const *
+       getPreviewImage(Buffer const & buffer) const;
 
-       /// Connect and you'll be informed when the preview is ready.
-       typedef boost::signal0<void>::slot_type slot_type;
-       boost::signals::connection connect(slot_type const &);
+       /// equivalent to dynamic_cast
+       virtual RenderPreview * asPreview() { return this; }
 
 private:
        /// Not implemented.
-       void operator=(RenderPreview const &);
+       RenderPreview & operator=(RenderPreview const &);
 
        /// This method is connected to the PreviewLoader::imageReady signal.
        void imageReady(lyx::graphics::PreviewImage const &);
@@ -87,35 +91,39 @@ private:
        /// The thing that we're trying to generate a preview of.
        std::string snippet_;
 
-       /// We don't own this. Cached for efficiency reasons.
-       lyx::graphics::PreviewImage const * pimage_;
-
        /** Store the connection to the preview loader so that we connect
         *  only once.
         */
        boost::signals::connection ploader_connection_;
 
-       /// This signal is emitted when the preview is ready for display.
-       boost::signal0<void> preview_ready_signal_;
+       /// Inform the core that the inset has changed.
+       InsetBase const * parent_;
 };
 
 
 class RenderMonitoredPreview : public RenderPreview {
 public:
-       RenderMonitoredPreview() : monitor_(std::string(), 2000) {}
+       RenderMonitoredPreview(InsetBase const *);
        ///
-       bool monitoring() const { return monitor_.monitoring(); }
+       void draw(PainterInfo & pi, int x, int y) const;
        ///
-       void startMonitoring(std::string const & file);
+       void setAbsFile(std::string const & file);
        ///
-       void stopMonitoring() { monitor_.stop(); }
+       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 lyx::support::FileMonitor::slot_type slot_type;
        boost::signals::connection fileChanged(slot_type const &);
 
+       /// equivalent to dynamic_cast
+       virtual RenderMonitoredPreview * asMonitoredPreview() { return this; }
+
 private:
        ///
-       lyx::support::FileMonitor monitor_;
+       mutable lyx::support::FileMonitor monitor_;
 };
 
 #endif // RENDERPREVIEW_H