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(std::ostream & os) const { p_.write(os); }
46 void read(Lexer & lex) { p_.read(lex); }
48 int latex(odocstream &, OutputParams const &) const;
50 int plaintext(odocstream &, OutputParams const &) const;
52 int docbook(odocstream &, OutputParams const & runparams) const;
54 InsetCode lyxCode() const { return NO_CODE; }
56 InsetCommandParams const & params() const { return p_; }
58 docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
60 void setParam(std::string const & name, docstring const & value)
65 docstring const & getParam(std::string const & name) const
70 void edit(Cursor & cur, bool front,
71 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
73 RenderButton & button() const { return button_; }
75 bool setMouseHover(bool mouse_hover);
76 /// Return parameter information for command cmdName.
77 /// Not implemented here. Must be implemented in derived class.
78 static ParamInfo const & findInfo(std::string const & cmdName);
79 /// Return default command for this inset.
80 /// Not implemented here. Must be implemented in derived class.
81 static std::string defaultCommand();
82 /// Whether this is a command this inset can represent.
83 /// Not implemented here. Must be implemented in derived class.
84 static bool isCompatibleCommand(std::string const & cmd);
85 /// update label and references.
86 virtual void updateCommand(docstring const &, bool) {};
88 virtual docstring contextMenu(BufferView const & bv, int x, int y) const;
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) { p_.setCmdName(n); }
102 void setParams(InsetCommandParams const &);
103 /// This should provide the text for the button
104 virtual docstring screenLabel() const = 0;
108 InsetCommandParams p_;
110 std::string mailer_name_;
111 /// changes color when mouse enters/leaves this inset
114 mutable RenderButton button_;
118 class InsetCommandMailer : public MailInset {
121 InsetCommandMailer(std::string const & name, InsetCommand & inset);
123 virtual Inset & inset() const { return inset_; }
125 virtual std::string const & name() const { return name_; }
127 virtual std::string const inset2string(Buffer const &) const;
128 /// returns true if params are successfully read
129 static bool string2params(std::string const &, std::string const & name,
130 InsetCommandParams &);
132 static std::string const params2string(std::string const & name,
133 InsetCommandParams const &);
136 std::string const name_;
138 InsetCommand & inset_;