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 : InsetText(buf), status_(Inset::Open),
81 openinlined_(false), autoOpen_(false), mouse_hover_(false)
83 DocumentClass const & dc = buf.params().documentClass();
85 setAutoBreakRows(true);
87 setFrameColor(Color_collapsableframe);
91 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
94 labelstring_(rhs.labelstring_),
95 button_dim(rhs.button_dim),
97 openinlined_(rhs.openinlined_),
98 autoOpen_(rhs.autoOpen_),
99 // the sole purpose of this copy constructor
105 docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
107 Dimension dim = dimensionCollapsed();
108 if (geometry() == NoButton)
109 return translateIfPossible(layout_->labelstring());
110 if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des || isOpen())
113 OutputParams rp(&buffer().params().encoding());
114 odocstringstream ods;
115 InsetText::plaintext(ods, rp);
116 docstring content_tip = ods.str();
117 // shorten it if necessary
118 if (content_tip.size() > 200)
119 content_tip = content_tip.substr(0, 200) + "...";
124 void InsetCollapsable::setLayout(BufferParams const & bp)
126 setLayout(bp.documentClassPtr());
130 void InsetCollapsable::setLayout(DocumentClass const * const dc)
133 layout_ = &(dc->insetLayout(name()));
134 labelstring_ = translateIfPossible(layout_->labelstring());
136 layout_ = &DocumentClass::plainInsetLayout();
137 labelstring_ = _("UNDEFINED");
144 void InsetCollapsable::write(ostream & os) const
156 text().write(buffer(), os);
160 void InsetCollapsable::read(Lexer & lex)
162 lex.setContext("InsetCollapsable::read");
165 lex >> "status" >> tmp_token;
166 if (tmp_token == "open")
169 // this must be set before we enter InsetText::read()
170 setLayout(buffer().params());
171 InsetText::read(lex);
172 // set button label again as the inset contents was not read yet at
176 // Force default font, if so requested
177 // This avoids paragraphs in buffer language that would have a
178 // foreign language after a document language change, and it ensures
179 // that all new text in ERT and similar gets the "latex" language,
180 // since new text inherits the language from the last position of the
181 // existing text. As a side effect this makes us also robust against
182 // bugs in LyX that might lead to font changes in ERT in .lyx files.
183 resetParagraphsFont();
187 Dimension InsetCollapsable::dimensionCollapsed() const
189 LASSERT(layout_, /**/);
191 theFontMetrics(layout_->labelfont()).buttonText(
192 labelstring_, dim.wid, dim.asc, dim.des);
197 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
199 LASSERT(layout_, /**/);
201 autoOpen_ = mi.base.bv->cursor().isInside(this);
203 FontInfo tmpfont = mi.base.font;
204 mi.base.font = layout_->font();
205 mi.base.font.realize(tmpfont);
207 switch (geometry()) {
209 InsetText::metrics(mi, dim);
212 InsetText::metrics(mi, dim);
217 InsetText::metrics(mi, dim);
218 // consider width of the inset label
219 FontInfo font(layout_->labelfont());
220 font.realize(sane_font);
226 theFontMetrics(font).rectText(labelstring_, w, a, d);
233 dim = dimensionCollapsed();
234 if (geometry() == TopButton || geometry() == LeftButton) {
236 InsetText::metrics(mi, textdim);
237 openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
239 // Correct for button width.
240 dim.wid += textdim.wid;
241 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
242 dim.asc = textdim.asc;
244 dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
245 dim.wid = max(dim.wid, textdim.wid);
251 mi.base.font = tmpfont;
255 bool InsetCollapsable::setMouseHover(bool mouse_hover)
257 mouse_hover_ = mouse_hover;
262 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
264 LASSERT(layout_, /**/);
266 autoOpen_ = pi.base.bv->cursor().isInside(this);
268 FontInfo tmpfont = pi.base.font;
269 pi.base.font = layout_->font();
270 pi.base.font.realize(tmpfont);
272 // Draw button first -- top, left or only
273 Dimension dimc = dimensionCollapsed();
275 if (geometry() == TopButton ||
276 geometry() == LeftButton ||
277 geometry() == ButtonOnly) {
278 button_dim.x1 = x + 0;
279 button_dim.x2 = x + dimc.width();
280 button_dim.y1 = y - dimc.asc;
281 button_dim.y2 = y + dimc.des;
283 pi.pain.buttonText(x, y, labelstring_, layout_->labelfont(),
292 Dimension const textdim = InsetText::dimension(*pi.base.bv);
293 int const baseline = y;
295 switch (geometry()) {
297 textx = x + dimc.width();
299 InsetText::draw(pi, textx, texty);
303 texty = baseline + dimc.des + textdim.asc;
304 InsetText::draw(pi, textx, texty);
311 InsetText::draw(pi, textx, texty);
317 const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
318 InsetText::draw(pi, textx, texty);
319 const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
321 int desc = textdim.descent();
322 if (geometry() == Corners)
325 const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
326 const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
327 pi.pain.line(xx1, y + desc - 4,
329 layout_->labelfont().color());
331 pi.pain.line(xx1, y + desc,
333 layout_->labelfont().color());
335 // Make status_ value visible:
336 pi.pain.line(xx1, y + desc,
338 layout_->labelfont().color());
339 pi.pain.line(xx2 - 4, y + desc,
341 layout_->labelfont().color());
343 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3,
344 y + desc - 4, layout_->labelfont().color());
346 // the label below the text. Can be toggled.
347 if (geometry() == SubLabel) {
348 FontInfo font(layout_->labelfont());
349 font.realize(sane_font);
355 theFontMetrics(font).rectText(labelstring_, w, a, d);
356 int const ww = max(textdim.wid, w);
357 pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
358 labelstring_, font, Color_none, Color_none);
362 // a visual cue when the cursor is inside the inset
363 Cursor & cur = pi.base.bv->cursor();
364 if (cur.isInside(this)) {
367 pi.pain.line(xx1, y + 4, xx1, y, layout_->labelfont().color());
368 pi.pain.line(xx1 + 4, y, xx1, y, layout_->labelfont().color());
369 pi.pain.line(xx2, y + 4, xx2, y,
370 layout_->labelfont().color());
371 pi.pain.line(xx2 - 4, y, xx2, y,
372 layout_->labelfont().color());
377 pi.base.font = tmpfont;
381 void InsetCollapsable::cursorPos(BufferView const & bv,
382 CursorSlice const & sl, bool boundary, int & x, int & y) const
384 if (geometry() == ButtonOnly)
386 LASSERT(geometry() != ButtonOnly, /**/);
388 InsetText::cursorPos(bv, sl, boundary, x, y);
389 Dimension const textdim = InsetText::dimension(bv);
391 switch (geometry()) {
393 x += dimensionCollapsed().wid;
396 y += dimensionCollapsed().des + textdim.asc;
411 Inset::EDITABLE InsetCollapsable::editable() const
413 return geometry() != ButtonOnly ? HIGHLY_EDITABLE : IS_EDITABLE;
417 bool InsetCollapsable::descendable() const
419 return geometry() != ButtonOnly;
423 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
425 return button_dim.contains(cmd.x, cmd.y);
429 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
432 pos_type const max_length = 15;
433 pos_type const p_siz = paragraphs().begin()->size();
434 pos_type const n = min(max_length, p_siz);
437 for (; i < n && j < p_siz; ++j) {
438 if (paragraphs().begin()->isInset(j))
440 label += paragraphs().begin()->getChar(j);
443 if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
446 return label.empty() ? l : label;
450 void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
452 //lyxerr << "InsetCollapsable: edit left/right" << endl;
454 InsetText::edit(cur, front, entry_from);
458 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
460 //lyxerr << "InsetCollapsable: edit xy" << endl;
461 if (geometry() == ButtonOnly
462 || (button_dim.contains(x, y)
463 && geometry() != NoButton))
466 return InsetText::editXY(cur, x, y);
470 void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
472 //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
473 // << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
475 switch (cmd.action) {
476 case LFUN_MOUSE_PRESS:
477 if (hitButton(cmd)) {
478 switch (cmd.button()) {
479 case mouse_button::button1:
480 case mouse_button::button3:
481 // Pass the command to the enclosing InsetText,
482 // so that the cursor gets set.
485 case mouse_button::none:
486 case mouse_button::button2:
487 case mouse_button::button4:
488 case mouse_button::button5:
493 } else if (geometry() != ButtonOnly)
494 InsetText::doDispatch(cur, cmd);
499 case LFUN_MOUSE_MOTION:
500 case LFUN_MOUSE_DOUBLE:
501 case LFUN_MOUSE_TRIPLE:
504 else if (geometry() != ButtonOnly)
505 InsetText::doDispatch(cur, cmd);
510 case LFUN_MOUSE_RELEASE:
511 if (!hitButton(cmd)) {
512 // The mouse click has to be within the inset!
513 if (geometry() != ButtonOnly)
514 InsetText::doDispatch(cur, cmd);
519 if (cmd.button() != mouse_button::button1) {
524 // if we are selecting, we do not want to
528 // Left button is clicked, the user asks to
529 // toggle the inset visual state.
531 cur.updateFlags(Update::Force | Update::FitCursor);
532 if (geometry() == ButtonOnly) {
533 setStatus(cur, Open);
537 setStatus(cur, Collapsed);
538 cur.bv().cursor() = cur;
541 case LFUN_INSET_TOGGLE:
542 if (cmd.argument() == "open")
543 setStatus(cur, Open);
544 else if (cmd.argument() == "close")
545 setStatus(cur, Collapsed);
546 else if (cmd.argument() == "toggle" || cmd.argument().empty())
547 if (status_ == Open) {
548 setStatus(cur, Collapsed);
549 if (geometry() == ButtonOnly)
550 cur.top().forwardPos();
552 setStatus(cur, Open);
553 else // if assign or anything else
559 case LFUN_CLIPBOARD_PASTE:
560 case LFUN_PRIMARY_SELECTION_PASTE: {
561 InsetText::doDispatch(cur, cmd);
562 // Since we can only store plain text, we must reset all
564 // FIXME: Change only the pasted paragraphs
566 resetParagraphsFont();
571 if (layout_ && layout_->isForceLtr()) {
572 // Force any new text to latex_language
573 // FIXME: This should only be necessary in constructor, but
574 // new paragraphs that are created by pressing enter at the
575 // start of an existing paragraph get the buffer language
576 // and not latex_language, so we take this brute force
578 cur.current_font.setLanguage(latex_language);
579 cur.real_current_font.setLanguage(latex_language);
581 InsetText::doDispatch(cur, cmd);
587 bool InsetCollapsable::allowMultiPar() const
589 return layout_->isMultiPar();
593 void InsetCollapsable::resetParagraphsFont()
596 font.fontInfo() = inherit_font;
597 if (layout_->isForceLtr())
598 font.setLanguage(latex_language);
599 if (layout_->isPassThru()) {
600 ParagraphList::iterator par = paragraphs().begin();
601 ParagraphList::iterator const end = paragraphs().end();
603 par->resetFonts(font);
604 par->params().clear();
611 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
612 FuncStatus & flag) const
614 switch (cmd.action) {
615 // FIXME At present, these are being enabled and disabled according to
616 // whether PASSTHRU has been set in the InsetLayout. This makes some
617 // sense, but there are other checks that should really be done. E.g.,
618 // one should not be able to inset IndexPrint inside an optional argument!!
619 case LFUN_ACCENT_ACUTE:
620 case LFUN_ACCENT_BREVE:
621 case LFUN_ACCENT_CARON:
622 case LFUN_ACCENT_CEDILLA:
623 case LFUN_ACCENT_CIRCLE:
624 case LFUN_ACCENT_CIRCUMFLEX:
625 case LFUN_ACCENT_DOT:
626 case LFUN_ACCENT_GRAVE:
627 case LFUN_ACCENT_HUNGARIAN_UMLAUT:
628 case LFUN_ACCENT_MACRON:
629 case LFUN_ACCENT_OGONEK:
630 case LFUN_ACCENT_TIE:
631 case LFUN_ACCENT_TILDE:
632 case LFUN_ACCENT_UMLAUT:
633 case LFUN_ACCENT_UNDERBAR:
634 case LFUN_ACCENT_UNDERDOT:
636 case LFUN_BOX_INSERT:
637 case LFUN_BRANCH_INSERT:
638 case LFUN_NEWLINE_INSERT:
639 case LFUN_CAPTION_INSERT:
640 case LFUN_DEPTH_DECREMENT:
641 case LFUN_DEPTH_INCREMENT:
642 case LFUN_ERT_INSERT:
643 case LFUN_FILE_INSERT:
644 case LFUN_FLEX_INSERT:
645 case LFUN_FLOAT_INSERT:
646 case LFUN_FLOAT_LIST_INSERT:
647 case LFUN_FLOAT_WIDE_INSERT:
649 case LFUN_FONT_BOLDSYMBOL:
650 case LFUN_FONT_TYPEWRITER:
651 case LFUN_FONT_DEFAULT:
653 case LFUN_TEXTSTYLE_APPLY:
654 case LFUN_TEXTSTYLE_UPDATE:
656 case LFUN_FONT_ROMAN:
661 case LFUN_FONT_STATE:
662 case LFUN_FONT_UNDERLINE:
663 case LFUN_FOOTNOTE_INSERT:
664 case LFUN_HYPERLINK_INSERT:
665 case LFUN_INDEX_INSERT:
666 case LFUN_INDEX_PRINT:
667 case LFUN_INSET_INSERT:
668 case LFUN_LABEL_GOTO:
669 case LFUN_LABEL_INSERT:
670 case LFUN_LINE_INSERT:
671 case LFUN_NEWPAGE_INSERT:
672 case LFUN_LAYOUT_TABULAR:
673 case LFUN_MARGINALNOTE_INSERT:
674 case LFUN_MATH_DISPLAY:
675 case LFUN_MATH_INSERT:
676 case LFUN_MATH_MATRIX:
680 case LFUN_NOMENCL_INSERT:
681 case LFUN_NOMENCL_PRINT:
682 case LFUN_NOTE_INSERT:
684 case LFUN_OPTIONAL_INSERT:
685 case LFUN_REFERENCE_NEXT:
686 case LFUN_SERVER_GOTO_FILE_ROW:
687 case LFUN_SERVER_NOTIFY:
688 case LFUN_SERVER_SET_XY:
689 case LFUN_SPACE_INSERT:
690 case LFUN_SPECIALCHAR_INSERT:
691 case LFUN_TABULAR_INSERT:
692 case LFUN_TOC_INSERT:
693 case LFUN_WRAP_INSERT:
694 if (layout_->isPassThru()) {
695 flag.setEnabled(false);
698 return InsetText::getStatus(cur, cmd, flag);
700 case LFUN_INSET_TOGGLE:
701 if (cmd.argument() == "open")
702 flag.setEnabled(status_ != Open);
703 else if (cmd.argument() == "close")
704 flag.setEnabled(status_ == Open);
705 else if (cmd.argument() == "toggle" || cmd.argument().empty()) {
706 flag.setEnabled(true);
707 flag.setOnOff(status_ == Open);
709 flag.setEnabled(false);
713 flag.setEnabled(!layout_->isForceLtr());
714 return InsetText::getStatus(cur, cmd, flag);
716 case LFUN_BREAK_PARAGRAPH:
717 flag.setEnabled(layout_->isMultiPar());
721 return InsetText::getStatus(cur, cmd, flag);
726 void InsetCollapsable::setLabel(docstring const & l)
732 void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
736 if (status_ == Collapsed) {
737 cur.leaveInset(*this);
738 mouse_hover_ = false;
743 docstring InsetCollapsable::floatName(
744 string const & type, BufferParams const & bp) const
746 FloatList const & floats = bp.documentClass().floats();
747 FloatList::const_iterator it = floats[type];
749 return (it == floats.end()) ? from_ascii(type) : bp.B_(it->second.name());
753 InsetLayout::InsetDecoration InsetCollapsable::decoration() const
756 return InsetLayout::CLASSIC;
757 InsetLayout::InsetDecoration const dec = layout_->decoration();
759 case InsetLayout::CLASSIC:
760 case InsetLayout::MINIMALISTIC:
761 case InsetLayout::CONGLOMERATE:
763 case InsetLayout::DEFAULT:
766 if (lyxCode() == FLEX_CODE)
767 return InsetLayout::CONGLOMERATE;
768 return InsetLayout::CLASSIC;
772 int InsetCollapsable::latex(odocstream & os,
773 OutputParams const & runparams) const
775 // FIXME: What should we do layout_ is 0?
777 // 2) through an error
781 // This implements the standard way of handling the LaTeX output of
782 // a collapsable inset, either a command or an environment. Standard
783 // collapsable insets should not redefine this, non-standard ones may
785 if (!layout_->latexname().empty()) {
786 if (layout_->latextype() == InsetLayout::COMMAND) {
788 if (runparams.moving_arg)
790 os << '\\' << from_utf8(layout_->latexname());
791 if (!layout_->latexparam().empty())
792 os << from_utf8(layout_->latexparam());
794 } else if (layout_->latextype() == InsetLayout::ENVIRONMENT) {
795 os << "%\n\\begin{" << from_utf8(layout_->latexname()) << "}\n";
796 if (!layout_->latexparam().empty())
797 os << from_utf8(layout_->latexparam());
800 OutputParams rp = runparams;
801 if (layout_->isPassThru())
803 if (layout_->isNeedProtect())
804 rp.moving_arg = true;
805 int i = InsetText::latex(os, rp);
806 if (!layout_->latexname().empty()) {
807 if (layout_->latextype() == InsetLayout::COMMAND) {
809 } else if (layout_->latextype() == InsetLayout::ENVIRONMENT) {
810 os << "\n\\end{" << from_utf8(layout_->latexname()) << "}\n";
818 void InsetCollapsable::validate(LaTeXFeatures & features) const
820 string const preamble = getLayout().preamble();
821 if (!preamble.empty())
822 features.addPreambleSnippet(preamble);
823 features.require(getLayout().requires());
824 InsetText::validate(features);
828 bool InsetCollapsable::undefined() const
830 docstring const & n = getLayout().name();
831 return n.empty() || n == DocumentClass::plainInsetLayout().name();
835 docstring InsetCollapsable::contextMenu(BufferView const & bv, int x,
838 if (decoration() == InsetLayout::CONGLOMERATE)
839 return from_ascii("context-conglomerate");
841 if (geometry() == NoButton)
842 return from_ascii("context-collapsable");
844 Dimension dim = dimensionCollapsed();
845 if (x < xo(bv) + dim.wid && y < yo(bv) + dim.des)
846 return from_ascii("context-collapsable");
848 return InsetText::contextMenu(bv, x, y);