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 virtual bool wide() const { return false; }
37 /// Standard LaTeX output -- short-circuited
38 int latex(Buffer const &, odocstream &,
39 OutputParams const &) const;
40 /// Standard DocBook output -- short-circuited
41 int docbook(Buffer const &, odocstream &,
42 OutputParams const &) const;
44 /// Standard plain text output -- short-circuited
45 int plaintext(Buffer const &, odocstream &,
46 OutputParams const &) const;
48 /// Outputting the optional parameter of a LaTeX command
49 int latexOptional(Buffer const &, odocstream &,
50 OutputParams const &) const;
51 /// Write out to the .lyx file
52 void write(Buffer const & buf, std::ostream & os) const;
54 /// should paragraph indendation be ommitted in any case?
55 virtual bool neverIndent(Buffer const &) const { return true; }
57 InsetOptArg(InsetOptArg const &);
59 virtual std::auto_ptr<InsetBase> doClone() const;
65 #endif // INSETOPTARG_H