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"
29 #include "TextClass.h"
31 #include "frontends/FontMetrics.h"
32 #include "frontends/Painter.h"
34 #include "support/debug.h"
35 #include "support/docstream.h"
36 #include "support/gettext.h"
37 #include "support/lassert.h"
38 #include "support/lstrings.h"
45 InsetCollapsable::InsetCollapsable(Buffer * buf, InsetText::UsePlain ltype)
46 : InsetText(buf, ltype), status_(Open), openinlined_(false)
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 const 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 FontInfo labelfont(getLabelfont());
176 labelfont.realize(sane_font);
177 theFontMetrics(labelfont).buttonText(
178 buttonLabel(bv), dim.wid, dim.asc, dim.des);
183 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
185 auto_open_[mi.base.bv] = mi.base.bv->cursor().isInside(this);
187 FontInfo tmpfont = mi.base.font;
188 mi.base.font = getFont();
189 mi.base.font.realize(tmpfont);
191 BufferView const & bv = *mi.base.bv;
193 switch (geometry(bv)) {
195 InsetText::metrics(mi, dim);
198 InsetText::metrics(mi, dim);
203 InsetText::metrics(mi, dim);
204 // consider width of the inset label
205 FontInfo font(getLabelfont());
206 font.realize(sane_font);
212 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
219 dim = dimensionCollapsed(bv);
220 if (geometry(bv) == TopButton
221 || geometry(bv) == LeftButton) {
223 InsetText::metrics(mi, textdim);
224 openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
226 // Correct for button width.
227 dim.wid += textdim.wid;
228 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
229 dim.asc = textdim.asc;
231 dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
232 dim.wid = max(dim.wid, textdim.wid);
238 mi.base.font = tmpfont;
242 bool InsetCollapsable::setMouseHover(BufferView const * bv, bool mouse_hover)
245 mouse_hover_[bv] = mouse_hover;
250 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
252 BufferView const & bv = *pi.base.bv;
254 auto_open_[&bv] = bv.cursor().isInside(this);
256 FontInfo tmpfont = pi.base.font;
257 pi.base.font = getFont();
258 pi.base.font.realize(tmpfont);
260 // Draw button first -- top, left or only
261 Dimension dimc = dimensionCollapsed(bv);
263 if (geometry(bv) == TopButton ||
264 geometry(bv) == LeftButton ||
265 geometry(bv) == ButtonOnly) {
266 button_dim.x1 = x + 0;
267 button_dim.x2 = x + dimc.width();
268 button_dim.y1 = y - dimc.asc;
269 button_dim.y2 = y + dimc.des;
271 FontInfo labelfont = getLabelfont();
272 labelfont.setColor(labelColor());
273 pi.pain.buttonText(x, y, buttonLabel(bv), labelfont,
282 Dimension const textdim = InsetText::dimension(bv);
283 int const baseline = y;
285 switch (geometry(bv)) {
287 textx = x + dimc.width();
289 InsetText::draw(pi, textx, texty);
293 texty = baseline + dimc.des + textdim.asc;
294 InsetText::draw(pi, textx, texty);
301 InsetText::draw(pi, textx, texty);
307 const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
308 InsetText::draw(pi, textx, texty);
309 const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
311 int desc = textdim.descent();
312 if (geometry(bv) == Corners)
315 const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
316 const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
317 pi.pain.line(xx1, y + desc - 4,
321 pi.pain.line(xx1, y + desc,
325 // Make status_ value visible:
326 pi.pain.line(xx1, y + desc,
329 pi.pain.line(xx2 - 4, y + desc,
333 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3,
334 y + desc - 4, Color_foreground);
336 // the label below the text. Can be toggled.
337 if (geometry(bv) == SubLabel) {
338 FontInfo font(getLabelfont());
339 font.realize(sane_font);
345 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
346 int const ww = max(textdim.wid, w);
347 pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
348 buttonLabel(bv), font, Color_none, Color_none);
352 // a visual cue when the cursor is inside the inset
353 Cursor const & cur = bv.cursor();
354 if (cur.isInside(this)) {
357 pi.pain.line(xx1, y + 4, xx1, y, Color_foreground);
358 pi.pain.line(xx1 + 4, y, xx1, y, Color_foreground);
359 pi.pain.line(xx2, y + 4, xx2, y, Color_foreground);
360 pi.pain.line(xx2 - 4, y, xx2, y, Color_foreground);
365 pi.base.font = tmpfont;
369 void InsetCollapsable::cursorPos(BufferView const & bv,
370 CursorSlice const & sl, bool boundary, int & x, int & y) const
372 if (geometry(bv) == ButtonOnly)
375 InsetText::cursorPos(bv, sl, boundary, x, y);
376 Dimension const textdim = InsetText::dimension(bv);
378 switch (geometry(bv)) {
380 x += dimensionCollapsed(bv).wid;
383 y += dimensionCollapsed(bv).des + textdim.asc;
398 bool InsetCollapsable::editable() const
400 return geometry() != ButtonOnly;
404 bool InsetCollapsable::descendable(BufferView const & bv) const
406 return geometry(bv) != ButtonOnly;
410 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
412 return button_dim.contains(cmd.x(), cmd.y());
416 bool InsetCollapsable::clickable(int x, int y) const
418 FuncRequest cmd(LFUN_NOACTION, x, y, mouse_button::none);
419 return hitButton(cmd);
423 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
426 pos_type const max_length = 15;
427 pos_type const p_siz = paragraphs().begin()->size();
428 pos_type const n = min(max_length, p_siz);
431 for (; i < n && j < p_siz; ++j) {
432 if (paragraphs().begin()->isInset(j))
434 label += paragraphs().begin()->getChar(j);
437 if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
440 return label.empty() ? l : label;
444 void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
446 //lyxerr << "InsetCollapsable: edit left/right" << endl;
448 InsetText::edit(cur, front, entry_from);
452 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
454 //lyxerr << "InsetCollapsable: edit xy" << endl;
455 if (geometry(cur.bv()) == ButtonOnly
456 || (button_dim.contains(x, y)
457 && geometry(cur.bv()) != NoButton))
460 return InsetText::editXY(cur, x, y);
464 void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
466 //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
467 // << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
469 switch (cmd.action()) {
470 case LFUN_MOUSE_PRESS:
471 if (hitButton(cmd)) {
472 switch (cmd.button()) {
473 case mouse_button::button1:
474 case mouse_button::button3:
475 // Pass the command to the enclosing InsetText,
476 // so that the cursor gets set.
479 case mouse_button::none:
480 case mouse_button::button2:
481 case mouse_button::button4:
482 case mouse_button::button5:
484 cur.noScreenUpdate();
487 } else if (geometry(cur.bv()) != ButtonOnly)
488 InsetText::doDispatch(cur, cmd);
493 case LFUN_MOUSE_MOTION:
494 case LFUN_MOUSE_DOUBLE:
495 case LFUN_MOUSE_TRIPLE:
497 cur.noScreenUpdate();
498 else if (geometry(cur.bv()) != ButtonOnly)
499 InsetText::doDispatch(cur, cmd);
504 case LFUN_MOUSE_RELEASE:
505 if (!hitButton(cmd)) {
506 // The mouse click has to be within the inset!
507 if (geometry(cur.bv()) != ButtonOnly)
508 InsetText::doDispatch(cur, cmd);
513 if (cmd.button() != mouse_button::button1) {
515 cur.noScreenUpdate();
518 // if we are selecting, we do not want to
522 // Left button is clicked, the user asks to
523 // toggle the inset visual state.
525 cur.screenUpdateFlags(Update::Force | Update::FitCursor);
526 if (geometry(cur.bv()) == ButtonOnly) {
527 setStatus(cur, Open);
531 setStatus(cur, Collapsed);
532 cur.bv().cursor() = cur;
535 case LFUN_INSET_TOGGLE:
536 if (cmd.argument() == "open")
537 setStatus(cur, Open);
538 else if (cmd.argument() == "close")
539 setStatus(cur, Collapsed);
540 else if (cmd.argument() == "toggle" || cmd.argument().empty())
542 setStatus(cur, Collapsed);
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 InsetLayout const & il = getLayout();
588 docstring const label = labelstring_.empty() ?
589 translateIfPossible(il.labelstring()) : labelstring_;
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 string InsetCollapsable::contextMenu(BufferView const & bv, int x,
625 string context_menu = contextMenuName();
626 string const it_context_menu = InsetText::contextMenuName();
627 if (decoration() == InsetLayout::CONGLOMERATE)
628 return context_menu + ";" + it_context_menu;
630 string const ic_context_menu = InsetCollapsable::contextMenuName();
631 if (ic_context_menu != context_menu)
632 context_menu += ";" + ic_context_menu;
634 if (geometry(bv) == NoButton)
635 return context_menu + ";" + it_context_menu;
637 Dimension dim = dimensionCollapsed(bv);
638 if (x < xo(bv) + dim.wid && y < yo(bv) + dim.des)
641 return it_context_menu;
645 string InsetCollapsable::contextMenuName() const
647 if (decoration() == InsetLayout::CONGLOMERATE)
648 return "context-conglomerate";
650 return "context-collapsable";