4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
8 * \author Lars Gullik Bjønnes
10 * Full author contact details are available in file CREDITS.
13 #ifndef INSET_LATEXCOMMAND_H
14 #define INSET_LATEXCOMMAND_H
17 #include "insetcommandparams.h"
18 #include "render_button.h"
19 #include "mailinset.h"
23 // Created by Alejandro 970222
24 /** Used to insert a LaTeX command automatically
26 * Similar to InsetLaTeX but having control of the basic structure of a
27 * LaTeX command: \name[options]{contents}.
31 class InsetCommand : public InsetOld {
34 InsetCommand(InsetCommandParams const &, std::string const & mailer_name);
38 void metrics(MetricsInfo &, Dimension &) const;
40 void draw(PainterInfo & pi, int x, int y) const;
42 void write(Buffer const &, std::ostream & os) const
45 virtual void read(Buffer const &, LyXLex & lex)
47 /// Can remove one InsetBibKey is modified
49 void scanCommand(std::string const & c) { p_.scanCommand(c); };
51 virtual int latex(Buffer const &, lyx::odocstream &,
52 OutputParams const &) const;
54 int plaintext(Buffer const &, lyx::odocstream &,
55 OutputParams const &) const;
57 virtual int docbook(Buffer const &, lyx::odocstream &,
58 OutputParams const & runparams) const;
60 InsetBase::Code lyxCode() const { return InsetBase::NO_CODE; }
63 InsetCommandParams const & params() const { return p_; }
65 std::string const getContents() const { return p_.getContents(); }
67 void setContents(std::string const & c)
69 updateButtonLabel_ = true;
73 void setParam(std::string const & name, lyx::docstring const & value)
75 updateButtonLabel_ = true;
79 lyx::docstring const & getParam(std::string const & name) const
84 virtual void replaceContents(std::string const & from, std::string const & to);
86 std::string const getOptions() const { return p_.getOptions(); }
88 std::string const getSecOptions() const { return p_.getSecOptions(); }
90 RenderButton & button() const { return button_; }
94 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
96 bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
98 lyx::docstring const getCommand() const { return p_.getCommand(); }
100 std::string const & getCmdName() const { return p_.getCmdName(); }
102 void setCmdName(std::string const & n)
104 updateButtonLabel_ = true;
108 void setOptions(std::string const & o)
110 updateButtonLabel_ = true;
114 void setSecOptions(std::string const & s)
116 updateButtonLabel_ = true;
120 void setParams(InsetCommandParams const &);
121 /// This should provide the text for the button
122 virtual lyx::docstring const getScreenLabel(Buffer const &) const = 0;
126 InsetCommandParams p_;
127 std::string mailer_name_;
128 mutable bool updateButtonLabel_;
129 mutable RenderButton button_;
133 class InsetCommandMailer : public MailInset {
136 InsetCommandMailer(std::string const & name, InsetCommand & inset);
138 virtual InsetBase & inset() const { return inset_; }
140 virtual std::string const & name() const { return name_; }
142 virtual std::string const inset2string(Buffer const &) const;
144 static void string2params(std::string const &, std::string const & name,
145 InsetCommandParams &);
147 static std::string const params2string(std::string const & name,
148 InsetCommandParams const &);
151 std::string const name_;
153 InsetCommand & inset_;