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  * Similar to InsetLaTeX but having control of the basic structure of a
  30  *   LaTeX command: \name[options]{contents}.
  31  */
  32
  33 ///
  34 class InsetCommand : public Inset {
  35 public:
  36         ///
  37         InsetCommand(InsetCommandParams const &, std::string const & mailer_name);
  38         ///
  39         ~InsetCommand();
  40         ///
  41         bool metrics(MetricsInfo &, Dimension &) const;
  42         ///
  43         void draw(PainterInfo & pi, int x, int y) const;
  44         ///
  45         void write(Buffer const &, std::ostream & os) const
  46                 { p_.write(os); }
  47         ///
  48         virtual void read(Buffer const &, Lexer & lex)
  49                 { p_.read(lex); }
  50         ///
  51         int latex(Buffer const &, odocstream &, OutputParams const &) const;
  52         ///
  53         int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
  54         ///
  55         int docbook(Buffer const &, odocstream &, OutputParams const & runparams) const;
  56         ///
  57         Inset::Code lyxCode() const { return Inset::NO_CODE; }
  58
  59         ///
  60         InsetCommandParams const & params() const { return p_; }
  61         /// FIXME remove
  62         std::string const getContents() const { return p_.getContents(); }
  63 protected:
  64         /// FIXME remove
  65         void setContents(std::string const & c)
  66         {
  67                 updateButtonLabel_ = true;
  68                 p_.setContents(c);
  69         }
  70 public:
  71         /// tell that the button label should be recomputed.
  72         void refresh() { updateButtonLabel_ = true; }
  73         ///
  74         void setParam(std::string const & name, docstring const & value)
  75         {
  76                 updateButtonLabel_ = true;
  77                 p_[name] = value;
  78         }
  79         ///
  80         docstring const & getParam(std::string const & name) const
  81         {
  82                 return p_[name];
  83         }
  84         ///
  85         void edit(Cursor & cur, bool left);
  86         /// FIXME remove
  87         virtual void replaceContents(std::string const & from, std::string const & to);
  88         ///
  89         RenderButton & button() const { return button_; }
  90         ///
  91         bool setMouseHover(bool mouse_hover);
  92
  93 protected:
  94         ///
  95         virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
  96         ///
  97         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
  98         ///
  99         docstring const getCommand() const { return p_.getCommand(); }
 100         ///
 101         std::string const & getCmdName() const { return p_.getCmdName(); }
 102         ///
 103         void setCmdName(std::string const & n)
 104         {
 105                 updateButtonLabel_ = true;
 106                 p_.setCmdName(n);
 107         }
 108         ///
 109         void setParams(InsetCommandParams const &);
 110         /// This should provide the text for the button
 111         virtual docstring const getScreenLabel(Buffer const &) const = 0;
 112
 113 private:
 114         ///
 115         InsetCommandParams p_;
 116         ///
 117         std::string mailer_name_;
 118         /// changes color when mouse enters/leaves this inset
 119         bool mouse_hover_;
 120         ///
 121         mutable bool updateButtonLabel_;
 122         ///
 123         mutable RenderButton button_;
 124 };
 125
 126
 127 class InsetCommandMailer : public MailInset {
 128 public:
 129         ///
 130         InsetCommandMailer(std::string const & name, InsetCommand & inset);
 131         ///
 132         virtual Inset & inset() const { return inset_; }
 133         ///
 134         virtual std::string const & name() const { return name_; }
 135         ///
 136         virtual std::string const inset2string(Buffer const &) const;
 137         ///
 138         static void string2params(std::string const &, std::string const & name,
 139                                   InsetCommandParams &);
 140         ///
 141         static std::string const params2string(std::string const & name,
 142                                                InsetCommandParams const &);
 143 private:
 144         ///
 145         std::string const name_;
 146         ///
 147         InsetCommand & inset_;
 148 };
 149
 150
 151
 152 } // namespace lyx
 153
 154 #endif