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