X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetCommand.h;h=39b1cbbef36ae745633b307033de70cd3d192e85;hb=625e7609f0bb4087f0cd91ae3853beee6c6ba402;hp=7c0f29c2c64424c09ad36e2107d711a0df36299f;hpb=07b6198f4c3aa6dfe3245394b660966fd3e85c99;p=lyx.git diff --git a/src/insets/InsetCommand.h b/src/insets/InsetCommand.h index 7c0f29c2c6..39b1cbbef3 100644 --- a/src/insets/InsetCommand.h +++ b/src/insets/InsetCommand.h @@ -5,146 +5,150 @@ * Licence details can be found in the file COPYING. * * \author Angus Leeming - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * * Full author contact details are available in file CREDITS. */ -#ifndef INSET_LATEXCOMMAND_H -#define INSET_LATEXCOMMAND_H +#ifndef INSETCOMMAND_H +#define INSETCOMMAND_H #include "Inset.h" #include "InsetCommandParams.h" #include "RenderButton.h" -#include "MailInset.h" -#include "Cursor.h" namespace lyx { +class Cursor; + +///////////////////////////////////////////////////////////////////////// +// +// InsetCommand +// +///////////////////////////////////////////////////////////////////////// // Created by Alejandro 970222 -/** Used to insert a LaTeX command automatically. - */ +// Used to insert a LaTeX command automatically. -/// -class InsetCommand : public Inset { +class InsetCommand : public Inset +{ public: /// - InsetCommand(InsetCommandParams const &, std::string const & mailer_name); + InsetCommand(Buffer *, InsetCommandParams const &); /// - ~InsetCommand(); - /// - void metrics(MetricsInfo &, Dimension &) const; + InsetCommand(InsetCommand const & rhs); /// - Dimension const dimension(BufferView const &) const { return button_.dimension(); } + InsetCommand & operator=(InsetCommand const & rhs); /// - void draw(PainterInfo & pi, int x, int y) const; + virtual ~InsetCommand(); /// - void write(Buffer const &, std::ostream & os) const - { p_.write(os); } + InsetCommand * asInsetCommand() { return this; } /// - virtual void read(Buffer const &, Lexer & lex) - { p_.read(lex); } + InsetCommand const * asInsetCommand() const { return this; } + + /// \return true if params are successfully read + static bool string2params(std::string const & data, + InsetCommandParams &); /// - int latex(Buffer const &, odocstream &, OutputParams const &) const; + static std::string params2string(InsetCommandParams const &); /// - int plaintext(Buffer const &, odocstream &, OutputParams const &) const; + InsetCommandParams const & params() const { return p_; } /// - int docbook(Buffer const &, odocstream &, OutputParams const & runparams) const; + void setParams(InsetCommandParams const &); /// - InsetCode lyxCode() const { return NO_CODE; } + docstring const & getParam(std::string const & name) const; /// - InsetCommandParams const & params() const { return p_; } + void setParam(std::string const & name, docstring const & value); /// FIXME Remove docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); } - /// Whether the button label should be recomputed. - void refresh() { updateButtonLabel_ = true; } + + /// \name Public functions inherited from Inset class + //@{ /// - void setParam(std::string const & name, docstring const & value) - { - updateButtonLabel_ = true; - p_[name] = value; - } + void write(std::ostream & os) const { p_.write(os); } /// - docstring const & getParam(std::string const & name) const - { - return p_[name]; - } + void read(Lexer & lex) { p_.Read(lex, &buffer()); } /// - void edit(Cursor & cur, bool left); + void doDispatch(Cursor & cur, FuncRequest & cmd); /// - RenderButton & button() const { return button_; } + bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; /// - bool setMouseHover(bool mouse_hover); - /// Return parameter information for command cmdName. - /// Not implemented here. Must be implemented in derived class. - static CommandInfo const * findInfo(std::string const & cmdName); - /// Return default command for this inset. - /// Not implemented here. Must be implemented in derived class. - static std::string defaultCommand(); - /// Whether this is a command this inset can represent. - /// Not implemented here. Must be implemented in derived class. - static bool isCompatibleCommand(std::string const & cmd); - -protected: + void metrics(MetricsInfo &, Dimension &) const; /// - virtual void doDispatch(Cursor & cur, FuncRequest & cmd); + void draw(PainterInfo & pi, int x, int y) const; /// - bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; + void latex(otexstream &, OutputParams const &) const; /// - docstring const getCommand() const { return p_.getCommand(); } + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; /// - std::string const & getCmdName() const { return p_.getCmdName(); } + int docbook(odocstream &, OutputParams const & runparams) const; /// - void setCmdName(std::string const & n) - { - updateButtonLabel_ = true; - p_.setCmdName(n); - } + bool setMouseHover(BufferView const * bv, bool mouse_hover) const; /// - void setParams(InsetCommandParams const &); - /// This should provide the text for the button - virtual docstring const getScreenLabel(Buffer const &) const = 0; + bool clickable(BufferView const &, int, int) const { return hasSettings(); } + //@} -private: - /// - InsetCommandParams p_; +protected: + /// \name Methods relaying to the InsetCommandParams p_ + //@{ /// - std::string mailer_name_; - /// changes color when mouse enters/leaves this inset - bool mouse_hover_; + std::string contextMenuName() const; /// - mutable bool updateButtonLabel_; + bool showInsetDialog(BufferView * bv) const; /// - mutable RenderButton button_; -}; + Dimension const dimension(BufferView const &) const + { return button_.dimension(); } + //@} +protected: + /// \name Functions relaying to the InsetCommandParams + //@{ + /// Build the complete LaTeX command + /// \see InsetCommandParams::getCommand + docstring const getCommand(OutputParams const & rp) const + { return p_.getCommand(rp); } + /// Return the command name + /// \see InsetCommandParams::getCmdName + std::string const & getCmdName() const { return p_.getCmdName(); } + /// Set the name to \p n. This must be a known name. All parameters + /// are cleared except those that exist also in the new command. + /// What matters here is the parameter name, not position. + /// \see InsetCommandParams::setCmdName + void setCmdName(std::string const & n) { p_.setCmdName(n); } + //@} -class InsetCommandMailer : public MailInset { -public: - /// - InsetCommandMailer(std::string const & name, InsetCommand & inset); - /// - virtual Inset & inset() const { return inset_; } - /// - virtual std::string const & name() const { return name_; } - /// - virtual std::string const inset2string(Buffer const &) const; - /// returns true if params are successfully read - static bool string2params(std::string const &, std::string const & name, - InsetCommandParams &); - /// - static std::string const params2string(std::string const & name, - InsetCommandParams const &); private: /// - std::string const name_; + RenderButton & button() const { return button_; } + /// This should provide the text for the button + virtual docstring screenLabel() const = 0; + + /// \name Static public methods obligated for InsetCommand derived classes + //@{ + /// Return parameter information for command cmdName. + /// Not implemented here. Must be implemented in derived class. + static ParamInfo const & findInfo(std::string const & cmdName); + /// Return default command for this inset. + /// Not implemented here. Must be implemented in derived class. + static std::string defaultCommand(); + /// Whether this is a command this inset can represent. + /// Not implemented here. Must be implemented in derived class. + static bool isCompatibleCommand(std::string const & cmd); + //@} + /// - InsetCommand & inset_; + InsetCommandParams p_; + /// changes color when mouse enters/leaves this inset + mutable std::map mouse_hover_; + /// + mutable RenderButton button_; }; - +/// Decode InsetCommand considering Inset name and data. +bool decodeInsetParam(std::string const & name, std::string & data, + Buffer const & buffer); } // namespace lyx