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
30 InsetOptArg(Buffer const &);
32 /// Outputting the optional parameter of a LaTeX command
33 int latexOptional(odocstream &, OutputParams const &) const;
37 InsetCode lyxCode() const { return OPTARG_CODE; }
39 docstring name() const { return from_ascii("OptArg"); }
40 /// return an message upon editing
41 docstring editMessage() const;
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;
50 virtual bool forcePlainLayout(idx_type = 0) const { return true; }
52 /// Write out to the .lyx file
53 void write(std::ostream & os) const;
55 /// should paragraph indendation be ommitted in any case?
56 bool neverIndent() const { return true; }
58 Inset * clone() const { return new InsetOptArg(*this); }
64 #endif // INSETOPTARG_H