*
* \author Asger Alstrup Nielsen
*
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
*/
#ifndef INSET_EXTERNAL_H
#define INSET_EXTERNAL_H
+#include "inset.h"
+#include "graphics/GraphicsTypes.h"
+#include "support/filename.h"
+#include "support/std_string.h"
-#include "insetbutton.h"
-#include "ExternalTemplate.h"
-#include "LString.h"
+#include <boost/scoped_ptr.hpp>
+#include <boost/signals/trackable.hpp>
+
+
+class RenderInset;
///
-class InsetExternal : public InsetButton {
+class InsetExternal : public InsetOld, public boost::signals::trackable {
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) {}
+ Params();
+ ~Params();
/// the filename
- string filename;
- /// the parameters of the current choice
- string parameters;
+ lyx::support::FileName filename;
/// the current template used
- ExternalTemplate templ;
+ string templatename;
+ /// The name of the tempfile used for manipulations.
+ string tempname;
+ /// how the inset is displayed by LyX
+ lyx::graphics::DisplayType display;
+ /// The scale of the displayed graphic (If shown).
+ unsigned int lyxscale;
};
InsetExternal();
///
+ InsetExternal(InsetExternal const &);
+ ///
virtual ~InsetExternal();
///
- virtual dispatch_result localDispatch(FuncRequest const & cmd);
- /// what appears in the minibuffer when opening
- virtual string const editMessage() const;
+ virtual dispatch_result localDispatch(FuncRequest const & cmd);
///
- virtual void edit(BufferView *, int x, int y, mouse_button::state button);
+ void metrics(MetricsInfo &, Dimension &) const;
///
- virtual void edit(BufferView * bv, bool front = true);
+ void draw(PainterInfo & pi, int x, int y) const;
///
virtual EDITABLE editable() const { return IS_EDITABLE; }
///
- virtual void write(Buffer const *, std::ostream &) const;
+ virtual void write(Buffer const &, std::ostream &) const;
///
- virtual void read(Buffer const *, LyXLex & lex);
+ 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
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;
+ virtual int latex(Buffer const &, std::ostream &,
+ LatexRunParams const &) const;
/// write ASCII output to the ostream
- virtual int ascii(Buffer const *, std::ostream &, int linelen) const;
+ virtual int ascii(Buffer const &, std::ostream &, int linelen) const;
/// write LinuxDoc output to the ostream
- virtual int linuxdoc(Buffer const *, std::ostream &) const;
+ virtual int linuxdoc(Buffer const &, std::ostream &) const;
/// write DocBook output to the ostream
- virtual int docbook(Buffer const *, std::ostream &, bool mixcont) const;
+ virtual int docbook(Buffer const &, std::ostream &, bool mixcont) 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; }
-
- ///
- 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 InsetOld::Code lyxCode() const { return EXTERNAL_CODE; }
///
- void updateExternal() const;
-
- /// update the file represented by the template
- void updateExternal(string const &, Buffer const *) const;
-
- /// edit file of this template
- void editExternal() const;
-
- /// view file of this template
- void viewExternal() const;
+ virtual std::auto_ptr<InsetBase> clone() const;
/// return a copy of our current params
Params const & params() const;
- ///
- void setView(BufferView * bv) { view_ = bv; }
-
-private:
- /// Write the output for a specific file format
- int write(string const & format, Buffer const *,
- std::ostream &) const;
+ /// Set the inset parameters.
+ virtual void setParams(Params const &, Buffer const &);
- /// Execute this command in the directory of this document
- void executeCommand(string const & s, Buffer const * buf) const;
+ /** update the file represented by the template.
+ If \param external_in_tmpdir == true, then the generated file is
+ place in the buffer's temporary directory.
+ */
+ void updateExternal(string const &, Buffer const &,
+ bool external_in_tmpdir) const;
- /// Substitute meta-variables in this string
- string const doSubstitution(Buffer const *, string const & s) const;
+private:
+ /** This method is connected to the graphics loader, so we are
+ * informed when the image has been loaded.
+ */
+ void statusChanged();
- /// our owning view
- BufferView * view_;
+ /** Write the output for a specific file format
+ and generate any external data files.
+ If \param external_in_tmpdir == true, then the generated file is
+ place in the buffer's temporary directory.
+ */
+ int write(string const & format, Buffer const &, std::ostream &,
+ bool external_in_tmpdir = false) const;
/// the current params
Params params_;
- /// A temp filename
- string tempname_;
+ /// The thing that actually draws the image on LyX's screen.
+ boost::scoped_ptr<RenderInset> renderer_;
};
///
InsetExternalMailer(InsetExternal & inset);
///
- virtual Inset & inset() const { return inset_; }
+ virtual InsetBase & inset() const { return inset_; }
///
virtual string const & name() const { return name_; }
///
- virtual string const inset2string() const;
+ virtual string const inset2string(Buffer const &) const;
///
- static void string2params(string const &, InsetExternal::Params &);
+ static void string2params(string const &, Buffer const &,
+ InsetExternal::Params &);
///
- static string const params2string(InsetExternal::Params const &);
+ static string const params2string(InsetExternal::Params const &,
+ Buffer const &);
private:
///
static string const name_;