// -*- 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 "inset.h"
+#include "ExternalTransforms.h"
-#include "insetbutton.h"
-#include "LString.h"
-#include "../lyx.h"
+#include "support/filename.h"
+#include "support/translator.h"
-struct ExternalTemplate;
+#include <boost/scoped_ptr.hpp>
+#include <boost/signals/trackable.hpp>
-///
-class InsetExternal : public InsetButton {
-public:
- InsetExternal();
- ///
- virtual ~InsetExternal();
- /// what appears in the minibuffer when opening
- virtual char const * EditMessage() const;
- ///
- virtual void Edit(BufferView *, int x, int y, unsigned int button);
- ///
- virtual EDITABLE Editable() const { return IS_EDITABLE; }
- ///
- virtual void Write(Buffer const *, std::ostream &) 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;
- ///
- virtual int Ascii(Buffer const *, std::ostream &) const;
- ///
- virtual int Linuxdoc(Buffer const *, std::ostream &) const;
- ///
- 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; }
-
- ///
- virtual Inset * Clone() const;
+/** No two InsetExternalParams variables can have the same temporary file.
+ * This struct has copy-semantics but the copy constructor
+ * and assignment operator simply call the default constructor.
+ * Use of this struct enables us to use the compiler-generated
+ * copy constructor and assignment operator for the
+ * InsetExternalParams struct.
+ */
+namespace lyx {
+namespace external {
- /// returns the text of the button
- virtual string getScreenLabel() const;
+struct TempName {
+ TempName();
+ TempName(TempName const &);
+ ~TempName();
+ TempName & operator=(TempName const &);
+ std::string const & operator()() const { return tempname_; }
+private:
+ std::string tempname_;
+};
- /// Callback function for the template drop-down
- static void templateCB(FL_OBJECT *, long);
+/// How is the image to be displayed on the LyX screen?
+enum DisplayType {
+ DefaultDisplay,
+ MonochromeDisplay,
+ GrayscaleDisplay,
+ ColorDisplay,
+ PreviewDisplay,
+ NoDisplay
+};
- /// Callback function for the browse button
- static void browseCB(FL_OBJECT *, long);
- /// Callback function for the edit button
- static void editCB(FL_OBJECT *, long);
+/// The translator between the Display enum and corresponding lyx string.
+Translator<DisplayType, std::string> const & displayTranslator();
- /// Callback function for the view button
- static void viewCB(FL_OBJECT *, long);
+} // namespace external
+} // namespace lyx
- /// Callback function for the update production button
- static void updateCB(FL_OBJECT *, long);
- /// Callback function for the ok button
- static void okCB(FL_OBJECT *, long);
+/// hold parameters settable from the GUI
+struct InsetExternalParams {
+ InsetExternalParams();
- /// Callback function for the cancel button
- static void cancelCB(FL_OBJECT *, long);
-private:
- /// Write the output for a specific file format
- int write(string const & format, Buffer const *,
- std::ostream &) const;
+ void write(Buffer const &, std::ostream &) const;
+ bool read(Buffer const &, LyXLex &);
- /// Apply the changes
- void doApply(BufferView * bv);
+ /// The name of the tempfile used for manipulations.
+ std::string const & tempname() const { return tempname_(); }
- /// Execute this command in the directory of this document
- void executeCommand(string const & s, Buffer const * buf) const;
+ /// The template currently in use.
+ void settemplate(std::string const &);
+ std::string const & templatename() const { return templatename_; }
- /// Update if automatic
- void automaticUpdate(BufferView const *) const;
+ /// The external file.
+ lyx::support::FileName filename;
+ /// How the inset is to be displayed by LyX.
+ lyx::external::DisplayType display;
+ /// The scale of the displayed graphic (if shown).
+ unsigned int lyxscale;
- /// Do update
- void doUpdate(BufferView const *) const;
- /// Do edit
- void doEdit(BufferView const *) const;
- /// Do view
- void doView(BufferView const *) const;
+ lyx::external::ClipData clipdata;
+ lyx::external::ExtraData extradata;
+ lyx::external::ResizeData resizedata;
+ lyx::external::RotationData rotationdata;
- /// Substitute meta-variables in this string
- string doSubstitution(Buffer const *, string const & s) const;
-
- /** Get the LyX name of the currently selected
- template in the choice list
- */
- string getCurrentTemplate() const;
+private:
+ lyx::external::TempName tempname_;
+ std::string templatename_;
+};
- /// Get a certain template from a LyX name
- ExternalTemplate getTemplate(string const & lyxname) const;
- /**
- * Get the number starting from 1 of a template with a
- * specific LyX name for the choice list
- */
- int getTemplateNumber(string const & guiname) const;
+class RenderBase;
- /// Get the LyX name of a template with a given number starting from 1
- string getTemplateName(int n) const;
+///
+class InsetExternal : public InsetOld, public boost::signals::trackable
+{
+public:
+ InsetExternal();
+ ///
+ InsetExternal(InsetExternal const &);
+ ///
+ virtual ~InsetExternal();
+ ///
+ virtual std::auto_ptr<InsetBase> clone() const;
+ ///
+ virtual InsetOld::Code lyxCode() const { return EXTERNAL_CODE; }
+ ///
+ virtual EDITABLE editable() const { return IS_EDITABLE; }
- /// Get a string with all the GUI template names separated by |
- string getTemplateString() const;
+ ///
+ void metrics(MetricsInfo &, Dimension &) const;
+ ///
+ void draw(PainterInfo & pi, int x, int y) const;
+ ///
+ virtual void write(Buffer const &, std::ostream &) const;
+ ///
+ virtual void read(Buffer const &, LyXLex & lex);
+ /// \returns the number of rows (\n's) of generated code.
+ virtual int latex(Buffer const &, std::ostream &,
+ OutputParams const &) const;
///
- struct Holder {
- InsetExternal * inset;
- BufferView * view;
- };
+ virtual int plaintext(Buffer const &, std::ostream &,
+ OutputParams const &) const;
///
- Holder holder;
+ virtual int linuxdoc(Buffer const &, std::ostream &,
+ OutputParams const &) const;
+ ///
+ virtual int docbook(Buffer const &, std::ostream &,
+ OutputParams const &) const;
- /// The external inset form
- FD_form_external * form_external;
+ /// Update needed features for this inset.
+ virtual void validate(LaTeXFeatures & features) const;
///
- string templatename;
-
+ InsetExternalParams const & params() const;
+ void setParams(InsetExternalParams const &, Buffer const &);
///
- string filename;
+ void addPreview(lyx::graphics::PreviewLoader &) const;
+ ///
+ void edit(BufferView * bv, bool);
+protected:
///
- string parameters;
+ virtual
+ DispatchResult
+ priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &);
+private:
+ /** 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;
- /// A temp filename
- string tempname;
+ /// The current params
+ InsetExternalParams params_;
+ /// The thing that actually draws the image on LyX's screen.
+ boost::scoped_ptr<RenderBase> renderer_;
+};
+
+
+#include "mailinset.h"
+
+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_;
};
#endif
projects / lyx.git / blobdiff