src/insets/insetfloat.h

   1 // -*- C++ -*-
   2 /**
   3  * \file insetfloat.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Jürgen Vigna
   8  * \author Lars Gullik Bjønnes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSETFLOAT_H
  14 #define INSETFLOAT_H
  15
  16 #include "insetcollapsable.h"
  17 #include "toc.h"
  18
  19
  20 class InsetFloatParams {
  21 public:
  22         ///
  23         InsetFloatParams() : wide(false), sideways(false) {}
  24         ///
  25         void write(std::ostream & os) const;
  26         ///
  27         void read(LyXLex & lex);
  28         ///
  29         std::string type;
  30         ///
  31         std::string placement;
  32         ///
  33         bool wide;
  34         ///
  35         bool sideways;
  36 };
  37
  38
  39 /** The float inset
  40
  41 */
  42 class InsetFloat : public InsetCollapsable {
  43 public:
  44         ///
  45         InsetFloat(BufferParams const &, std::string const &);
  46         ///
  47         ~InsetFloat();
  48         ///
  49         void write(Buffer const & buf, std::ostream & os) const;
  50         ///
  51         void read(Buffer const & buf, LyXLex & lex);
  52         ///
  53         void validate(LaTeXFeatures & features) const;
  54         ///
  55         InsetBase::Code lyxCode() const { return InsetBase::FLOAT_CODE; }
  56         ///
  57         int latex(Buffer const &, std::ostream &,
  58                   OutputParams const &) const;
  59         ///
  60         int docbook(Buffer const &, std::ostream &,
  61                     OutputParams const &) const;
  62         ///
  63         virtual lyx::docstring const editMessage() const;
  64         ///
  65         bool insetAllowed(InsetBase::Code) const;
  66         /** returns true if, when outputing LaTeX, font changes should
  67             be closed before generating this inset. This is needed for
  68             insets that may contain several paragraphs */
  69         bool noFontChange() const { return true; }
  70         ///
  71         void wide(bool w, BufferParams const &);
  72         ///
  73         void sideways(bool s, BufferParams const &);
  74         ///
  75         void addToToc(lyx::toc::TocList &, Buffer const &) const;
  76         ///
  77         bool  showInsetDialog(BufferView *) const;
  78         ///
  79         InsetFloatParams const & params() const { return params_; }
  80         ///
  81         bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
  82 protected:
  83         virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
  84 private:
  85         virtual std::auto_ptr<InsetBase> doClone() const;
  86
  87         ///
  88         InsetFloatParams params_;
  89 };
  90
  91
  92 #include "mailinset.h"
  93
  94
  95 class InsetFloatMailer : public MailInset {
  96 public:
  97         ///
  98         InsetFloatMailer(InsetFloat & inset);
  99         ///
 100         virtual InsetBase & inset() const { return inset_; }
 101         ///
 102         virtual std::string const & name() const { return name_; }
 103         ///
 104         virtual std::string const inset2string(Buffer const &) const;
 105         ///
 106         static void string2params(std::string const &, InsetFloatParams &);
 107         ///
 108         static std::string const params2string(InsetFloatParams const &);
 109 private:
 110         ///
 111         static std::string const name_;
 112         ///
 113         InsetFloat & inset_;
 114 };
 115
 116 #endif