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"
22 #include "DispatchResult.h"
23 #include "FloatList.h"
24 #include "FuncStatus.h"
27 #include "LaTeXFeatures.h"
29 #include "FuncRequest.h"
30 #include "MetricsInfo.h"
31 #include "ParagraphParameters.h"
33 #include "frontends/FontMetrics.h"
34 #include "frontends/Painter.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
77 (BufferParams const & bp, CollapseStatus status)
78 : InsetText(bp), status_(status),
79 openinlined_(false), autoOpen_(false), mouse_hover_(false)
81 setAutoBreakRows(true);
83 setFrameColor(Color_collapsableframe);
87 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
89 button_dim(rhs.button_dim),
91 topbaseline(rhs.topbaseline),
94 openinlined_(rhs.openinlined_),
95 autoOpen_(rhs.autoOpen_),
96 // the sole purpose of this copy constructor
102 void InsetCollapsable::setLayout(BufferParams const & bp)
104 layout_ = &getLayout(bp);
105 labelstring_ = layout_->labelstring;
111 void InsetCollapsable::write(Buffer const & buf, ostream & os) const
123 text_.write(buf, os);
127 void InsetCollapsable::read(Buffer const & buf, Lexer & lex)
129 bool token_found = false;
132 string const token = lex.getString();
133 if (token == "status") {
135 string const tmp_token = lex.getString();
137 if (tmp_token == "collapsed") {
140 } else if (tmp_token == "open") {
144 lyxerr << "InsetCollapsable::read: Missing status!"
146 // Take countermeasures
147 lex.pushToken(token);
150 lyxerr << "InsetCollapsable::read: Missing 'status'-tag!"
152 // take countermeasures
153 lex.pushToken(token);
156 InsetText::read(buf, lex);
159 status_ = isOpen() ? Open : Collapsed;
161 setLayout(buf.params());
163 // Force default font, if so requested
164 // This avoids paragraphs in buffer language that would have a
165 // foreign language after a document language change, and it ensures
166 // that all new text in ERT and similar gets the "latex" language,
167 // since new text inherits the language from the last position of the
168 // existing text. As a side effect this makes us also robust against
169 // bugs in LyX that might lead to font changes in ERT in .lyx files.
170 resetParagraphsFont();
174 Dimension InsetCollapsable::dimensionCollapsed() const
177 theFontMetrics(layout_->labelfont).buttonText(
178 labelstring_, dim.wid, dim.asc, dim.des);
183 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
185 autoOpen_ = mi.base.bv->cursor().isInside(this);
187 FontInfo tmpfont = mi.base.font;
188 mi.base.font = layout_->font;
189 mi.base.font.realize(tmpfont);
191 switch (geometry()) {
193 InsetText::metrics(mi, dim);
196 InsetText::metrics(mi, dim);
201 InsetText::metrics(mi, dim);
202 // consider width of the inset label
203 FontInfo font(layout_->labelfont);
204 font.realize(sane_font);
210 theFontMetrics(font).rectText(labelstring_, w, a, d);
217 dim = dimensionCollapsed();
218 if (geometry() == TopButton
219 || geometry() == LeftButton) {
221 InsetText::metrics(mi, textdim);
222 openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
224 // Correct for button width.
225 dim.wid += textdim.wid;
226 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
227 dim.asc = textdim.asc;
229 dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
230 dim.wid = max(dim.wid, textdim.wid);
236 mi.base.font = tmpfont;
240 bool InsetCollapsable::setMouseHover(bool mouse_hover)
242 mouse_hover_ = mouse_hover;
247 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
249 autoOpen_ = pi.base.bv->cursor().isInside(this);
250 ColorCode const old_color = pi.background_color;
251 pi.background_color = backgroundColor();
253 FontInfo tmpfont = pi.base.font;
254 pi.base.font = layout_->font;
255 pi.base.font.realize(tmpfont);
257 // Draw button first -- top, left or only
258 Dimension dimc = dimensionCollapsed();
260 if (geometry() == TopButton ||
261 geometry() == LeftButton ||
262 geometry() == ButtonOnly) {
263 button_dim.x1 = x + 0;
264 button_dim.x2 = x + dimc.width();
265 button_dim.y1 = y - dimc.asc;
266 button_dim.y2 = y + dimc.des;
268 pi.pain.buttonText(x, y, labelstring_, layout_->labelfont,
277 Dimension const textdim = InsetText::dimension(*pi.base.bv);
278 int const baseline = y;
280 switch (geometry()) {
282 textx = x + dimc.width();
284 InsetText::draw(pi, textx, texty);
288 texty = baseline + dimc.des + textdim.asc;
289 InsetText::draw(pi, textx, texty);
296 InsetText::draw(pi, textx, texty);
302 const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
303 InsetText::draw(pi, textx, texty);
304 const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
306 int desc = textdim.descent();
307 if (geometry() == Corners)
310 const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
311 const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
312 pi.pain.line(xx1, y + desc - 4,
314 layout_->labelfont.color());
315 if (internalStatus() == Open)
316 pi.pain.line(xx1, y + desc,
318 layout_->labelfont.color());
320 // Make status_ value visible:
321 pi.pain.line(xx1, y + desc,
323 layout_->labelfont.color());
324 pi.pain.line(xx2 - 4, y + desc,
326 layout_->labelfont.color());
328 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3, y + desc - 4,
329 layout_->labelfont.color());
331 // the label below the text. Can be toggled.
332 if (geometry() == SubLabel) {
333 FontInfo font(layout_->labelfont);
334 font.realize(sane_font);
340 theFontMetrics(font).rectText(labelstring_, w, a, d);
341 int const ww = max(textdim.wid, w);
342 pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
343 labelstring_, font, Color_none, Color_none);
347 // a visual cue when the cursor is inside the inset
348 Cursor & cur = pi.base.bv->cursor();
349 if (cur.isInside(this)) {
352 pi.pain.line(xx1, y + 4, xx1, y, layout_->labelfont.color());
353 pi.pain.line(xx1 + 4, y, xx1, y, layout_->labelfont.color());
354 pi.pain.line(xx2, y + 4, xx2, y,
355 layout_->labelfont.color());
356 pi.pain.line(xx2 - 4, y, xx2, y,
357 layout_->labelfont.color());
361 pi.background_color = old_color;
363 pi.base.font = tmpfont;
367 void InsetCollapsable::cursorPos(BufferView const & bv,
368 CursorSlice const & sl, bool boundary, int & x, int & y) const
370 if (geometry() == ButtonOnly)
372 BOOST_ASSERT(geometry() != ButtonOnly);
374 InsetText::cursorPos(bv, sl, boundary, x, y);
375 Dimension const textdim = InsetText::dimension(bv);
377 switch (geometry()) {
379 x += dimensionCollapsed().wid;
382 y += dimensionCollapsed().des + textdim.asc;
397 Inset::EDITABLE InsetCollapsable::editable() const
399 return geometry() != ButtonOnly? HIGHLY_EDITABLE : IS_EDITABLE;
403 bool InsetCollapsable::descendable() const
405 return geometry() != ButtonOnly;
409 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
411 return button_dim.contains(cmd.x, cmd.y);
415 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
418 pos_type const max_length = 15;
419 pos_type const p_siz = paragraphs().begin()->size();
420 pos_type const n = std::min(max_length, p_siz);
423 for (; i < n && j < p_siz; ++j) {
424 if (paragraphs().begin()->isInset(j))
426 label += paragraphs().begin()->getChar(j);
429 if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
432 return label.empty() ? l : label;
436 void InsetCollapsable::edit(Cursor & cur, bool left)
438 //lyxerr << "InsetCollapsable: edit left/right" << endl;
440 InsetText::edit(cur, left);
444 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
446 //lyxerr << "InsetCollapsable: edit xy" << endl;
447 if (geometry() == ButtonOnly
448 || (button_dim.contains(x, y)
449 && geometry() != NoButton))
452 return InsetText::editXY(cur, x, y);
456 void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
458 //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
459 // << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
461 switch (cmd.action) {
462 case LFUN_MOUSE_PRESS:
463 if (cmd.button() == mouse_button::button1
465 && geometry() != NoButton) {
466 // reset selection if necessary (see bug 3060)
468 cur.bv().cursor().clearSelection();
474 if (geometry() == NoButton)
475 InsetText::doDispatch(cur, cmd);
476 else if (geometry() != ButtonOnly
478 InsetText::doDispatch(cur, cmd);
483 case LFUN_MOUSE_MOTION:
484 case LFUN_MOUSE_DOUBLE:
485 case LFUN_MOUSE_TRIPLE:
486 if (geometry() == NoButton)
487 InsetText::doDispatch(cur, cmd);
488 else if (geometry() != ButtonOnly
490 InsetText::doDispatch(cur, cmd);
495 case LFUN_MOUSE_RELEASE:
496 if (cmd.button() == mouse_button::button3) {
497 // There is no button to right click:
498 if (geometry() == Corners ||
499 geometry() == SubLabel ||
500 geometry() == NoButton) {
501 if (internalStatus() == Open)
502 setStatus(cur, Collapsed);
504 setStatus(cur, Open);
508 // configuration dialog
509 showInsetDialog(&cur.bv());
514 if (geometry() == NoButton) {
515 // The mouse click has to be within the inset!
516 InsetText::doDispatch(cur, cmd);
520 if (cmd.button() == mouse_button::button1 && hitButton(cmd)) {
521 // if we are selecting, we do not want to
525 // Left button is clicked, the user asks to
526 // toggle the inset visual state.
528 cur.updateFlags(Update::Force | Update::FitCursor);
529 if (geometry() == ButtonOnly) {
530 setStatus(cur, Open);
534 setStatus(cur, Collapsed);
536 cur.bv().cursor() = cur;
540 // The mouse click is within the opened inset.
541 if (geometry() == TopButton
542 || geometry() == LeftButton)
543 InsetText::doDispatch(cur, cmd);
546 case LFUN_INSET_TOGGLE:
547 if (cmd.argument() == "open")
548 setStatus(cur, Open);
549 else if (cmd.argument() == "close")
550 setStatus(cur, Collapsed);
551 else if (cmd.argument() == "toggle" || cmd.argument().empty())
552 if (internalStatus() == Open) {
553 setStatus(cur, Collapsed);
554 if (geometry() == ButtonOnly)
555 cur.top().forwardPos();
557 setStatus(cur, Open);
558 else // if assign or anything else
564 case LFUN_CLIPBOARD_PASTE:
565 case LFUN_PRIMARY_SELECTION_PASTE: {
566 InsetText::doDispatch(cur, cmd);
567 // Since we can only store plain text, we must reset all
569 // FIXME: Change only the pasted paragraphs
571 resetParagraphsFont();
576 if (layout_->forceltr) {
577 // Force any new text to latex_language
578 // FIXME: This should only be necessary in constructor, but
579 // new paragraphs that are created by pressing enter at the
580 // start of an existing paragraph get the buffer language
581 // and not latex_language, so we take this brute force
583 cur.current_font.setLanguage(latex_language);
584 cur.real_current_font.setLanguage(latex_language);
586 InsetText::doDispatch(cur, cmd);
592 bool InsetCollapsable::allowMultiPar() const
594 return layout_->multipar;
598 void InsetCollapsable::resetParagraphsFont()
601 font.fontInfo() = sane_font;
602 if (layout_->forceltr)
603 font.setLanguage(latex_language);
604 if (layout_->passthru) {
605 ParagraphList::iterator par = paragraphs().begin();
606 ParagraphList::iterator const end = paragraphs().end();
608 par->resetFonts(font);
609 par->params().clear();
616 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
617 FuncStatus & flag) const
619 switch (cmd.action) {
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_SPECIAL_CARON:
633 case LFUN_ACCENT_TIE:
634 case LFUN_ACCENT_TILDE:
635 case LFUN_ACCENT_UMLAUT:
636 case LFUN_ACCENT_UNDERBAR:
637 case LFUN_ACCENT_UNDERDOT:
639 case LFUN_BIBITEM_INSERT:
640 case LFUN_BOX_INSERT:
641 case LFUN_BRANCH_INSERT:
642 case LFUN_BREAK_LINE:
643 case LFUN_CAPTION_INSERT:
644 case LFUN_CLEARPAGE_INSERT:
645 case LFUN_CLEARDOUBLEPAGE_INSERT:
646 case LFUN_DEPTH_DECREMENT:
647 case LFUN_DEPTH_INCREMENT:
648 case LFUN_DOTS_INSERT:
649 case LFUN_END_OF_SENTENCE_PERIOD_INSERT:
650 case LFUN_ENVIRONMENT_INSERT:
651 case LFUN_ERT_INSERT:
652 case LFUN_FILE_INSERT:
653 case LFUN_FLEX_INSERT:
654 case LFUN_FLOAT_INSERT:
655 case LFUN_FLOAT_LIST:
656 case LFUN_FLOAT_WIDE_INSERT:
658 case LFUN_FONT_TYPEWRITER:
659 case LFUN_FONT_DEFAULT:
661 case LFUN_FONT_FREE_APPLY:
662 case LFUN_FONT_FREE_UPDATE:
664 case LFUN_FONT_ROMAN:
669 case LFUN_FONT_STATE:
670 case LFUN_FONT_UNDERLINE:
671 case LFUN_FOOTNOTE_INSERT:
672 case LFUN_HFILL_INSERT:
673 case LFUN_HYPERLINK_INSERT:
674 case LFUN_HYPHENATION_POINT_INSERT:
675 case LFUN_INDEX_INSERT:
676 case LFUN_INDEX_PRINT:
677 case LFUN_INSET_INSERT:
678 case LFUN_LABEL_GOTO:
679 case LFUN_LABEL_INSERT:
680 case LFUN_LIGATURE_BREAK_INSERT:
681 case LFUN_LINE_INSERT:
682 case LFUN_PAGEBREAK_INSERT:
684 case LFUN_LAYOUT_PARAGRAPH:
685 case LFUN_LAYOUT_TABULAR:
686 case LFUN_MARGINALNOTE_INSERT:
687 case LFUN_MATH_DISPLAY:
688 case LFUN_MATH_INSERT:
689 case LFUN_MATH_MATRIX:
692 case LFUN_MENU_SEPARATOR_INSERT:
694 case LFUN_NOMENCL_INSERT:
695 case LFUN_NOMENCL_PRINT:
696 case LFUN_NOTE_INSERT:
698 case LFUN_OPTIONAL_INSERT:
699 case LFUN_PARAGRAPH_PARAMS:
700 case LFUN_PARAGRAPH_PARAMS_APPLY:
701 case LFUN_PARAGRAPH_SPACING:
702 case LFUN_PARAGRAPH_UPDATE:
703 case LFUN_REFERENCE_NEXT:
704 case LFUN_SERVER_GOTO_FILE_ROW:
705 case LFUN_SERVER_NOTIFY:
706 case LFUN_SERVER_SET_XY:
707 case LFUN_SPACE_INSERT:
708 case LFUN_TABULAR_INSERT:
709 case LFUN_TOC_INSERT:
710 case LFUN_WRAP_INSERT:
711 if (layout_->passthru) {
715 return InsetText::getStatus(cur, cmd, flag);
717 case LFUN_INSET_TOGGLE:
718 if (cmd.argument() == "open" || cmd.argument() == "close" ||
719 cmd.argument() == "toggle")
726 flag.enabled(!layout_->forceltr);
727 return InsetText::getStatus(cur, cmd, flag);
729 case LFUN_BREAK_PARAGRAPH:
730 case LFUN_BREAK_PARAGRAPH_SKIP:
731 flag.enabled(layout_->multipar);
735 return InsetText::getStatus(cur, cmd, flag);
740 void InsetCollapsable::setLabel(docstring const & l)
746 void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
750 if (status_ == Collapsed)
751 cur.leaveInset(*this);
755 docstring InsetCollapsable::floatName(string const & type, BufferParams const & bp) const
757 FloatList const & floats = bp.getTextClass().floats();
758 FloatList::const_iterator it = floats[type];
760 return (it == floats.end()) ? from_ascii(type) : bp.B_(it->second.name());
764 InsetCollapsable::Decoration InsetCollapsable::decoration() const
766 if (layout_->decoration == "classic")
768 if (layout_->decoration == "minimalistic")
770 if (layout_->decoration == "conglomerate")
772 if (name() == from_ascii("Flex"))
778 int InsetCollapsable::latex(Buffer const & buf, odocstream & os,
779 OutputParams const & runparams) const
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 == "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 == "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_->passthru)
803 if (layout_->needprotect)
804 rp.moving_arg = true;
805 int i = InsetText::latex(buf, os, rp);
806 if (!layout_->latexname.empty()) {
807 if (layout_->latextype == "command") {
809 } else if (layout_->latextype == "environment") {
810 os << "\n\\end{" << from_utf8(layout_->latexname) << "}\n";
818 void InsetCollapsable::validate(LaTeXFeatures & features) const
820 // Force inclusion of preamble snippet in layout file
821 features.require(layout_->name);
822 InsetText::validate(features);