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 "RenderButton.h"
19 #include "MailInset.h"
26 // Created by Alejandro 970222
27 /** Used to insert a LaTeX command automatically.
31 class InsetCommand : public Inset {
34 InsetCommand(InsetCommandParams const &, std::string const & mailer_name);
38 void metrics(MetricsInfo &, Dimension &) const;
40 Dimension const dimension(BufferView const &) const { return button_.dimension(); }
42 void draw(PainterInfo & pi, int x, int y) const;
44 void write(Buffer const &, std::ostream & os) const
47 virtual void read(Buffer const &, Lexer & lex)
50 int latex(Buffer const &, odocstream &, OutputParams const &) const;
52 int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
54 int docbook(Buffer const &, odocstream &, OutputParams const & runparams) const;
56 InsetCode lyxCode() const { return NO_CODE; }
58 InsetCommandParams const & params() const { return p_; }
60 docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
61 /// Whether the button label should be recomputed.
62 void refresh() { updateButtonLabel_ = true; }
64 void setParam(std::string const & name, docstring const & value)
66 updateButtonLabel_ = true;
70 docstring const & getParam(std::string const & name) const
75 void edit(Cursor & cur, bool left);
77 RenderButton & button() const { return button_; }
79 bool setMouseHover(bool mouse_hover);
80 /// Return parameter information for command cmdName.
81 /// Not implemented here. Must be implemented in derived class.
82 static CommandInfo const * findInfo(std::string const & cmdName);
83 /// Return default command for this inset.
84 /// Not implemented here. Must be implemented in derived class.
85 static std::string defaultCommand();
86 /// Whether this is a command this inset can represent.
87 /// Not implemented here. Must be implemented in derived class.
88 static bool isCompatibleCommand(std::string const & cmd);
92 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
94 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
96 docstring const getCommand() const { return p_.getCommand(); }
98 std::string const & getCmdName() const { return p_.getCmdName(); }
100 void setCmdName(std::string const & n)
102 updateButtonLabel_ = true;
106 void setParams(InsetCommandParams const &);
107 /// This should provide the text for the button
108 virtual docstring const getScreenLabel(Buffer const &) const = 0;
112 InsetCommandParams p_;
114 std::string mailer_name_;
115 /// changes color when mouse enters/leaves this inset
118 mutable bool updateButtonLabel_;
120 mutable RenderButton button_;
124 class InsetCommandMailer : public MailInset {
127 InsetCommandMailer(std::string const & name, InsetCommand & inset);
129 virtual Inset & inset() const { return inset_; }
131 virtual std::string const & name() const { return name_; }
133 virtual std::string const inset2string(Buffer const &) const;
134 /// returns true if params are successfully read
135 static bool string2params(std::string const &, std::string const & name,
136 InsetCommandParams &);
138 static std::string const params2string(std::string const & name,
139 InsetCommandParams const &);
142 std::string const name_;
144 InsetCommand & inset_;