// -*- C++ -*-
-/* This file is part of*
- * ======================================================
+/**
+ * \file insetexternal.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * LyX, The Document Processor
+ * \author Asger Alstrup Nielsen
*
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
- *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
#ifndef INSET_EXTERNAL_H
#define INSET_EXTERNAL_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "inset.h"
+#include "ExternalTransforms.h"
-#include "insetbutton.h"
-#include "ExternalTemplate.h"
-#include "LString.h"
-#include <sigc++/signal_system.h>
+#include "support/filename.h"
+#include "support/translator.h"
-///
-class InsetExternal : public InsetButton {
+#include <boost/scoped_ptr.hpp>
+#include <boost/signals/trackable.hpp>
+
+#include "mailinset.h"
+
+
+/** No two InsetExternalParams variables can have the same temporary file.
+ * This class has copy-semantics but the copy constructor
+ * and assignment operator simply call the default constructor.
+ * Use of this class enables us to use the compiler-generated
+ * 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_; }
+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
+
+
+/// hold parameters settable from the GUI
+class InsetExternalParams {
public:
- /// hold parameters settable from the GUI
- struct Params {
- Params(string const & f = string(),
- string const & p = string(),
- ExternalTemplate const & t = ExternalTemplate())
- : filename(f), parameters(p), templ(t) {}
- /// the filename
- string filename;
- /// the parameters of the current choice
- string parameters;
- /// the current template used
- ExternalTemplate templ;
- };
+ InsetExternalParams();
+ void write(Buffer const &, std::ostream &) const;
+ bool read(Buffer const &, LyXLex &);
+
+ /// The name of the tempfile used for manipulations.
+ support::FileName const & tempname() const { return tempname_(); }
+
+ /// The template currently in use.
+ void settemplate(std::string const &);
+ std::string const & templatename() const { return templatename_; }
+
+ /// The external file.
+ support::DocFileName filename;
+ /// How the inset is to be displayed by LyX.
+ external::DisplayType display;
+ /// The scale of the displayed graphic (if shown).
+ unsigned int lyxscale;
+
+ external::ClipData clipdata;
+ external::ExtraData extradata;
+ external::ResizeData resizedata;
+ external::RotationData rotationdata;
+
+ /** if \c true, simply output the filename, maybe wrapped in a
+ * box, rather than generate and display the image etc.
+ */
+ bool draft;
+
+private:
+ external::TempName tempname_;
+ std::string templatename_;
+};
+
+
+class RenderBase;
+
+///
+class InsetExternal : public InsetOld, public boost::signals::trackable
+{
+public:
InsetExternal();
///
virtual ~InsetExternal();
- /// what appears in the minibuffer when opening
- virtual string const editMessage() const;
- ///
- virtual void edit(BufferView *, int x, int y, mouse_button::state button);
///
- virtual void edit(BufferView * bv, bool front = true);
+ virtual InsetBase::Code lyxCode() const { return EXTERNAL_CODE; }
///
virtual EDITABLE editable() const { return IS_EDITABLE; }
+
///
- virtual void write(Buffer const *, std::ostream &) const;
+ bool metrics(MetricsInfo &, Dimension &) const;
///
- virtual void read(Buffer const *, LyXLex & lex);
-
- /** returns the number of rows (\n's) of generated tex code.
- fragile == true means, that the inset should take care about
- fragile commands by adding a \protect before.
- If the free_spc (freespacing) variable is set, then this inset
- is in a free-spacing paragraph.
- */
- virtual int latex(Buffer const *, std::ostream &, bool fragile,
- bool free_spc) const;
- /// write ASCII output to the ostream
- virtual int ascii(Buffer const *, std::ostream &, int linelen) const;
- /// write LinuxDoc output to the ostream
- virtual int linuxdoc(Buffer const *, std::ostream &) const;
- /// write DocBook output to the ostream
- virtual int docbook(Buffer const *, std::ostream &) const;
-
- /// Updates needed features for this inset.
- virtual void validate(LaTeXFeatures & features) const;
-
- /// returns LyX code associated with the inset. Used for TOC, ...)
- virtual Inset::Code lyxCode() const { return EXTERNAL_CODE; }
-
+ void draw(PainterInfo & pi, int x, int y) const;
///
- virtual Inset * clone(Buffer const &, bool same_id = false) const;
-
- /// returns the text of the button
- virtual string const getScreenLabel(Buffer const *) const;
-
- // The following public members are used from the frontends code
-
- /// set the parameters from a Params structure
- virtual void setFromParams(Params const &);
-
+ virtual void write(Buffer const &, std::ostream &) const;
///
- void updateExternal() const;
-
- /// update the file represented by the template
- void updateExternal(string const &, Buffer const *) const;
+ virtual void read(Buffer const &, LyXLex & lex);
- /// edit file of this template
- void editExternal() const;
-
- /// view file of this template
- void viewExternal() const;
+ /// \returns the number of rows (\n's) of generated code.
+ virtual int latex(Buffer const &, odocstream &,
+ OutputParams const &) const;
+ ///
+ virtual int plaintext(Buffer const &, odocstream &,
+ OutputParams const &) const;
+ ///
+ virtual int docbook(Buffer const &, odocstream &,
+ OutputParams const &) const;
- /// return a copy of our current params
- Params params() const;
+ /// Update needed features for this inset.
+ virtual void validate(LaTeXFeatures & features) const;
- /// hide connection
- SigC::Signal0<void> hideDialog;
+ ///
+ InsetExternalParams const & params() const;
+ ///
+ void setParams(InsetExternalParams const &, Buffer const &);
+ ///
+ void addPreview(graphics::PreviewLoader &) const;
+ ///
+ void edit(LCursor & cur, bool left);
+ ///
+ bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
+protected:
+ InsetExternal(InsetExternal const &);
+ ///
+ virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
private:
- /// Write the output for a specific file format
- int write(string const & format, Buffer const *,
- std::ostream &) const;
+ virtual std::auto_ptr<InsetBase> doClone() const;
- /// Execute this command in the directory of this document
- void executeCommand(string const & s, Buffer const * buf) const;
+ /** This method is connected to the graphics loader, so we are
+ * informed when the image has been loaded.
+ */
+ void statusChanged() const;
- /// Substitute meta-variables in this string
- string const doSubstitution(Buffer const *, string const & s) const;
+ /** Slot receiving a signal that the external file has changed
+ * and the preview should be regenerated.
+ */
+ void fileChanged() const;
- /// our owning view
- BufferView * view_;
+ /// The current params
+ InsetExternalParams params_;
+ /// The thing that actually draws the image on LyX's screen.
+ boost::scoped_ptr<RenderBase> renderer_;
+};
- /// the current params
- Params params_;
- /// A temp filename
- string tempname_;
+class InsetExternalMailer : public MailInset {
+public:
+ ///
+ InsetExternalMailer(InsetExternal & inset);
+ ///
+ virtual InsetBase & 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_;
};
-///
-bool operator==(InsetExternal::Params const &, InsetExternal::Params const &);
-///
-bool operator!=(InsetExternal::Params const &, InsetExternal::Params const &);
+} // namespace lyx
#endif
projects / lyx.git / blobdiff