Clean up InsetGraphics::Cache and rename as GraphicsInset.

[lyx.git] / src / insets / insetgraphics.h

diff --git a/src/insets/insetgraphics.h b/src/insets/insetgraphics.h
index d3e04cf76b2f44f69d28b153efc6af2d72f37631..0ea045452f3cfcdac71dea21a9229ae9b096af17 100644 (file)
--- a/src/insets/insetgraphics.h
+++ b/src/insets/insetgraphics.h
@@ -1,33 +1,27 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- *           LyX, The Document Processor
- *
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2001 the LyX Team.
+/**
+ * \file insetgraphics.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
  * \author Baruch Even
- * \author Herbert Voss <voss@lyx.org>
- * ====================================================== */
+ * \author Herbert Voss
+ *
+ * Full author contact details are available in file CREDITS
+ */
 
 #ifndef INSET_GRAPHICS_H
 #define INSET_GRAPHICS_H
 
+#include "inset.h"
+#include "insetgraphicsParams.h"
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "insets/inset.h"
-#include "graphics/GraphicsTypes.h"
-#include "insets/insetgraphicsParams.h"
-
-// We need a signal here to hide an active dialog when we are deleted.
-#include <boost/signals/signal0.hpp>
+#include <boost/scoped_ptr.hpp>
 #include <boost/signals/trackable.hpp>
 
+
 class Dialogs;
+class GraphicInset;
 class LaTeXFeatures;
 
 ///
@@ -36,22 +30,15 @@ public:
        ///
        InsetGraphics();
        ///
-       InsetGraphics(InsetGraphics const &, string const & filepath,
-                     bool same_id = false);
+       InsetGraphics(InsetGraphics const &);
        ///
        ~InsetGraphics();
        ///
-       int ascent(BufferView *, LyXFont const &) const;
+       virtual dispatch_result localDispatch(FuncRequest const & cmd);
        ///
-       int descent(BufferView *, LyXFont const &) const;
+       void metrics(MetricsInfo &, Dimension &) const;
        ///
-       int width(BufferView *, LyXFont const &) const;
-       ///
-       void draw(BufferView *, LyXFont const &, int, float &, bool) const;
-       ///
-       void edit(BufferView *, int, int, mouse_button::state);
-       ///
-       void edit(BufferView * bv, bool front = true);
+       void draw(PainterInfo & pi, int x, int y) const;
        ///
        EDITABLE editable() const;
        ///
@@ -64,13 +51,13 @@ public:
         fragile commands by adding a #\protect# before.
         */
        int latex(Buffer const *, std::ostream &,
-                 bool fragile, bool free_spc) const;
+                 LatexRunParams const &) const;
        ///
        int ascii(Buffer const *, std::ostream &, int linelen) const;
        ///
        int linuxdoc(Buffer const *, std::ostream &) const;
        ///
-       int docbook(Buffer const *, std::ostream &) const;
+       int docbook(Buffer const *, std::ostream &, bool mixcont) const;
 
        /** Tell LyX what the latex features you need i.e. what latex packages
            you need to be included.
@@ -81,41 +68,34 @@ public:
        Inset::Code lyxCode() const { return Inset::GRAPHICS_CODE; }
 
        ///
-       virtual Inset * clone(Buffer const &, bool same_id = false) const;
+       virtual Inset * clone() const;
 
        /** Set the inset parameters, used by the GUIndependent dialog.
            Return true of new params are different from what was so far.
        */
-       bool setParams(InsetGraphicsParams const & params,
-                      string const & filepath);
+       bool setParams(InsetGraphicsParams const & params);
 
        /// Get the inset parameters, used by the GUIndependent dialog.
        InsetGraphicsParams const & params() const;
 
-       /** This signal is connected by our dialog and called when the inset
-           is deleted.
-       */
-       boost::signal0<void> hideDialog;
-
 private:
-       /// Set the cached variables
-       void setCache() const;
-       /// Is the image ready to draw, or should we display a message instead?
-       bool drawImage() const;
+       ///
+       friend class InsetGraphicsMailer;
+
+       /** This method is connected to the graphics loader, so we are
+        *  informed when the image has been loaded.
+        */
+       void statusChanged();
 
        /// Read the inset native format
-       void readInsetGraphics(LyXLex & lex);
-       /// Read the FigInset file format
-       void readFigInset(LyXLex & lex);
+       void readInsetGraphics(LyXLex & lex, string const & bufpath);
 
-       /// Update the inset after parameter change.
-       void updateInset(string const & filepath) const;
        /// Get the status message, depends on the image loading status.
        string const statusMessage() const;
        /// Create the options for the latex command.
        string const createLatexOptions() const;
        /// Convert the file if needed, and return the location of the file.
-       string const prepareFile(Buffer const * buf) const;
+       string const prepareFile(Buffer const * buf, LatexRunParams const &) const;
 
        ///
        InsetGraphicsParams params_;
@@ -123,14 +103,32 @@ private:
        /// holds the entity name that defines the graphics location (SGML).
        string const graphic_label;
 
-       /// The cached variables
-       mutable grfx::ImageStatus cached_status_;
+       /// The thing that actually draws the image on LyX's screen.
+       boost::scoped_ptr<GraphicInset> const graphic_;
+};
+
+
+#include "mailinset.h"
+
+class InsetGraphicsMailer : public MailInset {
+public:
        ///
-       mutable grfx::ImagePtr cached_image_;
+       InsetGraphicsMailer(InsetGraphics & inset);
+       ///
+       virtual InsetBase & inset() const { return inset_; }
+       ///
+       virtual string const & name() const { return name_; }
+       ///
+       virtual string const inset2string() const;
+       ///
+       static void string2params(string const &, InsetGraphicsParams &);
+       ///
+       static string const params2string(InsetGraphicsParams const &);
+private:
        ///
-       mutable bool cache_filled_;
+       static string const name_;
        ///
-       mutable int old_asc;
+       InsetGraphics & inset_;
 };
 
 #endif