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 "insettext.h"
17 #include "insetcollapsable.h"
21 * InsetOptArg. Used to insert a short version of sectioning header etc.
22 * automatically, or other optional LaTeX arguments
24 class InsetOptArg : public InsetCollapsable {
26 InsetOptArg(BufferParams const &);
28 InsetOptArg(InsetOptArg const &, bool same_id = false);
30 /// make a duplicate of this inset
31 Inset * clone(Buffer const &, bool same_id = false) const;
33 /// this inset is editable
34 EDITABLE editable() const { return IS_EDITABLE; }
36 Inset::Code lyxCode() const { return Inset::OPTARG_CODE; }
37 /// return an message upon editing
38 string const editMessage() const;
40 /// Standard LaTeX output -- short-circuited
41 int latex(Buffer const *, std::ostream &,
42 LatexRunParams const &) const;
43 /// Outputting the optional parameter of a LaTeX command
44 int latexOptional(Buffer const *, std::ostream &,
45 LatexRunParams const &) const;
46 /// Write out tothe .lyx file
47 void write(Buffer const * buf, std::ostream & os) const;
50 #endif // INSETOPTARG_H