src/insets/InsetArgument.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetArgument.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Martin Vermeer
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSETARGUMENT_H
  13 #define INSETARGUMENT_H
  14
  15
  16 #include "InsetCollapsable.h"
  17
  18
  19 namespace lyx {
  20
  21
  22 /**
  23  * InsetArgument. Used to insert a short version of sectioning header etc.
  24  * automatically, or other optional LaTeX arguments
  25  */
  26 class InsetArgument : public InsetCollapsable
  27 {
  28 public:
  29         ///
  30         InsetArgument(Buffer *, std::string const &);
  31
  32         /// Outputting the parameter of a LaTeX command
  33         void latexArgument(otexstream &, OutputParams const &,
  34                            docstring const&, docstring const &,
  35                            docstring const &) const;
  36
  37         std::string name() const { return name_; }
  38
  39         /// \name Public functions inherited from Inset class
  40         //@{
  41         ///
  42         bool hasSettings() const { return false; }
  43         ///
  44         InsetCode lyxCode() const { return ARG_CODE; }
  45         ///
  46         docstring layoutName() const { return from_ascii("Argument"); }
  47         /// Update the label string of this inset
  48         void updateBuffer(ParIterator const &, UpdateType);
  49         ///
  50         void latex(otexstream &, OutputParams const &) const { }
  51         ///
  52         int plaintext(odocstream &, OutputParams const &) const { return 0; }
  53         ///
  54         int docbook(odocstream &, OutputParams const &) const { return 0; }
  55         ///
  56         docstring xhtml(XHTMLStream &, OutputParams const &) const
  57                 { return docstring(); }
  58         ///
  59         void write(std::ostream & os) const;
  60         ///
  61         void read(Lexer & lex);
  62         ///
  63         bool neverIndent() const { return true; }
  64         ///
  65         std::string contextMenuName() const;
  66         ///
  67         bool isPassThru() const { return pass_thru_; }
  68         //@}
  69         /// \name Public functions inherited from InsetCollapsable class
  70         //@{
  71         ///
  72         InsetLayout::InsetDecoration decoration() const;
  73         ///
  74         FontInfo getFont() const;
  75         ///
  76         FontInfo getLabelfont() const;
  77         ///
  78         void setButtonLabel();
  79         //@}
  80
  81 private:
  82         ///
  83         docstring toolTip(BufferView const & bv, int, int) const;
  84         ///
  85         std::string name_;
  86         ///
  87         docstring labelstring_;
  88         ///
  89         docstring tooltip_;
  90         ///
  91         FontInfo font_;
  92         ///
  93         FontInfo labelfont_;
  94         ///
  95         std::string decoration_;
  96         ///
  97         bool pass_thru_;
  98
  99 protected:
 100         /// \name Protected functions inherited from Inset class
 101         //@{
 102         ///
 103         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
 104         ///
 105         void doDispatch(Cursor & cur, FuncRequest & cmd);
 106         ///
 107         Inset * clone() const { return new InsetArgument(*this); }
 108         //@}
 109 };
 110
 111
 112 } // namespace lyx
 113
 114 #endif // INSETARGUMENT_H