2 * \file insetcollapsable.C
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alejandro Aguilar Sierra
8 * \author Lars Gullik Bjønnes
10 * Full author contact details are available in file CREDITS.
15 #include "insetcollapsable.h"
18 #include "bufferparams.h"
19 #include "BufferView.h"
22 #include "dispatchresult.h"
23 #include "FloatList.h"
24 #include "FuncStatus.h"
28 #include "funcrequest.h"
29 #include "metricsinfo.h"
30 #include "paragraph.h"
32 #include "frontends/FontMetrics.h"
33 #include "frontends/Painter.h"
38 using graphics::PreviewLoader;
47 InsetCollapsable::CollapseStatus InsetCollapsable::status() const
49 return (autoOpen_ && status_ != Inlined) ? Open : status_;
53 InsetCollapsable::InsetCollapsable
54 (BufferParams const & bp, CollapseStatus status)
55 : InsetText(bp), label(from_ascii("Label")), status_(status),
56 openinlined_(false), autoOpen_(false), mouse_hover_(false)
58 setAutoBreakRows(true);
60 setFrameColor(LColor::collapsableframe);
61 setInsetName(from_ascii("Collapsable"));
66 void InsetCollapsable::write(Buffer const & buf, ostream & os) const
85 void InsetCollapsable::read(Buffer const & buf, LyXLex & lex)
87 bool token_found = false;
90 string const token = lex.getString();
91 if (token == "status") {
93 string const tmp_token = lex.getString();
95 if (tmp_token == "inlined") {
98 } else if (tmp_token == "collapsed") {
101 } else if (tmp_token == "open") {
105 lyxerr << "InsetCollapsable::read: Missing status!"
107 // Take countermeasures
108 lex.pushToken(token);
111 lyxerr << "InsetCollapsable::read: Missing 'status'-tag!"
113 // take countermeasures
114 lex.pushToken(token);
117 InsetText::read(buf, lex);
120 status_ = isOpen() ? Open : Collapsed;
126 Dimension InsetCollapsable::dimensionCollapsed() const
129 theFontMetrics(labelfont_).buttonText(
130 label, dim.wid, dim.asc, dim.des);
135 bool InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
137 autoOpen_ = mi.base.bv->cursor().isInside(this);
138 mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
140 if (status() == Inlined) {
141 InsetText::metrics(mi, dim);
143 dim = dimensionCollapsed();
144 if (status() == Open) {
145 InsetText::metrics(mi, textdim_);
146 // This expression should not contain mi.base.texwidth
147 openinlined_ = textdim_.wid < 0.5 * mi.base.bv->workWidth();
149 // Correct for button width, and re-fit
150 mi.base.textwidth -= dim.wid;
151 InsetText::metrics(mi, textdim_);
152 dim.wid += textdim_.wid;
153 dim.des = max(dim.des - textdim_.asc + dim.asc, textdim_.des);
154 dim.asc = textdim_.asc;
156 dim.des += textdim_.height() + TEXT_TO_BOTTOM_OFFSET;
157 dim.wid = max(dim.wid, textdim_.wid);
161 dim.asc += TEXT_TO_INSET_OFFSET;
162 dim.des += TEXT_TO_INSET_OFFSET;
163 dim.wid += 2 * TEXT_TO_INSET_OFFSET;
164 mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET;
165 bool const changed = dim_ != dim;
171 bool InsetCollapsable::setMouseHover(bool mouse_hover)
173 mouse_hover_ = mouse_hover;
178 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
180 const int xx = x + TEXT_TO_INSET_OFFSET;
181 if (status() == Inlined) {
182 InsetText::draw(pi, xx, y);
184 Dimension dimc = dimensionCollapsed();
185 int const top = y - ascent() + TEXT_TO_INSET_OFFSET;
186 button_dim.x1 = xx + 0;
187 button_dim.x2 = xx + dimc.width();
189 button_dim.y2 = top + dimc.height();
191 pi.pain.buttonText(xx, top + dimc.asc, label, labelfont_, mouse_hover_);
193 if (status() == Open) {
196 textx = xx + dimc.width();
197 texty = top + textdim_.asc;
200 texty = top + dimc.height() + textdim_.asc;
202 InsetText::draw(pi, textx, texty);
205 setPosCache(pi, x, y);
209 void InsetCollapsable::drawSelection(PainterInfo & pi, int x, int y) const
211 x += TEXT_TO_INSET_OFFSET;
212 if (status() == Open) {
214 x += dimensionCollapsed().wid;
216 y += dimensionCollapsed().des + textdim_.asc;
218 if (status() != Collapsed)
219 InsetText::drawSelection(pi, x, y);
223 void InsetCollapsable::cursorPos(BufferView const & bv,
224 CursorSlice const & sl, bool boundary, int & x, int & y) const
226 BOOST_ASSERT(status() != Collapsed);
228 InsetText::cursorPos(bv, sl, boundary, x, y);
230 if (status() == Open) {
232 x += dimensionCollapsed().wid;
234 y += dimensionCollapsed().height() - ascent()
235 + TEXT_TO_INSET_OFFSET + textdim_.asc;
237 x += TEXT_TO_INSET_OFFSET;
241 InsetBase::EDITABLE InsetCollapsable::editable() const
243 return status() != Collapsed ? HIGHLY_EDITABLE : IS_EDITABLE;
247 bool InsetCollapsable::descendable() const
249 return status() != Collapsed;
253 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
255 return button_dim.contains(cmd.x, cmd.y);
259 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
262 pos_type const max_length = 15;
263 pos_type const p_siz = paragraphs().begin()->size();
264 pos_type const n = min(max_length, p_siz);
267 for (; i < n && j < p_siz; ++j) {
268 if (paragraphs().begin()->isInset(j))
270 label += paragraphs().begin()->getChar(j);
273 if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
276 return label.empty() ? l : label;
280 void InsetCollapsable::edit(LCursor & cur, bool left)
282 //lyxerr << "InsetCollapsable: edit left/right" << endl;
284 InsetText::edit(cur, left);
288 InsetBase * InsetCollapsable::editXY(LCursor & cur, int x, int y)
290 //lyxerr << "InsetCollapsable: edit xy" << endl;
291 if (status() == Collapsed || button_dim.contains(x, y))
294 return InsetText::editXY(cur, x, y);
298 void InsetCollapsable::doDispatch(LCursor & cur, FuncRequest & cmd)
300 //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
301 // << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
303 switch (cmd.action) {
304 case LFUN_MOUSE_PRESS:
305 if (cmd.button() == mouse_button::button1 && hitButton(cmd)) {
310 if (status() == Inlined)
311 InsetText::doDispatch(cur, cmd);
312 else if (status() == Open && !hitButton(cmd))
313 InsetText::doDispatch(cur, cmd);
318 case LFUN_MOUSE_MOTION:
319 case LFUN_MOUSE_DOUBLE:
320 case LFUN_MOUSE_TRIPLE:
321 if (status_ == Inlined)
322 InsetText::doDispatch(cur, cmd);
323 else if (status() && !hitButton(cmd))
324 InsetText::doDispatch(cur, cmd);
329 case LFUN_MOUSE_RELEASE:
330 if (cmd.button() == mouse_button::button3) {
331 // Open the Inset configuration dialog
332 showInsetDialog(&cur.bv());
336 if (status() == Inlined) {
337 // The mouse click has to be within the inset!
338 InsetText::doDispatch(cur, cmd);
342 if (cmd.button() == mouse_button::button1 && hitButton(cmd)) {
343 // Left button is clicked, the user asks to toggle the inset
346 cur.updateFlags(Update::Force | Update::FitCursor);
347 if (status() == Collapsed) {
348 setStatus(cur, Open);
352 setStatus(cur, Collapsed);
354 cur.bv().cursor() = cur;
358 // The mouse click is within the opened inset.
359 InsetText::doDispatch(cur, cmd);
362 case LFUN_INSET_TOGGLE:
363 if (cmd.argument() == "open")
364 setStatus(cur, Open);
365 else if (cmd.argument() == "close")
366 setStatus(cur, Collapsed);
367 else if (cmd.argument() == "toggle" || cmd.argument().empty())
369 setStatus(cur, Collapsed);
370 cur.forwardPosNoDescend();
373 setStatus(cur, Open);
374 else // if assign or anything else
380 InsetText::doDispatch(cur, cmd);
386 bool InsetCollapsable::getStatus(LCursor & cur, FuncRequest const & cmd,
387 FuncStatus & flag) const
389 switch (cmd.action) {
391 case LFUN_INSET_TOGGLE:
392 if (cmd.argument() == "open" || cmd.argument() == "close" ||
393 cmd.argument() == "toggle")
400 return InsetText::getStatus(cur, cmd, flag);
405 void InsetCollapsable::setLabel(docstring const & l)
411 void InsetCollapsable::setStatus(LCursor & cur, CollapseStatus status)
415 if (status_ == Collapsed)
416 cur.leaveInset(*this);
420 void InsetCollapsable::setLabelFont(LyXFont & font)
425 docstring InsetCollapsable::floatName(string const & type, BufferParams const & bp)
427 FloatList const & floats = bp.getLyXTextClass().floats();
428 FloatList::const_iterator it = floats[type];
430 return (it == floats.end()) ? from_ascii(type) : _(it->second.name());