src/insets/InsetCaption.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetCaption.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSETCAPTION_H
  13 #define INSETCAPTION_H
  14
  15 #include "InsetText.h"
  16
  17 namespace lyx {
  18
  19 /** A caption inset
  20 */
  21 class InsetCaption : public InsetText {
  22 public:
  23         ///
  24         InsetCaption(Buffer *);
  25         ///
  26         std::string const & type() const { return type_; }
  27         ///
  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;
  37 private:
  38         ///
  39         void write(std::ostream & os) const;
  40         ///
  41         DisplayType display() const { return AlignCenter; }
  42         ///
  43         bool neverIndent() const { return true; }
  44         ///
  45         InsetCode lyxCode() const { return CAPTION_CODE; }
  46         ///
  47         void cursorPos(BufferView const & bv,
  48                 CursorSlice const & sl, bool boundary, int & x, int & y) const;
  49         ///
  50         bool descendable(BufferView const &) const { return true; }
  51         ///
  52         void metrics(MetricsInfo & mi, Dimension & dim) const;
  53         ///
  54         void drawBackground(PainterInfo & pi, int x, int y) const;
  55         ///
  56         void draw(PainterInfo & pi, int x, int y) const;
  57         ///
  58         void edit(Cursor & cur, bool front, EntryDirection entry_from);
  59         ///
  60         Inset * editXY(Cursor & cur, int x, int y);
  61         ///
  62         bool insetAllowed(InsetCode code) const;
  63         ///
  64         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
  65         // Update the counters of this inset and of its contents
  66         void updateBuffer(ParIterator const &, UpdateType);
  67         ///
  68         void latex(otexstream & os, OutputParams const &) const;
  69         ///
  70         int plaintext(odocstream & os, OutputParams const & runparams) const;
  71         ///
  72         int docbook(odocstream & os, OutputParams const & runparams) const;
  73         ///
  74         docstring xhtml(XHTMLStream & os, OutputParams const & runparams) const;
  75         ///
  76         void setCustomLabel(docstring const & label);
  77         ///
  78         void addToToc(DocIterator const &) const;
  79         ///
  80         virtual bool forcePlainLayout(idx_type = 0) const { return true; }
  81         /// Captions don't accept alignment, spacing, etc.
  82         virtual bool allowParagraphCustomization(idx_type = 0) const { return false; }
  83         ///
  84         Inset * clone() const { return new InsetCaption(*this); }
  85
  86         ///
  87         mutable docstring full_label_;
  88         ///
  89         mutable int labelwidth_;
  90         ///
  91         std::string type_;
  92         ///
  93         docstring custom_label_;
  94 };
  95
  96
  97 } // namespace lyx
  98
  99 #endif