src/insets/insetwrap.h

   1 /**
   2  * \file insetwrap.h
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Dekel Tsur
   7  *
   8  * Full author contact details are available in file CREDITS
   9  */
  10
  11 #ifndef InsetWrap_H
  12 #define InsetWrap_H
  13
  14 #ifdef __GNUG__
  15 #pragma interface
  16 #endif
  17
  18 #include "insetcollapsable.h"
  19 #include "toc.h"
  20 #include "lyxlength.h"
  21
  22 #include <boost/signals/signal0.hpp>
  23
  24 class Painter;
  25
  26 /** The wrap inset
  27
  28 */
  29 class InsetWrap : public InsetCollapsable {
  30 public:
  31         ///
  32         InsetWrap(BufferParams const &, string const &);
  33         ///
  34         InsetWrap(InsetWrap const &, bool same_id = false);
  35         ///
  36         ~InsetWrap();
  37         ///
  38         void write(Buffer const * buf, std::ostream & os) const;
  39         ///
  40         void read(Buffer const * buf, LyXLex & lex);
  41         ///
  42         void validate(LaTeXFeatures & features) const;
  43         ///
  44         Inset * clone(Buffer const &, bool same_id = false) const;
  45         ///
  46         Inset::Code lyxCode() const { return Inset::WRAP_CODE; }
  47         ///
  48         int latex(Buffer const *, std::ostream &, bool fragile, bool fp) const;
  49         ///
  50         int docbook(Buffer const *, std::ostream &, bool mixcont) const;
  51         ///
  52         string const editMessage() const;
  53         ///
  54         bool insetAllowed(Inset::Code) const;
  55         ///
  56         int getMaxWidth(BufferView *, UpdatableInset const *) const;
  57         ///
  58         string const & type() const;
  59         ///
  60         LyXLength const & pageWidth() const;
  61         ///
  62         void pageWidth(LyXLength const &);
  63         ///
  64         void placement(string const & p);
  65         ///
  66         string const & placement() const;
  67         ///
  68         void addToToc(toc::TocList &, Buffer const *) const;
  69         ///
  70         bool  showInsetDialog(BufferView *) const;
  71         ///
  72         boost::signal0<void> hideDialog;
  73         ///
  74         int latexTextWidth(BufferView *) const;
  75 private:
  76         ///
  77         string Type_;
  78         ///
  79         string Placement_;
  80         ///
  81         LyXLength width_;
  82 };
  83
  84 #endif