src/insets/insetoptarg.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insetoptarg.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 INSETOPTARG_H
  13 #define INSETOPTARG_H
  14
  15
  16 #include "insettext.h"
  17 #include "insetcollapsable.h"
  18
  19
  20 /**
  21  * InsetOptArg. Used to insert a short version of sectioning header etc.
  22  * automatically, or other optional LaTeX arguments
  23  */
  24 class InsetOptArg : public InsetCollapsable {
  25 public:
  26         InsetOptArg(BufferParams const &);
  27
  28         InsetOptArg(InsetOptArg const &, bool same_id = false);
  29
  30         /// make a duplicate of this inset
  31         Inset * clone(Buffer const &, bool same_id = false) const;
  32
  33         /// this inset is editable
  34         EDITABLE editable() const { return IS_EDITABLE; }
  35         /// code of the inset
  36         Inset::Code lyxCode() const { return Inset::OPTARG_CODE; }
  37         /// return an message upon editing
  38         string const editMessage() const;
  39
  40         /// Standard LaTeX output -- short-circuited
  41         int latex(Buffer const *, std::ostream &,
  42                                         bool fragile, bool fp) const;
  43         /// Outputting the optional parameter of a LaTeX command
  44         int latexOptional(Buffer const *, std::ostream &,
  45                                         bool fragile, bool fp) const;
  46         /// Write out tothe .lyx file
  47         void write(Buffer const * buf, std::ostream & os) const;
  48 };
  49
  50 #endif // INSETOPTARG_H