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"
26 // Created by Alejandro 970222
27 /** Used to insert a LaTeX command automatically
29 * Similar to InsetLaTeX but having control of the basic structure of a
30 * LaTeX command: \name[options]{contents}.
34 class InsetCommand : public InsetOld {
37 InsetCommand(InsetCommandParams const &, std::string const & mailer_name);
41 bool metrics(MetricsInfo &, Dimension &) const;
43 void draw(PainterInfo & pi, int x, int y) const;
45 void write(Buffer const &, std::ostream & os) const
48 virtual void read(Buffer const &, LyXLex & lex)
51 virtual int latex(Buffer const &, odocstream &,
52 OutputParams const &) const;
54 int plaintext(Buffer const &, odocstream &,
55 OutputParams const &) const;
57 virtual int docbook(Buffer const &, 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, docstring const & value)
75 updateButtonLabel_ = true;
79 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_; }
92 bool setMouseHover(bool mouse_hover);
96 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
98 bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
100 docstring const getCommand() const { return p_.getCommand(); }
102 std::string const & getCmdName() const { return p_.getCmdName(); }
104 void setCmdName(std::string const & n)
106 updateButtonLabel_ = true;
110 void setOptions(std::string const & o)
112 updateButtonLabel_ = true;
116 void setSecOptions(std::string const & s)
118 updateButtonLabel_ = true;
122 void setParams(InsetCommandParams const &);
123 /// This should provide the text for the button
124 virtual docstring const getScreenLabel(Buffer const &) const = 0;
128 InsetCommandParams p_;
129 std::string mailer_name_;
130 /// changes color when mouse enters/leaves this inset
132 mutable bool updateButtonLabel_;
133 mutable RenderButton button_;
137 class InsetCommandMailer : public MailInset {
140 InsetCommandMailer(std::string const & name, InsetCommand & inset);
142 virtual InsetBase & inset() const { return inset_; }
144 virtual std::string const & name() const { return name_; }
146 virtual std::string const inset2string(Buffer const &) const;
148 static void string2params(std::string const &, std::string const & name,
149 InsetCommandParams &);
151 static std::string const params2string(std::string const & name,
152 InsetCommandParams const &);
155 std::string const name_;
157 InsetCommand & inset_;