2 * \file InsetCollapsable.cpp
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"
21 #include "Dimension.h"
22 #include "FloatList.h"
23 #include "FuncRequest.h"
24 #include "FuncStatus.h"
25 #include "InsetLayout.h"
27 #include "MetricsInfo.h"
28 #include "OutputParams.h"
30 #include "frontends/FontMetrics.h"
31 #include "frontends/Painter.h"
33 #include "support/debug.h"
34 #include "support/docstream.h"
35 #include "support/gettext.h"
36 #include "support/lassert.h"
37 #include "support/lstrings.h"
44 InsetCollapsable::InsetCollapsable(Buffer * buf, InsetText::UsePlain ltype)
45 : InsetText(buf, ltype), status_(Open), openinlined_(false)
47 setAutoBreakRows(true);
49 setFrameColor(Color_collapsableframe);
53 // The sole purpose of this copy constructor is to make sure
54 // that the mouse_hover_ map is not copied and remains empty.
55 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
58 labelstring_(rhs.labelstring_),
59 button_dim(rhs.button_dim),
60 openinlined_(rhs.openinlined_)
64 InsetCollapsable::~InsetCollapsable()
66 map<BufferView const *, bool>::iterator it = mouse_hover_.begin();
67 map<BufferView const *, bool>::iterator end = mouse_hover_.end();
68 for (; it != end; ++it)
70 it->first->clearLastInset(this);
74 InsetCollapsable::CollapseStatus InsetCollapsable::status(BufferView const & bv) const
76 if (decoration() == InsetLayout::CONGLOMERATE)
78 return auto_open_[&bv] ? Open : status_;
82 InsetCollapsable::Geometry InsetCollapsable::geometry(BufferView const & bv) const
84 switch (decoration()) {
85 case InsetLayout::CLASSIC:
86 if (status(bv) == Open)
87 return openinlined_ ? LeftButton : TopButton;
90 case InsetLayout::MINIMALISTIC:
91 return status(bv) == Open ? NoButton : ButtonOnly ;
93 case InsetLayout::CONGLOMERATE:
94 return status(bv) == Open ? SubLabel : Corners ;
96 case InsetLayout::DEFAULT:
97 break; // this shouldn't happen
100 // dummy return value to shut down a warning,
101 // this is dead code.
106 InsetCollapsable::Geometry InsetCollapsable::geometry() const
108 switch (decoration()) {
109 case InsetLayout::CLASSIC:
111 return openinlined_ ? LeftButton : TopButton;
114 case InsetLayout::MINIMALISTIC:
115 return status_ == Open ? NoButton : ButtonOnly ;
117 case InsetLayout::CONGLOMERATE:
118 return status_ == Open ? SubLabel : Corners ;
120 case InsetLayout::DEFAULT:
121 break; // this shouldn't happen
124 // dummy return value to shut down a warning,
125 // this is dead code.
130 docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
132 Dimension dim = dimensionCollapsed(bv);
133 if (geometry(bv) == NoButton)
134 return translateIfPossible(getLayout().labelstring());
135 if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des || isOpen(bv))
138 return toolTipText();
142 void InsetCollapsable::write(ostream & os) const
158 void InsetCollapsable::read(Lexer & lex)
160 lex.setContext("InsetCollapsable::read");
163 lex >> "status" >> tmp_token;
164 if (tmp_token == "open")
167 InsetText::read(lex);
172 Dimension InsetCollapsable::dimensionCollapsed(BufferView const & bv) const
175 theFontMetrics(getLayout().labelfont()).buttonText(
176 buttonLabel(bv), dim.wid, dim.asc, dim.des);
181 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
183 auto_open_[mi.base.bv] = mi.base.bv->cursor().isInside(this);
185 FontInfo tmpfont = mi.base.font;
186 mi.base.font = getLayout().font();
187 mi.base.font.realize(tmpfont);
189 BufferView const & bv = *mi.base.bv;
191 switch (geometry(bv)) {
193 InsetText::metrics(mi, dim);
196 InsetText::metrics(mi, dim);
201 InsetText::metrics(mi, dim);
202 // consider width of the inset label
203 FontInfo font(getLayout().labelfont());
204 font.realize(sane_font);
210 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
217 dim = dimensionCollapsed(bv);
218 if (geometry(bv) == TopButton
219 || geometry(bv) == LeftButton) {
221 InsetText::metrics(mi, textdim);
222 openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
224 // Correct for button width.
225 dim.wid += textdim.wid;
226 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
227 dim.asc = textdim.asc;
229 dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
230 dim.wid = max(dim.wid, textdim.wid);
236 mi.base.font = tmpfont;
240 bool InsetCollapsable::setMouseHover(BufferView const * bv, bool mouse_hover)
243 mouse_hover_[bv] = mouse_hover;
248 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
250 BufferView const & bv = *pi.base.bv;
252 auto_open_[&bv] = bv.cursor().isInside(this);
254 FontInfo tmpfont = pi.base.font;
255 pi.base.font = getLayout().font();
256 pi.base.font.realize(tmpfont);
258 // Draw button first -- top, left or only
259 Dimension dimc = dimensionCollapsed(bv);
261 if (geometry(bv) == TopButton ||
262 geometry(bv) == LeftButton ||
263 geometry(bv) == ButtonOnly) {
264 button_dim.x1 = x + 0;
265 button_dim.x2 = x + dimc.width();
266 button_dim.y1 = y - dimc.asc;
267 button_dim.y2 = y + dimc.des;
269 FontInfo labelfont = getLayout().labelfont();
270 labelfont.setColor(labelColor());
271 pi.pain.buttonText(x, y, buttonLabel(bv), labelfont,
280 Dimension const textdim = InsetText::dimension(bv);
281 int const baseline = y;
283 switch (geometry(bv)) {
285 textx = x + dimc.width();
287 InsetText::draw(pi, textx, texty);
291 texty = baseline + dimc.des + textdim.asc;
292 InsetText::draw(pi, textx, texty);
299 InsetText::draw(pi, textx, texty);
305 const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
306 InsetText::draw(pi, textx, texty);
307 const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
309 int desc = textdim.descent();
310 if (geometry(bv) == Corners)
313 const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
314 const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
315 pi.pain.line(xx1, y + desc - 4,
319 pi.pain.line(xx1, y + desc,
323 // Make status_ value visible:
324 pi.pain.line(xx1, y + desc,
327 pi.pain.line(xx2 - 4, y + desc,
331 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3,
332 y + desc - 4, Color_foreground);
334 // the label below the text. Can be toggled.
335 if (geometry(bv) == SubLabel) {
336 FontInfo font(getLayout().labelfont());
337 font.realize(sane_font);
343 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
344 int const ww = max(textdim.wid, w);
345 pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
346 buttonLabel(bv), font, Color_none, Color_none);
350 // a visual cue when the cursor is inside the inset
351 Cursor const & cur = bv.cursor();
352 if (cur.isInside(this)) {
355 pi.pain.line(xx1, y + 4, xx1, y, Color_foreground);
356 pi.pain.line(xx1 + 4, y, xx1, y, Color_foreground);
357 pi.pain.line(xx2, y + 4, xx2, y, Color_foreground);
358 pi.pain.line(xx2 - 4, y, xx2, y, Color_foreground);
363 pi.base.font = tmpfont;
367 void InsetCollapsable::cursorPos(BufferView const & bv,
368 CursorSlice const & sl, bool boundary, int & x, int & y) const
370 if (geometry(bv) == ButtonOnly)
373 InsetText::cursorPos(bv, sl, boundary, x, y);
374 Dimension const textdim = InsetText::dimension(bv);
376 switch (geometry(bv)) {
378 x += dimensionCollapsed(bv).wid;
381 y += dimensionCollapsed(bv).des + textdim.asc;
396 bool InsetCollapsable::editable() const
398 return geometry() != ButtonOnly;
402 bool InsetCollapsable::descendable(BufferView const & bv) const
404 return geometry(bv) != ButtonOnly;
408 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
410 return button_dim.contains(cmd.x(), cmd.y());
414 bool InsetCollapsable::clickable(int x, int y) const
416 FuncRequest cmd(LFUN_NOACTION, x, y, mouse_button::none);
417 return hitButton(cmd);
421 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
424 pos_type const max_length = 15;
425 pos_type const p_siz = paragraphs().begin()->size();
426 pos_type const n = min(max_length, p_siz);
429 for (; i < n && j < p_siz; ++j) {
430 if (paragraphs().begin()->isInset(j))
432 label += paragraphs().begin()->getChar(j);
435 if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
438 return label.empty() ? l : label;
442 void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
444 //lyxerr << "InsetCollapsable: edit left/right" << endl;
446 InsetText::edit(cur, front, entry_from);
450 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
452 //lyxerr << "InsetCollapsable: edit xy" << endl;
453 if (geometry(cur.bv()) == ButtonOnly
454 || (button_dim.contains(x, y)
455 && geometry(cur.bv()) != NoButton))
458 return InsetText::editXY(cur, x, y);
462 void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
464 //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
465 // << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
467 switch (cmd.action()) {
468 case LFUN_MOUSE_PRESS:
469 if (hitButton(cmd)) {
470 switch (cmd.button()) {
471 case mouse_button::button1:
472 case mouse_button::button3:
473 // Pass the command to the enclosing InsetText,
474 // so that the cursor gets set.
477 case mouse_button::none:
478 case mouse_button::button2:
479 case mouse_button::button4:
480 case mouse_button::button5:
482 cur.noScreenUpdate();
485 } else if (geometry(cur.bv()) != ButtonOnly)
486 InsetText::doDispatch(cur, cmd);
491 case LFUN_MOUSE_MOTION:
492 case LFUN_MOUSE_DOUBLE:
493 case LFUN_MOUSE_TRIPLE:
495 cur.noScreenUpdate();
496 else if (geometry(cur.bv()) != ButtonOnly)
497 InsetText::doDispatch(cur, cmd);
502 case LFUN_MOUSE_RELEASE:
503 if (!hitButton(cmd)) {
504 // The mouse click has to be within the inset!
505 if (geometry(cur.bv()) != ButtonOnly)
506 InsetText::doDispatch(cur, cmd);
511 if (cmd.button() != mouse_button::button1) {
513 cur.noScreenUpdate();
516 // if we are selecting, we do not want to
520 // Left button is clicked, the user asks to
521 // toggle the inset visual state.
523 cur.screenUpdateFlags(Update::Force | Update::FitCursor);
524 if (geometry(cur.bv()) == ButtonOnly) {
525 setStatus(cur, Open);
529 setStatus(cur, Collapsed);
530 cur.bv().cursor() = cur;
533 case LFUN_INSET_TOGGLE:
534 if (cmd.argument() == "open")
535 setStatus(cur, Open);
536 else if (cmd.argument() == "close")
537 setStatus(cur, Collapsed);
538 else if (cmd.argument() == "toggle" || cmd.argument().empty())
539 if (status_ == Open) {
540 setStatus(cur, Collapsed);
541 if (geometry(cur.bv()) == ButtonOnly)
542 cur.top().forwardPos();
544 setStatus(cur, Open);
545 else // if assign or anything else
551 InsetText::doDispatch(cur, cmd);
557 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
558 FuncStatus & flag) const
560 switch (cmd.action()) {
561 case LFUN_INSET_TOGGLE:
562 if (cmd.argument() == "open")
563 flag.setEnabled(status_ != Open);
564 else if (cmd.argument() == "close")
565 flag.setEnabled(status_ == Open);
566 else if (cmd.argument() == "toggle" || cmd.argument().empty()) {
567 flag.setEnabled(true);
568 flag.setOnOff(status_ == Open);
570 flag.setEnabled(false);
574 return InsetText::getStatus(cur, cmd, flag);
579 void InsetCollapsable::setLabel(docstring const & l)
585 docstring const InsetCollapsable::buttonLabel(BufferView const & bv) const
587 docstring const label = labelstring_.empty() ?
588 translateIfPossible(getLayout().labelstring()) : labelstring_;
589 InsetLayout const & il = getLayout();
590 if (!il.contentaslabel() || geometry(bv) != ButtonOnly)
592 return getNewLabel(label);
596 void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
600 if (status_ == Collapsed)
601 cur.leaveInset(*this);
605 docstring InsetCollapsable::floatName(string const & type) const
607 BufferParams const & bp = buffer().params();
608 FloatList const & floats = bp.documentClass().floats();
609 FloatList::const_iterator it = floats[type];
611 return (it == floats.end()) ? from_ascii(type) : bp.B_(it->second.name());
615 InsetLayout::InsetDecoration InsetCollapsable::decoration() const
617 InsetLayout::InsetDecoration const dec = getLayout().decoration();
618 return dec == InsetLayout::DEFAULT ? InsetLayout::CLASSIC : dec;
622 docstring InsetCollapsable::contextMenu(BufferView const & bv, int x,
625 if (decoration() == InsetLayout::CONGLOMERATE)
626 return from_ascii("context-conglomerate");
628 if (geometry(bv) == NoButton)
629 return from_ascii("context-collapsable");
631 Dimension dim = dimensionCollapsed(bv);
632 if (x < xo(bv) + dim.wid && y < yo(bv) + dim.des)
633 return from_ascii("context-collapsable");
635 return InsetText::contextMenu(bv, x, y);