1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1998 The LyX Team.
8 *======================================================*/
13 #pragma implementation
16 #include "insetminipage.h"
19 #include "BufferView.h"
21 #include "frontends/Dialogs.h"
23 #include "insets/insettext.h"
24 #include "support/LOstream.h"
25 #include "support/lstrings.h"
32 // Some information about Minipages in LaTeX:
33 // A minipage is a complete miniversion of a page and can contain
34 // its own footnotes, paragraphs, and array, tabular, and multicols
35 // environments. However it cannot contain floats or \marginpar's,
36 // but it can appear inside floats.
38 // The minipage environment is defined like this:
40 // \begin{minipage}[pos][height][inner-pos]{width} <text> \end{minipage}
43 // pos [opt] = is the vertical placement of the box with respect
44 // to the text baseline, [c], [t] and [b].
45 // height [opt] = the height of the box
46 // inner-pos [opt] = the position of the text within the box.
47 // It can be t, c, b or s, if unspecified the value
49 // width = the width of the box
51 // In LyX we should try to support all these parameters, settable in a
53 // In this pop-up diallog it should also be possible to set all margin
54 // values that is usable in the minipage.
55 // With regard to different formats (like DocBook) I guess a minipage
56 // can be used there also. Perhaps not in the latex way, but we do not
57 // have to output "" for minipages.
60 InsetMinipage::InsetMinipage()
61 : InsetCollapsable(), pos_(center),
62 inner_pos_(inner_center)
64 setLabel(_("minipage"));
65 LyXFont font(LyXFont::ALL_SANE);
68 font.setColor(LColor::footnote);
70 setAutoCollapse(false);
71 setInsetName("Minipage");
72 width_ = "100%"; // set default to 100% of column_width
76 InsetMinipage::~InsetMinipage()
82 void InsetMinipage::Write(Buffer const * buf, ostream & os) const
84 os << getInsetName() << "\n"
85 << "position " << pos_ << "\n"
86 << "inner_position " << inner_pos_ << "\n"
87 << "height \"" << height_ << "\"\n"
88 << "width \"" << width_ << "\"\n";
89 InsetCollapsable::Write(buf, os);
93 void InsetMinipage::Read(Buffer const * buf, LyXLex & lex)
99 token = lex.GetString();
100 if (token == "position") {
102 pos_ = static_cast<Position>(lex.GetInteger());
105 lyxerr << "InsetMinipage::Read: Missing 'position'-tag!"
112 token = lex.GetString();
114 if (token == "inner_position") {
116 inner_pos_ = static_cast<InnerPosition>(lex.GetInteger());
119 lyxerr << "InsetMinipage::Read: Missing 'inner_position'-tag!"
126 token = lex.GetString();
128 if (token == "height") {
130 height_ = lex.GetString();
133 lyxerr << "InsetMinipage::Read: Missing 'height'-tag!"
140 token = lex.GetString();
142 if (token == "width") {
144 width_ = lex.GetString();
147 lyxerr << "InsetMinipage::Read: Missing 'width'-tag!"
151 #warning Remove me before final 1.2.0 (Jug)
152 // this is only for compatibility to the intermediate format and should
153 // vanish till the final 1.2.0!
157 token = lex.GetString();
159 if (token == "widthp") {
161 // only do this if the width_-string was not already set!
163 width_ = lex.GetString() + "%";
166 lyxerr << "InsetMinipage::Read: Missing 'widthp_'-tag!"
171 lex.pushToken(token);
172 InsetCollapsable::Read(buf, lex);
176 Inset * InsetMinipage::Clone(Buffer const &) const
178 InsetMinipage * result = new InsetMinipage;
179 result->inset->init(inset);
181 result->collapsed = collapsed;
183 result->inner_pos_ = inner_pos_;
184 result->height_ = height_;
185 result->width_ = width_;
190 int InsetMinipage::ascent(BufferView * bv, LyXFont const & font) const
193 return ascent_collapsed(bv->painter(), font);
195 // Take placement into account.
199 i = InsetCollapsable::ascent(bv, font);
202 i = (InsetCollapsable::ascent(bv, font)
203 + InsetCollapsable::descent(bv, font)) / 2;
206 i = InsetCollapsable::descent(bv, font);
214 int InsetMinipage::descent(BufferView * bv, LyXFont const & font) const
217 return descent_collapsed(bv->painter(), font);
219 // Take placement into account.
223 i = InsetCollapsable::descent(bv, font);
226 i = (InsetCollapsable::ascent(bv, font)
227 + InsetCollapsable::descent(bv, font)) / 2;
230 i = InsetCollapsable::ascent(bv, font);
238 string const InsetMinipage::EditMessage() const
240 return _("Opened Minipage Inset");
244 int InsetMinipage::Latex(Buffer const * buf,
245 ostream & os, bool fragile, bool fp) const
259 os << "\\begin{minipage}[" << s_pos << "]{"
260 << LyXLength(width_).asLatexString() << "}%\n";
262 int i = inset->Latex(buf, os, fragile, fp);
264 os << "\\end{minipage}%\n";
269 bool InsetMinipage::InsertInsetAllowed(Inset * in) const
271 if ((in->LyxCode() == Inset::FLOAT_CODE) ||
272 (in->LyxCode() == Inset::MARGIN_CODE)) {
279 InsetMinipage::Position InsetMinipage::pos() const
285 void InsetMinipage::pos(InsetMinipage::Position p)
291 InsetMinipage::InnerPosition InsetMinipage::innerPos() const
297 void InsetMinipage::innerPos(InsetMinipage::InnerPosition ip)
303 string const & InsetMinipage::height() const
309 void InsetMinipage::height(string const & ll)
315 string const & InsetMinipage::width() const
321 void InsetMinipage::width(string const & ll)
327 bool InsetMinipage::ShowInsetDialog(BufferView * bv) const
329 if (!inset->ShowInsetDialog(bv))
330 bv->owner()->getDialogs()->showMinipage(const_cast<InsetMinipage *>(this));
335 void InsetMinipage::InsetButtonRelease(BufferView * bv, int x, int y,
342 InsetCollapsable::InsetButtonRelease(bv, x, y, button);
346 int InsetMinipage::getMaxWidth(BufferView * bv, UpdatableInset const * inset)
350 return VSpace(width_).inPixels(bv);
351 // this should not happen!
352 return InsetCollapsable::getMaxWidth(bv, inset);