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 INSET_LATEXCOMMAND_H
  14 #define INSET_LATEXCOMMAND_H
  15
  16 #include "Inset.h"
  17 #include "InsetCommandParams.h"
  18 #include "RenderButton.h"
  19 #include "MailInset.h"
  20 #include "Cursor.h"
  21
  22
  23 namespace lyx {
  24
  25
  26 // Created by Alejandro 970222
  27 /** Used to insert a LaTeX command automatically.
  28  */
  29
  30 ///
  31 class InsetCommand : public Inset {
  32 public:
  33         ///
  34         InsetCommand(InsetCommandParams const &, std::string const & mailer_name);
  35         ///
  36         ~InsetCommand();
  37         ///
  38         void metrics(MetricsInfo &, Dimension &) const;
  39         ///
  40         Dimension const dimension(BufferView const &) const { return button_.dimension(); }
  41         ///
  42         void draw(PainterInfo & pi, int x, int y) const;
  43         ///
  44         void write(std::ostream & os) const { p_.write(os); }
  45         ///
  46         void read(Lexer & lex) { p_.read(lex); }
  47         ///
  48         int latex(odocstream &, OutputParams const &) const;
  49         ///
  50         int plaintext(odocstream &, OutputParams const &) const;
  51         ///
  52         int docbook(odocstream &, OutputParams const & runparams) const;
  53         ///
  54         InsetCode lyxCode() const { return NO_CODE; }
  55         ///
  56         InsetCommandParams const & params() const { return p_; }
  57         /// FIXME Remove
  58         docstring const getFirstNonOptParam() const { return p_.getFirstNonOptParam(); }
  59         /// Whether the button label should be recomputed.
  60         void refresh() { updateButtonLabel_ = true; }
  61         ///
  62         void setParam(std::string const & name, docstring const & value)
  63         {
  64                 updateButtonLabel_ = true;
  65                 p_[name] = value;
  66         }
  67         ///
  68         docstring const & getParam(std::string const & name) const
  69         {
  70                 return p_[name];
  71         }
  72         ///
  73         void edit(Cursor & cur, bool front,
  74                 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
  75         ///
  76         RenderButton & button() const { return button_; }
  77         ///
  78         bool setMouseHover(bool mouse_hover);
  79         /// Return parameter information for command cmdName.
  80         /// Not implemented here. Must be implemented in derived class.
  81         static ParamInfo const & findInfo(std::string const & cmdName);
  82         /// Return default command for this inset.
  83         /// Not implemented here. Must be implemented in derived class.
  84         static std::string defaultCommand();
  85         /// Whether this is a command this inset can represent.
  86         /// Not implemented here. Must be implemented in derived class.
  87         static bool isCompatibleCommand(std::string const & cmd);
  88
  89 protected:
  90         ///
  91         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
  92         ///
  93         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
  94         ///
  95         docstring const getCommand() const { return p_.getCommand(); }
  96         ///
  97         std::string const & getCmdName() const { return p_.getCmdName(); }
  98         ///
  99         void setCmdName(std::string const & n)
 100         {
 101                 updateButtonLabel_ = true;
 102                 p_.setCmdName(n);
 103         }
 104         ///
 105         void setParams(InsetCommandParams const &);
 106         /// This should provide the text for the button
 107         virtual docstring screenLabel() const = 0;
 108
 109 private:
 110         ///
 111         InsetCommandParams p_;
 112         ///
 113         std::string mailer_name_;
 114         /// changes color when mouse enters/leaves this inset
 115         bool mouse_hover_;
 116         ///
 117         mutable bool updateButtonLabel_;
 118         ///
 119         mutable RenderButton button_;
 120 };
 121
 122
 123 class InsetCommandMailer : public MailInset {
 124 public:
 125         ///
 126         InsetCommandMailer(std::string const & name, InsetCommand & inset);
 127         ///
 128         virtual Inset & inset() const { return inset_; }
 129         ///
 130         virtual std::string const & name() const { return name_; }
 131         ///
 132         virtual std::string const inset2string(Buffer const &) const;
 133         /// returns true if params are successfully read
 134         static bool string2params(std::string const &, std::string const & name,
 135                                   InsetCommandParams &);
 136         ///
 137         static std::string const params2string(std::string const & name,
 138                                                InsetCommandParams const &);
 139 private:
 140         ///
 141         std::string const name_;
 142         ///
 143         InsetCommand & inset_;
 144 };
 145
 146
 147
 148 } // namespace lyx
 149
 150 #endif