]> git.lyx.org Git - lyx.git/blob - src/insets/InsetBox.h
Fix bug 4037 and related problems. The patch has been cleaned up a bit
[lyx.git] / src / insets / InsetBox.h
1 // -*- C++ -*-
2 /**
3  * \file InsetBox.h
4  * This file is part of LyX, the document processor.
5  * Licence details can be found in the file COPYING.
6  *
7  * \author Angus Leeming
8  * \author Martin Vermeer
9  *
10  * Full author contact details are available in file CREDITS.
11  */
12
13 #ifndef INSETBOX_H
14 #define INSETBOX_H
15
16 #include "InsetCollapsable.h"
17 #include "Length.h"
18 #include "MailInset.h"
19
20
21 namespace lyx {
22
23 class InsetBoxParams {
24 public:
25         ///
26         InsetBoxParams(std::string const &);
27         ///
28         void write(std::ostream & os) const;
29         ///
30         void read(Lexer & lex);
31         ///
32         std::string type;
33         /// Use a parbox (true) or minipage (false)
34         bool use_parbox;
35         /// Do we have an inner parbox or minipage to format paragraphs to
36         /// columnwidth?
37         bool inner_box;
38         ///
39         Length width;
40         /// "special" widths, see usrguide.dvi ยง3.5
41         std::string special;
42         ///
43         char pos;
44         ///
45         char hor_pos;
46         ///
47         char inner_pos;
48         ///
49         Length height;
50         ///
51         std::string height_special;
52 };
53
54
55 /** The fbox/fancybox inset
56
57 */
58 class InsetBox : public InsetCollapsable {
59 public:
60         ///
61         InsetBox(BufferParams const &, std::string const &);
62         ///
63         ~InsetBox();
64         ///
65         virtual docstring const editMessage() const;
66         ///
67         InsetCode lyxCode() const { return BOX_CODE; }
68         ///
69         docstring name() const;
70         ///
71         void write(Buffer const &, std::ostream &) const;
72         ///
73         void read(Buffer const & buf, Lexer & lex);
74         ///
75         void setButtonLabel();
76         ///
77         void metrics(MetricsInfo &, Dimension &) const;
78         /// show the Box dialog
79         bool showInsetDialog(BufferView * bv) const;
80         ///
81         DisplayType display() const { return Inline; }
82         //FIXME Is this the one we want? or is it:
83         //allowParagraphCustomization(idx_type)?
84         ///
85         virtual bool forceEmptyLayout() const;
86         ///
87         bool neverIndent(Buffer const &) const { return true; }
88         ///
89         bool noFontChange() const { return true; }
90         ///
91         bool isMacroScope(Buffer const & buf) const;
92         ///
93         int latex(Buffer const &, odocstream &, OutputParams const &) const;
94         ///
95         int plaintext(Buffer const &, odocstream &, OutputParams const &) const;
96         ///
97         int docbook(Buffer const &, odocstream &, OutputParams const &) const;
98         ///
99         void validate(LaTeXFeatures &) const;
100         ///
101         InsetBoxParams const & params() const { return params_; }
102         ///
103         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
104         ///
105         enum BoxType {
106                 Frameless,
107                 Boxed,
108                 Framed,
109                 ovalbox,
110                 Ovalbox,
111                 Shadowbox,
112                 Shaded,
113                 Doublebox
114         };
115 protected:
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;
120 private:
121         friend class InsetBoxParams;
122
123         virtual Inset * clone() const;
124
125         /// used by the constructors
126         void init();
127         ///
128         InsetBoxParams params_;
129 };
130
131
132 class InsetBoxMailer : public MailInset {
133 public:
134         ///
135         InsetBoxMailer(InsetBox & inset);
136         ///
137         virtual Inset & inset() const { return inset_; }
138         ///
139         virtual std::string const & name() const { return name_; }
140         ///
141         virtual std::string const inset2string(Buffer const &) const;
142         ///
143         static std::string const params2string(InsetBoxParams const &);
144         ///
145         static void string2params(std::string const &, InsetBoxParams &);
146
147 private:
148         ///
149         static std::string const name_;
150         ///
151         InsetBox & inset_;
152 };
153
154
155 } // namespace lyx
156
157 #endif // INSET_BOX_H