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 "FuncStatus.h"
26 #include "LaTeXFeatures.h"
28 #include "FuncRequest.h"
29 #include "MetricsInfo.h"
30 #include "ParagraphParameters.h"
31 #include "TextClass.h"
33 #include "frontends/FontMetrics.h"
34 #include "frontends/Painter.h"
36 #include "support/debug.h"
37 #include "support/docstream.h"
38 #include "support/gettext.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;
135 layout_ = &TextClass::emptyInsetLayout();
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 //this must be set before we enter InsetText::read()
188 setLayout(buf.params());
190 InsetText::read(buf, lex);
193 status_ = isOpen() ? Open : Collapsed;
195 // Force default font, if so requested
196 // This avoids paragraphs in buffer language that would have a
197 // foreign language after a document language change, and it ensures
198 // that all new text in ERT and similar gets the "latex" language,
199 // since new text inherits the language from the last position of the
200 // existing text. As a side effect this makes us also robust against
201 // bugs in LyX that might lead to font changes in ERT in .lyx files.
202 resetParagraphsFont();
206 Dimension InsetCollapsable::dimensionCollapsed() const
208 BOOST_ASSERT(layout_);
210 theFontMetrics(layout_->labelfont).buttonText(
211 labelstring_, dim.wid, dim.asc, dim.des);
216 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
218 BOOST_ASSERT(layout_);
220 autoOpen_ = mi.base.bv->cursor().isInside(this);
222 FontInfo tmpfont = mi.base.font;
223 mi.base.font = layout_->font;
224 mi.base.font.realize(tmpfont);
226 switch (geometry()) {
228 InsetText::metrics(mi, dim);
231 InsetText::metrics(mi, dim);
236 InsetText::metrics(mi, dim);
237 // consider width of the inset label
238 FontInfo font(layout_->labelfont);
239 font.realize(sane_font);
245 theFontMetrics(font).rectText(labelstring_, w, a, d);
252 dim = dimensionCollapsed();
253 if (geometry() == TopButton
254 || geometry() == LeftButton) {
256 InsetText::metrics(mi, textdim);
257 openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
259 // Correct for button width.
260 dim.wid += textdim.wid;
261 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
262 dim.asc = textdim.asc;
264 dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
265 dim.wid = max(dim.wid, textdim.wid);
271 mi.base.font = tmpfont;
275 bool InsetCollapsable::setMouseHover(bool mouse_hover)
277 mouse_hover_ = mouse_hover;
282 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
284 BOOST_ASSERT(layout_);
286 autoOpen_ = pi.base.bv->cursor().isInside(this);
287 ColorCode const old_color = pi.background_color;
288 pi.background_color = backgroundColor();
290 FontInfo tmpfont = pi.base.font;
291 pi.base.font = layout_->font;
292 pi.base.font.realize(tmpfont);
294 // Draw button first -- top, left or only
295 Dimension dimc = dimensionCollapsed();
297 if (geometry() == TopButton ||
298 geometry() == LeftButton ||
299 geometry() == ButtonOnly) {
300 button_dim.x1 = x + 0;
301 button_dim.x2 = x + dimc.width();
302 button_dim.y1 = y - dimc.asc;
303 button_dim.y2 = y + dimc.des;
305 pi.pain.buttonText(x, y, labelstring_, layout_->labelfont,
314 Dimension const textdim = InsetText::dimension(*pi.base.bv);
315 int const baseline = y;
317 switch (geometry()) {
319 textx = x + dimc.width();
321 InsetText::draw(pi, textx, texty);
325 texty = baseline + dimc.des + textdim.asc;
326 InsetText::draw(pi, textx, texty);
333 InsetText::draw(pi, textx, texty);
339 const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
340 InsetText::draw(pi, textx, texty);
341 const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
343 int desc = textdim.descent();
344 if (geometry() == Corners)
347 const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
348 const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
349 pi.pain.line(xx1, y + desc - 4,
351 layout_->labelfont.color());
353 pi.pain.line(xx1, y + desc,
355 layout_->labelfont.color());
357 // Make status_ value visible:
358 pi.pain.line(xx1, y + desc,
360 layout_->labelfont.color());
361 pi.pain.line(xx2 - 4, y + desc,
363 layout_->labelfont.color());
365 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3, y + desc - 4,
366 layout_->labelfont.color());
368 // the label below the text. Can be toggled.
369 if (geometry() == SubLabel) {
370 FontInfo font(layout_->labelfont);
371 font.realize(sane_font);
377 theFontMetrics(font).rectText(labelstring_, w, a, d);
378 int const ww = max(textdim.wid, w);
379 pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
380 labelstring_, font, Color_none, Color_none);
384 // a visual cue when the cursor is inside the inset
385 Cursor & cur = pi.base.bv->cursor();
386 if (cur.isInside(this)) {
389 pi.pain.line(xx1, y + 4, xx1, y, layout_->labelfont.color());
390 pi.pain.line(xx1 + 4, y, xx1, y, layout_->labelfont.color());
391 pi.pain.line(xx2, y + 4, xx2, y,
392 layout_->labelfont.color());
393 pi.pain.line(xx2 - 4, y, xx2, y,
394 layout_->labelfont.color());
398 pi.background_color = old_color;
400 pi.base.font = tmpfont;
404 void InsetCollapsable::cursorPos(BufferView const & bv,
405 CursorSlice const & sl, bool boundary, int & x, int & y) const
407 if (geometry() == ButtonOnly)
409 BOOST_ASSERT(geometry() != ButtonOnly);
411 InsetText::cursorPos(bv, sl, boundary, x, y);
412 Dimension const textdim = InsetText::dimension(bv);
414 switch (geometry()) {
416 x += dimensionCollapsed().wid;
419 y += dimensionCollapsed().des + textdim.asc;
434 Inset::EDITABLE InsetCollapsable::editable() const
436 return geometry() != ButtonOnly? HIGHLY_EDITABLE : IS_EDITABLE;
440 bool InsetCollapsable::descendable() const
442 return geometry() != ButtonOnly;
446 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
448 return button_dim.contains(cmd.x, cmd.y);
452 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
455 pos_type const max_length = 15;
456 pos_type const p_siz = paragraphs().begin()->size();
457 pos_type const n = min(max_length, p_siz);
460 for (; i < n && j < p_siz; ++j) {
461 if (paragraphs().begin()->isInset(j))
463 label += paragraphs().begin()->getChar(j);
466 if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
469 return label.empty() ? l : label;
473 void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
475 //lyxerr << "InsetCollapsable: edit left/right" << endl;
477 InsetText::edit(cur, front, entry_from);
481 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
483 //lyxerr << "InsetCollapsable: edit xy" << endl;
484 if (geometry() == ButtonOnly
485 || (button_dim.contains(x, y)
486 && geometry() != NoButton))
489 return InsetText::editXY(cur, x, y);
493 void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
495 //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
496 // << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
498 switch (cmd.action) {
499 case LFUN_MOUSE_PRESS:
500 if (cmd.button() == mouse_button::button1
502 && geometry() != NoButton) {
503 // reset selection if necessary (see bug 3060)
505 cur.bv().cursor().clearSelection();
511 if (geometry() == NoButton)
512 InsetText::doDispatch(cur, cmd);
513 else if (geometry() != ButtonOnly
515 InsetText::doDispatch(cur, cmd);
520 case LFUN_MOUSE_MOTION:
521 case LFUN_MOUSE_DOUBLE:
522 case LFUN_MOUSE_TRIPLE:
523 if (geometry() == NoButton)
524 InsetText::doDispatch(cur, cmd);
525 else if (geometry() != ButtonOnly
527 InsetText::doDispatch(cur, cmd);
532 case LFUN_MOUSE_RELEASE:
533 if (cmd.button() == mouse_button::button3) {
534 // There is no button to right click:
535 if (decoration() == Minimalistic ||
536 geometry() == Corners ||
537 geometry() == SubLabel ||
538 geometry() == NoButton
541 setStatus(cur, Collapsed);
543 setStatus(cur, Open);
547 // configuration dialog
548 showInsetDialog(&cur.bv());
553 if (geometry() == NoButton) {
554 // The mouse click has to be within the inset!
555 InsetText::doDispatch(cur, cmd);
559 if (cmd.button() == mouse_button::button1 && hitButton(cmd)) {
560 // if we are selecting, we do not want to
564 // Left button is clicked, the user asks to
565 // toggle the inset visual state.
567 cur.updateFlags(Update::Force | Update::FitCursor);
568 if (geometry() == ButtonOnly) {
569 setStatus(cur, Open);
573 setStatus(cur, Collapsed);
575 cur.bv().cursor() = cur;
579 // The mouse click is within the opened inset.
580 if (geometry() == TopButton
581 || geometry() == LeftButton)
582 InsetText::doDispatch(cur, cmd);
585 case LFUN_INSET_TOGGLE:
586 if (cmd.argument() == "open")
587 setStatus(cur, Open);
588 else if (cmd.argument() == "close")
589 setStatus(cur, Collapsed);
590 else if (cmd.argument() == "toggle" || cmd.argument().empty())
591 if (status_ == Open) {
592 setStatus(cur, Collapsed);
593 if (geometry() == ButtonOnly)
594 cur.top().forwardPos();
596 setStatus(cur, Open);
597 else // if assign or anything else
603 case LFUN_CLIPBOARD_PASTE:
604 case LFUN_PRIMARY_SELECTION_PASTE: {
605 InsetText::doDispatch(cur, cmd);
606 // Since we can only store plain text, we must reset all
608 // FIXME: Change only the pasted paragraphs
610 resetParagraphsFont();
615 if (layout_ && layout_->forceltr) {
616 // Force any new text to latex_language
617 // FIXME: This should only be necessary in constructor, but
618 // new paragraphs that are created by pressing enter at the
619 // start of an existing paragraph get the buffer language
620 // and not latex_language, so we take this brute force
622 cur.current_font.setLanguage(latex_language);
623 cur.real_current_font.setLanguage(latex_language);
625 InsetText::doDispatch(cur, cmd);
631 bool InsetCollapsable::allowMultiPar() const
633 return layout_->multipar;
637 void InsetCollapsable::resetParagraphsFont()
640 font.fontInfo() = inherit_font;
641 if (layout_->forceltr)
642 font.setLanguage(latex_language);
643 if (layout_->passthru) {
644 ParagraphList::iterator par = paragraphs().begin();
645 ParagraphList::iterator const end = paragraphs().end();
647 par->resetFonts(font);
648 par->params().clear();
655 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
656 FuncStatus & flag) const
658 switch (cmd.action) {
660 case LFUN_ACCENT_ACUTE:
661 case LFUN_ACCENT_BREVE:
662 case LFUN_ACCENT_CARON:
663 case LFUN_ACCENT_CEDILLA:
664 case LFUN_ACCENT_CIRCLE:
665 case LFUN_ACCENT_CIRCUMFLEX:
666 case LFUN_ACCENT_DOT:
667 case LFUN_ACCENT_GRAVE:
668 case LFUN_ACCENT_HUNGARIAN_UMLAUT:
669 case LFUN_ACCENT_MACRON:
670 case LFUN_ACCENT_OGONEK:
671 case LFUN_ACCENT_SPECIAL_CARON:
672 case LFUN_ACCENT_TIE:
673 case LFUN_ACCENT_TILDE:
674 case LFUN_ACCENT_UMLAUT:
675 case LFUN_ACCENT_UNDERBAR:
676 case LFUN_ACCENT_UNDERDOT:
678 case LFUN_BIBITEM_INSERT:
679 case LFUN_BOX_INSERT:
680 case LFUN_BRANCH_INSERT:
682 case LFUN_CAPTION_INSERT:
683 case LFUN_CLEARPAGE_INSERT:
684 case LFUN_CLEARDOUBLEPAGE_INSERT:
685 case LFUN_DEPTH_DECREMENT:
686 case LFUN_DEPTH_INCREMENT:
687 case LFUN_ENVIRONMENT_INSERT:
688 case LFUN_ERT_INSERT:
689 case LFUN_FILE_INSERT:
690 case LFUN_FLEX_INSERT:
691 case LFUN_FLOAT_INSERT:
692 case LFUN_FLOAT_LIST:
693 case LFUN_FLOAT_WIDE_INSERT:
695 case LFUN_FONT_TYPEWRITER:
696 case LFUN_FONT_DEFAULT:
698 case LFUN_FONT_FREE_APPLY:
699 case LFUN_FONT_FREE_UPDATE:
701 case LFUN_FONT_ROMAN:
706 case LFUN_FONT_STATE:
707 case LFUN_FONT_UNDERLINE:
708 case LFUN_FOOTNOTE_INSERT:
709 case LFUN_HFILL_INSERT:
710 case LFUN_HYPERLINK_INSERT:
711 case LFUN_INDEX_INSERT:
712 case LFUN_INDEX_PRINT:
713 case LFUN_INSET_INSERT:
714 case LFUN_LABEL_GOTO:
715 case LFUN_LABEL_INSERT:
716 case LFUN_LINE_INSERT:
717 case LFUN_NEWPAGE_INSERT:
718 case LFUN_PAGEBREAK_INSERT:
720 case LFUN_LAYOUT_PARAGRAPH:
721 case LFUN_LAYOUT_TABULAR:
722 case LFUN_MARGINALNOTE_INSERT:
723 case LFUN_MATH_DISPLAY:
724 case LFUN_MATH_INSERT:
725 case LFUN_MATH_MATRIX:
729 case LFUN_NOMENCL_INSERT:
730 case LFUN_NOMENCL_PRINT:
731 case LFUN_NOTE_INSERT:
733 case LFUN_OPTIONAL_INSERT:
734 case LFUN_PARAGRAPH_PARAMS:
735 case LFUN_PARAGRAPH_PARAMS_APPLY:
736 case LFUN_PARAGRAPH_SPACING:
737 case LFUN_PARAGRAPH_UPDATE:
738 case LFUN_REFERENCE_NEXT:
739 case LFUN_SERVER_GOTO_FILE_ROW:
740 case LFUN_SERVER_NOTIFY:
741 case LFUN_SERVER_SET_XY:
742 case LFUN_SPACE_INSERT:
743 case LFUN_SPECIALCHAR_INSERT:
744 case LFUN_TABULAR_INSERT:
745 case LFUN_TOC_INSERT:
746 case LFUN_WRAP_INSERT:
747 if (layout_->passthru) {
751 return InsetText::getStatus(cur, cmd, flag);
753 case LFUN_INSET_TOGGLE:
754 if (cmd.argument() == "open" || cmd.argument() == "close" ||
755 cmd.argument() == "toggle")
762 flag.enabled(!layout_->forceltr);
763 return InsetText::getStatus(cur, cmd, flag);
765 case LFUN_BREAK_PARAGRAPH:
766 case LFUN_BREAK_PARAGRAPH_SKIP:
767 flag.enabled(layout_->multipar);
771 return InsetText::getStatus(cur, cmd, flag);
776 void InsetCollapsable::setLabel(docstring const & l)
782 void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
786 if (status_ == Collapsed)
787 cur.leaveInset(*this);
791 docstring InsetCollapsable::floatName(string const & type, BufferParams const & bp) const
793 FloatList const & floats = bp.getTextClass().floats();
794 FloatList::const_iterator it = floats[type];
796 return (it == floats.end()) ? from_ascii(type) : bp.B_(it->second.name());
800 InsetCollapsable::Decoration InsetCollapsable::decoration() const
802 if (!layout_ || layout_->decoration == "classic")
804 if (layout_->decoration == "minimalistic")
806 if (layout_->decoration == "conglomerate")
808 if (lyxCode() == FLEX_CODE)
809 // FIXME: Is this really necessary?
815 bool InsetCollapsable::isMacroScope(Buffer const &) const
817 // layout_ == 0 leads to no latex output, so ignore
818 // the macros outside
822 // see InsetCollapsable::latex(...) below. In these case
823 // an environment is opened there
824 if (!layout_->latexname.empty())
831 int InsetCollapsable::latex(Buffer const & buf, odocstream & os,
832 OutputParams const & runparams) const
834 // FIXME: What should we do layout_ is 0?
836 // 2) through an error
840 // This implements the standard way of handling the LaTeX output of
841 // a collapsable inset, either a command or an environment. Standard
842 // collapsable insets should not redefine this, non-standard ones may
844 if (!layout_->latexname.empty()) {
845 if (layout_->latextype == "command") {
847 if (runparams.moving_arg)
849 os << '\\' << from_utf8(layout_->latexname);
850 if (!layout_->latexparam.empty())
851 os << from_utf8(layout_->latexparam);
853 } else if (layout_->latextype == "environment") {
854 os << "%\n\\begin{" << from_utf8(layout_->latexname) << "}\n";
855 if (!layout_->latexparam.empty())
856 os << from_utf8(layout_->latexparam);
859 OutputParams rp = runparams;
860 if (layout_->passthru)
862 if (layout_->needprotect)
863 rp.moving_arg = true;
864 int i = InsetText::latex(buf, os, rp);
865 if (!layout_->latexname.empty()) {
866 if (layout_->latextype == "command") {
868 } else if (layout_->latextype == "environment") {
869 os << "\n\\end{" << from_utf8(layout_->latexname) << "}\n";
877 void InsetCollapsable::validate(LaTeXFeatures & features) const
882 // Force inclusion of preamble snippet in layout file
883 features.require(layout_->name);
884 InsetText::validate(features);
888 bool InsetCollapsable::undefined() const
890 std::string const & n = getLayout().name;
891 return n.empty() || n == TextClass::emptyInsetLayout().name;