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"
19 #include "support/translator.h"
22 struct 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 &);
61 InsetBox(InsetBox const &);
65 virtual std::auto_ptr<InsetBase> clone() const;
67 std::string const editMessage() const;
69 InsetOld::Code lyxCode() const { return InsetOld::BOX_CODE; }
71 void write(Buffer const &, std::ostream &) const;
73 void read(Buffer const & buf, LyXLex & lex);
75 void setButtonLabel();
77 void metrics(MetricsInfo &, Dimension &) const;
78 /// show the Box dialog
79 bool showInsetDialog(BufferView * bv) const;
81 bool display() const { return false; }
83 int latex(Buffer const &, std::ostream &,
84 OutputParams const &) const;
86 int linuxdoc(Buffer const &, std::ostream &,
87 OutputParams const &) const;
89 int docbook(Buffer const &, std::ostream &,
90 OutputParams const &) const;
92 int plaintext(Buffer const &, std::ostream &,
93 OutputParams const & runparams) const;
95 void validate(LaTeXFeatures &) const;
97 InsetBoxParams const & params() const { return params_; }
111 priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
113 friend class InsetBoxParams;
115 /// used by the constructors
118 InsetBoxParams params_;
124 typedef Translator<std::string, InsetBox::BoxType> BoxTranslator;
125 BoxTranslator const & boxtranslator();
126 BoxTranslator const & boxtranslator_loc();
131 #include "mailinset.h"
133 class InsetBoxMailer : public MailInset {
136 InsetBoxMailer(InsetBox & inset);
138 virtual InsetBase & inset() const { return inset_; }
140 virtual std::string const & name() const { return name_; }
142 virtual std::string const inset2string(Buffer const &) const;
144 static std::string const params2string(InsetBoxParams const &);
146 static void string2params(std::string const &, InsetBoxParams &);
150 static std::string const name_;
155 #endif // INSET_BOX_H