src/insets/insetcommand.h

   1 // -*- C++ -*-
   2 /* This file is part of*
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1995 Matthias Ettrich
   8  *           Copyright 1995-2000 The LyX Team.
   9  *
  10  * ====================================================== */
  11
  12 #ifndef INSET_LATEXCOMMAND_H
  13 #define INSET_LATEXCOMMAND_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "lyxinset.h"
  20 #include "LString.h"
  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 class InsetCommand: public Inset {
  29 public:
  30         ///
  31         InsetCommand();
  32         ///
  33         explicit
  34         InsetCommand(string const & name, string const & arg = string(),
  35                      string const & opt = string());
  36         ///
  37         int ascent(Painter &, LyXFont const &) const;
  38         ///
  39         int descent(Painter &, LyXFont const &) const;
  40         ///
  41         int width(Painter &, LyXFont const &) const;
  42         ///
  43         void draw(Painter &, LyXFont const &, int baseline, float & x) const;
  44         ///
  45         void Write(std::ostream &) const;
  46         /// Parse the command.
  47         void scanCommand(string const & cmd);
  48         /// Will not be used when lyxf3
  49         void Read(LyXLex & lex);
  50         ///
  51         virtual int Latex(std::ostream &,
  52                           bool fragile, bool free_spc) const;
  53         ///
  54         int Ascii(std::ostream &) const;
  55         ///
  56         virtual int Linuxdoc(std::ostream &) const;
  57         ///
  58         virtual int DocBook(std::ostream &) const;
  59         ///
  60         Inset * Clone() const;
  61         ///
  62         Inset::Code LyxCode() const
  63         {
  64                 return Inset::NO_CODE;
  65         }
  66
  67         /** Get the label that appears at screen.
  68
  69          I thought it was enough to eliminate the argument to avoid
  70          confusion with lyxinset::getLabel(int), but I've seen that
  71          it wasn't. I hope you never confuse again both methods.  (ale)
  72          */
  73         virtual string getScreenLabel() const
  74         {
  75                 return getCommand();
  76         }
  77
  78         /// Build the complete LaTeX command
  79         string getCommand() const;
  80         ///
  81         string const & getCmdName() const {
  82                 return command;
  83         }
  84         ///
  85         string const & getOptions() const {
  86                 return options;
  87         }
  88         ///
  89         string const & getContents() const {
  90                 return contents;
  91         }
  92         ///
  93         void setCmdName(string const & n) {
  94                 command = n;
  95         }
  96         ///
  97         void setOptions(string const & o) {
  98                 options = o;
  99         }
 100         ///
 101         virtual void setContents(string const & c) {
 102                 contents = c;
 103         }
 104 protected:
 105         ///
 106         string command;
 107         ///
 108         string options;
 109         ///
 110         string contents;
 111 };
 112
 113 #endif