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 "paragraph_funcs.h"
32 #include "ParagraphParameters.h"
34 #include "TextClass.h"
36 #include "frontends/FontMetrics.h"
37 #include "frontends/Painter.h"
39 #include "support/debug.h"
40 #include "support/docstream.h"
41 #include "support/gettext.h"
42 #include "support/lassert.h"
49 InsetCollapsable::CollapseStatus InsetCollapsable::status(BufferView const & bv) const
51 if (decoration() == InsetLayout::CONGLOMERATE)
53 return auto_open_[&bv] ? Open : status_;
57 InsetCollapsable::Geometry InsetCollapsable::geometry(BufferView const & bv) const
59 switch (decoration()) {
60 case InsetLayout::CLASSIC:
61 if (status(bv) == Open)
62 return openinlined_ ? LeftButton : TopButton;
65 case InsetLayout::MINIMALISTIC:
66 return status(bv) == Open ? NoButton : ButtonOnly ;
68 case InsetLayout::CONGLOMERATE:
69 return status(bv) == Open ? SubLabel : Corners ;
71 case InsetLayout::DEFAULT:
72 break; // this shouldn't happen
75 // dummy return value to shut down a warning,
81 InsetCollapsable::Geometry InsetCollapsable::geometry() const
83 switch (decoration()) {
84 case InsetLayout::CLASSIC:
86 return openinlined_ ? LeftButton : TopButton;
89 case InsetLayout::MINIMALISTIC:
90 return status_ == Open ? NoButton : ButtonOnly ;
92 case InsetLayout::CONGLOMERATE:
93 return status_ == Open ? SubLabel : Corners ;
95 case InsetLayout::DEFAULT:
96 break; // this shouldn't happen
99 // dummy return value to shut down a warning,
100 // this is dead code.
105 InsetCollapsable::InsetCollapsable(Buffer const & buf, InsetText::UsePlain ltype)
106 : InsetText(buf, ltype), status_(Inset::Open),
107 openinlined_(false), mouse_hover_(false)
109 setLayout(&buf.params().documentClass());
110 setAutoBreakRows(true);
112 setFrameColor(Color_collapsableframe);
116 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
118 status_(rhs.status_),
119 layout_(rhs.layout_),
120 labelstring_(rhs.labelstring_),
121 button_dim(rhs.button_dim),
122 openinlined_(rhs.openinlined_),
123 auto_open_(rhs.auto_open_),
124 // the sole purpose of this copy constructor
130 docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
132 Dimension dim = dimensionCollapsed(bv);
133 if (geometry(bv) == NoButton)
134 return translateIfPossible(layout_->labelstring());
135 if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des || isOpen(bv))
138 OutputParams rp(&buffer().params().encoding());
139 odocstringstream ods;
140 InsetText::plaintext(ods, rp);
141 docstring content_tip = ods.str();
142 // shorten it if necessary
143 if (content_tip.size() > 200)
144 content_tip = content_tip.substr(0, 200) + "...";
149 void InsetCollapsable::setLayout(BufferParams const & bp)
151 setLayout(bp.documentClassPtr());
155 void InsetCollapsable::setLayout(DocumentClass const * const dc)
158 layout_ = &(dc->insetLayout(name()));
159 labelstring_ = translateIfPossible(layout_->labelstring());
161 layout_ = &DocumentClass::plainInsetLayout();
162 labelstring_ = _("UNDEFINED");
169 void InsetCollapsable::write(ostream & os) const
181 text().write(buffer(), os);
185 void InsetCollapsable::read(Lexer & lex)
187 lex.setContext("InsetCollapsable::read");
190 lex >> "status" >> tmp_token;
191 if (tmp_token == "open")
194 // this must be set before we enter InsetText::read()
195 setLayout(buffer().params());
196 InsetText::read(lex);
197 // set button label again as the inset contents was not read yet at
201 // Force default font, if so requested
202 // This avoids paragraphs in buffer language that would have a
203 // foreign language after a document language change, and it ensures
204 // that all new text in ERT and similar gets the "latex" language,
205 // since new text inherits the language from the last position of the
206 // existing text. As a side effect this makes us also robust against
207 // bugs in LyX that might lead to font changes in ERT in .lyx files.
208 resetParagraphsFont();
212 Dimension InsetCollapsable::dimensionCollapsed(BufferView const & bv) const
214 LASSERT(layout_, /**/);
216 theFontMetrics(layout_->labelfont()).buttonText(
217 buttonLabel(bv), dim.wid, dim.asc, dim.des);
222 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
224 LASSERT(layout_, /**/);
226 auto_open_[mi.base.bv] = mi.base.bv->cursor().isInside(this);
228 FontInfo tmpfont = mi.base.font;
229 mi.base.font = layout_->font();
230 mi.base.font.realize(tmpfont);
232 BufferView const & bv = *mi.base.bv;
234 switch (geometry(bv)) {
236 InsetText::metrics(mi, dim);
239 InsetText::metrics(mi, dim);
244 InsetText::metrics(mi, dim);
245 // consider width of the inset label
246 FontInfo font(layout_->labelfont());
247 font.realize(sane_font);
253 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
260 dim = dimensionCollapsed(bv);
261 if (geometry(bv) == TopButton
262 || geometry(bv) == LeftButton) {
264 InsetText::metrics(mi, textdim);
265 openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
267 // Correct for button width.
268 dim.wid += textdim.wid;
269 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
270 dim.asc = textdim.asc;
272 dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
273 dim.wid = max(dim.wid, textdim.wid);
279 mi.base.font = tmpfont;
283 bool InsetCollapsable::setMouseHover(bool mouse_hover)
285 mouse_hover_ = mouse_hover;
290 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
292 LASSERT(layout_, /**/);
293 BufferView const & bv = *pi.base.bv;
295 auto_open_[&bv] = bv.cursor().isInside(this);
297 FontInfo tmpfont = pi.base.font;
298 pi.base.font = layout_->font();
299 pi.base.font.realize(tmpfont);
301 // Draw button first -- top, left or only
302 Dimension dimc = dimensionCollapsed(bv);
304 if (geometry(*pi.base.bv) == TopButton ||
305 geometry(*pi.base.bv) == LeftButton ||
306 geometry(*pi.base.bv) == ButtonOnly) {
307 button_dim.x1 = x + 0;
308 button_dim.x2 = x + dimc.width();
309 button_dim.y1 = y - dimc.asc;
310 button_dim.y2 = y + dimc.des;
312 pi.pain.buttonText(x, y, buttonLabel(bv), layout_->labelfont(),
321 Dimension const textdim = InsetText::dimension(bv);
322 int const baseline = y;
324 switch (geometry(bv)) {
326 textx = x + dimc.width();
328 InsetText::draw(pi, textx, texty);
332 texty = baseline + dimc.des + textdim.asc;
333 InsetText::draw(pi, textx, texty);
340 InsetText::draw(pi, textx, texty);
346 const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
347 InsetText::draw(pi, textx, texty);
348 const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
350 int desc = textdim.descent();
351 if (geometry(bv) == Corners)
354 const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
355 const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
356 pi.pain.line(xx1, y + desc - 4,
358 layout_->labelfont().color());
360 pi.pain.line(xx1, y + desc,
362 layout_->labelfont().color());
364 // Make status_ value visible:
365 pi.pain.line(xx1, y + desc,
367 layout_->labelfont().color());
368 pi.pain.line(xx2 - 4, y + desc,
370 layout_->labelfont().color());
372 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3,
373 y + desc - 4, layout_->labelfont().color());
375 // the label below the text. Can be toggled.
376 if (geometry(bv) == SubLabel) {
377 FontInfo font(layout_->labelfont());
378 font.realize(sane_font);
384 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
385 int const ww = max(textdim.wid, w);
386 pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
387 buttonLabel(bv), font, Color_none, Color_none);
391 // a visual cue when the cursor is inside the inset
392 Cursor const & cur = bv.cursor();
393 if (cur.isInside(this)) {
396 pi.pain.line(xx1, y + 4, xx1, y, layout_->labelfont().color());
397 pi.pain.line(xx1 + 4, y, xx1, y, layout_->labelfont().color());
398 pi.pain.line(xx2, y + 4, xx2, y,
399 layout_->labelfont().color());
400 pi.pain.line(xx2 - 4, y, xx2, y,
401 layout_->labelfont().color());
406 pi.base.font = tmpfont;
410 void InsetCollapsable::cursorPos(BufferView const & bv,
411 CursorSlice const & sl, bool boundary, int & x, int & y) const
413 if (geometry(bv) == ButtonOnly)
415 LASSERT(geometry(bv) != ButtonOnly, /**/);
417 InsetText::cursorPos(bv, sl, boundary, x, y);
418 Dimension const textdim = InsetText::dimension(bv);
420 switch (geometry(bv)) {
422 x += dimensionCollapsed(bv).wid;
425 y += dimensionCollapsed(bv).des + textdim.asc;
440 bool InsetCollapsable::editable() const
442 return geometry() != ButtonOnly;
446 bool InsetCollapsable::descendable() const
448 return geometry() != ButtonOnly;
452 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
454 return button_dim.contains(cmd.x, cmd.y);
458 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
461 pos_type const max_length = 15;
462 pos_type const p_siz = paragraphs().begin()->size();
463 pos_type const n = min(max_length, p_siz);
466 for (; i < n && j < p_siz; ++j) {
467 if (paragraphs().begin()->isInset(j))
469 label += paragraphs().begin()->getChar(j);
472 if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
475 return label.empty() ? l : label;
479 void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
481 //lyxerr << "InsetCollapsable: edit left/right" << endl;
483 InsetText::edit(cur, front, entry_from);
487 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
489 //lyxerr << "InsetCollapsable: edit xy" << endl;
490 if (geometry(cur.bv()) == ButtonOnly
491 || (button_dim.contains(x, y)
492 && geometry(cur.bv()) != NoButton))
495 return InsetText::editXY(cur, x, y);
499 void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
501 //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
502 // << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
504 switch (cmd.action) {
505 case LFUN_MOUSE_PRESS:
506 if (hitButton(cmd)) {
507 switch (cmd.button()) {
508 case mouse_button::button1:
509 case mouse_button::button3:
510 // Pass the command to the enclosing InsetText,
511 // so that the cursor gets set.
514 case mouse_button::none:
515 case mouse_button::button2:
516 case mouse_button::button4:
517 case mouse_button::button5:
522 } else if (geometry(cur.bv()) != ButtonOnly)
523 InsetText::doDispatch(cur, cmd);
528 case LFUN_MOUSE_MOTION:
529 case LFUN_MOUSE_DOUBLE:
530 case LFUN_MOUSE_TRIPLE:
533 else if (geometry(cur.bv()) != ButtonOnly)
534 InsetText::doDispatch(cur, cmd);
539 case LFUN_MOUSE_RELEASE:
540 if (!hitButton(cmd)) {
541 // The mouse click has to be within the inset!
542 if (geometry(cur.bv()) != ButtonOnly)
543 InsetText::doDispatch(cur, cmd);
548 if (cmd.button() != mouse_button::button1) {
553 // if we are selecting, we do not want to
557 // Left button is clicked, the user asks to
558 // toggle the inset visual state.
560 cur.updateFlags(Update::Force | Update::FitCursor);
561 if (geometry(cur.bv()) == ButtonOnly) {
562 setStatus(cur, Open);
566 setStatus(cur, Collapsed);
567 cur.bv().cursor() = cur;
570 case LFUN_INSET_TOGGLE:
571 if (cmd.argument() == "open")
572 setStatus(cur, Open);
573 else if (cmd.argument() == "close")
574 setStatus(cur, Collapsed);
575 else if (cmd.argument() == "toggle" || cmd.argument().empty())
576 if (status_ == Open) {
577 setStatus(cur, Collapsed);
578 if (geometry(cur.bv()) == ButtonOnly)
579 cur.top().forwardPos();
581 setStatus(cur, Open);
582 else // if assign or anything else
588 case LFUN_CLIPBOARD_PASTE:
589 case LFUN_PRIMARY_SELECTION_PASTE: {
590 InsetText::doDispatch(cur, cmd);
591 // Since we can only store plain text, we must reset all
593 // FIXME: Change only the pasted paragraphs
595 resetParagraphsFont();
600 if (layout_ && layout_->isForceLtr()) {
601 // Force any new text to latex_language
602 // FIXME: This should only be necessary in constructor, but
603 // new paragraphs that are created by pressing enter at the
604 // start of an existing paragraph get the buffer language
605 // and not latex_language, so we take this brute force
607 cur.current_font.setLanguage(latex_language);
608 cur.real_current_font.setLanguage(latex_language);
610 InsetText::doDispatch(cur, cmd);
616 bool InsetCollapsable::allowMultiPar() const
618 return layout_->isMultiPar();
622 void InsetCollapsable::resetParagraphsFont()
624 Font font(inherit_font, buffer().params().language);
625 if (layout_->isForceLtr())
626 font.setLanguage(latex_language);
627 if (layout_->isPassThru()) {
628 ParagraphList::iterator par = paragraphs().begin();
629 ParagraphList::iterator const end = paragraphs().end();
631 par->resetFonts(font);
632 par->params().clear();
639 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
640 FuncStatus & flag) const
642 switch (cmd.action) {
643 // FIXME At present, these are being enabled and disabled according to
644 // whether PASSTHRU has been set in the InsetLayout. This makes some
645 // sense, but there are other checks that should really be done. E.g.,
646 // one should not be able to inset IndexPrint inside an optional argument!!
647 case LFUN_ACCENT_ACUTE:
648 case LFUN_ACCENT_BREVE:
649 case LFUN_ACCENT_CARON:
650 case LFUN_ACCENT_CEDILLA:
651 case LFUN_ACCENT_CIRCLE:
652 case LFUN_ACCENT_CIRCUMFLEX:
653 case LFUN_ACCENT_DOT:
654 case LFUN_ACCENT_GRAVE:
655 case LFUN_ACCENT_HUNGARIAN_UMLAUT:
656 case LFUN_ACCENT_MACRON:
657 case LFUN_ACCENT_OGONEK:
658 case LFUN_ACCENT_TIE:
659 case LFUN_ACCENT_TILDE:
660 case LFUN_ACCENT_UMLAUT:
661 case LFUN_ACCENT_UNDERBAR:
662 case LFUN_ACCENT_UNDERDOT:
664 case LFUN_BOX_INSERT:
665 case LFUN_BRANCH_INSERT:
666 case LFUN_NEWLINE_INSERT:
667 case LFUN_CAPTION_INSERT:
668 case LFUN_DEPTH_DECREMENT:
669 case LFUN_DEPTH_INCREMENT:
670 case LFUN_ERT_INSERT:
671 case LFUN_FILE_INSERT:
672 case LFUN_FLEX_INSERT:
673 case LFUN_FLOAT_INSERT:
674 case LFUN_FLOAT_LIST_INSERT:
675 case LFUN_FLOAT_WIDE_INSERT:
677 case LFUN_FONT_BOLDSYMBOL:
678 case LFUN_FONT_TYPEWRITER:
679 case LFUN_FONT_DEFAULT:
681 case LFUN_TEXTSTYLE_APPLY:
682 case LFUN_TEXTSTYLE_UPDATE:
684 case LFUN_FONT_ROMAN:
689 case LFUN_FONT_STATE:
690 case LFUN_FONT_UNDERLINE:
691 case LFUN_FONT_STRIKEOUT:
692 case LFUN_FOOTNOTE_INSERT:
693 case LFUN_HYPERLINK_INSERT:
694 case LFUN_INDEX_INSERT:
695 case LFUN_INDEX_PRINT:
696 case LFUN_INSET_INSERT:
697 case LFUN_LABEL_GOTO:
698 case LFUN_LABEL_INSERT:
699 case LFUN_LINE_INSERT:
700 case LFUN_NEWPAGE_INSERT:
701 case LFUN_LAYOUT_TABULAR:
702 case LFUN_MARGINALNOTE_INSERT:
703 case LFUN_MATH_DISPLAY:
704 case LFUN_MATH_INSERT:
705 case LFUN_MATH_MATRIX:
709 case LFUN_NOMENCL_INSERT:
710 case LFUN_NOMENCL_PRINT:
711 case LFUN_NOTE_INSERT:
713 case LFUN_OPTIONAL_INSERT:
714 case LFUN_PHANTOM_INSERT:
715 case LFUN_REFERENCE_NEXT:
716 case LFUN_SERVER_GOTO_FILE_ROW:
717 case LFUN_SERVER_NOTIFY:
718 case LFUN_SERVER_SET_XY:
719 case LFUN_SPACE_INSERT:
720 case LFUN_SPECIALCHAR_INSERT:
721 case LFUN_TABULAR_INSERT:
722 case LFUN_TOC_INSERT:
723 case LFUN_WRAP_INSERT:
724 if (layout_->isPassThru()) {
725 flag.setEnabled(false);
728 return InsetText::getStatus(cur, cmd, flag);
730 case LFUN_INSET_TOGGLE:
731 if (cmd.argument() == "open")
732 flag.setEnabled(status_ != Open);
733 else if (cmd.argument() == "close")
734 flag.setEnabled(status_ == Open);
735 else if (cmd.argument() == "toggle" || cmd.argument().empty()) {
736 flag.setEnabled(true);
737 flag.setOnOff(status_ == Open);
739 flag.setEnabled(false);
743 flag.setEnabled(!layout_->isForceLtr());
744 return InsetText::getStatus(cur, cmd, flag);
746 case LFUN_BREAK_PARAGRAPH:
747 flag.setEnabled(layout_->isMultiPar());
751 return InsetText::getStatus(cur, cmd, flag);
756 void InsetCollapsable::setLabel(docstring const & l)
762 void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
766 if (status_ == Collapsed) {
767 cur.leaveInset(*this);
768 mouse_hover_ = false;
773 docstring InsetCollapsable::floatName(
774 string const & type, BufferParams const & bp) const
776 FloatList const & floats = bp.documentClass().floats();
777 FloatList::const_iterator it = floats[type];
779 return (it == floats.end()) ? from_ascii(type) : bp.B_(it->second.name());
783 InsetLayout::InsetDecoration InsetCollapsable::decoration() const
786 return InsetLayout::CLASSIC;
787 InsetLayout::InsetDecoration const dec = layout_->decoration();
789 case InsetLayout::CLASSIC:
790 case InsetLayout::MINIMALISTIC:
791 case InsetLayout::CONGLOMERATE:
793 case InsetLayout::DEFAULT:
796 if (lyxCode() == FLEX_CODE)
797 return InsetLayout::CONGLOMERATE;
798 return InsetLayout::CLASSIC;
802 int InsetCollapsable::latex(odocstream & os,
803 OutputParams const & runparams) const
805 // FIXME: What should we do layout_ is 0?
811 // This implements the standard way of handling the LaTeX output of
812 // a collapsable inset, either a command or an environment. Standard
813 // collapsable insets should not redefine this, non-standard ones may
815 if (!layout_->latexname().empty()) {
816 if (layout_->latextype() == InsetLayout::COMMAND) {
818 if (runparams.moving_arg)
820 os << '\\' << from_utf8(layout_->latexname());
821 if (!layout_->latexparam().empty())
822 os << from_utf8(layout_->latexparam());
824 } else if (layout_->latextype() == InsetLayout::ENVIRONMENT) {
825 os << "%\n\\begin{" << from_utf8(layout_->latexname()) << "}\n";
826 if (!layout_->latexparam().empty())
827 os << from_utf8(layout_->latexparam());
830 OutputParams rp = runparams;
831 if (layout_->isPassThru())
833 if (layout_->isNeedProtect())
834 rp.moving_arg = true;
835 int i = InsetText::latex(os, rp);
836 if (!layout_->latexname().empty()) {
837 if (layout_->latextype() == InsetLayout::COMMAND) {
839 } else if (layout_->latextype() == InsetLayout::ENVIRONMENT) {
840 os << "\n\\end{" << from_utf8(layout_->latexname()) << "}\n";
848 // FIXME It seems as if it ought to be possible to do this more simply,
849 // maybe by calling InsetText::docbook() in the middle there.
850 int InsetCollapsable::docbook(odocstream & os, OutputParams const & runparams) const
852 ParagraphList::const_iterator const beg = paragraphs().begin();
853 ParagraphList::const_iterator par = paragraphs().begin();
854 ParagraphList::const_iterator const end = paragraphs().end();
857 sgml::openTag(os, getLayout().latexname(),
858 par->getID(buffer(), runparams) + getLayout().latexparam());
860 for (; par != end; ++par) {
861 par->simpleDocBookOnePar(buffer(), os, runparams,
862 outerFont(distance(beg, par),
867 sgml::closeTag(os, getLayout().latexname());
873 void InsetCollapsable::validate(LaTeXFeatures & features) const
875 string const preamble = getLayout().preamble();
876 if (!preamble.empty())
877 features.addPreambleSnippet(preamble);
878 features.require(getLayout().requires());
879 InsetText::validate(features);
883 bool InsetCollapsable::undefined() const
885 docstring const & n = getLayout().name();
886 return n.empty() || n == DocumentClass::plainInsetLayout().name();
890 docstring InsetCollapsable::contextMenu(BufferView const & bv, int x,
893 if (decoration() == InsetLayout::CONGLOMERATE)
894 return from_ascii("context-conglomerate");
896 if (geometry(bv) == NoButton)
897 return from_ascii("context-collapsable");
899 Dimension dim = dimensionCollapsed(bv);
900 if (x < xo(bv) + dim.wid && y < yo(bv) + dim.des)
901 return from_ascii("context-collapsable");
903 return InsetText::contextMenu(bv, x, y);
906 void InsetCollapsable::tocString(odocstream & os) const
908 if (!getLayout().isInToc())
910 os << text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);