src/insets/insetcaption.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 2000-2001 The LyX Team.
   8  *
   9  *======================================================
  10  */
  11
  12
  13 #ifndef INSETCAPTION_H
  14 #define INSETCAPTION_H
  15
  16 #ifdef __GNUG__
  17 #pragma interface
  18 #endif
  19
  20 #include "insettext.h"
  21
  22 /** A caption inset
  23 */
  24 class InsetCaption : public InsetText {
  25 public:
  26         ///
  27         InsetCaption();
  28         ///
  29         void write(Buffer const * buf, std::ostream & os) const;
  30         ///
  31         void read(Buffer const * buf, LyXLex & lex);
  32         ///
  33         virtual
  34         bool display() const;
  35         ///
  36         virtual
  37         bool needFullRow() const;
  38         ///
  39         virtual
  40         Inset::Code lyxCode() const;
  41         ///
  42         virtual
  43         string const editMessage() const;
  44         ///
  45         virtual
  46         void draw(BufferView * bv, LyXFont const & f,
  47                           int baseline, float & x, bool cleared) const;
  48         ///
  49         virtual
  50         int latex(Buffer const * buf, std::ostream & os,
  51                           bool fragile, bool free_spc) const;
  52         ///
  53         virtual
  54         int ascii(Buffer const * buf, std::ostream & os, int linelen) const;
  55         ///
  56         virtual
  57         int docbook(Buffer const * buf, std::ostream & os) const;
  58 protected:
  59 private:
  60 };
  61
  62
  63 inline
  64 bool InsetCaption::display() const
  65 {
  66         return true;
  67 }
  68
  69
  70 inline
  71 bool InsetCaption::needFullRow() const
  72 {
  73         return true;
  74 }
  75
  76
  77 inline
  78 Inset::Code InsetCaption::lyxCode() const
  79 {
  80         return CAPTION_CODE;
  81 }
  82 #endif