4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
12 #ifndef INSETCAPTION_H
13 #define INSETCAPTION_H
15 #include "InsetText.h"
23 class InsetCaption : public InsetText {
26 InsetCaption(InsetCaption const &);
27 InsetCaption(BufferParams const &);
29 virtual ~InsetCaption() {}
31 void write(std::ostream & os) const;
33 void read(Lexer & lex);
35 virtual DisplayType display() const;
37 virtual bool neverIndent() const { return true; }
39 virtual InsetCode lyxCode() const;
41 docstring editMessage() const;
43 virtual void cursorPos(BufferView const & bv,
44 CursorSlice const & sl, bool boundary, int & x, int & y) const;
46 bool descendable() const { return true; }
48 virtual void metrics(MetricsInfo & mi, Dimension & dim) const;
50 virtual void draw(PainterInfo & pi, int x, int y) const;
52 virtual void edit(Cursor & cur, bool front, EntryDirection entry_from);
54 virtual Inset * editXY(Cursor & cur, int x, int y);
56 bool insetAllowed(InsetCode code) const;
58 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
59 // Update the counters of this inset and of its contents
60 virtual void updateLabels(ParIterator const &);
62 int latex(odocstream & os, OutputParams const &) const;
64 int plaintext(odocstream & os, OutputParams const & runparams) const;
66 int docbook(odocstream & os, OutputParams const & runparams) const;
67 /// return the mandatory argument (LaTeX format) only
68 int getArgument(odocstream & os, OutputParams const &) const;
69 /// return the optional argument(s) only
70 int getOptArg(odocstream & os, OutputParams const &) const;
72 std::string const & type() const { return type_; }
74 void setCustomLabel(docstring const & label);
76 void addToToc(ParConstIterator const &) const;
78 virtual bool forceEmptyLayout() const { return true; }
79 /// Captions don't accept alignment, spacing, etc.
80 virtual bool allowParagraphCustomization(idx_type) const { return false; }
84 virtual Inset * clone() const;
86 mutable docstring full_label_;
88 mutable int labelwidth_;
92 docstring custom_label_;
94 TextClass const & textclass_;
99 Inset::DisplayType InsetCaption::display() const
106 InsetCode InsetCaption::lyxCode() const