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"
21 class InsetCaption : public InsetText {
24 InsetCaption(Buffer *);
26 std::string const & type() const { return type_; }
28 docstring layoutName() const;
29 /// return the mandatory argument (LaTeX format) only
30 void getArgument(otexstream & os, OutputParams const &) const;
31 /// return the optional argument(s) only
32 void getOptArg(otexstream & os, OutputParams const &) const;
33 /// return the caption text
34 int getCaptionAsPlaintext(odocstream & os, OutputParams const &) const;
35 /// return the caption text as HTML
36 docstring getCaptionAsHTML(XHTMLStream & os, OutputParams const &) const;
39 void write(std::ostream & os) const;
41 void read(Lexer & lex);
43 DisplayType display() const { return AlignCenter; }
45 bool neverIndent() const { return true; }
47 InsetCode lyxCode() const { return CAPTION_CODE; }
49 void cursorPos(BufferView const & bv,
50 CursorSlice const & sl, bool boundary, int & x, int & y) const;
52 bool descendable(BufferView const &) const { return true; }
54 void metrics(MetricsInfo & mi, Dimension & dim) const;
56 void drawBackground(PainterInfo & pi, int x, int y) const;
58 void draw(PainterInfo & pi, int x, int y) const;
60 void edit(Cursor & cur, bool front, EntryDirection entry_from);
62 Inset * editXY(Cursor & cur, int x, int y);
64 bool insetAllowed(InsetCode code) const;
66 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
67 // Update the counters of this inset and of its contents
68 void updateBuffer(ParIterator const &, UpdateType);
70 void latex(otexstream & os, OutputParams const &) const;
72 int plaintext(odocstream & os, OutputParams const & runparams) const;
74 int docbook(odocstream & os, OutputParams const & runparams) const;
76 docstring xhtml(XHTMLStream & os, OutputParams const & runparams) const;
78 void setCustomLabel(docstring const & label);
80 void addToToc(DocIterator const &) const;
82 virtual bool forcePlainLayout(idx_type = 0) const { return true; }
83 /// Captions don't accept alignment, spacing, etc.
84 virtual bool allowParagraphCustomization(idx_type = 0) const { return false; }
86 Inset * clone() const { return new InsetCaption(*this); }
89 mutable docstring full_label_;
91 mutable int labelwidth_;
95 docstring custom_label_;