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"
32 #include "frontends/FontMetrics.h"
33 #include "frontends/Painter.h"
43 InsetCollapsable::CollapseStatus InsetCollapsable::status() const
45 return autoOpen_ ? Open : status_;
49 InsetCollapsable::Geometry InsetCollapsable::geometry() const
51 switch (decoration()) {
53 if (status() == Open) {
62 return status() == Open ? NoButton : ButtonOnly ;
65 return status() == Open ? SubLabel : Corners ;
68 // dummy return value to shut down a warning,
74 InsetCollapsable::InsetCollapsable
75 (BufferParams const & bp, CollapseStatus status)
76 : InsetText(bp), status_(status),
77 openinlined_(false), autoOpen_(false), mouse_hover_(false)
79 setAutoBreakRows(true);
81 setFrameColor(Color::collapsableframe);
83 // Fallback for lacking inset layout item
84 layout_.bgcolor = Color::background;
88 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
90 button_dim(rhs.button_dim),
92 topbaseline(rhs.topbaseline),
95 openinlined_(rhs.openinlined_),
96 autoOpen_(rhs.autoOpen_),
97 textdim_(rhs.textdim_),
98 // the sole purpose of this copy constructor
104 void InsetCollapsable::setLayout(BufferParams const & bp)
106 layout_ = getLayout(bp);
110 void InsetCollapsable::write(Buffer const & buf, ostream & os) const
122 text_.write(buf, os);
126 void InsetCollapsable::read(Buffer const & buf, Lexer & lex)
128 bool token_found = false;
131 string const token = lex.getString();
132 if (token == "status") {
134 string const tmp_token = lex.getString();
136 if (tmp_token == "collapsed") {
139 } else if (tmp_token == "open") {
143 lyxerr << "InsetCollapsable::read: Missing status!"
145 // Take countermeasures
146 lex.pushToken(token);
149 lyxerr << "InsetCollapsable::read: Missing 'status'-tag!"
151 // take countermeasures
152 lex.pushToken(token);
155 InsetText::read(buf, lex);
158 status_ = isOpen() ? Open : Collapsed;
164 Dimension InsetCollapsable::dimensionCollapsed() const
167 theFontMetrics(layout_.labelfont).buttonText(
168 layout_.labelstring, dim.wid, dim.asc, dim.des);
173 bool InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
177 autoOpen_ = mi.base.bv->cursor().isInside(this);
178 mi.base.textwidth -= int(1.5 * TEXT_TO_INSET_OFFSET);
180 switch (geometry()) {
182 InsetText::metrics(mi, dim);
185 InsetText::metrics(mi, dim);
190 InsetText::metrics(mi, dim);
191 // consider width of the inset label
192 Font font(layout_.labelfont);
193 font.realize(Font(Font::ALL_SANE));
199 docstring s = layout_.labelstring;
200 theFontMetrics(font).rectText(s, w, a, d);
201 dim.wid = max(dim.wid, w);
208 dim = dimensionCollapsed();
209 if (geometry() == TopButton
210 || geometry() == LeftButton) {
211 InsetText::metrics(mi, textdim_);
212 // This expression should not contain mi.base.texwidth
213 openinlined_ = !hasFixedWidth()
214 && textdim_.wid < 0.5 * mi.base.bv->workWidth();
216 // Correct for button width.
217 dim.wid += textdim_.wid;
218 dim.des = max(dim.des - textdim_.asc + dim.asc, textdim_.des);
219 dim.asc = textdim_.asc;
221 dim.des += textdim_.height() + TEXT_TO_BOTTOM_OFFSET;
222 dim.wid = max(dim.wid, textdim_.wid);
224 dim.wid = max(dim.wid, mi.base.textwidth);
229 dim.asc += TEXT_TO_INSET_OFFSET;
230 dim.des += TEXT_TO_INSET_OFFSET;
231 dim.wid += int(1.5 * TEXT_TO_INSET_OFFSET);
232 mi.base.textwidth += int(1.5 * TEXT_TO_INSET_OFFSET);
233 bool const changed = dim_ != dim;
239 bool InsetCollapsable::setMouseHover(bool mouse_hover)
241 mouse_hover_ = mouse_hover;
246 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
248 autoOpen_ = pi.base.bv->cursor().isInside(this);
249 text_.background_color_ = backgroundColor();
250 const int xx = x + TEXT_TO_INSET_OFFSET;
252 // Draw button first -- top, left or only
253 Dimension dimc = dimensionCollapsed();
254 int const top = y - ascent() + TEXT_TO_INSET_OFFSET;
255 if (geometry() == TopButton ||
256 geometry() == LeftButton ||
257 geometry() == ButtonOnly) {
258 button_dim.x1 = xx + 0;
259 button_dim.x2 = xx + dimc.width();
261 button_dim.y2 = top + dimc.height();
263 pi.pain.buttonText(xx, top + dimc.asc, layout_.labelstring, layout_.labelfont, mouse_hover_);
272 switch (geometry()) {
274 textx = xx + dimc.width();
275 texty = top + textdim_.asc;
276 InsetText::draw(pi, textx, texty);
280 texty = top + dimc.height() + textdim_.asc;
281 InsetText::draw(pi, textx, texty);
287 texty = y + textdim_.asc;
288 InsetText::draw(pi, textx, texty);
293 texty = y + textdim_.asc;
294 const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
295 InsetText::draw(pi, textx, texty);
296 const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
298 int desc = InsetText::descent();
299 if (geometry() == SubLabel)
304 const int xx1 = xx + border_ - 1;
305 const int xx2 = x + dim_.wid - border_
306 - TEXT_TO_INSET_OFFSET + 1;
307 pi.pain.line(xx1, y + desc - 4,
309 layout_.labelfont.color());
310 if (internalStatus() == Open)
311 pi.pain.line(xx1, y + desc,
313 layout_.labelfont.color());
315 // Make status_ value visible:
316 pi.pain.line(xx1, y + desc,
318 layout_.labelfont.color());
319 pi.pain.line(xx2 - 4, y + desc,
321 layout_.labelfont.color());
323 pi.pain.line(x + dim_.wid - 3, y + desc, x + dim_.wid - 3, y + desc - 4,
324 layout_.labelfont.color());
326 // the label below the text. Can be toggled.
327 if (geometry() == SubLabel) {
328 Font font(layout_.labelfont);
329 font.realize(Font(Font::ALL_SANE));
336 docstring s = layout_.labelstring;
337 theFontMetrics(font).rectText(s, w, a, d);
338 pi.pain.rectText(x + (dim_.wid - w) / 2, y + desc + a,
339 s, font, Color::none, Color::none);
342 // a visual clue when the cursor is inside the inset
343 Cursor & cur = pi.base.bv->cursor();
344 if (cur.isInside(this)) {
347 pi.pain.line(xx1, y + 4, xx1, y, layout_.labelfont.color());
348 pi.pain.line(xx1 + 4, y, xx1, y, layout_.labelfont.color());
349 pi.pain.line(xx2, y + 4, x + dim_.wid - 3, y,
350 layout_.labelfont.color());
351 pi.pain.line(xx2 - 4, y, xx2, y,
352 layout_.labelfont.color());
356 setPosCache(pi, x, y);
360 void InsetCollapsable::drawSelection(PainterInfo & pi, int x, int y) const
362 x += TEXT_TO_INSET_OFFSET;
363 switch (geometry()) {
365 x += dimensionCollapsed().wid;
366 InsetText::drawSelection(pi, x, y);
369 y += dimensionCollapsed().des + textdim_.asc;
370 InsetText::drawSelection(pi, x, y);
377 InsetText::drawSelection(pi, x, y);
383 void InsetCollapsable::cursorPos(BufferView const & bv,
384 CursorSlice const & sl, bool boundary, int & x, int & y) const
386 BOOST_ASSERT(geometry() != ButtonOnly);
388 InsetText::cursorPos(bv, sl, boundary, x, y);
390 switch (geometry()) {
392 x += dimensionCollapsed().wid;
395 y += dimensionCollapsed().height() - ascent()
396 + TEXT_TO_INSET_OFFSET + textdim_.asc;
407 x += TEXT_TO_INSET_OFFSET;
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 = std::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 left)
452 //lyxerr << "InsetCollapsable: edit left/right" << endl;
454 InsetText::edit(cur, left);
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 (cmd.button() == mouse_button::button1
479 && geometry() != NoButton) {
480 // reset selection if necessary (see bug 3060)
482 cur.bv().cursor().clearSelection();
488 if (geometry() == NoButton)
489 InsetText::doDispatch(cur, cmd);
490 else if (geometry() != ButtonOnly
492 InsetText::doDispatch(cur, cmd);
497 case LFUN_MOUSE_MOTION:
498 case LFUN_MOUSE_DOUBLE:
499 case LFUN_MOUSE_TRIPLE:
500 if (geometry() == NoButton)
501 InsetText::doDispatch(cur, cmd);
502 else if (geometry() != ButtonOnly
504 InsetText::doDispatch(cur, cmd);
509 case LFUN_MOUSE_RELEASE:
510 if (cmd.button() == mouse_button::button3) {
511 // There is no button to right click:
512 if (geometry() == Corners ||
513 geometry() == SubLabel ||
514 geometry() == NoButton) {
515 if (internalStatus() == Open)
516 setStatus(cur, Collapsed);
518 setStatus(cur, Open);
522 // configuration dialog
523 showInsetDialog(&cur.bv());
528 if (geometry() == NoButton) {
529 // The mouse click has to be within the inset!
530 InsetText::doDispatch(cur, cmd);
534 if (cmd.button() == mouse_button::button1 && hitButton(cmd)) {
535 // if we are selecting, we do not want to
539 // Left button is clicked, the user asks to
540 // toggle the inset visual state.
542 cur.updateFlags(Update::Force | Update::FitCursor);
543 if (geometry() == ButtonOnly) {
544 setStatus(cur, Open);
548 setStatus(cur, Collapsed);
550 cur.bv().cursor() = cur;
554 // The mouse click is within the opened inset.
555 if (geometry() == TopButton
556 || geometry() == LeftButton)
557 InsetText::doDispatch(cur, cmd);
560 case LFUN_INSET_TOGGLE:
561 if (cmd.argument() == "open")
562 setStatus(cur, Open);
563 else if (cmd.argument() == "close")
564 setStatus(cur, Collapsed);
565 else if (cmd.argument() == "toggle" || cmd.argument().empty())
566 if (internalStatus() == Open) {
567 setStatus(cur, Collapsed);
568 if (geometry() == ButtonOnly)
569 cur.top().forwardPos();
571 setStatus(cur, Open);
572 else // if assign or anything else
578 InsetText::doDispatch(cur, cmd);
584 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
585 FuncStatus & flag) const
587 switch (cmd.action) {
589 case LFUN_INSET_TOGGLE:
590 if (cmd.argument() == "open" || cmd.argument() == "close" ||
591 cmd.argument() == "toggle")
598 return InsetText::getStatus(cur, cmd, flag);
603 void InsetCollapsable::setLabel(docstring const & l)
605 layout_.labelstring = l;
609 void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
613 if (status_ == Collapsed)
614 cur.leaveInset(*this);
618 void InsetCollapsable::setLabelFont(Font const & font)
620 layout_.labelfont = font;
623 docstring InsetCollapsable::floatName(string const & type, BufferParams const & bp) const
625 FloatList const & floats = bp.getTextClass().floats();
626 FloatList::const_iterator it = floats[type];
628 return (it == floats.end()) ? from_ascii(type) : bp.B_(it->second.name());
632 InsetCollapsable::Decoration InsetCollapsable::decoration() const
634 if (layout_.decoration == "classic")
636 if (layout_.decoration == "minimalistic")
638 if (layout_.decoration == "conglomerate")
640 if (name() == from_ascii("CharStyle"))
646 int InsetCollapsable::latex(Buffer const & buf, odocstream & os,
647 OutputParams const & runparams) const
649 // This implements the standard way of handling the LaTeX output of
650 // a collapsable inset, either a command or an environment. Standard
651 // collapsable insets should not redefine this, non-standard ones may
653 if (!layout_.latexname.empty()) {
654 if (layout_.latextype == "command") {
656 os << '\\' << from_utf8(layout_.latexname);
657 if (!layout_.latexparam.empty())
658 os << from_utf8(layout_.latexparam);
660 } else if (layout_.latextype == "environment") {
661 os << "%\n\\begin{" << from_utf8(layout_.latexname) << "}\n";
662 if (!layout_.latexparam.empty())
663 os << from_utf8(layout_.latexparam);
666 int i = InsetText::latex(buf, os, runparams);
667 if (!layout_.latexname.empty())
668 if (layout_.latextype == "command") {
670 } else if (layout_.latextype == "environment") {
671 os << "\n\\end{" << from_utf8(layout_.latexname) << "}\n";
678 void InsetCollapsable::validate(LaTeXFeatures & features) const
680 // Force inclusion of preamble snippet in layout file
681 features.addPreambleSnippet(layout_.preamble);
682 InsetText::validate(features);