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 &, std::ostream &,
  54                   OutputParams const &) const;
  55         ///
  56         virtual int linuxdoc(Buffer const &, std::ostream &,
  57                              OutputParams const &) const;
  58         ///
  59         virtual int docbook(Buffer const &, std::ostream &,
  60                             OutputParams const & runparams) const;
  61         ///
  62         InsetBase::Code lyxCode() const { return InsetBase::NO_CODE; }
  63
  64         ///
  65         InsetCommandParams const & params() const { return p_; }
  66         ///
  67         std::string const & getContents() const { return p_.getContents(); }
  68         ///
  69         void setContents(std::string const & c)
  70         {
  71                 updateButtonLabel_ = true;
  72                 p_.setContents(c);
  73         }
  74         ///
  75         std::string const & getOptions() const { return p_.getOptions(); }
  76         ///
  77         std::string const & getSecOptions() const { return p_.getSecOptions(); }
  78         ///
  79         RenderButton & button() const { return button_; }
  80
  81 protected:
  82         ///
  83         virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
  84         ///
  85         bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
  86         ///
  87         std::string const getCommand() const { return p_.getCommand(); }
  88         ///
  89         std::string const & getCmdName() const { return p_.getCmdName(); }
  90         ///
  91         void setCmdName(std::string const & n)
  92         {
  93                 updateButtonLabel_ = true;
  94                 p_.setCmdName(n);
  95         }
  96         ///
  97         void setOptions(std::string const & o)
  98         {
  99                 updateButtonLabel_ = true;
 100                 p_.setOptions(o);
 101         }
 102         ///
 103         void setSecOptions(std::string const & s)
 104         {
 105                 updateButtonLabel_ = true;
 106                 p_.setSecOptions(s);
 107         }
 108         ///
 109         void setParams(InsetCommandParams const &);
 110         /// This should provide the text for the button
 111         virtual std::string const getScreenLabel(Buffer const &) const = 0;
 112
 113 private:
 114         ///
 115         InsetCommandParams p_;
 116         std::string mailer_name_;
 117         mutable bool updateButtonLabel_;
 118         mutable RenderButton button_;
 119 };
 120
 121
 122 class InsetCommandMailer : public MailInset {
 123 public:
 124         ///
 125         InsetCommandMailer(std::string const & name, InsetCommand & inset);
 126         ///
 127         virtual InsetBase & inset() const { return inset_; }
 128         ///
 129         virtual std::string const & name() const { return name_; }
 130         ///
 131         virtual std::string const inset2string(Buffer const &) const;
 132         ///
 133         static void string2params(std::string const &, std::string const & name,
 134                                   InsetCommandParams &);
 135         ///
 136         static std::string const params2string(std::string const & name,
 137                                                InsetCommandParams const &);
 138 private:
 139         ///
 140         std::string const name_;
 141         ///
 142         InsetCommand & inset_;
 143 };
 144
 145
 146 #endif