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 &);
40 InsetCommand(InsetCommand const & rhs);
42 virtual ~InsetCommand();
44 InsetCommand * asInsetCommand() { return this; }
46 InsetCommand const * asInsetCommand() const { return this; }
48 /// \return true if params are successfully read
49 static bool string2params(std::string const & data,
50 InsetCommandParams &);
52 static std::string params2string(InsetCommandParams const &);
54 InsetCommandParams const & params() const { return p_; }
56 void setParams(InsetCommandParams const &);
58 docstring const & getParam(std::string const & name) const;
60 void setParam(std::string const & name, docstring const & value);
62 docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
64 /// \name Public functions inherited from Inset class
67 void write(std::ostream & os) const { p_.write(os); }
69 void read(Lexer & lex) { p_.read(lex); }
71 void doDispatch(Cursor & cur, FuncRequest & cmd);
73 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
75 void metrics(MetricsInfo &, Dimension &) const;
77 void draw(PainterInfo & pi, int x, int y) const;
79 void latex(otexstream &, OutputParams const &) const;
81 int plaintext(odocstream &, OutputParams const &) const;
83 int docbook(odocstream &, OutputParams const & runparams) const;
85 bool setMouseHover(BufferView const * bv, bool mouse_hover) const;
87 bool clickable(int, int) const { return hasSettings(); }
91 /// \name Methods relaying to the InsetCommandParams p_
94 std::string contextMenuName() const;
96 bool showInsetDialog(BufferView * bv) const;
98 Dimension const dimension(BufferView const &) const
99 { return button_.dimension(); }
103 /// \name Functions relaying to the InsetCommandParams
105 /// Build the complete LaTeX command
106 /// \see InsetCommandParams::getCommand
107 docstring const getCommand(OutputParams const & rp) const
108 { return p_.getCommand(rp); }
109 /// Return the command name
110 /// \see InsetCommandParams::getCmdName
111 std::string const & getCmdName() const { return p_.getCmdName(); }
112 /// Set the name to \p n. This must be a known name. All parameters
113 /// are cleared except those that exist also in the new command.
114 /// What matters here is the parameter name, not position.
115 /// \see InsetCommandParams::setCmdName
116 void setCmdName(std::string const & n) { p_.setCmdName(n); }
121 RenderButton & button() const { return button_; }
122 /// This should provide the text for the button
123 virtual docstring screenLabel() const = 0;
125 /// \name Static public methods obligated for InsetCommand derived classes
127 /// Return parameter information for command cmdName.
128 /// Not implemented here. Must be implemented in derived class.
129 static ParamInfo const & findInfo(std::string const & cmdName);
130 /// Return default command for this inset.
131 /// Not implemented here. Must be implemented in derived class.
132 static std::string defaultCommand();
133 /// Whether this is a command this inset can represent.
134 /// Not implemented here. Must be implemented in derived class.
135 static bool isCompatibleCommand(std::string const & cmd);
139 InsetCommandParams p_;
140 /// changes color when mouse enters/leaves this inset
141 mutable std::map<BufferView const *, bool> mouse_hover_;
143 mutable RenderButton button_;
146 /// Decode InsetCommand considering Inset name and data.
147 bool decodeInsetParam(std::string const & name, std::string & data,
148 Buffer const & buffer);