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 INSETCOMMAND_H
14 #define INSETCOMMAND_H
17 #include "InsetCommandParams.h"
18 #include "RenderButton.h"
25 /////////////////////////////////////////////////////////////////////////
29 /////////////////////////////////////////////////////////////////////////
31 // Created by Alejandro 970222
32 // Used to insert a LaTeX command automatically.
34 class InsetCommand : public Inset
38 InsetCommand(Buffer *, InsetCommandParams const &,
39 std::string const & mailer_name);
43 /// returns true if params are successfully read
44 static bool string2params(std::string const &, std::string const & name,
45 InsetCommandParams &);
47 static std::string params2string(std::string const & name,
48 InsetCommandParams const &);
50 InsetCommandParams const & params() const { return p_; }
52 void setParams(InsetCommandParams const &);
54 void setParam(std::string const & name, docstring const & value);
56 docstring const & getParam(std::string const & name) const;
58 docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
59 /// update label and references.
60 virtual void updateCommand(docstring const &, bool) {}
62 virtual InsetCommand * asInsetCommand() { return this; }
64 virtual InsetCommand const * asInsetCommand() const { return this; }
65 /// whether to include this inset in the strings generated for the TOC
66 virtual bool isInToc() const { return false; }
70 void write(std::ostream & os) const { p_.write(os); }
72 void read(Lexer & lex) { p_.read(lex); }
74 void doDispatch(Cursor & cur, FuncRequest & cmd);
76 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
78 docstring const getCommand() const { return p_.getCommand(); }
80 std::string const & getCmdName() const { return p_.getCmdName(); }
82 void setCmdName(std::string const & n) { p_.setCmdName(n); }
86 void metrics(MetricsInfo &, Dimension &) const;
88 Dimension const dimension(BufferView const &) const { return button_.dimension(); }
90 void draw(PainterInfo & pi, int x, int y) const;
92 int latex(odocstream &, OutputParams const &) const;
94 int plaintext(odocstream &, OutputParams const &) const;
96 int docbook(odocstream &, OutputParams const & runparams) const;
98 InsetCode lyxCode() const { return NO_CODE; }
100 RenderButton & button() const { return button_; }
102 bool setMouseHover(bool mouse_hover);
103 /// Return parameter information for command cmdName.
104 /// Not implemented here. Must be implemented in derived class.
105 static ParamInfo const & findInfo(std::string const & cmdName);
106 /// Return default command for this inset.
107 /// Not implemented here. Must be implemented in derived class.
108 static std::string defaultCommand();
109 /// Whether this is a command this inset can represent.
110 /// Not implemented here. Must be implemented in derived class.
111 static bool isCompatibleCommand(std::string const & cmd);
113 docstring contextMenu(BufferView const & bv, int x, int y) const;
114 /// This should provide the text for the button
115 virtual docstring screenLabel() const = 0;
117 bool showInsetDialog(BufferView * bv) const;
119 InsetCommandParams p_;
121 std::string mailer_name_;
122 /// changes color when mouse enters/leaves this inset
125 mutable RenderButton button_;
128 /// Decode InsetCommand considering Inset name and data.
129 bool decodeInsetParam(std::string const & name, std::string & data,
130 Buffer const & buffer);