X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetCommand.h;h=78e6d7fc5d6f6c9aba604018db08e681d9ce5220;hb=f365a650686cc27487f686a7803968df1f24e0b8;hp=6297cf723eb5d7d5ea87d1a72b62322629180c5f;hpb=c9e4d6657d0e3e09d46ecf51e7e838ddd7374671;p=lyx.git diff --git a/src/insets/InsetCommand.h b/src/insets/InsetCommand.h index 6297cf723e..78e6d7fc5d 100644 --- a/src/insets/InsetCommand.h +++ b/src/insets/InsetCommand.h @@ -16,11 +16,11 @@ #include "Inset.h" #include "InsetCommandParams.h" #include "RenderButton.h" -#include "Cursor.h" namespace lyx { +class Cursor; ///////////////////////////////////////////////////////////////////////// // @@ -35,73 +35,101 @@ class InsetCommand : public Inset { public: /// - InsetCommand(Buffer *, InsetCommandParams const &, - std::string const & mailer_name); + InsetCommand(Buffer *, InsetCommandParams const &); /// InsetCommand(InsetCommand const & rhs); /// + InsetCommand & operator=(InsetCommand const & rhs); + /// virtual ~InsetCommand(); + /// + InsetCommand * asInsetCommand() { return this; } + /// + InsetCommand const * asInsetCommand() const { return this; } - /// returns true if params are successfully read - static bool string2params(std::string const &, std::string const & name, + /// \return true if params are successfully read + static bool string2params(std::string const & data, InsetCommandParams &); /// - static std::string params2string(std::string const & name, - InsetCommandParams const &); + static std::string params2string(InsetCommandParams const &); /// InsetCommandParams const & params() const { return p_; } /// void setParams(InsetCommandParams const &); /// - void setParam(std::string const & name, docstring const & value); - /// docstring const & getParam(std::string const & name) const; + /// + void setParam(std::string const & name, docstring const & value); /// FIXME Remove docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); } - /// update label and references. - virtual void updateCommand(docstring const &, bool) {} - /// - InsetCommand * asInsetCommand() { return this; } - /// - InsetCommand const * asInsetCommand() const { return this; } - /// whether to include this inset in the strings generated for the TOC - virtual bool isInToc() const { return false; } -protected: + /// \name Public functions inherited from Inset class + //@{ /// void write(std::ostream & os) const { p_.write(os); } /// - void read(Lexer & lex) { p_.read(lex); } + void read(Lexer & lex) { p_.Read(lex, &buffer()); } /// void doDispatch(Cursor & cur, FuncRequest & cmd); /// bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; /// - docstring const getCommand(OutputParams & rp) const { return p_.getCommand(rp); } + void metrics(MetricsInfo &, Dimension &) const; /// - std::string const & getCmdName() const { return p_.getCmdName(); } + void draw(PainterInfo & pi, int x, int y) const; /// - void setCmdName(std::string const & n) { p_.setCmdName(n); } - -private: + virtual void drawBackground(PainterInfo &, int, int) const {} /// - void metrics(MetricsInfo &, Dimension &) const; + void latex(otexstream &, OutputParams const &) const; /// - Dimension const dimension(BufferView const &) const { return button_.dimension(); } + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; /// - void draw(PainterInfo & pi, int x, int y) const; + int docbook(odocstream &, OutputParams const & runparams) const; /// - int latex(odocstream &, OutputParams const &) const; + void validate(LaTeXFeatures & features) const; /// - int plaintext(odocstream &, OutputParams const &) const; + bool setMouseHover(BufferView const * bv, bool mouse_hover) const; /// - int docbook(odocstream &, OutputParams const & runparams) const; + bool clickable(BufferView const &, int, int) const { return hasSettings(); } + //@} + +protected: + /// \name Methods relaying to the InsetCommandParams p_ + //@{ /// - InsetCode lyxCode() const { return NO_CODE; } + std::string contextMenuName() const; /// - RenderButton & button() const { return button_; } + bool showInsetDialog(BufferView * bv) const; + //@} + +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); } + //@} + +private: /// - bool setMouseHover(BufferView const * bv, bool mouse_hover); + RenderButton & button() const { return button_; } + /// This should provide the text for the button + virtual docstring screenLabel() const = 0; + /// This should return true when font is inherited from text + virtual bool inheritFont() const { return false; } + + /// \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); @@ -111,16 +139,10 @@ private: /// 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); - /// - docstring contextMenu(BufferView const & bv, int x, int y) const; - /// This should provide the text for the button - virtual docstring screenLabel() const = 0; - /// - bool showInsetDialog(BufferView * bv) const; + //@} + /// InsetCommandParams p_; - /// - std::string mailer_name_; /// changes color when mouse enters/leaves this inset mutable std::map mouse_hover_; ///