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 "BufferView.h"
20 #include "Dimension.h"
21 #include "FuncRequest.h"
22 #include "FuncStatus.h"
23 #include "InsetLayout.h"
25 #include "MetricsInfo.h"
26 #include "OutputParams.h"
27 #include "TocBackend.h"
29 #include "frontends/FontMetrics.h"
30 #include "frontends/Painter.h"
32 #include "support/debug.h"
33 #include "support/docstream.h"
34 #include "support/gettext.h"
35 #include "support/lassert.h"
36 #include "support/lstrings.h"
37 #include "support/RefChanger.h"
44 InsetCollapsable::InsetCollapsable(Buffer * buf, InsetText::UsePlain ltype)
45 : InsetText(buf, ltype), status_(Open)
48 setFrameColor(Color_collapsableframe);
52 // The sole purpose of this copy constructor is to make sure
53 // that the view_ map is not copied and remains empty.
54 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
57 labelstring_(rhs.labelstring_)
61 InsetCollapsable::~InsetCollapsable()
63 map<BufferView const *, View>::iterator it = view_.begin();
64 map<BufferView const *, View>::iterator end = view_.end();
65 for (; it != end; ++it)
66 if (it->second.mouse_hover_)
67 it->first->clearLastInset(this);
71 InsetCollapsable::CollapseStatus InsetCollapsable::status(BufferView const & bv) const
73 if (decoration() == InsetLayout::CONGLOMERATE)
75 return view_[&bv].auto_open_ ? Open : status_;
79 InsetCollapsable::Geometry InsetCollapsable::geometry(BufferView const & bv) const
81 switch (decoration()) {
82 case InsetLayout::CLASSIC:
83 if (status(bv) == Open)
84 return view_[&bv].openinlined_ ? LeftButton : TopButton;
87 case InsetLayout::MINIMALISTIC:
88 return status(bv) == Open ? NoButton : ButtonOnly ;
90 case InsetLayout::CONGLOMERATE:
91 return status(bv) == Open ? SubLabel : Corners ;
93 case InsetLayout::DEFAULT:
94 break; // this shouldn't happen
97 // dummy return value to shut down a warning,
103 docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
105 Dimension const dim = dimensionCollapsed(bv);
106 if (geometry(bv) == NoButton)
107 return translateIfPossible(getLayout().labelstring());
108 if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des || isOpen(bv))
111 return toolTipText();
115 void InsetCollapsable::write(ostream & os) const
131 void InsetCollapsable::read(Lexer & lex)
133 lex.setContext("InsetCollapsable::read");
136 lex >> "status" >> tmp_token;
137 if (tmp_token == "open")
140 InsetText::read(lex);
145 Dimension InsetCollapsable::dimensionCollapsed(BufferView const & bv) const
148 FontInfo labelfont(getLabelfont());
149 labelfont.realize(sane_font);
150 theFontMetrics(labelfont).buttonText(
151 buttonLabel(bv), TEXT_TO_INSET_OFFSET, dim.wid, dim.asc, dim.des);
156 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
158 view_[mi.base.bv].auto_open_ = mi.base.bv->cursor().isInside(this);
160 FontInfo tmpfont = mi.base.font;
161 mi.base.font = getFont();
162 mi.base.font.realize(tmpfont);
164 BufferView const & bv = *mi.base.bv;
166 switch (geometry(bv)) {
168 InsetText::metrics(mi, dim);
171 InsetText::metrics(mi, dim);
176 InsetText::metrics(mi, dim);
177 // consider width of the inset label
178 FontInfo font(getLabelfont());
179 font.realize(sane_font);
185 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
192 if (hasFixedWidth()){
193 int const mindim = view_[&bv].button_dim_.x2 - view_[&bv].button_dim_.x1;
194 if (mi.base.textwidth < mindim)
195 mi.base.textwidth = mindim;
197 dim = dimensionCollapsed(bv);
198 if (geometry(bv) == TopButton || geometry(bv) == LeftButton) {
200 InsetText::metrics(mi, textdim);
201 view_[&bv].openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
202 if (view_[&bv].openinlined_) {
203 // Correct for button width.
204 dim.wid += textdim.wid;
205 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
206 dim.asc = textdim.asc;
208 dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
209 dim.wid = max(dim.wid, textdim.wid);
215 mi.base.font = tmpfont;
219 bool InsetCollapsable::setMouseHover(BufferView const * bv, bool mouse_hover)
222 view_[bv].mouse_hover_ = mouse_hover;
227 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
229 BufferView const & bv = *pi.base.bv;
231 view_[&bv].auto_open_ = bv.cursor().isInside(this);
233 Changer dummy = pi.base.font.change(getFont(), true);
235 // Draw button first -- top, left or only
236 Dimension dimc = dimensionCollapsed(bv);
238 if (geometry(bv) == TopButton ||
239 geometry(bv) == LeftButton ||
240 geometry(bv) == ButtonOnly) {
241 view_[&bv].button_dim_.x1 = x + 0;
242 view_[&bv].button_dim_.x2 = x + dimc.width();
243 view_[&bv].button_dim_.y1 = y - dimc.asc;
244 view_[&bv].button_dim_.y2 = y + dimc.des;
246 FontInfo labelfont = getLabelfont();
247 labelfont.setColor(labelColor());
248 labelfont.realize(pi.base.font);
249 pi.pain.buttonText(x, y, buttonLabel(bv), labelfont,
250 view_[&bv].mouse_hover_ ? Color_buttonhoverbg : Color_buttonbg,
251 Color_buttonframe, TEXT_TO_INSET_OFFSET);
252 // Draw the change tracking cue on the label, unless RowPainter already
254 if (canPaintChange(bv))
255 pi.change_.paintCue(pi, x, y, x + dimc.width(), labelfont);
257 view_[&bv].button_dim_.x1 = 0;
258 view_[&bv].button_dim_.y1 = 0;
259 view_[&bv].button_dim_.x2 = 0;
260 view_[&bv].button_dim_.y2 = 0;
263 Dimension const textdim = dimensionHelper(bv);
264 int const baseline = y;
266 Geometry g = geometry(bv);
270 if (g == LeftButton) {
271 textx = x + dimc.width();
275 texty = baseline + dimc.des + textdim.asc;
277 // Do not draw the cue for INSERTED -- it is already in the button and
279 Changer dummy = (pi.change_.type == Change::INSERTED)
280 ? make_change(pi.change_, Change())
282 InsetText::draw(pi, textx, texty);
290 InsetText::draw(pi, textx, texty);
296 { // We will take care of the frame and the change tracking cue
298 Changer dummy = make_change(pi.change_, Change());
299 const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
300 InsetText::draw(pi, textx, texty);
301 const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
304 int desc = textdim.descent();
308 // Colour the frame according to the change type. (Like for tables.)
309 Color colour = pi.change_.changed() ? pi.change_.color()
311 const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
312 const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
313 pi.pain.line(xx1, y + desc - 4,
314 xx1, y + desc, colour);
316 pi.pain.line(xx1, y + desc,
317 xx2, y + desc, colour);
319 // Make status_ value visible:
320 pi.pain.line(xx1, y + desc,
321 xx1 + 4, y + desc, colour);
322 pi.pain.line(xx2 - 4, y + desc,
323 xx2, y + desc, colour);
325 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3,
326 y + desc - 4, colour);
328 // the label below the text. Can be toggled.
330 FontInfo font(getLabelfont());
331 if (pi.change_.changed())
332 font.setPaintColor(colour);
333 font.realize(sane_font);
339 Color const col = pi.full_repaint ? Color_none : pi.backgroundColor(this);
340 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
341 int const ww = max(textdim.wid, w);
342 pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
343 buttonLabel(bv), font, col, Color_none);
346 int const y1 = y - textdim.asc + 3;
347 // a visual cue when the cursor is inside the inset
348 Cursor const & cur = bv.cursor();
349 if (cur.isInside(this)) {
350 pi.pain.line(xx1, y1 + 4, xx1, y1, colour);
351 pi.pain.line(xx1 + 4, y1, xx1, y1, colour);
352 pi.pain.line(xx2, y1 + 4, xx2, y1, colour);
353 pi.pain.line(xx2 - 4, y1, xx2, y1, colour);
355 // Strike through the inset if deleted and not already handled by
357 if (pi.change_.deleted() && canPaintChange(bv))
358 pi.change_.paintCue(pi, xx1, y1, xx2, y + desc);
364 void InsetCollapsable::cursorPos(BufferView const & bv,
365 CursorSlice const & sl, bool boundary, int & x, int & y) const
367 if (geometry(bv) == ButtonOnly)
370 InsetText::cursorPos(bv, sl, boundary, x, y);
371 Dimension const textdim = dimensionHelper(bv);
373 switch (geometry(bv)) {
375 x += dimensionCollapsed(bv).wid;
378 y += dimensionCollapsed(bv).des + textdim.asc;
393 bool InsetCollapsable::editable() const
395 switch (decoration()) {
396 case InsetLayout::CLASSIC:
397 case InsetLayout::MINIMALISTIC:
398 return status_ == Open;
405 bool InsetCollapsable::descendable(BufferView const & bv) const
407 return geometry(bv) != ButtonOnly;
411 bool InsetCollapsable::clickable(BufferView const & bv, int x, int y) const
413 return view_[&bv].button_dim_.contains(x, y);
417 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
420 pos_type const max_length = 15;
421 pos_type const p_siz = paragraphs().begin()->size();
422 pos_type const n = min(max_length, p_siz);
425 for (; i < n && j < p_siz; ++j) {
426 if (paragraphs().begin()->isInset(j))
428 label += paragraphs().begin()->getChar(j);
431 if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
434 return label.empty() ? l : label;
438 void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
440 //lyxerr << "InsetCollapsable: edit left/right" << endl;
442 InsetText::edit(cur, front, entry_from);
446 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
448 //lyxerr << "InsetCollapsable: edit xy" << endl;
449 if (geometry(cur.bv()) == ButtonOnly
450 || (view_[&cur.bv()].button_dim_.contains(x, y)
451 && geometry(cur.bv()) != NoButton))
454 return InsetText::editXY(cur, x, y);
458 void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
460 //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
461 // << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
463 bool const hitButton = clickable(cur.bv(), cmd.x(), cmd.y());
465 switch (cmd.action()) {
466 case LFUN_MOUSE_PRESS:
468 switch (cmd.button()) {
469 case mouse_button::button1:
470 case mouse_button::button3:
471 // Pass the command to the enclosing InsetText,
472 // so that the cursor gets set.
475 case mouse_button::none:
476 case mouse_button::button2:
477 case mouse_button::button4:
478 case mouse_button::button5:
480 cur.noScreenUpdate();
483 } else if (geometry(cur.bv()) != ButtonOnly)
484 InsetText::doDispatch(cur, cmd);
489 case LFUN_MOUSE_DOUBLE:
490 case LFUN_MOUSE_TRIPLE:
492 cur.noScreenUpdate();
493 else if (geometry(cur.bv()) != ButtonOnly)
494 InsetText::doDispatch(cur, cmd);
499 case LFUN_MOUSE_RELEASE:
501 // The mouse click has to be within the inset!
502 if (geometry(cur.bv()) != ButtonOnly)
503 InsetText::doDispatch(cur, cmd);
508 if (cmd.button() != mouse_button::button1) {
510 cur.noScreenUpdate();
513 // if we are selecting, we do not want to
517 // Left button is clicked, the user asks to
518 // toggle the inset visual state.
520 cur.screenUpdateFlags(Update::Force | Update::FitCursor);
521 if (geometry(cur.bv()) == ButtonOnly) {
522 setStatus(cur, Open);
526 setStatus(cur, Collapsed);
527 cur.bv().cursor() = cur;
530 case LFUN_INSET_TOGGLE:
531 if (cmd.argument() == "open")
532 setStatus(cur, Open);
533 else if (cmd.argument() == "close")
534 setStatus(cur, Collapsed);
535 else if (cmd.argument() == "toggle" || cmd.argument().empty())
537 setStatus(cur, Collapsed);
539 setStatus(cur, Open);
540 else // if assign or anything else
546 InsetText::doDispatch(cur, cmd);
552 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
553 FuncStatus & flag) const
555 switch (cmd.action()) {
556 case LFUN_INSET_TOGGLE:
557 if (cmd.argument() == "open")
558 flag.setEnabled(status_ != Open);
559 else if (cmd.argument() == "close")
560 flag.setEnabled(status_ == Open);
561 else if (cmd.argument() == "toggle" || cmd.argument().empty()) {
562 flag.setEnabled(true);
563 flag.setOnOff(status_ == Open);
565 flag.setEnabled(false);
569 return InsetText::getStatus(cur, cmd, flag);
574 void InsetCollapsable::setLabel(docstring const & l)
580 docstring InsetCollapsable::getLabel() const
582 InsetLayout const & il = getLayout();
583 return labelstring_.empty() ?
584 translateIfPossible(il.labelstring()) : labelstring_;
588 docstring const InsetCollapsable::buttonLabel(BufferView const & bv) const
590 InsetLayout const & il = getLayout();
591 docstring const label = getLabel();
592 if (!il.contentaslabel() || geometry(bv) != ButtonOnly)
594 return getNewLabel(label);
598 void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
602 if (status_ == Collapsed)
603 cur.leaveInset(*this);
607 InsetLayout::InsetDecoration InsetCollapsable::decoration() const
609 InsetLayout::InsetDecoration const dec = getLayout().decoration();
610 return dec == InsetLayout::DEFAULT ? InsetLayout::CLASSIC : dec;
614 string InsetCollapsable::contextMenu(BufferView const & bv, int x,
617 string context_menu = contextMenuName();
618 string const it_context_menu = InsetText::contextMenuName();
619 if (decoration() == InsetLayout::CONGLOMERATE)
620 return context_menu + ";" + it_context_menu;
622 string const ic_context_menu = InsetCollapsable::contextMenuName();
623 if (ic_context_menu != context_menu)
624 context_menu += ";" + ic_context_menu;
626 if (geometry(bv) == NoButton)
627 return context_menu + ";" + it_context_menu;
629 Dimension dim = dimensionCollapsed(bv);
630 if (x < xo(bv) + dim.wid && y < yo(bv) + dim.des)
633 return it_context_menu;
637 string InsetCollapsable::contextMenuName() const
639 if (decoration() == InsetLayout::CONGLOMERATE)
640 return "context-conglomerate";
642 return "context-collapsable";
646 bool InsetCollapsable::canPaintChange(BufferView const & bv) const
648 // return false to let RowPainter draw the change tracking cue consistently
649 // with the surrounding text, when the inset is inline: for buttons, for
650 // non-allowMultiPar insets.
651 switch (geometry(bv)) {
654 return allowMultiPar();
664 void InsetCollapsable::addToToc(DocIterator const & cpit, bool output_active,
665 UpdateType utype, TocBackend & backend) const
667 bool doing_output = output_active && producesOutput();
668 InsetLayout const & layout = getLayout();
669 if (layout.addToToc()) {
670 TocBuilder & b = backend.builder(layout.tocType());
671 // Cursor inside the inset
672 DocIterator pit = cpit;
673 pit.push_back(CursorSlice(const_cast<InsetCollapsable &>(*this)));
674 docstring const label = getLabel();
675 b.pushItem(pit, label + (label.empty() ? "" : ": "), output_active);
676 // Proceed with the rest of the inset.
677 InsetText::addToToc(cpit, doing_output, utype, backend);
678 if (layout.isTocCaption()) {
680 text().forOutliner(str, TOC_ENTRY_LENGTH);
685 InsetText::addToToc(cpit, doing_output, utype, backend);