#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
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 &);
std::string const & templatename() const { return templatename_; }
/// The external file.
- EmbeddedFile filename;
- /// How the inset is to be displayed by LyX.
- external::DisplayType display;
+ support::DocFileName filename;
+ /// 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;
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(Buffer &);
+ explicit InsetExternal(Buffer *);
///
~InsetExternal();
///
- void setBuffer(Buffer & buffer);
+ static void string2params(std::string const &, Buffer const &,
+ InsetExternalParams &);
///
- InsetCode lyxCode() const { return EXTERNAL_CODE; }
+ static std::string params2string(InsetExternalParams const &,
+ Buffer const &);
///
- EDITABLE editable() const { return IS_EDITABLE; }
-
+ InsetExternalParams const & params() const;
///
- void metrics(MetricsInfo &, Dimension &) 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 override;
///
- void draw(PainterInfo & pi, int x, int y) const;
+ std::string contextMenuName() const override;
///
- void write(std::ostream &) const;
+ bool setMouseHover(BufferView const * bv, bool mouse_hover) const override;
///
- void read(Lexer & lex);
-
- /// \returns the number of rows (\n's) of generated code.
- int latex(odocstream &, OutputParams const &) const;
+ bool clickable(BufferView const &, int, int) const override { return true; }
+ ///
+ void addToToc(DocIterator const & di, bool output_active,
+ UpdateType utype, TocBackend & backend) const override;
///
- int plaintext(odocstream &, OutputParams const &) const;
+ InsetCode lyxCode() const override { return EXTERNAL_CODE; }
///
- int docbook(odocstream &, OutputParams const &) const;
+ bool hasSettings() const override { return true; }
- /// Update needed features for this inset.
- virtual void validate(LaTeXFeatures & features) const;
+ ///
+ int topOffset(BufferView const *) const override { return 0; }
+ ///
+ int bottomOffset(BufferView const *) const override { return 0; }
+ ///
+ int leftOffset(BufferView const *) const override { return 0; }
+ ///
+ int rightOffset(BufferView const *) const override { return 0; }
///
- InsetExternalParams const & params() const;
+ void metrics(MetricsInfo &, Dimension &) const override;
///
- void setParams(InsetExternalParams const &);
+ void draw(PainterInfo & pi, int x, int y) const override;
///
- void addPreview(graphics::PreviewLoader &) const;
+ void write(std::ostream &) const override;
///
- void edit(Cursor & cur, bool front, EntryDirection entry_from);
+ void read(Lexer & lex) override;
///
- bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
- /// external file can be embedded
- void registerEmbeddedFiles(EmbeddedFileList &) const;
+ int plaintext(odocstringstream & ods, OutputParams const & op,
+ size_t max_length = INT_MAX) const override;
///
- void updateEmbeddedFile(EmbeddedFile const &);
-
-protected:
- InsetExternal(InsetExternal const &);
+ void generateXML(XMLStream &, OutputParams const &, std::string const &) const;
///
- void doDispatch(Cursor & cur, FuncRequest & cmd);
-private:
+ void docbook(XMLStream &, OutputParams const &) const override;
+ /// For now, this does nothing. Someone who knows about this
+ /// should see what needs doing for XHTML output.
+ docstring xhtml(XMLStream &, OutputParams const &) const override;
+ /// Update needed features for this inset.
+ void validate(LaTeXFeatures & features) const override;
///
- 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;
-
+ void addPreview(DocIterator const &, graphics::PreviewLoader &) const override;
+ ///
+ bool showInsetDialog(BufferView * bv) const override;
+ ///
+ bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const override;
+ ///
+ void doDispatch(Cursor & cur, FuncRequest & cmd) override;
+ ///
+ Inset * clone() const override { return new InsetExternal(*this); }
/** Slot receiving a signal that the external file has changed
* and the preview should be regenerated.
*/
void fileChanged() const;
+private:
+ ///
+ InsetExternal(InsetExternal 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