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 "support/debug.h"
22 #include "Dimension.h"
23 #include "DispatchResult.h"
24 #include "FloatList.h"
25 #include "FuncStatus.h"
26 #include "support/gettext.h"
28 #include "LaTeXFeatures.h"
30 #include "FuncRequest.h"
31 #include "MetricsInfo.h"
32 #include "ParagraphParameters.h"
33 #include "TextClass.h"
35 #include "frontends/FontMetrics.h"
36 #include "frontends/Painter.h"
38 #include "support/docstream.h"
45 InsetCollapsable::CollapseStatus InsetCollapsable::status() const
47 return autoOpen_ ? Open : status_;
51 InsetCollapsable::Geometry InsetCollapsable::geometry() const
53 switch (decoration()) {
55 if (status() == Open) {
64 return status() == Open ? NoButton : ButtonOnly ;
67 return status() == Open ? SubLabel : Corners ;
70 // dummy return value to shut down a warning,
76 InsetCollapsable::InsetCollapsable(BufferParams const & bp,
77 CollapseStatus status, TextClassPtr tc)
78 : InsetText(bp), status_(status),
79 openinlined_(false), autoOpen_(false), mouse_hover_(false)
82 setAutoBreakRows(true);
84 setFrameColor(Color_collapsableframe);
85 paragraphs().back().layout(bp.getTextClass().emptyLayout());
89 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
91 textClass_(rhs.textClass_),
93 labelstring_(rhs.labelstring_),
94 button_dim(rhs.button_dim),
96 openinlined_(rhs.openinlined_),
97 autoOpen_(rhs.autoOpen_),
98 // the sole purpose of this copy constructor
104 docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
106 Dimension dim = dimensionCollapsed();
107 if (geometry() == NoButton)
108 return layout_->labelstring;
109 else if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des)
114 return _("Left-click to collapse the inset");
116 return _("Left-click to open the inset");
122 void InsetCollapsable::setLayout(BufferParams const & bp)
124 setLayout(bp.getTextClassPtr());
128 void InsetCollapsable::setLayout(TextClassPtr tc)
131 if ( tc.get() != 0 ) {
132 layout_ = &tc->insetlayout(name());
133 labelstring_ = layout_->labelstring;
136 labelstring_ = _("UNDEFINED");
143 void InsetCollapsable::write(Buffer const & buf, ostream & os) const
155 text_.write(buf, os);
159 void InsetCollapsable::read(Buffer const & buf, Lexer & lex)
161 bool token_found = false;
164 string const token = lex.getString();
165 if (token == "status") {
167 string const tmp_token = lex.getString();
169 if (tmp_token == "collapsed") {
172 } else if (tmp_token == "open") {
176 lyxerr << "InsetCollapsable::read: Missing status!"
178 // Take countermeasures
179 lex.pushToken(token);
182 LYXERR0("InsetCollapsable::read: Missing 'status'-tag!");
183 // take countermeasures
184 lex.pushToken(token);
187 InsetText::read(buf, lex);
189 setLayout(buf.params());
192 status_ = isOpen() ? Open : Collapsed;
194 // Force default font, if so requested
195 // This avoids paragraphs in buffer language that would have a
196 // foreign language after a document language change, and it ensures
197 // that all new text in ERT and similar gets the "latex" language,
198 // since new text inherits the language from the last position of the
199 // existing text. As a side effect this makes us also robust against
200 // bugs in LyX that might lead to font changes in ERT in .lyx files.
201 resetParagraphsFont();
205 Dimension InsetCollapsable::dimensionCollapsed() const
207 BOOST_ASSERT(layout_);
209 theFontMetrics(layout_->labelfont).buttonText(
210 labelstring_, dim.wid, dim.asc, dim.des);
215 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
217 BOOST_ASSERT(layout_);
219 autoOpen_ = mi.base.bv->cursor().isInside(this);
221 FontInfo tmpfont = mi.base.font;
222 mi.base.font = layout_->font;
223 mi.base.font.realize(tmpfont);
225 switch (geometry()) {
227 InsetText::metrics(mi, dim);
230 InsetText::metrics(mi, dim);
235 InsetText::metrics(mi, dim);
236 // consider width of the inset label
237 FontInfo font(layout_->labelfont);
238 font.realize(sane_font);
244 theFontMetrics(font).rectText(labelstring_, w, a, d);
251 dim = dimensionCollapsed();
252 if (geometry() == TopButton
253 || geometry() == LeftButton) {
255 InsetText::metrics(mi, textdim);
256 openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
258 // Correct for button width.
259 dim.wid += textdim.wid;
260 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
261 dim.asc = textdim.asc;
263 dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
264 dim.wid = max(dim.wid, textdim.wid);
270 mi.base.font = tmpfont;
274 bool InsetCollapsable::setMouseHover(bool mouse_hover)
276 mouse_hover_ = mouse_hover;
281 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
283 BOOST_ASSERT(layout_);
285 autoOpen_ = pi.base.bv->cursor().isInside(this);
286 ColorCode const old_color = pi.background_color;
287 pi.background_color = backgroundColor();
289 FontInfo tmpfont = pi.base.font;
290 pi.base.font = layout_->font;
291 pi.base.font.realize(tmpfont);
293 // Draw button first -- top, left or only
294 Dimension dimc = dimensionCollapsed();
296 if (geometry() == TopButton ||
297 geometry() == LeftButton ||
298 geometry() == ButtonOnly) {
299 button_dim.x1 = x + 0;
300 button_dim.x2 = x + dimc.width();
301 button_dim.y1 = y - dimc.asc;
302 button_dim.y2 = y + dimc.des;
304 pi.pain.buttonText(x, y, labelstring_, layout_->labelfont,
313 Dimension const textdim = InsetText::dimension(*pi.base.bv);
314 int const baseline = y;
316 switch (geometry()) {
318 textx = x + dimc.width();
320 InsetText::draw(pi, textx, texty);
324 texty = baseline + dimc.des + textdim.asc;
325 InsetText::draw(pi, textx, texty);
332 InsetText::draw(pi, textx, texty);
338 const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
339 InsetText::draw(pi, textx, texty);
340 const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
342 int desc = textdim.descent();
343 if (geometry() == Corners)
346 const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
347 const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
348 pi.pain.line(xx1, y + desc - 4,
350 layout_->labelfont.color());
352 pi.pain.line(xx1, y + desc,
354 layout_->labelfont.color());
356 // Make status_ value visible:
357 pi.pain.line(xx1, y + desc,
359 layout_->labelfont.color());
360 pi.pain.line(xx2 - 4, y + desc,
362 layout_->labelfont.color());
364 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3, y + desc - 4,
365 layout_->labelfont.color());
367 // the label below the text. Can be toggled.
368 if (geometry() == SubLabel) {
369 FontInfo font(layout_->labelfont);
370 font.realize(sane_font);
376 theFontMetrics(font).rectText(labelstring_, w, a, d);
377 int const ww = max(textdim.wid, w);
378 pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
379 labelstring_, font, Color_none, Color_none);
383 // a visual cue when the cursor is inside the inset
384 Cursor & cur = pi.base.bv->cursor();
385 if (cur.isInside(this)) {
388 pi.pain.line(xx1, y + 4, xx1, y, layout_->labelfont.color());
389 pi.pain.line(xx1 + 4, y, xx1, y, layout_->labelfont.color());
390 pi.pain.line(xx2, y + 4, xx2, y,
391 layout_->labelfont.color());
392 pi.pain.line(xx2 - 4, y, xx2, y,
393 layout_->labelfont.color());
397 pi.background_color = old_color;
399 pi.base.font = tmpfont;
403 void InsetCollapsable::cursorPos(BufferView const & bv,
404 CursorSlice const & sl, bool boundary, int & x, int & y) const
406 if (geometry() == ButtonOnly)
408 BOOST_ASSERT(geometry() != ButtonOnly);
410 InsetText::cursorPos(bv, sl, boundary, x, y);
411 Dimension const textdim = InsetText::dimension(bv);
413 switch (geometry()) {
415 x += dimensionCollapsed().wid;
418 y += dimensionCollapsed().des + textdim.asc;
433 Inset::EDITABLE InsetCollapsable::editable() const
435 return geometry() != ButtonOnly? HIGHLY_EDITABLE : IS_EDITABLE;
439 bool InsetCollapsable::descendable() const
441 return geometry() != ButtonOnly;
445 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
447 return button_dim.contains(cmd.x, cmd.y);
451 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
454 pos_type const max_length = 15;
455 pos_type const p_siz = paragraphs().begin()->size();
456 pos_type const n = min(max_length, p_siz);
459 for (; i < n && j < p_siz; ++j) {
460 if (paragraphs().begin()->isInset(j))
462 label += paragraphs().begin()->getChar(j);
465 if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
468 return label.empty() ? l : label;
472 void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
474 //lyxerr << "InsetCollapsable: edit left/right" << endl;
476 InsetText::edit(cur, front, entry_from);
480 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
482 //lyxerr << "InsetCollapsable: edit xy" << endl;
483 if (geometry() == ButtonOnly
484 || (button_dim.contains(x, y)
485 && geometry() != NoButton))
488 return InsetText::editXY(cur, x, y);
492 void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
494 //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
495 // << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
497 switch (cmd.action) {
498 case LFUN_MOUSE_PRESS:
499 if (cmd.button() == mouse_button::button1
501 && geometry() != NoButton) {
502 // reset selection if necessary (see bug 3060)
504 cur.bv().cursor().clearSelection();
510 if (geometry() == NoButton)
511 InsetText::doDispatch(cur, cmd);
512 else if (geometry() != ButtonOnly
514 InsetText::doDispatch(cur, cmd);
519 case LFUN_MOUSE_MOTION:
520 case LFUN_MOUSE_DOUBLE:
521 case LFUN_MOUSE_TRIPLE:
522 if (geometry() == NoButton)
523 InsetText::doDispatch(cur, cmd);
524 else if (geometry() != ButtonOnly
526 InsetText::doDispatch(cur, cmd);
531 case LFUN_MOUSE_RELEASE:
532 if (cmd.button() == mouse_button::button3) {
533 // There is no button to right click:
534 if (decoration() == Minimalistic ||
535 geometry() == Corners ||
536 geometry() == SubLabel ||
537 geometry() == NoButton
540 setStatus(cur, Collapsed);
542 setStatus(cur, Open);
546 // configuration dialog
547 showInsetDialog(&cur.bv());
552 if (geometry() == NoButton) {
553 // The mouse click has to be within the inset!
554 InsetText::doDispatch(cur, cmd);
558 if (cmd.button() == mouse_button::button1 && hitButton(cmd)) {
559 // if we are selecting, we do not want to
563 // Left button is clicked, the user asks to
564 // toggle the inset visual state.
566 cur.updateFlags(Update::Force | Update::FitCursor);
567 if (geometry() == ButtonOnly) {
568 setStatus(cur, Open);
572 setStatus(cur, Collapsed);
574 cur.bv().cursor() = cur;
578 // The mouse click is within the opened inset.
579 if (geometry() == TopButton
580 || geometry() == LeftButton)
581 InsetText::doDispatch(cur, cmd);
584 case LFUN_INSET_TOGGLE:
585 if (cmd.argument() == "open")
586 setStatus(cur, Open);
587 else if (cmd.argument() == "close")
588 setStatus(cur, Collapsed);
589 else if (cmd.argument() == "toggle" || cmd.argument().empty())
590 if (status_ == Open) {
591 setStatus(cur, Collapsed);
592 if (geometry() == ButtonOnly)
593 cur.top().forwardPos();
595 setStatus(cur, Open);
596 else // if assign or anything else
602 case LFUN_CLIPBOARD_PASTE:
603 case LFUN_PRIMARY_SELECTION_PASTE: {
604 InsetText::doDispatch(cur, cmd);
605 // Since we can only store plain text, we must reset all
607 // FIXME: Change only the pasted paragraphs
609 resetParagraphsFont();
614 if (layout_ && layout_->forceltr) {
615 // Force any new text to latex_language
616 // FIXME: This should only be necessary in constructor, but
617 // new paragraphs that are created by pressing enter at the
618 // start of an existing paragraph get the buffer language
619 // and not latex_language, so we take this brute force
621 cur.current_font.setLanguage(latex_language);
622 cur.real_current_font.setLanguage(latex_language);
624 InsetText::doDispatch(cur, cmd);
630 bool InsetCollapsable::allowMultiPar() const
632 return layout_->multipar;
636 void InsetCollapsable::resetParagraphsFont()
639 font.fontInfo() = inherit_font;
640 if (layout_->forceltr)
641 font.setLanguage(latex_language);
642 if (layout_->passthru) {
643 ParagraphList::iterator par = paragraphs().begin();
644 ParagraphList::iterator const end = paragraphs().end();
646 par->resetFonts(font);
647 par->params().clear();
654 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
655 FuncStatus & flag) const
657 switch (cmd.action) {
659 case LFUN_ACCENT_ACUTE:
660 case LFUN_ACCENT_BREVE:
661 case LFUN_ACCENT_CARON:
662 case LFUN_ACCENT_CEDILLA:
663 case LFUN_ACCENT_CIRCLE:
664 case LFUN_ACCENT_CIRCUMFLEX:
665 case LFUN_ACCENT_DOT:
666 case LFUN_ACCENT_GRAVE:
667 case LFUN_ACCENT_HUNGARIAN_UMLAUT:
668 case LFUN_ACCENT_MACRON:
669 case LFUN_ACCENT_OGONEK:
670 case LFUN_ACCENT_SPECIAL_CARON:
671 case LFUN_ACCENT_TIE:
672 case LFUN_ACCENT_TILDE:
673 case LFUN_ACCENT_UMLAUT:
674 case LFUN_ACCENT_UNDERBAR:
675 case LFUN_ACCENT_UNDERDOT:
677 case LFUN_BIBITEM_INSERT:
678 case LFUN_BOX_INSERT:
679 case LFUN_BRANCH_INSERT:
681 case LFUN_CAPTION_INSERT:
682 case LFUN_CLEARPAGE_INSERT:
683 case LFUN_CLEARDOUBLEPAGE_INSERT:
684 case LFUN_DEPTH_DECREMENT:
685 case LFUN_DEPTH_INCREMENT:
686 case LFUN_ENVIRONMENT_INSERT:
687 case LFUN_ERT_INSERT:
688 case LFUN_FILE_INSERT:
689 case LFUN_FLEX_INSERT:
690 case LFUN_FLOAT_INSERT:
691 case LFUN_FLOAT_LIST:
692 case LFUN_FLOAT_WIDE_INSERT:
694 case LFUN_FONT_TYPEWRITER:
695 case LFUN_FONT_DEFAULT:
697 case LFUN_FONT_FREE_APPLY:
698 case LFUN_FONT_FREE_UPDATE:
700 case LFUN_FONT_ROMAN:
705 case LFUN_FONT_STATE:
706 case LFUN_FONT_UNDERLINE:
707 case LFUN_FOOTNOTE_INSERT:
708 case LFUN_HFILL_INSERT:
709 case LFUN_HYPERLINK_INSERT:
710 case LFUN_INDEX_INSERT:
711 case LFUN_INDEX_PRINT:
712 case LFUN_INSET_INSERT:
713 case LFUN_LABEL_GOTO:
714 case LFUN_LABEL_INSERT:
715 case LFUN_LINE_INSERT:
716 case LFUN_NEWPAGE_INSERT:
717 case LFUN_PAGEBREAK_INSERT:
719 case LFUN_LAYOUT_PARAGRAPH:
720 case LFUN_LAYOUT_TABULAR:
721 case LFUN_MARGINALNOTE_INSERT:
722 case LFUN_MATH_DISPLAY:
723 case LFUN_MATH_INSERT:
724 case LFUN_MATH_MATRIX:
728 case LFUN_NOMENCL_INSERT:
729 case LFUN_NOMENCL_PRINT:
730 case LFUN_NOTE_INSERT:
732 case LFUN_OPTIONAL_INSERT:
733 case LFUN_PARAGRAPH_PARAMS:
734 case LFUN_PARAGRAPH_PARAMS_APPLY:
735 case LFUN_PARAGRAPH_SPACING:
736 case LFUN_PARAGRAPH_UPDATE:
737 case LFUN_REFERENCE_NEXT:
738 case LFUN_SERVER_GOTO_FILE_ROW:
739 case LFUN_SERVER_NOTIFY:
740 case LFUN_SERVER_SET_XY:
741 case LFUN_SPACE_INSERT:
742 case LFUN_SPECIALCHAR_INSERT:
743 case LFUN_TABULAR_INSERT:
744 case LFUN_TOC_INSERT:
745 case LFUN_WRAP_INSERT:
746 if (layout_->passthru) {
750 return InsetText::getStatus(cur, cmd, flag);
752 case LFUN_INSET_TOGGLE:
753 if (cmd.argument() == "open" || cmd.argument() == "close" ||
754 cmd.argument() == "toggle")
761 flag.enabled(!layout_->forceltr);
762 return InsetText::getStatus(cur, cmd, flag);
764 case LFUN_BREAK_PARAGRAPH:
765 case LFUN_BREAK_PARAGRAPH_SKIP:
766 flag.enabled(layout_->multipar);
770 return InsetText::getStatus(cur, cmd, flag);
775 void InsetCollapsable::setLabel(docstring const & l)
781 void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
785 if (status_ == Collapsed)
786 cur.leaveInset(*this);
790 docstring InsetCollapsable::floatName(string const & type, BufferParams const & bp) const
792 FloatList const & floats = bp.getTextClass().floats();
793 FloatList::const_iterator it = floats[type];
795 return (it == floats.end()) ? from_ascii(type) : bp.B_(it->second.name());
799 InsetCollapsable::Decoration InsetCollapsable::decoration() const
801 if (!layout_ || layout_->decoration == "classic")
803 if (layout_->decoration == "minimalistic")
805 if (layout_->decoration == "conglomerate")
807 if (lyxCode() == FLEX_CODE)
808 // FIXME: Is this really necessary?
814 bool InsetCollapsable::isMacroScope(Buffer const &) const
816 // layout_ == 0 leads to no latex output, so ignore
817 // the macros outside
821 // see InsetCollapsable::latex(...) below. In these case
822 // an environment is opened there
823 if (!layout_->latexname.empty())
830 int InsetCollapsable::latex(Buffer const & buf, odocstream & os,
831 OutputParams const & runparams) const
833 // FIXME: What should we do layout_ is 0?
835 // 2) through an error
839 // This implements the standard way of handling the LaTeX output of
840 // a collapsable inset, either a command or an environment. Standard
841 // collapsable insets should not redefine this, non-standard ones may
843 if (!layout_->latexname.empty()) {
844 if (layout_->latextype == "command") {
846 if (runparams.moving_arg)
848 os << '\\' << from_utf8(layout_->latexname);
849 if (!layout_->latexparam.empty())
850 os << from_utf8(layout_->latexparam);
852 } else if (layout_->latextype == "environment") {
853 os << "%\n\\begin{" << from_utf8(layout_->latexname) << "}\n";
854 if (!layout_->latexparam.empty())
855 os << from_utf8(layout_->latexparam);
858 OutputParams rp = runparams;
859 if (layout_->passthru)
861 if (layout_->needprotect)
862 rp.moving_arg = true;
863 int i = InsetText::latex(buf, os, rp);
864 if (!layout_->latexname.empty()) {
865 if (layout_->latextype == "command") {
867 } else if (layout_->latextype == "environment") {
868 os << "\n\\end{" << from_utf8(layout_->latexname) << "}\n";
876 void InsetCollapsable::validate(LaTeXFeatures & features) const
881 // Force inclusion of preamble snippet in layout file
882 features.require(layout_->name);
883 InsetText::validate(features);