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 "render_button.h"
  19 #include "mailinset.h"
  20 #include "cursor.h"
  21
  22
  23 // Created by Alejandro 970222
  24 /** Used to insert a LaTeX command automatically
  25  *
  26  * Similar to InsetLaTeX but having control of the basic structure of a
  27  *   LaTeX command: \name[options]{contents}.
  28  */
  29
  30 ///
  31 class InsetCommand : public InsetOld {
  32 public:
  33         ///
  34         InsetCommand(InsetCommandParams const &, std::string const & mailer_name);
  35         ///
  36         ~InsetCommand();
  37         ///
  38         void metrics(MetricsInfo &, Dimension &) const;
  39         ///
  40         void draw(PainterInfo & pi, int x, int y) const;
  41         ///
  42         void write(Buffer const &, std::ostream & os) const
  43                 { p_.write(os); }
  44         ///
  45         virtual void read(Buffer const &, LyXLex & lex)
  46                 { p_.read(lex); }
  47         /// Can remove one InsetBibKey is modified
  48         void scanCommand(std::string const & c) { p_.scanCommand(c); };
  49         ///
  50         virtual int latex(Buffer const &, std::ostream &,
  51                           OutputParams const &) const;
  52         ///
  53         int plaintext(Buffer const &, lyx::odocstream &,
  54                   OutputParams const &) const;
  55         ///
  56         virtual int docbook(Buffer const &, std::ostream &,
  57                             OutputParams const & runparams) const;
  58         ///
  59         InsetBase::Code lyxCode() const { return InsetBase::NO_CODE; }
  60
  61         ///
  62         InsetCommandParams const & params() const { return p_; }
  63         ///
  64         std::string const & getContents() const { return p_.getContents(); }
  65         ///
  66         void setContents(std::string const & c)
  67         {
  68                 updateButtonLabel_ = true;
  69                 p_.setContents(c);
  70         }
  71         ///
  72         virtual void replaceContents(std::string const & from, std::string const & to);
  73         ///
  74         std::string const & getOptions() const { return p_.getOptions(); }
  75         ///
  76         std::string const & getSecOptions() const { return p_.getSecOptions(); }
  77         ///
  78         RenderButton & button() const { return button_; }
  79
  80 protected:
  81         ///
  82         virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
  83         ///
  84         bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
  85         ///
  86         std::string const getCommand() const { return p_.getCommand(); }
  87         ///
  88         std::string const & getCmdName() const { return p_.getCmdName(); }
  89         ///
  90         void setCmdName(std::string const & n)
  91         {
  92                 updateButtonLabel_ = true;
  93                 p_.setCmdName(n);
  94         }
  95         ///
  96         void setOptions(std::string const & o)
  97         {
  98                 updateButtonLabel_ = true;
  99                 p_.setOptions(o);
 100         }
 101         ///
 102         void setSecOptions(std::string const & s)
 103         {
 104                 updateButtonLabel_ = true;
 105                 p_.setSecOptions(s);
 106         }
 107         ///
 108         void setParams(InsetCommandParams const &);
 109         /// This should provide the text for the button
 110         virtual lyx::docstring const getScreenLabel(Buffer const &) const = 0;
 111
 112 private:
 113         ///
 114         InsetCommandParams p_;
 115         std::string mailer_name_;
 116         mutable bool updateButtonLabel_;
 117         mutable RenderButton button_;
 118 };
 119
 120
 121 class InsetCommandMailer : public MailInset {
 122 public:
 123         ///
 124         InsetCommandMailer(std::string const & name, InsetCommand & inset);
 125         ///
 126         virtual InsetBase & inset() const { return inset_; }
 127         ///
 128         virtual std::string const & name() const { return name_; }
 129         ///
 130         virtual std::string const inset2string(Buffer const &) const;
 131         ///
 132         static void string2params(std::string const &, std::string const & name,
 133                                   InsetCommandParams &);
 134         ///
 135         static std::string const params2string(std::string const & name,
 136                                                InsetCommandParams const &);
 137 private:
 138         ///
 139         std::string const name_;
 140         ///
 141         InsetCommand & inset_;
 142 };
 143
 144
 145 #endif