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
  17 #include "insetbutton.h"
  18 #include "insetcommandparams.h"
  19 #include "mailinset.h"
  20 #include <boost/utility.hpp>
  21
  22 // Created by Alejandro 970222
  23 /** Used to insert a LaTeX command automatically
  24  *
  25  * Similar to InsetLaTeX but having control of the basic structure of a
  26  *   LaTeX command: \name[options]{contents}.
  27  */
  28
  29 ///
  30 class InsetCommand : public InsetButton, boost::noncopyable {
  31 public:
  32         ///
  33         explicit
  34         InsetCommand(InsetCommandParams const &, bool same_id = false);
  35         ///
  36         void write(Buffer const *, std::ostream & os) const
  37                 { p_.write(os); }
  38         ///
  39         virtual void read(Buffer const *, LyXLex & lex)
  40                 { p_.read(lex); }
  41         /// Can remove one InsetBibKey is modified
  42         void scanCommand(string const & c) { p_.scanCommand(c); };
  43         ///
  44         virtual int latex(Buffer const *, std::ostream &,
  45                           LatexRunParams const &,
  46                           bool free_spc) const;
  47         ///
  48         int ascii(Buffer const *, std::ostream &, int linelen) const;
  49         ///
  50         virtual int linuxdoc(Buffer const *, std::ostream &) const;
  51         ///
  52         virtual int docbook(Buffer const *, std::ostream &, bool) const;
  53         ///
  54         Inset::Code lyxCode() const { return Inset::NO_CODE; }
  55
  56         ///
  57         string const getCommand() const { return p_.getCommand(); }
  58         ///
  59         string const & getCmdName() const { return p_.getCmdName(); }
  60         ///
  61         string const & getOptions() const { return p_.getOptions(); }
  62         ///
  63         string const & getContents() const { return p_.getContents(); }
  64         ///
  65         void setCmdName(string const & n) { p_.setCmdName(n); }
  66         ///
  67         void setOptions(string const & o) { p_.setOptions(o); }
  68         ///
  69         void setContents(string const & c) { p_.setContents(c); }
  70         ///
  71         InsetCommandParams const & params() const { return p_; }
  72         ///
  73         void setParams(InsetCommandParams const &);
  74         ///
  75         virtual dispatch_result localDispatch(FuncRequest const & cmd);
  76
  77 private:
  78         ///
  79         InsetCommandParams p_;
  80 };
  81
  82
  83 class InsetCommandMailer : public MailInset {
  84 public:
  85         ///
  86         InsetCommandMailer(string const & name, InsetCommand & inset);
  87         ///
  88         virtual InsetBase & inset() const { return inset_; }
  89         ///
  90         virtual string const & name() const { return name_; }
  91         ///
  92         virtual string const inset2string() const;
  93         ///
  94         static void string2params(string const &, InsetCommandParams &);
  95         ///
  96         static string const params2string(string const & name,
  97                                           InsetCommandParams const &);
  98 private:
  99         ///
 100         string const name_;
 101         ///
 102         InsetCommand & inset_;
 103 };
 104
 105
 106 #endif