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; }
50 /// returns true if params are successfully read
51 static bool string2params(std::string const &, std::string const & name,
52 InsetCommandParams &);
54 static std::string params2string(std::string const & name,
55 InsetCommandParams const &);
57 InsetCommandParams const & params() const { return p_; }
59 void setParams(InsetCommandParams const &);
61 docstring const & getParam(std::string const & name) const;
63 void setParam(std::string const & name, docstring const & value);
65 docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
66 /// update label and references
67 virtual void updateCommand(docstring const &, bool) {}
68 /// whether to include this inset in the strings generated for the TOC
69 virtual bool isInToc() const { return false; }
71 /// \name Methods inherited from Inset class
74 void write(std::ostream & os) const { p_.write(os); }
76 void read(Lexer & lex) { p_.read(lex); }
78 void doDispatch(Cursor & cur, FuncRequest & cmd);
80 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
82 void metrics(MetricsInfo &, Dimension &) const;
84 void draw(PainterInfo & pi, int x, int y) const;
86 int latex(odocstream &, OutputParams const &) const;
88 int plaintext(odocstream &, OutputParams const &) const;
90 int docbook(odocstream &, OutputParams const & runparams) const;
92 bool setMouseHover(BufferView const * bv, bool mouse_hover) const;
94 bool clickable(int, int) const { return hasSettings(); }
96 docstring contextMenu(BufferView const & bv, int x, int y) const;
98 bool showInsetDialog(BufferView * bv) const;
100 Dimension const dimension(BufferView const &) const
101 { return button_.dimension(); }
105 /// \name Methods relaying to the InsetCommandParams
107 /// Build the complete LaTeX command
108 /// \see InsetCommandParams::getCommand
109 docstring const getCommand(OutputParams const & rp) const
110 { return p_.getCommand(rp); }
111 /// Return the command name
112 /// \see InsetCommandParams::getCmdName
113 std::string const & getCmdName() const { return p_.getCmdName(); }
114 /// Set the name to \p n. This must be a known name. All parameters
115 /// are cleared except those that exist also in the new command.
116 /// What matters here is the parameter name, not position.
117 /// \see InsetCommandParams::setCmdName
118 void setCmdName(std::string const & n) { p_.setCmdName(n); }
123 RenderButton & button() const { return button_; }
124 /// This should provide the text for the button
125 virtual docstring screenLabel() const = 0;
127 /// \name Methods obligated for InsetCommand derived classes
129 /// Return parameter information for command cmdName.
130 /// Not implemented here. Must be implemented in derived class.
131 static ParamInfo const & findInfo(std::string const & cmdName);
132 /// Return default command for this inset.
133 /// Not implemented here. Must be implemented in derived class.
134 static std::string defaultCommand();
135 /// Whether this is a command this inset can represent.
136 /// Not implemented here. Must be implemented in derived class.
137 static bool isCompatibleCommand(std::string const & cmd);
141 InsetCommandParams p_;
143 std::string mailer_name_;
144 /// changes color when mouse enters/leaves this inset
145 mutable std::map<BufferView const *, bool> mouse_hover_;
147 mutable RenderButton button_;
150 /// Decode InsetCommand considering Inset name and data.
151 bool decodeInsetParam(std::string const & name, std::string & data,
152 Buffer const & buffer);