4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
8 * \author Martin Vermeer
10 * Full author contact details are available in file CREDITS.
16 #include "InsetCollapsable.h"
18 #include "MailInset.h"
23 class InsetBoxParams {
26 InsetBoxParams(std::string const &);
28 void write(std::ostream & os) const;
30 void read(Lexer & lex);
33 /// Use a parbox (true) or minipage (false)
35 /// Do we have an inner parbox or minipage to format paragraphs to
40 /// "special" widths, see usrguide.dvi ยง3.5
51 std::string height_special;
55 /** The fbox/fancybox inset
58 class InsetBox : public InsetCollapsable {
61 InsetBox(BufferParams const &, std::string const &);
65 virtual docstring const editMessage() const;
67 InsetCode lyxCode() const { return BOX_CODE; }
69 docstring name() const;
71 void write(Buffer const &, std::ostream &) const;
73 void read(Buffer const & buf, Lexer & lex);
75 void setButtonLabel();
77 void metrics(MetricsInfo &, Dimension &) const;
78 /// show the Box dialog
79 bool showInsetDialog(BufferView * bv) const;
81 DisplayType display() const { return Inline; }
82 //FIXME Is this the one we want? or is it:
83 //allowParagraphCustomization(idx_type)?
85 virtual bool forceEmptyLayout() const;
87 bool neverIndent(Buffer const &) const { return true; }
89 bool noFontChange() const { return true; }
91 bool isMacroScope(Buffer const & buf) const;
93 int latex(Buffer const &, odocstream &, OutputParams const &) const;
95 int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
97 int docbook(Buffer const &, odocstream &, OutputParams const &) const;
99 void validate(LaTeXFeatures &) const;
101 InsetBoxParams const & params() const { return params_; }
103 bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
116 InsetBox(InsetBox const &);
117 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
118 /// Is the width forced to some value?
119 virtual bool hasFixedWidth() const;
121 friend class InsetBoxParams;
123 virtual Inset * clone() const;
125 /// used by the constructors
128 InsetBoxParams params_;
132 class InsetBoxMailer : public MailInset {
135 InsetBoxMailer(InsetBox & inset);
137 virtual Inset & inset() const { return inset_; }
139 virtual std::string const & name() const { return name_; }
141 virtual std::string const inset2string(Buffer const &) const;
143 static std::string const params2string(InsetBoxParams const &);
145 static void string2params(std::string const &, InsetBoxParams &);
149 static std::string const name_;
157 #endif // INSET_BOX_H