3 * \file InsetCaptionable.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Alejandro Aguilar Sierra
9 * \author Lars Gullik Bjønnes
10 * \author Guillaume Munch
12 * Full author contact details are available in file CREDITS.
15 #ifndef INSET_CAPTIONABLE_H
16 #define INSET_CAPTIONABLE_H
18 #include "InsetCollapsible.h"
23 class InsetCaptionable : public InsetCollapsible
26 InsetCaptionable(Buffer * buffer, std::string const & type = "senseless")
27 : InsetCollapsible(buffer), caption_type_(type) {}
29 std::string const & captionType() const { return caption_type_; }
31 docstring floatName(std::string const & type) const;
35 InsetCaption const * getCaptionInset() const;
37 docstring getCaptionText(OutputParams const &) const;
39 docstring getCaptionHTML(OutputParams const &) const;
41 docstring getCaptionDocBook(OutputParams const &) const;
43 virtual void setCaptionType(std::string const & type);
44 /// are our captions subcaptions?
45 virtual bool hasSubCaptions(ParIterator const &) const { return false; }
47 void addToToc(DocIterator const & di, bool output_active,
48 UpdateType utype, TocBackend & backend) const override;
49 /// Update the counters of this inset and of its contents
50 void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false) override;
52 bool insetAllowed(InsetCode) const override;
55 std::string caption_type_;
61 #endif // INSET_CAPTIONABLE_H