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