4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
8 * \author Lars Gullik Bjønnes
10 * Full author contact details are available in file CREDITS.
16 #include "insetcollapsable.h"
17 #include "mailinset.h"
23 class InsetFloatParams {
26 InsetFloatParams() : wide(false), sideways(false) {}
28 void write(std::ostream & os) const;
30 void read(LyXLex & lex);
34 std::string placement;
45 class InsetFloat : public InsetCollapsable {
48 InsetFloat(BufferParams const &, std::string const &);
52 void write(Buffer const & buf, std::ostream & os) const;
54 void read(Buffer const & buf, LyXLex & lex);
56 void validate(LaTeXFeatures & features) const;
58 InsetBase::Code lyxCode() const { return InsetBase::FLOAT_CODE; }
60 int latex(Buffer const &, odocstream &,
61 OutputParams const &) const;
63 int docbook(Buffer const &, odocstream &,
64 OutputParams const &) const;
66 virtual docstring const editMessage() const;
68 bool insetAllowed(InsetBase::Code) const;
69 /** returns true if, when outputing LaTeX, font changes should
70 be closed before generating this inset. This is needed for
71 insets that may contain several paragraphs */
72 bool noFontChange() const { return true; }
74 void wide(bool w, BufferParams const &);
76 void sideways(bool s, BufferParams const &);
78 void addToToc(TocList &, Buffer const &) const;
80 bool showInsetDialog(BufferView *) const;
82 InsetFloatParams const & params() const { return params_; }
84 bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
86 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
88 virtual std::auto_ptr<InsetBase> doClone() const;
91 InsetFloatParams params_;
95 class InsetFloatMailer : public MailInset {
98 InsetFloatMailer(InsetFloat & inset);
100 virtual InsetBase & inset() const { return inset_; }
102 virtual std::string const & name() const { return name_; }
104 virtual std::string const inset2string(Buffer const &) const;
106 static void string2params(std::string const &, InsetFloatParams &);
108 static std::string const params2string(InsetFloatParams const &);
111 static std::string const name_;