3 * \file insetexternal.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Asger Alstrup Nielsen
9 * Full author contact details are available in file CREDITS.
12 #ifndef INSET_EXTERNAL_H
13 #define INSET_EXTERNAL_H
16 #include "ExternalTransforms.h"
18 #include "support/filename.h"
19 #include "support/translator.h"
21 #include <boost/scoped_ptr.hpp>
22 #include <boost/signals/trackable.hpp>
25 /** No two InsetExternalParams variables can have the same temporary file.
26 * This struct has copy-semantics but the copy constructor
27 * and assignment operator simply call the default constructor.
28 * Use of this struct enables us to use the compiler-generated
29 * copy constructor and assignment operator for the
30 * InsetExternalParams struct.
37 TempName(TempName const &);
39 TempName & operator=(TempName const &);
40 std::string const & operator()() const { return tempname_; }
42 std::string tempname_;
45 /// How is the image to be displayed on the LyX screen?
56 /// The translator between the Display enum and corresponding lyx string.
57 Translator<DisplayType, std::string> const & displayTranslator();
59 } // namespace external
63 /// hold parameters settable from the GUI
64 struct InsetExternalParams {
65 InsetExternalParams();
67 void write(Buffer const &, std::ostream &) const;
68 bool read(Buffer const &, LyXLex &);
70 /// The name of the tempfile used for manipulations.
71 std::string const & tempname() const { return tempname_(); }
73 /// The template currently in use.
74 void settemplate(std::string const &);
75 std::string const & templatename() const { return templatename_; }
77 /// The external file.
78 lyx::support::FileName filename;
79 /// How the inset is to be displayed by LyX.
80 lyx::external::DisplayType display;
81 /// The scale of the displayed graphic (if shown).
82 unsigned int lyxscale;
84 lyx::external::ClipData clipdata;
85 lyx::external::ExtraData extradata;
86 lyx::external::ResizeData resizedata;
87 lyx::external::RotationData rotationdata;
89 /** if \c true, simply output the filename, maybe wrapped in a
90 * box, rather than generate and display the image etc.
95 lyx::external::TempName tempname_;
96 std::string templatename_;
103 class InsetExternal : public InsetOld, public boost::signals::trackable
108 InsetExternal(InsetExternal const &);
110 virtual ~InsetExternal();
112 virtual std::auto_ptr<InsetBase> clone() const;
114 virtual InsetOld::Code lyxCode() const { return EXTERNAL_CODE; }
116 virtual EDITABLE editable() const { return IS_EDITABLE; }
119 void metrics(MetricsInfo &, Dimension &) const;
121 void draw(PainterInfo & pi, int x, int y) const;
123 virtual void write(Buffer const &, std::ostream &) const;
125 virtual void read(Buffer const &, LyXLex & lex);
127 /// \returns the number of rows (\n's) of generated code.
128 virtual int latex(Buffer const &, std::ostream &,
129 OutputParams const &) const;
131 virtual int plaintext(Buffer const &, std::ostream &,
132 OutputParams const &) const;
134 virtual int linuxdoc(Buffer const &, std::ostream &,
135 OutputParams const &) const;
137 virtual int docbook(Buffer const &, std::ostream &,
138 OutputParams const &) const;
140 /// Update needed features for this inset.
141 virtual void validate(LaTeXFeatures & features) const;
144 InsetExternalParams const & params() const;
145 void setParams(InsetExternalParams const &, Buffer const &);
147 void addPreview(lyx::graphics::PreviewLoader &) const;
149 void edit(LCursor & cur, bool);
155 priv_dispatch(LCursor & cur, FuncRequest const & cmd);
157 /** This method is connected to the graphics loader, so we are
158 * informed when the image has been loaded.
160 void statusChanged() const;
162 /** Slot receiving a signal that the external file has changed
163 * and the preview should be regenerated.
165 void fileChanged() const;
167 /// The current params
168 InsetExternalParams params_;
169 /// The thing that actually draws the image on LyX's screen.
170 boost::scoped_ptr<RenderBase> renderer_;
174 #include "mailinset.h"
176 class InsetExternalMailer : public MailInset {
179 InsetExternalMailer(InsetExternal & inset);
181 virtual InsetBase & inset() const { return inset_; }
183 virtual std::string const & name() const { return name_; }
185 virtual std::string const inset2string(Buffer const &) const;
187 static void string2params(std::string const &, Buffer const &,
188 InsetExternalParams &);
190 static std::string const params2string(InsetExternalParams const &,
194 static std::string const name_;
196 InsetExternal & inset_;