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
  16 #include "insettext.h"
  17
  18 /** A caption inset
  19 */
  20 class InsetCaption : public InsetText {
  21 public:
  22         ///
  23         InsetCaption(BufferParams const &);
  24         ///
  25         void write(Buffer const * buf, std::ostream & os) const;
  26         ///
  27         void read(Buffer const * buf, LyXLex & lex);
  28         ///
  29         virtual bool display() const;
  30         ///
  31         virtual bool needFullRow() const;
  32         ///
  33         virtual Inset::Code lyxCode() const;
  34         ///
  35         virtual string const editMessage() const;
  36         ///
  37         virtual void draw(BufferView * bv, LyXFont const & f,
  38                           int baseline, float & x) const;
  39         ///
  40         virtual int latex(Buffer const * buf, std::ostream & os,
  41                           LatexRunParams const &) const;
  42         ///
  43         int ascii(Buffer const * buf, std::ostream & os, int linelen) const;
  44         ///
  45         int docbook(Buffer const * buf, std::ostream & os, bool mixcont) const;
  46 };
  47
  48
  49 inline
  50 bool InsetCaption::display() const
  51 {
  52         return true;
  53 }
  54
  55
  56 inline
  57 bool InsetCaption::needFullRow() const
  58 {
  59         return true;
  60 }
  61
  62
  63 inline
  64 Inset::Code InsetCaption::lyxCode() const
  65 {
  66         return CAPTION_CODE;
  67 }
  68
  69 #endif