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"
16 #include "TextClass.h"
23 class InsetCaption : public InsetText {
26 InsetCaption(InsetCaption const &);
27 InsetCaption(BufferParams const &);
29 virtual ~InsetCaption() {}
31 void write(Buffer const & buf, std::ostream & os) const;
33 void read(Buffer const & buf, Lexer & lex);
35 virtual DisplayType display() const;
37 virtual bool neverIndent(Buffer const &) const { return true; }
39 virtual Inset::Code lyxCode() const;
41 virtual docstring const 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 bool metrics(MetricsInfo & mi, Dimension & dim) const;
50 virtual void draw(PainterInfo & pi, int x, int y) const;
52 void drawSelection(PainterInfo & pi, int x, int y) const;
54 virtual void edit(Cursor & cur, bool left);
56 virtual Inset * editXY(Cursor & cur, int x, int y);
58 bool insetAllowed(Inset::Code code) const;
60 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
61 // Update the counters of this inset and of its contents
62 virtual void updateLabels(Buffer const &, ParIterator const &);
64 virtual bool wide() const { return false; }
66 int latex(Buffer const & buf, odocstream & os,
67 OutputParams const &) const;
69 int plaintext(Buffer const & buf, odocstream & os,
70 OutputParams const & runparams) const;
72 int docbook(Buffer const & buf, odocstream & os,
73 OutputParams const & runparams) const;
74 /// return the mandatory argument (LaTeX format) only
75 int getArgument(Buffer const & buf, odocstream & os,
76 OutputParams const &) const;
77 /// return the optional argument(s) only
78 int getOptArg(Buffer const & buf, odocstream & os,
79 OutputParams const &) const;
81 std::string const & type() const { return type_; }
83 void setType(std::string const & type) { type_ = type; }
85 void setCustomLabel(docstring const & label);
87 void addToToc(TocList &, Buffer const &, ParConstIterator const &) const;
88 /// Captions don't accept alignment, spacing, etc.
89 bool forceDefaultParagraphs(idx_type) const { return true; }
93 virtual std::auto_ptr<Inset> doClone() const;
95 mutable docstring full_label_;
97 mutable int labelwidth_;
101 docstring custom_label_;
103 TextClass const & textclass_;
108 Inset::DisplayType InsetCaption::display() const
115 Inset::Code InsetCaption::lyxCode() const