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         InsetOld::Code lyxCode() const { return InsetOld::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) { p_.setContents(c); }
  70         ///
  71         std::string const & getOptions() const { return p_.getOptions(); }
  72         ///
  73         RenderButton & button() const { return button_; }
  74
  75 protected:
  76         ///
  77         virtual
  78         DispatchResult
  79         priv_dispatch(LCursor & cur, FuncRequest const & cmd);
  80         ///
  81         std::string const getCommand() const { return p_.getCommand(); }
  82         ///
  83         std::string const & getCmdName() const { return p_.getCmdName(); }
  84         ///
  85         void setCmdName(std::string const & n) { p_.setCmdName(n); }
  86         ///
  87         void setOptions(std::string const & o) { p_.setOptions(o); }
  88         ///
  89         void setParams(InsetCommandParams const &);
  90         /// This should provide the text for the button
  91         virtual std::string const getScreenLabel(Buffer const &) const = 0;
  92
  93 private:
  94         ///
  95         InsetCommandParams p_;
  96         std::string mailer_name_;
  97         mutable bool set_label_;
  98         mutable RenderButton button_;
  99 };
 100
 101
 102 class InsetCommandMailer : public MailInset {
 103 public:
 104         ///
 105         InsetCommandMailer(std::string const & name, InsetCommand & inset);
 106         ///
 107         virtual InsetBase & inset() const { return inset_; }
 108         ///
 109         virtual std::string const & name() const { return name_; }
 110         ///
 111         virtual std::string const inset2string(Buffer const &) const;
 112         ///
 113         static void string2params(std::string const &, std::string const & name,
 114                                   InsetCommandParams &);
 115         ///
 116         static std::string const params2string(std::string const & name,
 117                                                InsetCommandParams const &);
 118 private:
 119         ///
 120         std::string const name_;
 121         ///
 122         InsetCommand & inset_;
 123 };
 124
 125
 126 #endif