4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Martin Vermeer
9 * Full author contact details are available in file CREDITS.
16 #include "insetcollapsable.h"
23 * InsetOptArg. Used to insert a short version of sectioning header etc.
24 * automatically, or other optional LaTeX arguments
26 class InsetOptArg : public InsetCollapsable {
28 InsetOptArg(BufferParams const &);
31 InsetBase::Code lyxCode() const { return InsetBase::OPTARG_CODE; }
32 /// return an message upon editing
33 virtual docstring const editMessage() const;
35 /// Standard LaTeX output -- short-circuited
36 int latex(Buffer const &, odocstream &,
37 OutputParams const &) const;
38 /// Standard DocBook output -- short-circuited
39 int docbook(Buffer const &, odocstream &,
40 OutputParams const &) const;
42 /// Standard plain text output -- short-circuited
43 int plaintext(Buffer const &, odocstream &,
44 OutputParams const &) const;
46 /// Outputting the optional parameter of a LaTeX command
47 int latexOptional(Buffer const &, odocstream &,
48 OutputParams const &) const;
49 /// Write out to the .lyx file
50 void write(Buffer const & buf, std::ostream & os) const;
52 /// should paragraph indendation be ommitted in any case?
53 virtual bool neverIndent(Buffer const &) const { return true; }
55 InsetOptArg(InsetOptArg const &);
57 virtual std::auto_ptr<InsetBase> doClone() const;
63 #endif // INSETOPTARG_H