2 * \file InsetCollapsible.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 "InsetCollapsible.h"
18 #include "BufferParams.h"
19 #include "BufferView.h"
20 #include "CutAndPaste.h"
22 #include "Dimension.h"
24 #include "FuncRequest.h"
25 #include "FuncStatus.h"
26 #include "InsetLayout.h"
28 #include "MetricsInfo.h"
29 #include "TextClass.h"
30 #include "TocBackend.h"
32 #include "frontends/FontMetrics.h"
33 #include "frontends/Painter.h"
35 #include "support/debug.h"
36 #include "support/docstream.h"
37 #include "support/FileName.h"
38 #include "support/gettext.h"
39 #include "support/lassert.h"
40 #include "support/lstrings.h"
41 #include "support/Changer.h"
42 #include "support/TempFile.h"
49 InsetCollapsible::InsetCollapsible(Buffer * buf, InsetText::UsePlain ltype)
50 : InsetText(buf, ltype), status_(Open)
53 setFrameColor(Color_collapsibleframe);
57 // The sole purpose of this copy constructor is to make sure
58 // that the view_ map is not copied and remains empty.
59 InsetCollapsible::InsetCollapsible(InsetCollapsible const & rhs)
62 labelstring_(rhs.labelstring_)
68 InsetCollapsible & InsetCollapsible::operator=(InsetCollapsible const & that)
72 *this = InsetCollapsible(that);
77 InsetCollapsible::~InsetCollapsible()
79 map<BufferView const *, View>::iterator it = view_.begin();
80 map<BufferView const *, View>::iterator end = view_.end();
81 for (; it != end; ++it)
82 if (it->second.mouse_hover_)
83 it->first->clearLastInset(this);
87 InsetCollapsible::CollapseStatus InsetCollapsible::status(BufferView const & bv) const
89 if (decoration() == InsetDecoration::CONGLOMERATE)
91 return view_[&bv].auto_open_ ? Open : status_;
95 InsetCollapsible::Geometry InsetCollapsible::geometry(BufferView const & bv) const
97 switch (decoration()) {
98 case InsetDecoration::CLASSIC:
99 if (status(bv) == Open)
100 return view_[&bv].openinlined_ ? LeftButton : TopButton;
103 case InsetDecoration::MINIMALISTIC: {
104 return status(bv) == Open ?
105 (tempfile_ ? LeftButton : NoButton)
109 case InsetDecoration::CONGLOMERATE:
110 return status(bv) == Open ? SubLabel : Corners ;
112 case InsetDecoration::DEFAULT:
113 break; // this shouldn't happen
116 // dummy return value to shut down a warning,
117 // this is dead code.
122 docstring InsetCollapsible::toolTip(BufferView const & bv, int x, int y) const
124 Dimension const dim = dimensionCollapsed(bv);
125 if (geometry(bv) == NoButton)
126 return translateIfPossible(getLayout().labelstring());
127 if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des || isOpen(bv))
130 return toolTipText();
134 void InsetCollapsible::write(ostream & os) const
150 void InsetCollapsible::read(Lexer & lex)
152 lex.setContext("InsetCollapsible::read");
155 lex >> "status" >> tmp_token;
156 if (tmp_token == "open")
159 InsetText::read(lex);
163 int InsetCollapsible::topOffset(BufferView const * bv) const
165 switch (geometry(*bv)) {
170 return InsetText::topOffset(bv);
174 int InsetCollapsible::bottomOffset(BufferView const * bv) const
176 switch (geometry(*bv)) {
179 return InsetText::bottomOffset(bv) / 4;
181 return InsetText::bottomOffset(bv);
186 Dimension InsetCollapsible::dimensionCollapsed(BufferView const & bv) const
189 FontInfo labelfont(getLabelfont());
190 labelfont.realize(sane_font);
191 theFontMetrics(labelfont).buttonText(
192 buttonLabel(bv), Inset::textOffset(&bv), dim.wid, dim.asc, dim.des);
197 void InsetCollapsible::metrics(MetricsInfo & mi, Dimension & dim) const
199 view_[mi.base.bv].auto_open_ = mi.base.bv->cursor().isInside(this);
201 FontInfo tmpfont = mi.base.font;
202 mi.base.font = getFont();
203 mi.base.font.realize(tmpfont);
205 BufferView const & bv = *mi.base.bv;
207 switch (geometry(bv)) {
209 InsetText::metrics(mi, dim);
212 InsetText::metrics(mi, dim);
215 InsetText::metrics(mi, dim);
216 // consider width of the inset label
217 FontInfo font(getLabelfont());
218 font.realize(sane_font);
224 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
226 dim.wid = max(dim.wid, w);
232 if (hasFixedWidth()){
233 int const mindim = view_[&bv].button_dim_.x2 - view_[&bv].button_dim_.x1;
234 if (mi.base.textwidth < mindim)
235 mi.base.textwidth = mindim;
237 dim = dimensionCollapsed(bv);
238 if (geometry(bv) == TopButton || geometry(bv) == LeftButton) {
240 InsetText::metrics(mi, textdim);
241 view_[&bv].openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
242 if (view_[&bv].openinlined_) {
243 // Correct for button width.
244 dim.wid += textdim.wid;
245 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
246 dim.asc = textdim.asc;
248 dim.des += textdim.height() + topOffset(mi.base.bv);
249 dim.wid = max(dim.wid, textdim.wid);
255 mi.base.font = tmpfont;
259 bool InsetCollapsible::setMouseHover(BufferView const * bv, bool mouse_hover)
262 view_[bv].mouse_hover_ = mouse_hover;
267 ColorCode InsetCollapsible::backgroundColor(PainterInfo const &) const
269 return getLayout().bgcolor();
273 ColorCode InsetCollapsible::labelColor() const
275 return getLayout().labelfont().color();
279 void InsetCollapsible::draw(PainterInfo & pi, int x, int y) const
281 BufferView const & bv = *pi.base.bv;
283 view_[&bv].auto_open_ = bv.cursor().isInside(this);
285 Changer dummy = pi.base.font.change(getFont(), true);
287 // Draw button first -- top, left or only
288 Dimension dimc = dimensionCollapsed(bv);
290 if (geometry(bv) == TopButton ||
291 geometry(bv) == LeftButton ||
292 geometry(bv) == ButtonOnly) {
293 view_[&bv].button_dim_.x1 = x + 0;
294 view_[&bv].button_dim_.x2 = x + dimc.width();
295 view_[&bv].button_dim_.y1 = y - dimc.asc;
296 view_[&bv].button_dim_.y2 = y + dimc.des;
298 FontInfo labelfont = getLabelfont();
299 labelfont.setColor(labelColor());
300 labelfont.realize(pi.base.font);
301 pi.pain.buttonText(x, y, buttonLabel(bv), labelfont,
302 view_[&bv].mouse_hover_ ? Color_buttonhoverbg : Color_buttonbg,
303 Color_buttonframe, Inset::textOffset(pi.base.bv));
304 // Draw the change tracking cue on the label, unless RowPainter already
306 if (canPaintChange(bv))
307 pi.change.paintCue(pi, x, y, x + dimc.width(), labelfont);
309 view_[&bv].button_dim_.x1 = 0;
310 view_[&bv].button_dim_.y1 = 0;
311 view_[&bv].button_dim_.x2 = 0;
312 view_[&bv].button_dim_.y2 = 0;
315 Dimension const textdim = dimensionHelper(bv);
316 int const baseline = y;
318 Geometry g = geometry(bv);
322 if (g == LeftButton) {
323 textx = x + dimc.width();
327 texty = baseline + dimc.des + textdim.asc;
329 // Do not draw the cue for INSERTED -- it is already in the button and
331 Changer cdummy = (pi.change.type == Change::INSERTED)
332 ? changeVar(pi.change, Change())
334 InsetText::draw(pi, textx, texty);
342 InsetText::draw(pi, textx, texty);
348 // We will take care of the frame and the change tracking cue
351 Changer cdummy = changeVar(pi.change, Change());
352 const_cast<InsetCollapsible *>(this)->setDrawFrame(false);
353 InsetText::draw(pi, textx, texty);
354 const_cast<InsetCollapsible *>(this)->setDrawFrame(true);
357 int desc = textdim.descent();
359 // Colour the frame according to the change type. (Like for tables.)
360 Color colour = pi.change.changed() ? pi.change.color()
362 const int xx1 = x + leftOffset(pi.base.bv) - 1;
363 const int xx2 = x + textdim.wid - rightOffset(pi.base.bv) + 1;
364 pi.pain.line(xx1, y + desc - 4,
365 xx1, y + desc, colour);
367 pi.pain.line(xx1, y + desc,
368 xx2, y + desc, colour);
370 // Make status_ value visible:
371 pi.pain.line(xx1, y + desc,
372 xx1 + 4, y + desc, colour);
373 pi.pain.line(xx2 - 4, y + desc,
374 xx2, y + desc, colour);
376 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3,
377 y + desc - 4, colour);
379 // the label below the text. Can be toggled.
381 FontInfo font(getLabelfont());
382 if (pi.change.changed())
383 font.setPaintColor(colour);
384 font.realize(sane_font);
390 Color const col = pi.full_repaint ? Color_none : pi.backgroundColor();
391 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
392 int const ww = max(textdim.wid, w);
393 pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
394 buttonLabel(bv), font, col, Color_none);
397 int const y1 = y - textdim.asc + 3;
398 // a visual cue when the cursor is inside the inset
399 Cursor const & cur = bv.cursor();
400 if (cur.isInside(this)) {
401 pi.pain.line(xx1, y1 + 4, xx1, y1, colour);
402 pi.pain.line(xx1 + 4, y1, xx1, y1, colour);
403 pi.pain.line(xx2, y1 + 4, xx2, y1, colour);
404 pi.pain.line(xx2 - 4, y1, xx2, y1, colour);
406 // Strike through the inset if deleted and not already handled by
408 if (pi.change.deleted() && canPaintChange(bv))
409 pi.change.paintCue(pi, xx1, y1, xx2, y + desc);
415 void InsetCollapsible::cursorPos(BufferView const & bv,
416 CursorSlice const & sl, bool boundary, int & x, int & y) const
418 if (geometry(bv) == ButtonOnly)
421 InsetText::cursorPos(bv, sl, boundary, x, y);
422 Dimension const textdim = dimensionHelper(bv);
424 switch (geometry(bv)) {
426 x += dimensionCollapsed(bv).wid;
429 y += dimensionCollapsed(bv).des + textdim.asc;
444 bool InsetCollapsible::editable() const
449 switch (decoration()) {
450 case InsetDecoration::CLASSIC:
451 case InsetDecoration::MINIMALISTIC:
452 return status_ == Open;
459 bool InsetCollapsible::descendable(BufferView const & bv) const
464 return geometry(bv) != ButtonOnly;
468 bool InsetCollapsible::clickable(BufferView const & bv, int x, int y) const
470 return view_[&bv].button_dim_.contains(x, y);
474 docstring const InsetCollapsible::getNewLabel(docstring const & l) const
476 odocstringstream label;
477 pos_type const max_length = 15;
478 pos_type const p_siz = paragraphs().begin()->size();
479 pos_type const n = min(max_length, p_siz);
482 for (; i < n && j < p_siz; ++j) {
483 if (paragraphs().begin()->isDeleted(j))
485 if (paragraphs().begin()->isInset(j)) {
486 if (!paragraphs().begin()->getInset(j)->isChar())
488 paragraphs().begin()->getInset(j)->toString(label);
490 label.put(paragraphs().begin()->getChar(j));
493 if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
496 return label.str().empty() ? l : label.str();
500 void InsetCollapsible::edit(Cursor & cur, bool front, EntryDirection entry_from)
502 //lyxerr << "InsetCollapsible: edit left/right" << endl;
504 InsetText::edit(cur, front, entry_from);
508 Inset * InsetCollapsible::editXY(Cursor & cur, int x, int y)
510 //lyxerr << "InsetCollapsible: edit xy" << endl;
511 if (geometry(cur.bv()) == ButtonOnly
512 || !descendable(cur.bv())
513 || (view_[&cur.bv()].button_dim_.contains(x, y)
514 && geometry(cur.bv()) != NoButton))
517 return InsetText::editXY(cur, x, y);
521 void InsetCollapsible::doDispatch(Cursor & cur, FuncRequest & cmd)
523 //lyxerr << "InsetCollapsible::doDispatch (begin): cmd: " << cmd
524 // << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
526 bool const hitButton = clickable(cur.bv(), cmd.x(), cmd.y());
528 switch (cmd.action()) {
529 case LFUN_MOUSE_PRESS:
531 switch (cmd.button()) {
532 case mouse_button::button1:
533 case mouse_button::button3:
534 // Pass the command to the enclosing InsetText,
535 // so that the cursor gets set.
538 case mouse_button::none:
539 case mouse_button::button2:
540 case mouse_button::button4:
541 case mouse_button::button5:
543 cur.noScreenUpdate();
546 } else if (geometry(cur.bv()) != ButtonOnly)
547 InsetText::doDispatch(cur, cmd);
552 case LFUN_MOUSE_DOUBLE:
553 case LFUN_MOUSE_TRIPLE:
555 cur.noScreenUpdate();
556 else if (geometry(cur.bv()) != ButtonOnly)
557 InsetText::doDispatch(cur, cmd);
562 case LFUN_MOUSE_RELEASE:
564 // The mouse click has to be within the inset!
565 if (geometry(cur.bv()) != ButtonOnly)
566 InsetText::doDispatch(cur, cmd);
571 if (cmd.button() != mouse_button::button1) {
573 cur.noScreenUpdate();
576 // if we are selecting, we do not want to
580 // Left button is clicked, the user asks to
581 // toggle the inset visual state.
583 cur.screenUpdateFlags(Update::Force | Update::FitCursor);
584 if (geometry(cur.bv()) == ButtonOnly) {
585 setStatus(cur, Open);
589 setStatus(cur, Collapsed);
590 cur.bv().cursor() = cur;
593 case LFUN_INSET_TOGGLE:
594 if (cmd.argument() == "open")
595 setStatus(cur, Open);
596 else if (cmd.argument() == "close")
597 setStatus(cur, Collapsed);
598 else if (cmd.argument() == "toggle" || cmd.argument().empty())
600 setStatus(cur, Collapsed);
602 setStatus(cur, Open);
603 else // if assign or anything else
608 case LFUN_INSET_EDIT: {
610 text().selectAll(cur);
611 string const format =
612 cur.buffer()->params().documentClass().outputFormat();
613 string const ext = theFormats().extension(format);
614 tempfile_.reset(new support::TempFile("ert_editXXXXXX." + ext));
615 support::FileName const tempfilename = tempfile_->name();
616 string const name = tempfilename.toFilesystemEncoding();
617 ofdocstream os(name.c_str());
618 os << cur.selectionAsString(false);
620 // Since we lock the inset while the external file is edited,
621 // we need to move the cursor outside and clear any selection inside
622 cur.clearSelection();
624 cur.leaveInset(*this);
625 theFormats().edit(buffer(), tempfilename, format);
628 case LFUN_INSET_END_EDIT: {
629 support::FileName const tempfilename = tempfile_->name();
630 docstring const s = tempfilename.fileContents("UTF-8");
631 cur.recordUndoInset(this);
633 text().selectAll(cur);
634 cap::replaceSelection(cur);
635 cur.text()->insertStringAsLines(cur, s, cur.current_font);
636 // FIXME (gb) it crashes without this
644 InsetText::doDispatch(cur, cmd);
650 bool InsetCollapsible::getStatus(Cursor & cur, FuncRequest const & cmd,
651 FuncStatus & flag) const
653 switch (cmd.action()) {
654 case LFUN_INSET_TOGGLE:
655 if (cmd.argument() == "open")
656 flag.setEnabled(status_ != Open);
657 else if (cmd.argument() == "close")
658 flag.setEnabled(status_ == Open);
659 else if (cmd.argument() == "toggle" || cmd.argument().empty()) {
660 flag.setEnabled(true);
661 flag.setOnOff(status_ == Open);
663 flag.setEnabled(false);
666 case LFUN_INSET_EDIT:
667 flag.setEnabled(!buffer().hasReadonlyFlag() &&
668 getLayout().editExternally() && tempfile_ == nullptr);
671 case LFUN_INSET_END_EDIT:
672 flag.setEnabled(!buffer().hasReadonlyFlag() &&
673 getLayout().editExternally() && tempfile_ != nullptr);
677 return InsetText::getStatus(cur, cmd, flag);
682 void InsetCollapsible::setLabel(docstring const & l)
688 docstring InsetCollapsible::getLabel() const
690 InsetLayout const & il = getLayout();
691 return labelstring_.empty() ?
692 translateIfPossible(il.labelstring()) : labelstring_;
696 docstring const InsetCollapsible::buttonLabel(BufferView const & bv) const
699 docstring const locked = tempfile_ ? docstring(1, 0x1F512) : docstring();
700 // indicate changed content in label (#8645)
701 // ✎ U+270E LOWER RIGHT PENCIL
702 docstring const indicator = (isChanged() && geometry(bv) == ButtonOnly)
703 ? docstring(1, 0x270E) : docstring();
704 InsetLayout const & il = getLayout();
705 docstring const label = getLabel();
706 if (!il.contentaslabel() || geometry(bv) != ButtonOnly)
707 return locked + indicator + label;
708 return locked + indicator + getNewLabel(label);
712 void InsetCollapsible::setStatus(Cursor & cur, CollapseStatus status)
716 if (status_ == Collapsed)
717 cur.leaveInset(*this);
721 InsetDecoration InsetCollapsible::decoration() const
723 InsetDecoration const dec = getLayout().decoration();
724 return dec == InsetDecoration::DEFAULT ? InsetDecoration::CLASSIC : dec;
728 FontInfo InsetCollapsible::getFont() const
730 return getLayout().font();
734 FontInfo InsetCollapsible::getLabelfont() const
736 return getLayout().labelfont();
740 string InsetCollapsible::contextMenu(BufferView const & bv, int x,
743 string context_menu = contextMenuName();
744 string const it_context_menu = InsetText::contextMenuName();
745 if (decoration() == InsetDecoration::CONGLOMERATE)
746 return context_menu + ";" + it_context_menu;
748 string const ic_context_menu = InsetCollapsible::contextMenuName();
749 if (ic_context_menu != context_menu)
750 context_menu += ";" + ic_context_menu;
752 if (geometry(bv) == NoButton)
753 return context_menu + ";" + it_context_menu;
755 Dimension dim = dimensionCollapsed(bv);
756 if (x < xo(bv) + dim.wid && y < yo(bv) + dim.des)
759 return it_context_menu;
763 string InsetCollapsible::contextMenuName() const
765 if (decoration() == InsetDecoration::CONGLOMERATE)
766 return "context-conglomerate";
768 return "context-collapsible";
772 bool InsetCollapsible::canPaintChange(BufferView const & bv) const
774 // return false to let RowPainter draw the change tracking cue consistently
775 // with the surrounding text, when the inset is inline: for buttons, for
776 // non-allowMultiPar insets.
777 switch (geometry(bv)) {
780 return allowMultiPar();
790 void InsetCollapsible::addToToc(DocIterator const & cpit, bool output_active,
791 UpdateType utype, TocBackend & backend) const
793 bool doing_output = output_active && producesOutput();
794 InsetLayout const & layout = getLayout();
795 if (!layout.addToToc())
796 return InsetText::addToToc(cpit, doing_output, utype, backend);
798 TocBuilder & b = backend.builder(layout.tocType());
799 // Cursor inside the inset
800 DocIterator pit = cpit;
801 pit.push_back(CursorSlice(const_cast<InsetCollapsible &>(*this)));
802 docstring const label = getLabel();
803 b.pushItem(pit, label + (label.empty() ? "" : ": "), output_active);
804 // Proceed with the rest of the inset.
805 InsetText::addToToc(cpit, doing_output, utype, backend);
806 if (layout.isTocCaption()) {
808 text().forOutliner(str, TOC_ENTRY_LENGTH);