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 "DispatchResult.h"
23 #include "FloatList.h"
24 #include "FuncRequest.h"
25 #include "FuncStatus.h"
26 #include "InsetLayout.h"
28 #include "LaTeXFeatures.h"
30 #include "MetricsInfo.h"
31 #include "ParagraphParameters.h"
32 #include "TextClass.h"
34 #include "frontends/FontMetrics.h"
35 #include "frontends/Painter.h"
37 #include "support/debug.h"
38 #include "support/docstream.h"
39 #include "support/gettext.h"
40 #include "support/lassert.h"
47 InsetCollapsable::CollapseStatus InsetCollapsable::status() const
49 if (decoration() == InsetLayout::Conglomerate)
51 return autoOpen_ ? Open : status_;
55 InsetCollapsable::Geometry InsetCollapsable::geometry() const
57 switch (decoration()) {
58 case InsetLayout::Classic:
60 return openinlined_ ? LeftButton : TopButton;
63 case InsetLayout::Minimalistic:
64 return status() == Open ? NoButton : ButtonOnly ;
66 case InsetLayout::Conglomerate:
67 return status() == Open ? SubLabel : Corners ;
69 case InsetLayout::Default:
70 break; // this shouldn't happen
73 // dummy return value to shut down a warning,
79 InsetCollapsable::InsetCollapsable(Buffer const & buf,
80 CollapseStatus status)
81 : InsetText(buf), status_(status),
82 openinlined_(false), autoOpen_(false), mouse_hover_(false)
84 DocumentClass const & dc = buf.params().documentClass();
86 setAutoBreakRows(true);
88 setFrameColor(Color_collapsableframe);
89 paragraphs().back().setLayout(dc.plainLayout());
93 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
96 labelstring_(rhs.labelstring_),
97 button_dim(rhs.button_dim),
99 openinlined_(rhs.openinlined_),
100 autoOpen_(rhs.autoOpen_),
101 // the sole purpose of this copy constructor
107 docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
109 Dimension dim = dimensionCollapsed();
110 if (geometry() == NoButton)
111 return translateIfPossible(layout_->labelstring());
112 if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des || isOpen())
115 OutputParams rp(&buffer().params().encoding());
116 odocstringstream ods;
117 InsetText::plaintext(ods, rp);
118 docstring content_tip = ods.str();
119 // shorten it if necessary
120 if (content_tip.size() > 200)
121 content_tip = content_tip.substr(0, 200) + "...";
126 void InsetCollapsable::setLayout(BufferParams const & bp)
128 setLayout(bp.documentClassPtr());
132 void InsetCollapsable::setLayout(DocumentClass const * const dc)
135 layout_ = &(dc->insetLayout(name()));
136 labelstring_ = translateIfPossible(layout_->labelstring());
138 layout_ = &DocumentClass::plainInsetLayout();
139 labelstring_ = _("UNDEFINED");
146 void InsetCollapsable::write(ostream & os) const
158 text().write(buffer(), os);
162 void InsetCollapsable::read(Lexer & lex)
164 lex.setContext("InsetCollapsable::read");
167 lex >> "status" >> tmp_token;
168 if (tmp_token == "open")
171 // this must be set before we enter InsetText::read()
172 setLayout(buffer().params());
173 InsetText::read(lex);
174 // set button label again as the inset contents was not read yet at
178 // Force default font, if so requested
179 // This avoids paragraphs in buffer language that would have a
180 // foreign language after a document language change, and it ensures
181 // that all new text in ERT and similar gets the "latex" language,
182 // since new text inherits the language from the last position of the
183 // existing text. As a side effect this makes us also robust against
184 // bugs in LyX that might lead to font changes in ERT in .lyx files.
185 resetParagraphsFont();
189 Dimension InsetCollapsable::dimensionCollapsed() const
191 LASSERT(layout_, /**/);
193 theFontMetrics(layout_->labelfont()).buttonText(
194 labelstring_, dim.wid, dim.asc, dim.des);
199 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
201 LASSERT(layout_, /**/);
203 autoOpen_ = mi.base.bv->cursor().isInside(this);
205 FontInfo tmpfont = mi.base.font;
206 mi.base.font = layout_->font();
207 mi.base.font.realize(tmpfont);
209 switch (geometry()) {
211 InsetText::metrics(mi, dim);
214 InsetText::metrics(mi, dim);
219 InsetText::metrics(mi, dim);
220 // consider width of the inset label
221 FontInfo font(layout_->labelfont());
222 font.realize(sane_font);
228 theFontMetrics(font).rectText(labelstring_, w, a, d);
235 dim = dimensionCollapsed();
236 if (geometry() == TopButton || geometry() == LeftButton) {
238 InsetText::metrics(mi, textdim);
239 openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
241 // Correct for button width.
242 dim.wid += textdim.wid;
243 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
244 dim.asc = textdim.asc;
246 dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
247 dim.wid = max(dim.wid, textdim.wid);
253 mi.base.font = tmpfont;
257 bool InsetCollapsable::setMouseHover(bool mouse_hover)
259 mouse_hover_ = mouse_hover;
264 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
266 LASSERT(layout_, /**/);
268 autoOpen_ = pi.base.bv->cursor().isInside(this);
270 FontInfo tmpfont = pi.base.font;
271 pi.base.font = layout_->font();
272 pi.base.font.realize(tmpfont);
274 // Draw button first -- top, left or only
275 Dimension dimc = dimensionCollapsed();
277 if (geometry() == TopButton ||
278 geometry() == LeftButton ||
279 geometry() == ButtonOnly) {
280 button_dim.x1 = x + 0;
281 button_dim.x2 = x + dimc.width();
282 button_dim.y1 = y - dimc.asc;
283 button_dim.y2 = y + dimc.des;
285 pi.pain.buttonText(x, y, labelstring_, layout_->labelfont(),
294 Dimension const textdim = InsetText::dimension(*pi.base.bv);
295 int const baseline = y;
297 switch (geometry()) {
299 textx = x + dimc.width();
301 InsetText::draw(pi, textx, texty);
305 texty = baseline + dimc.des + textdim.asc;
306 InsetText::draw(pi, textx, texty);
313 InsetText::draw(pi, textx, texty);
319 const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
320 InsetText::draw(pi, textx, texty);
321 const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
323 int desc = textdim.descent();
324 if (geometry() == Corners)
327 const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
328 const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
329 pi.pain.line(xx1, y + desc - 4,
331 layout_->labelfont().color());
333 pi.pain.line(xx1, y + desc,
335 layout_->labelfont().color());
337 // Make status_ value visible:
338 pi.pain.line(xx1, y + desc,
340 layout_->labelfont().color());
341 pi.pain.line(xx2 - 4, y + desc,
343 layout_->labelfont().color());
345 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3,
346 y + desc - 4, layout_->labelfont().color());
348 // the label below the text. Can be toggled.
349 if (geometry() == SubLabel) {
350 FontInfo font(layout_->labelfont());
351 font.realize(sane_font);
357 theFontMetrics(font).rectText(labelstring_, w, a, d);
358 int const ww = max(textdim.wid, w);
359 pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
360 labelstring_, font, Color_none, Color_none);
364 // a visual cue when the cursor is inside the inset
365 Cursor & cur = pi.base.bv->cursor();
366 if (cur.isInside(this)) {
369 pi.pain.line(xx1, y + 4, xx1, y, layout_->labelfont().color());
370 pi.pain.line(xx1 + 4, y, xx1, y, layout_->labelfont().color());
371 pi.pain.line(xx2, y + 4, xx2, y,
372 layout_->labelfont().color());
373 pi.pain.line(xx2 - 4, y, xx2, y,
374 layout_->labelfont().color());
379 pi.base.font = tmpfont;
383 void InsetCollapsable::cursorPos(BufferView const & bv,
384 CursorSlice const & sl, bool boundary, int & x, int & y) const
386 if (geometry() == ButtonOnly)
388 LASSERT(geometry() != ButtonOnly, /**/);
390 InsetText::cursorPos(bv, sl, boundary, x, y);
391 Dimension const textdim = InsetText::dimension(bv);
393 switch (geometry()) {
395 x += dimensionCollapsed().wid;
398 y += dimensionCollapsed().des + textdim.asc;
413 Inset::EDITABLE InsetCollapsable::editable() const
415 return geometry() != ButtonOnly ? HIGHLY_EDITABLE : IS_EDITABLE;
419 bool InsetCollapsable::descendable() const
421 return geometry() != ButtonOnly;
425 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
427 return button_dim.contains(cmd.x, cmd.y);
431 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
434 pos_type const max_length = 15;
435 pos_type const p_siz = paragraphs().begin()->size();
436 pos_type const n = min(max_length, p_siz);
439 for (; i < n && j < p_siz; ++j) {
440 if (paragraphs().begin()->isInset(j))
442 label += paragraphs().begin()->getChar(j);
445 if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
448 return label.empty() ? l : label;
452 void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
454 //lyxerr << "InsetCollapsable: edit left/right" << endl;
456 InsetText::edit(cur, front, entry_from);
460 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
462 //lyxerr << "InsetCollapsable: edit xy" << endl;
463 if (geometry() == ButtonOnly
464 || (button_dim.contains(x, y)
465 && geometry() != NoButton))
468 return InsetText::editXY(cur, x, y);
472 void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
474 //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
475 // << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
477 switch (cmd.action) {
478 case LFUN_MOUSE_PRESS:
479 if (hitButton(cmd)) {
480 switch (cmd.button()) {
481 case mouse_button::button1:
482 case mouse_button::button3:
483 // Pass the command to the enclosing InsetText,
484 // so that the cursor gets set.
487 case mouse_button::none:
488 case mouse_button::button2:
489 case mouse_button::button4:
490 case mouse_button::button5:
495 } else if (geometry() != ButtonOnly)
496 InsetText::doDispatch(cur, cmd);
501 case LFUN_MOUSE_MOTION:
502 case LFUN_MOUSE_DOUBLE:
503 case LFUN_MOUSE_TRIPLE:
506 else if (geometry() != ButtonOnly)
507 InsetText::doDispatch(cur, cmd);
512 case LFUN_MOUSE_RELEASE:
513 if (!hitButton(cmd)) {
514 // The mouse click has to be within the inset!
515 if (geometry() != ButtonOnly)
516 InsetText::doDispatch(cur, cmd);
521 if (cmd.button() != mouse_button::button1) {
526 // if we are selecting, we do not want to
530 // Left button is clicked, the user asks to
531 // toggle the inset visual state.
533 cur.updateFlags(Update::Force | Update::FitCursor);
534 if (geometry() == ButtonOnly) {
535 setStatus(cur, Open);
539 setStatus(cur, Collapsed);
540 cur.bv().cursor() = cur;
543 case LFUN_INSET_TOGGLE:
544 if (cmd.argument() == "open")
545 setStatus(cur, Open);
546 else if (cmd.argument() == "close")
547 setStatus(cur, Collapsed);
548 else if (cmd.argument() == "toggle" || cmd.argument().empty())
549 if (status_ == Open) {
550 setStatus(cur, Collapsed);
551 if (geometry() == ButtonOnly)
552 cur.top().forwardPos();
554 setStatus(cur, Open);
555 else // if assign or anything else
561 case LFUN_CLIPBOARD_PASTE:
562 case LFUN_PRIMARY_SELECTION_PASTE: {
563 InsetText::doDispatch(cur, cmd);
564 // Since we can only store plain text, we must reset all
566 // FIXME: Change only the pasted paragraphs
568 resetParagraphsFont();
573 if (layout_ && layout_->isForceLtr()) {
574 // Force any new text to latex_language
575 // FIXME: This should only be necessary in constructor, but
576 // new paragraphs that are created by pressing enter at the
577 // start of an existing paragraph get the buffer language
578 // and not latex_language, so we take this brute force
580 cur.current_font.setLanguage(latex_language);
581 cur.real_current_font.setLanguage(latex_language);
583 InsetText::doDispatch(cur, cmd);
589 bool InsetCollapsable::allowMultiPar() const
591 return layout_->isMultiPar();
595 void InsetCollapsable::resetParagraphsFont()
598 font.fontInfo() = inherit_font;
599 if (layout_->isForceLtr())
600 font.setLanguage(latex_language);
601 if (layout_->isPassThru()) {
602 ParagraphList::iterator par = paragraphs().begin();
603 ParagraphList::iterator const end = paragraphs().end();
605 par->resetFonts(font);
606 par->params().clear();
613 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
614 FuncStatus & flag) const
616 switch (cmd.action) {
617 // FIXME At present, these are being enabled and disabled according to
618 // whether PASSTHRU has been set in the InsetLayout. This makes some
619 // sense, but there are other checks that should really be done. E.g.,
620 // one should not be able to inset IndexPrint inside an optional argument!!
621 case LFUN_ACCENT_ACUTE:
622 case LFUN_ACCENT_BREVE:
623 case LFUN_ACCENT_CARON:
624 case LFUN_ACCENT_CEDILLA:
625 case LFUN_ACCENT_CIRCLE:
626 case LFUN_ACCENT_CIRCUMFLEX:
627 case LFUN_ACCENT_DOT:
628 case LFUN_ACCENT_GRAVE:
629 case LFUN_ACCENT_HUNGARIAN_UMLAUT:
630 case LFUN_ACCENT_MACRON:
631 case LFUN_ACCENT_OGONEK:
632 case LFUN_ACCENT_TIE:
633 case LFUN_ACCENT_TILDE:
634 case LFUN_ACCENT_UMLAUT:
635 case LFUN_ACCENT_UNDERBAR:
636 case LFUN_ACCENT_UNDERDOT:
638 case LFUN_BOX_INSERT:
639 case LFUN_BRANCH_INSERT:
640 case LFUN_NEWLINE_INSERT:
641 case LFUN_CAPTION_INSERT:
642 case LFUN_DEPTH_DECREMENT:
643 case LFUN_DEPTH_INCREMENT:
644 case LFUN_ERT_INSERT:
645 case LFUN_FILE_INSERT:
646 case LFUN_FLEX_INSERT:
647 case LFUN_FLOAT_INSERT:
648 case LFUN_FLOAT_LIST_INSERT:
649 case LFUN_FLOAT_WIDE_INSERT:
651 case LFUN_FONT_BOLDSYMBOL:
652 case LFUN_FONT_TYPEWRITER:
653 case LFUN_FONT_DEFAULT:
655 case LFUN_TEXTSTYLE_APPLY:
656 case LFUN_TEXTSTYLE_UPDATE:
658 case LFUN_FONT_ROMAN:
663 case LFUN_FONT_STATE:
664 case LFUN_FONT_UNDERLINE:
665 case LFUN_FOOTNOTE_INSERT:
666 case LFUN_HYPERLINK_INSERT:
667 case LFUN_INDEX_INSERT:
668 case LFUN_INDEX_PRINT:
669 case LFUN_INSET_INSERT:
670 case LFUN_LABEL_GOTO:
671 case LFUN_LABEL_INSERT:
672 case LFUN_LINE_INSERT:
673 case LFUN_NEWPAGE_INSERT:
674 case LFUN_LAYOUT_TABULAR:
675 case LFUN_MARGINALNOTE_INSERT:
676 case LFUN_MATH_DISPLAY:
677 case LFUN_MATH_INSERT:
678 case LFUN_MATH_MATRIX:
682 case LFUN_NOMENCL_INSERT:
683 case LFUN_NOMENCL_PRINT:
684 case LFUN_NOTE_INSERT:
686 case LFUN_OPTIONAL_INSERT:
687 case LFUN_REFERENCE_NEXT:
688 case LFUN_SERVER_GOTO_FILE_ROW:
689 case LFUN_SERVER_NOTIFY:
690 case LFUN_SERVER_SET_XY:
691 case LFUN_SPACE_INSERT:
692 case LFUN_SPECIALCHAR_INSERT:
693 case LFUN_TABULAR_INSERT:
694 case LFUN_TOC_INSERT:
695 case LFUN_WRAP_INSERT:
696 if (layout_->isPassThru()) {
697 flag.setEnabled(false);
700 return InsetText::getStatus(cur, cmd, flag);
702 case LFUN_INSET_TOGGLE:
703 if (cmd.argument() == "open")
704 flag.setEnabled(status_ != Open);
705 else if (cmd.argument() == "close")
706 flag.setEnabled(status_ == Open);
707 else if (cmd.argument() == "toggle" || cmd.argument().empty()) {
708 flag.setEnabled(true);
709 flag.setOnOff(status_ == Open);
711 flag.setEnabled(false);
715 flag.setEnabled(!layout_->isForceLtr());
716 return InsetText::getStatus(cur, cmd, flag);
718 case LFUN_BREAK_PARAGRAPH:
719 flag.setEnabled(layout_->isMultiPar());
723 return InsetText::getStatus(cur, cmd, flag);
728 void InsetCollapsable::setLabel(docstring const & l)
734 void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
738 if (status_ == Collapsed) {
739 cur.leaveInset(*this);
740 mouse_hover_ = false;
745 docstring InsetCollapsable::floatName(
746 string const & type, BufferParams const & bp) const
748 FloatList const & floats = bp.documentClass().floats();
749 FloatList::const_iterator it = floats[type];
751 return (it == floats.end()) ? from_ascii(type) : bp.B_(it->second.name());
755 InsetLayout::InsetDecoration InsetCollapsable::decoration() const
758 return InsetLayout::Classic;
759 InsetLayout::InsetDecoration const dec = layout_->decoration();
761 case InsetLayout::Classic:
762 case InsetLayout::Minimalistic:
763 case InsetLayout::Conglomerate:
765 case InsetLayout::Default:
768 if (lyxCode() == FLEX_CODE)
769 return InsetLayout::Conglomerate;
770 return InsetLayout::Classic;
774 int InsetCollapsable::latex(odocstream & os,
775 OutputParams const & runparams) const
777 // FIXME: What should we do layout_ is 0?
779 // 2) through an error
783 // This implements the standard way of handling the LaTeX output of
784 // a collapsable inset, either a command or an environment. Standard
785 // collapsable insets should not redefine this, non-standard ones may
787 if (!layout_->latexname().empty()) {
788 if (layout_->latextype() == "command") {
790 if (runparams.moving_arg)
792 os << '\\' << from_utf8(layout_->latexname());
793 if (!layout_->latexparam().empty())
794 os << from_utf8(layout_->latexparam());
796 } else if (layout_->latextype() == "environment") {
797 os << "%\n\\begin{" << from_utf8(layout_->latexname()) << "}\n";
798 if (!layout_->latexparam().empty())
799 os << from_utf8(layout_->latexparam());
802 OutputParams rp = runparams;
803 if (layout_->isPassThru())
805 if (layout_->isNeedProtect())
806 rp.moving_arg = true;
807 int i = InsetText::latex(os, rp);
808 if (!layout_->latexname().empty()) {
809 if (layout_->latextype() == "command") {
811 } else if (layout_->latextype() == "environment") {
812 os << "\n\\end{" << from_utf8(layout_->latexname()) << "}\n";
820 void InsetCollapsable::validate(LaTeXFeatures & features) const
822 string const preamble = getLayout().preamble();
823 if (!preamble.empty())
824 features.addPreambleSnippet(preamble);
825 features.require(getLayout().requires());
826 InsetText::validate(features);
830 bool InsetCollapsable::undefined() const
832 docstring const & n = getLayout().name();
833 return n.empty() || n == DocumentClass::plainInsetLayout().name();
837 docstring InsetCollapsable::contextMenu(BufferView const & bv, int x,
840 if (decoration() == InsetLayout::Conglomerate)
841 return from_ascii("context-conglomerate");
843 if (geometry() == NoButton)
844 return from_ascii("context-collapsable");
846 Dimension dim = dimensionCollapsed();
847 if (x < xo(bv) + dim.wid && y < yo(bv) + dim.des)
848 return from_ascii("context-collapsable");
850 return InsetText::contextMenu(bv, x, y);