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 #include "TextClass.h"
  17
  18
  19 namespace lyx {
  20
  21 /** A caption inset
  22 */
  23 class InsetCaption : public InsetText {
  24 public:
  25         ///
  26         InsetCaption(InsetCaption const &);
  27         InsetCaption(BufferParams const &);
  28         ///
  29         virtual ~InsetCaption() {}
  30         ///
  31         void write(Buffer const & buf, std::ostream & os) const;
  32         ///
  33         void read(Buffer const & buf, Lexer & lex);
  34         ///
  35         virtual DisplayType display() const;
  36         ///
  37         virtual bool neverIndent(Buffer const &) const { return true; }
  38         ///
  39         virtual Inset::Code lyxCode() const;
  40         ///
  41         virtual docstring const editMessage() const;
  42         ///
  43         virtual void cursorPos(BufferView const & bv,
  44                 CursorSlice const & sl, bool boundary, int & x, int & y) const;
  45         ///
  46         bool descendable() const { return true; }
  47         ///
  48         virtual bool metrics(MetricsInfo & mi, Dimension & dim) const;
  49         ///
  50         virtual void draw(PainterInfo & pi, int x, int y) const;
  51         ///
  52         void drawSelection(PainterInfo & pi, int x, int y) const;
  53         ///
  54         virtual void edit(Cursor & cur, bool left);
  55         ///
  56         virtual Inset * editXY(Cursor & cur, int x, int y);
  57         ///
  58         bool insetAllowed(Inset::Code code) const;
  59         ///
  60         virtual bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
  61         ///
  62         virtual bool wide() const { return false; }
  63         ///
  64         int latex(Buffer const & buf, odocstream & os,
  65                   OutputParams const &) const;
  66         ///
  67         int plaintext(Buffer const & buf, odocstream & os,
  68                       OutputParams const & runparams) const;
  69         ///
  70         int docbook(Buffer const & buf, odocstream & os,
  71                     OutputParams const & runparams) const;
  72         /// return the mandatory argument (LaTeX format) only
  73         int getArgument(Buffer const & buf, odocstream & os,
  74                   OutputParams const &) const;
  75         /// return the optional argument(s) only
  76         int getOptArg(Buffer const & buf, odocstream & os,
  77                   OutputParams const &) const;
  78         ///
  79         void setCount(int c) { counter_ = c; }
  80         ///
  81         std::string const & type() const { return type_; }
  82         ///
  83         void setType(std::string const & type) { type_ = type; }
  84         ///
  85         void setCustomLabel(docstring const & label);
  86         ///
  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; }
  90
  91 private:
  92         ///
  93         void computeFullLabel(Buffer const & buf) const;
  94         ///
  95         virtual std::auto_ptr<Inset> doClone() const;
  96         ///
  97         mutable docstring full_label_;
  98         ///
  99         mutable int labelwidth_;
 100         ///
 101         std::string type_;
 102         ///
 103         docstring custom_label_;
 104         ///
 105         int counter_;
 106         ///
 107         TextClass const & textclass_;
 108 };
 109
 110
 111 inline
 112 Inset::DisplayType InsetCaption::display() const
 113 {
 114         return AlignCenter;
 115 }
 116
 117
 118 inline
 119 Inset::Code InsetCaption::lyxCode() const
 120 {
 121         return CAPTION_CODE;
 122 }
 123
 124
 125 } // namespace lyx
 126
 127 #endif