3 * \file InsetArgument.h
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.
12 #ifndef INSETARGUMENT_H
13 #define INSETARGUMENT_H
16 #include "InsetCollapsable.h"
23 * InsetArgument. Used to insert a short version of sectioning header etc.
24 * automatically, or other optional LaTeX arguments
26 class InsetArgument : public InsetCollapsable
30 InsetArgument(Buffer *, std::string const &);
32 /// Outputting the parameter of a LaTeX command
33 void latexArgument(otexstream &, OutputParams const &,
34 docstring const&, docstring const &,
35 docstring const &) const;
37 std::string name() const { return name_; }
39 /// \name Public functions inherited from Inset class
42 bool hasSettings() const { return false; }
44 InsetCode lyxCode() const { return ARG_CODE; }
46 docstring layoutName() const { return from_ascii("Argument"); }
47 /// Update the label string of this inset
48 void updateBuffer(ParIterator const &, UpdateType);
50 void latex(otexstream &, OutputParams const &) const { }
52 int plaintext(odocstringstream &, OutputParams const &, size_t) const { return 0; }
54 int docbook(odocstream &, OutputParams const &) const { return 0; }
56 docstring xhtml(XHTMLStream &, OutputParams const &) const
57 { return docstring(); }
59 void write(std::ostream & os) const;
61 void read(Lexer & lex);
63 bool neverIndent() const { return true; }
65 std::string contextMenuName() const;
67 bool isPassThru() const { return pass_thru_; }
69 /// \name Public functions inherited from InsetCollapsable class
72 InsetLayout::InsetDecoration decoration() const;
74 FontInfo getFont() const;
76 FontInfo getLabelfont() const;
78 void setButtonLabel();
83 docstring toolTip(BufferView const & bv, int, int) const;
87 docstring labelstring_;
95 std::string decoration_;
100 /// \name Protected functions inherited from Inset class
103 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
105 void doDispatch(Cursor & cur, FuncRequest & cmd);
107 Inset * clone() const { return new InsetArgument(*this); }
114 #endif // INSETARGUMENT_H