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         InsetCommand(string const & name, string const & arg = string(),
  34                      string const & opt = string());
  35         ///
  36         int ascent(Painter &, LyXFont const &) const;
  37         ///
  38         int descent(Painter &, LyXFont const &) const;
  39         ///
  40         int width(Painter &, LyXFont const &) const;
  41         ///
  42         void draw(Painter &, LyXFont const &, int baseline, float & x) const;
  43         ///
  44         void Write(ostream &) const;
  45         /// Parse the command.
  46         void scanCommand(string const & cmd);
  47         /// Will not be used when lyxf3
  48         void Read(LyXLex & lex);
  49         ///
  50         virtual int Latex(ostream &, signed char fragile, bool free_spc) const;
  51 #ifndef USE_OSTREAM_ONLY
  52         ///
  53         virtual int Latex(string & file, signed char fragile, bool free_spc) const;
  54         ///
  55         virtual int Linuxdoc(string & file) const;
  56         ///
  57         virtual int DocBook(string & file) const;
  58 #else
  59         ///
  60         virtual int Linuxdoc(ostream &) const;
  61         ///
  62         virtual int DocBook(ostream &) const;
  63 #endif
  64         ///
  65         Inset * Clone() const;
  66         ///
  67         Inset::Code LyxCode() const
  68         {
  69                 return Inset::NO_CODE;
  70         }
  71
  72         /** Get the label that appears at screen.
  73
  74          I thought it was enough to eliminate the argument to avoid
  75          confusion with lyxinset::getLabel(int), but I've seen that
  76          it wasn't. I hope you never confuse again both methods.  (ale)
  77          */
  78         virtual string getScreenLabel() const
  79         {
  80                 return getCommand();
  81         }
  82
  83         /// Build the complete LaTeX command
  84         string getCommand() const;
  85         ///
  86         string const & getCmdName() const {
  87                 return command;
  88         }
  89         ///
  90         string const & getOptions() const {
  91                 return options;
  92         }
  93         ///
  94         string const & getContents() const {
  95                 return contents;
  96         }
  97         ///
  98         void setCmdName(string const & n) {
  99                 command = n;
 100         }
 101         ///
 102         void setOptions(string const & o) {
 103                 options = o;
 104         }
 105         ///
 106         virtual void setContents(string const & c) {
 107                 contents = c;
 108         }
 109 protected:
 110         ///
 111         string command;
 112         ///
 113         string options;
 114         ///
 115         string contents;
 116 };
 117
 118 #endif