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 "InsetCollapsable.h"
  17
  18
  19 namespace lyx {
  20
  21
  22 /**
  23  * InsetOptArg. Used to insert a short version of sectioning header etc.
  24  * automatically, or other optional LaTeX arguments
  25  */
  26 class InsetOptArg : public InsetCollapsable
  27 {
  28 public:
  29         ///
  30         InsetOptArg(Buffer const &);
  31
  32         /// Outputting the optional parameter of a LaTeX command
  33         int latexOptional(odocstream &, OutputParams const &) const;
  34
  35 private:
  36         /// code of the inset
  37         InsetCode lyxCode() const { return OPTARG_CODE; }
  38         ///
  39         docstring name() const { return from_ascii("OptArg"); }
  40         /// return an message upon editing
  41         docstring editMessage() const;
  42
  43         /// Standard LaTeX output -- short-circuited
  44         int latex(odocstream &, OutputParams const &) const;
  45         /// Standard plain text output -- short-circuited
  46         int plaintext(odocstream &, OutputParams const &) const;
  47         /// Standard DocBook output -- short-circuited
  48         int docbook(odocstream &, OutputParams const &) const;
  49
  50         /// Write out to the .lyx file
  51         void write(std::ostream & os) const;
  52
  53         /// should paragraph indendation be ommitted in any case?
  54         bool neverIndent() const { return true; }
  55         ///
  56         Inset * clone() const { return new InsetOptArg(*this); }
  57 };
  58
  59
  60 } // namespace lyx
  61
  62 #endif // INSETOPTARG_H