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);
41 InsetCommand(InsetCommand const & rhs);
43 virtual ~InsetCommand();
45 InsetCommand * asInsetCommand() { return this; }
47 InsetCommand const * asInsetCommand() const { return this; }
49 /// \return true if params are successfully read
50 static bool string2params(std::string const & data,
51 InsetCommandParams &);
53 static std::string params2string(InsetCommandParams const &);
55 InsetCommandParams const & params() const { return p_; }
57 void setParams(InsetCommandParams const &);
59 docstring const & getParam(std::string const & name) const;
61 void setParam(std::string const & name, docstring const & value);
63 docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
65 /// \name Public functions inherited from Inset class
68 void write(std::ostream & os) const { p_.write(os); }
70 void read(Lexer & lex) { p_.read(lex); }
72 void doDispatch(Cursor & cur, FuncRequest & cmd);
74 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
76 void metrics(MetricsInfo &, Dimension &) const;
78 void draw(PainterInfo & pi, int x, int y) const;
80 int latex(odocstream &, OutputParams const &) const;
82 int plaintext(odocstream &, OutputParams const &) const;
84 int docbook(odocstream &, OutputParams const & runparams) const;
86 bool setMouseHover(BufferView const * bv, bool mouse_hover) const;
88 bool clickable(int, int) const { return hasSettings(); }
90 docstring contextMenu(BufferView const & bv, int x, int y) const;
92 bool showInsetDialog(BufferView * bv) const;
94 Dimension const dimension(BufferView const &) const
95 { return button_.dimension(); }
99 /// \name Functions relaying to the InsetCommandParams
101 /// Build the complete LaTeX command
102 /// \see InsetCommandParams::getCommand
103 docstring const getCommand(OutputParams const & rp) const
104 { return p_.getCommand(rp); }
105 /// Return the command name
106 /// \see InsetCommandParams::getCmdName
107 std::string const & getCmdName() const { return p_.getCmdName(); }
108 /// Set the name to \p n. This must be a known name. All parameters
109 /// are cleared except those that exist also in the new command.
110 /// What matters here is the parameter name, not position.
111 /// \see InsetCommandParams::setCmdName
112 void setCmdName(std::string const & n) { p_.setCmdName(n); }
117 RenderButton & button() const { return button_; }
118 /// This should provide the text for the button
119 virtual docstring screenLabel() const = 0;
121 /// \name Static public methods obligated for InsetCommand derived classes
123 /// Return parameter information for command cmdName.
124 /// Not implemented here. Must be implemented in derived class.
125 static ParamInfo const & findInfo(std::string const & cmdName);
126 /// Return default command for this inset.
127 /// Not implemented here. Must be implemented in derived class.
128 static std::string defaultCommand();
129 /// Whether this is a command this inset can represent.
130 /// Not implemented here. Must be implemented in derived class.
131 static bool isCompatibleCommand(std::string const & cmd);
135 InsetCommandParams p_;
137 std::string mailer_name_;
138 /// changes color when mouse enters/leaves this inset
139 mutable std::map<BufferView const *, bool> mouse_hover_;
141 mutable RenderButton button_;
144 /// Decode InsetCommand considering Inset name and data.
145 bool decodeInsetParam(std::string const & name, std::string & data,
146 Buffer const & buffer);