// -*- 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
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2000 The LyX Team.
+ * \author Asger Alstrup Nielsen
*
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
#ifndef INSET_EXTERNAL_H
#define INSET_EXTERNAL_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "insetbutton.h"
-#include "ExternalTemplate.h"
+#include "inset.h"
+#include "graphics/GraphicsTypes.h"
+#include "support/filename.h"
#include "LString.h"
-#include <sigc++/signal_system.h>
-#ifdef SIGC_CXX_NAMESPACES
-using SigC::Signal0;
-#endif
+#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 InsetExternalParams {
- InsetExternalParams(string const & f = string(),
- string const & p = string(),
- ExternalTemplate const & t = ExternalTemplate())
- : filename(f), parameters(p), templ(t) {}
+ struct Params {
+ 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();
- /// what appears in the minibuffer when opening
- virtual string const EditMessage() const;
///
- virtual void Edit(BufferView *, int x, int y, unsigned int button);
+ virtual dispatch_result localDispatch(FuncRequest const & cmd);
+ ///
+ void metrics(MetricsInfo &, Dimension &) const;
+ ///
+ void draw(PainterInfo & pi, int x, int y) const;
///
- virtual EDITABLE Editable() const { return IS_EDITABLE; }
+ 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 &) const;
+ virtual int docbook(Buffer const &, std::ostream &, bool mixcont) const;
/// Updates needed features for this inset.
- virtual void Validate(LaTeXFeatures & features) const;
+ 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 &) const;
-
- /// returns the text of the button
- virtual string const getScreenLabel() const;
-
- // The following public members are used from the frontends code
-
- /// set the parameters from a Params structure
- virtual void setFromParams(InsetExternalParams const &);
+ virtual InsetOld::Code lyxCode() const { return EXTERNAL_CODE; }
- /// update the file represented by the template
- void updateExternal() 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
- InsetExternalParams params() const;
+ Params const & params() const;
+
+ /// Set the inset parameters.
+ virtual void setParams(Params const &, Buffer const &);
- /// hide connection
- Signal0<void> hideDialog;
+ /** 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;
private:
- /// Write the output for a specific file format
- int write(string const & format, Buffer const *,
- std::ostream &) const;
+ /** This method is connected to the graphics loader, so we are
+ * informed when the image has been loaded.
+ */
+ void statusChanged();
- /// Execute this command in the directory of this document
- void executeCommand(string const & s, Buffer const * buf) const;
+ /** 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;
- /// Substitute meta-variables in this string
- string const doSubstitution(Buffer const *, string const & s) const;
+ /// the current params
+ Params params_;
- /// our owning view
- BufferView * view;
+ /// The thing that actually draws the image on LyX's screen.
+ boost::scoped_ptr<RenderInset> renderer_;
+};
- /// the current params
- InsetExternalParams params_;
- /// A temp filename
- string tempname;
+#include "mailinset.h"
+
+class InsetExternalMailer : public MailInset {
+public:
+ ///
+ InsetExternalMailer(InsetExternal & inset);
+ ///
+ virtual InsetBase & inset() const { return inset_; }
+ ///
+ virtual string const & name() const { return name_; }
+ ///
+ virtual string const inset2string(Buffer const &) const;
+ ///
+ static void string2params(string const &, Buffer const &,
+ InsetExternal::Params &);
+ ///
+ static string const params2string(InsetExternal::Params const &,
+ Buffer const &);
+private:
+ ///
+ static string const name_;
+ ///
+ InsetExternal & inset_;
};
#endif
projects / lyx.git / blobdiff