src/insets/InsetCommand.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetCommand.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  * \author Lars Gullik Bjønnes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSETCOMMAND_H
  14 #define INSETCOMMAND_H
  15
  16 #include "Inset.h"
  17 #include "InsetCommandParams.h"
  18 #include "RenderButton.h"
  19
  20
  21 namespace lyx {
  22
  23 class Cursor;
  24
  25 /////////////////////////////////////////////////////////////////////////
  26 //
  27 // InsetCommand
  28 //
  29 /////////////////////////////////////////////////////////////////////////
  30
  31 // Created by Alejandro 970222
  32 // Used to insert a LaTeX command automatically.
  33
  34 class InsetCommand : public Inset
  35 {
  36 public:
  37         ///
  38         InsetCommand(Buffer *, InsetCommandParams const &);
  39         ///
  40         InsetCommand(InsetCommand const & rhs);
  41         ///
  42         virtual ~InsetCommand();
  43         ///
  44         InsetCommand * asInsetCommand() { return this; }
  45         ///
  46         InsetCommand const * asInsetCommand() const { return this; }
  47
  48         /// \return true if params are successfully read
  49         static bool string2params(std::string const & data,
  50                                   InsetCommandParams &);
  51         ///
  52         static std::string params2string(InsetCommandParams const &);
  53         ///
  54         InsetCommandParams const & params() const { return p_; }
  55         ///
  56         void setParams(InsetCommandParams const &);
  57         ///
  58         docstring const & getParam(std::string const & name) const;
  59         ///
  60         void setParam(std::string const & name, docstring const & value);
  61         /// FIXME Remove
  62         docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
  63
  64         /// \name Public functions inherited from Inset class
  65         //@{
  66         ///
  67         void write(std::ostream & os) const { p_.write(os); }
  68         ///
  69         void read(Lexer & lex) { p_.read(lex); }
  70         ///
  71         void doDispatch(Cursor & cur, FuncRequest & cmd);
  72         ///
  73         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
  74         ///
  75         void metrics(MetricsInfo &, Dimension &) const;
  76         ///
  77         void draw(PainterInfo & pi, int x, int y) const;
  78         ///
  79         int latex(odocstream &, OutputParams const &) const;
  80         ///
  81         int plaintext(odocstream &, OutputParams const &) const;
  82         ///
  83         int docbook(odocstream &, OutputParams const & runparams) const;
  84         ///
  85         bool setMouseHover(BufferView const * bv, bool mouse_hover) const;
  86         ///
  87         bool clickable(int, int) const { return hasSettings(); }
  88         //@}
  89
  90 protected:
  91         /// \name Methods relaying to the InsetCommandParams p_
  92         //@{
  93         ///
  94         docstring contextMenu(BufferView const & bv, int x, int y) const;
  95         ///
  96         bool showInsetDialog(BufferView * bv) const;
  97         ///
  98         Dimension const dimension(BufferView const &) const
  99                 { return button_.dimension(); }
 100         //@}
 101
 102 protected:
 103         /// \name Functions relaying to the InsetCommandParams
 104         //@{
 105         /// Build the complete LaTeX command
 106         /// \see InsetCommandParams::getCommand
 107         docstring const getCommand(OutputParams const & rp) const
 108                 { return p_.getCommand(rp); }
 109         /// Return the command name
 110         /// \see InsetCommandParams::getCmdName
 111         std::string const & getCmdName() const { return p_.getCmdName(); }
 112         /// Set the name to \p n. This must be a known name. All parameters
 113         /// are cleared except those that exist also in the new command.
 114         /// What matters here is the parameter name, not position.
 115         /// \see InsetCommandParams::setCmdName
 116         void setCmdName(std::string const & n) { p_.setCmdName(n); }
 117         //@}
 118
 119 private:
 120         ///
 121         RenderButton & button() const { return button_; }
 122         /// This should provide the text for the button
 123         virtual docstring screenLabel() const = 0;
 124
 125         /// \name Static public methods obligated for InsetCommand derived classes
 126         //@{
 127         /// Return parameter information for command cmdName.
 128         /// Not implemented here. Must be implemented in derived class.
 129         static ParamInfo const & findInfo(std::string const & cmdName);
 130         /// Return default command for this inset.
 131         /// Not implemented here. Must be implemented in derived class.
 132         static std::string defaultCommand();
 133         /// Whether this is a command this inset can represent.
 134         /// Not implemented here. Must be implemented in derived class.
 135         static bool isCompatibleCommand(std::string const & cmd);
 136         //@}
 137
 138         ///
 139         InsetCommandParams p_;
 140         /// changes color when mouse enters/leaves this inset
 141         mutable std::map<BufferView const *, bool> mouse_hover_;
 142         ///
 143         mutable RenderButton button_;
 144 };
 145
 146 /// Decode InsetCommand considering Inset name and data.
 147 bool decodeInsetParam(std::string const & name, std::string & data,
 148         Buffer const & buffer);
 149
 150 } // namespace lyx
 151
 152 #endif