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.
17 #include "insetcollapsable.h"
18 #include "lyxlength.h"
21 class InsetBoxParams {
24 InsetBoxParams(std::string const &);
26 void write(std::ostream & os) const;
28 void read(LyXLex & lex);
31 /// Use a parbox (true) or minipage (false)
33 /// Do we have an inner parbox or minipage to format paragraphs to
38 /// "special" widths, see usrguide.dvi ยง3.5
49 std::string height_special;
53 /** The fbox/fancybox inset
56 class InsetBox : public InsetCollapsable {
59 InsetBox(BufferParams const &, std::string const &);
63 std::string const editMessage() const;
65 InsetBase::Code lyxCode() const { return InsetBase::BOX_CODE; }
67 void write(Buffer const &, std::ostream &) const;
69 void read(Buffer const & buf, LyXLex & lex);
71 void setButtonLabel();
73 void metrics(MetricsInfo &, Dimension &) const;
74 /// show the Box dialog
75 bool showInsetDialog(BufferView * bv) const;
77 bool display() const { return false; }
79 bool forceDefaultParagraphs(idx_type) const;
81 bool neverIndent() const { return true; }
83 bool noFontChange() const { return true; }
85 int latex(Buffer const &, std::ostream &,
86 OutputParams const &) const;
88 int linuxdoc(Buffer const &, std::ostream &,
89 OutputParams const &) const;
91 int docbook(Buffer const &, std::ostream &,
92 OutputParams const &) const;
94 int plaintext(Buffer const &, std::ostream &,
95 OutputParams const & runparams) const;
97 void validate(LaTeXFeatures &) const;
99 InsetBoxParams const & params() const { return params_; }
101 bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
112 InsetBox(InsetBox const &);
113 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
115 friend class InsetBoxParams;
117 virtual std::auto_ptr<InsetBase> doClone() const;
119 /// used by the constructors
122 InsetBoxParams params_;
126 #include "mailinset.h"
128 class InsetBoxMailer : public MailInset {
131 InsetBoxMailer(InsetBox & inset);
133 virtual InsetBase & inset() const { return inset_; }
135 virtual std::string const & name() const { return name_; }
137 virtual std::string const inset2string(Buffer const &) const;
139 static std::string const params2string(InsetBoxParams const &);
141 static void string2params(std::string const &, InsetBoxParams &);
145 static std::string const name_;
150 #endif // INSET_BOX_H