]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetExternal.h
Update shortcuts in fr.po
[lyx.git] / src / insets / InsetExternal.h
index ac6cc991fa8e9296d38da9c89463bf39c9716b7c..75b7f70ffa5f9d2690047422fec1145288552c13 100644 (file)
 #define INSET_EXTERNAL_H
 
 #include "Inset.h"
-#include "ExternalTransforms.h"
-#include "EmbeddedFiles.h"
+
+#include "ExternalTemplate.h"
 
 #include "support/FileName.h"
-#include "support/Translator.h"
+#include "support/unique_ptr.h"
 
-#include <boost/scoped_ptr.hpp>
-#include <boost/signals/trackable.hpp>
 
-#include "MailInset.h"
+namespace lyx {
 
+namespace external {
 
 /** No two InsetExternalParams variables can have the same temporary file.
  *  This class has copy-semantics but the copy constructor
  *  copy constructor and assignment operator for the
  *  InsetExternalParams class.
  */
-namespace lyx {
-
-namespace external {
-
 class TempName {
 public:
        TempName();
        TempName(TempName const &);
        ~TempName();
        TempName & operator=(TempName const &);
-       support::FileName const & operator()() const { return tempname_; }
+       support::FileName operator()() const;
 private:
        support::FileName tempname_;
 };
 
-/// How is the image to be displayed on the LyX screen?
-enum DisplayType {
-       DefaultDisplay,
-       MonochromeDisplay,
-       GrayscaleDisplay,
-       ColorDisplay,
-       PreviewDisplay,
-       NoDisplay
-};
-
-
-/// The translator between the Display enum and corresponding lyx string.
-Translator<DisplayType, std::string> const & displayTranslator();
-
 } // namespace external
 
 
@@ -73,7 +54,7 @@ public:
        bool read(Buffer const &, Lexer &);
 
        /// The name of the tempfile used for manipulations.
-       support::FileName const & tempname() const { return tempname_(); }
+       support::FileName tempname() const { return tempname_(); }
 
        /// The template currently in use.
        void settemplate(std::string const &);
@@ -81,8 +62,10 @@ public:
 
        /// The external file.
        support::DocFileName filename;
-       /// How the inset is to be displayed by LyX.
-       external::DisplayType display;
+       /// If the inset is to be displayed by LyX.
+       bool display;
+       /// If the inset is to use the preview mechanism.
+       PreviewMode preview_mode;
        /// The scale of the displayed graphic (if shown).
        unsigned int lyxscale;
 
@@ -105,100 +88,94 @@ private:
 class RenderBase;
 
 ///
-class InsetExternal : public Inset, public boost::signals::trackable
+class InsetExternal : public Inset
 {
+       // Disable assignment operator, since it is not used, and it is too
+       // complicated to implement it consistently with the copy constructor
+       InsetExternal & operator=(InsetExternal const &);
 public:
-       InsetExternal();
+       InsetExternal(Buffer *);
        ///
-       virtual ~InsetExternal();
+       ~InsetExternal();
        ///
-       virtual Inset::Code lyxCode() const { return EXTERNAL_CODE; }
+       static void string2params(std::string const &, Buffer const &,
+                                 InsetExternalParams &);
        ///
-       virtual EDITABLE editable() const { return IS_EDITABLE; }
-
+       static std::string params2string(InsetExternalParams const &,
+                                              Buffer const &);
        ///
-       bool metrics(MetricsInfo &, Dimension &) const;
+       InsetExternalParams const & params() const;
        ///
-       void draw(PainterInfo & pi, int x, int y) const;
+       void setParams(InsetExternalParams const &);
+       /// Update not loaded previews
+       void updatePreview() const;
+       /// \returns the number of rows (\n's) of generated code.
+       void latex(otexstream &, OutputParams const &) const;
        ///
-       virtual void write(Buffer const &, std::ostream &) const;
+       std::string contextMenuName() const;
        ///
-       virtual void read(Buffer const &, Lexer & lex);
-
-       /// \returns the number of rows (\n's) of generated code.
-       int latex(Buffer const &, odocstream &,
-                 OutputParams const &) const;
+       bool setMouseHover(BufferView const * bv, bool mouse_hover) const;
        ///
-       int plaintext(Buffer const &, odocstream &,
-                     OutputParams const &) const;
+       bool clickable(BufferView const &, int, int) const { return true; }
        ///
-       int docbook(Buffer const &, odocstream &,
-                   OutputParams const &) const;
-
-       /// Update needed features for this inset.
-       virtual void validate(LaTeXFeatures & features) const;
-
+       void addToToc(DocIterator const & di, bool output_active,
+                                 UpdateType utype, TocBackend & backend) const;
+private:
        ///
-       InsetExternalParams const & params() const;
+       InsetExternal(InsetExternal const &);
        ///
-       void setParams(InsetExternalParams const &, Buffer const &);
+       InsetCode lyxCode() const { return EXTERNAL_CODE; }
        ///
-       void addPreview(graphics::PreviewLoader &) const;
+       bool hasSettings() const { return true; }
+       ///
+       void metrics(MetricsInfo &, Dimension &) const;
+       ///
+       void draw(PainterInfo & pi, int x, int y) const;
        ///
-       void edit(Cursor & cur, bool left);
+       void write(std::ostream &) const;
+       ///
+       void read(Lexer & lex);
+       ///
+       int plaintext(odocstringstream & ods, OutputParams const & op,
+                     size_t max_length = INT_MAX) const;
+       ///
+       int docbook(odocstream &, OutputParams const &) const;
+       /// For now, this does nothing. Someone who knows about this
+       /// should see what needs doing for XHTML output.
+       docstring xhtml(XHTMLStream &, OutputParams const &) const;
+       /// Update needed features for this inset.
+       void validate(LaTeXFeatures & features) const;
+       ///
+       void addPreview(DocIterator const &, graphics::PreviewLoader &) const;
+       ///
+       bool showInsetDialog(BufferView * bv) const;
        ///
        bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
-       /// external file can be embedded
-       void registerEmbeddedFiles(Buffer const &, EmbeddedFiles &,
-                       ParConstIterator const &) const;
-
-protected:
-       InsetExternal(InsetExternal const &);
        ///
-       virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
-private:
-       virtual Inset * clone() const;
-
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
+       ///
+       Inset * clone() const { return new InsetExternal(*this); }
        /** This method is connected to the graphics loader, so we are
         *  informed when the image has been loaded.
         */
        void statusChanged() const;
-
        /** Slot receiving a signal that the external file has changed
         *  and the preview should be regenerated.
         */
        void fileChanged() const;
+       /// Is this inset using (instant or graphics) preview?
+       bool isPreviewed() const;
+       /// Do we have the right renderer (button, graphic or monitored preview)?
+       bool isRendererValid() const;
 
        /// The current params
        InsetExternalParams params_;
        /// The thing that actually draws the image on LyX's screen.
-       boost::scoped_ptr<RenderBase> renderer_;
-};
-
-
-class InsetExternalMailer : public MailInset {
-public:
-       ///
-       InsetExternalMailer(InsetExternal & inset);
-       ///
-       virtual Inset & inset() const { return inset_; }
-       ///
-       virtual std::string const & name() const { return name_; }
-       ///
-       virtual std::string const inset2string(Buffer const &) const;
-       ///
-       static void string2params(std::string const &, Buffer const &,
-                                 InsetExternalParams &);
-       ///
-       static std::string const params2string(InsetExternalParams const &,
-                                              Buffer const &);
-private:
-       ///
-       static std::string const name_;
-       ///
-       InsetExternal & inset_;
+       mutable unique_ptr<RenderBase> renderer_;
+       /// changes color of the button when mouse enters/leaves this inset
+       mutable std::map<BufferView const *, bool> mouse_hover_;
 };
 
 } // namespace lyx
 
-#endif
+#endif // INSET_EXTERNAL_H