*
* \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 "ExternalTransforms.h"
+
#include "support/filename.h"
-#include "LString.h"
+#include "support/translator.h"
#include <boost/scoped_ptr.hpp>
#include <boost/signals/trackable.hpp>
-class RenderInset;
+/** 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 {
+
+struct TempName {
+ TempName();
+ TempName(TempName const &);
+ ~TempName();
+ TempName & operator=(TempName const &);
+ std::string const & operator()() const { return tempname_; }
+private:
+ std::string 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
+} // namespace lyx
+
+
+/// hold parameters settable from the GUI
+struct InsetExternalParams {
+ InsetExternalParams();
+
+ void write(Buffer const &, std::ostream &) const;
+ bool read(Buffer const &, LyXLex &);
+
+ /// The name of the tempfile used for manipulations.
+ std::string 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.
+ 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;
+
+ lyx::external::ClipData clipdata;
+ lyx::external::ExtraData extradata;
+ lyx::external::ResizeData resizedata;
+ lyx::external::RotationData rotationdata;
+
+private:
+ lyx::external::TempName tempname_;
+ std::string templatename_;
+};
+
+
+class RenderBase;
///
-class InsetExternal : public InsetOld, public boost::signals::trackable {
+class InsetExternal : public InsetOld, public boost::signals::trackable
+{
public:
- /// hold parameters settable from the GUI
- struct Params {
- Params();
- ~Params();
- /// the filename
- lyx::support::FileName filename;
- /// the current template used
- 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);
+ virtual std::auto_ptr<InsetBase> clone() const;
+ ///
+ virtual InsetOld::Code lyxCode() const { return EXTERNAL_CODE; }
+ ///
+ virtual EDITABLE editable() const { return IS_EDITABLE; }
+
///
void metrics(MetricsInfo &, Dimension &) const;
///
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 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;
///
- virtual void write(Buffer const *, std::ostream &) const;
+ virtual int plaintext(Buffer const &, std::ostream &,
+ OutputParams const &) const;
///
- virtual void read(Buffer const *, LyXLex & lex);
+ virtual int linuxdoc(Buffer const &, std::ostream &,
+ OutputParams const &) const;
+ ///
+ virtual int docbook(Buffer const &, std::ostream &,
+ OutputParams const &) const;
- /** 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 &,
- LatexRunParams const &) 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 &, bool mixcont) const;
-
- /// Updates needed features for this inset.
+ /// Update needed features for this inset.
virtual void validate(LaTeXFeatures & features) const;
- /// returns LyX code associated with the inset. Used for TOC, ...)
- virtual InsetOld::Code lyxCode() const { return EXTERNAL_CODE; }
-
///
- virtual std::auto_ptr<InsetBase> clone() const;
-
- /// return a copy of our current params
- Params const & params() const;
-
- /// Set the inset parameters.
- virtual void setParams(Params const &, Buffer 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;
+ InsetExternalParams const & params() const;
+ void setParams(InsetExternalParams const &, Buffer const &);
+ ///
+ void addPreview(lyx::graphics::PreviewLoader &) const;
+ ///
+ void edit(BufferView * bv, bool);
+protected:
+ ///
+ 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();
+ void statusChanged() 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;
-
- /// the current params
- Params params_;
+ /** Slot receiving a signal that the external file has changed
+ * and the preview should be regenerated.
+ */
+ void fileChanged() const;
+ /// The current params
+ InsetExternalParams params_;
/// The thing that actually draws the image on LyX's screen.
- boost::scoped_ptr<RenderInset> renderer_;
+ boost::scoped_ptr<RenderBase> renderer_;
};
///
virtual InsetBase & inset() const { return inset_; }
///
- virtual string const & name() const { return name_; }
+ virtual std::string const & name() const { return name_; }
///
- virtual string const inset2string(Buffer const &) const;
+ virtual std::string const inset2string(Buffer const &) const;
///
- static void string2params(string const &, Buffer const &,
- InsetExternal::Params &);
+ static void string2params(std::string const &, Buffer const &,
+ InsetExternalParams &);
///
- static string const params2string(InsetExternal::Params const &,
- Buffer const &);
+ static std::string const params2string(InsetExternalParams const &,
+ Buffer const &);
private:
///
- static string const name_;
+ static std::string const name_;
///
InsetExternal & inset_;
};
projects / lyx.git / blobdiff