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 "BufferView.h"
20 #include "Dimension.h"
21 #include "FuncRequest.h"
22 #include "FuncStatus.h"
23 #include "InsetLayout.h"
25 #include "MetricsInfo.h"
26 #include "OutputParams.h"
28 #include "frontends/FontMetrics.h"
29 #include "frontends/Painter.h"
31 #include "support/debug.h"
32 #include "support/docstream.h"
33 #include "support/gettext.h"
34 #include "support/lassert.h"
35 #include "support/lstrings.h"
42 InsetCollapsable::InsetCollapsable(Buffer * buf, InsetText::UsePlain ltype)
43 : InsetText(buf, ltype), status_(Open)
46 setFrameColor(Color_collapsableframe);
50 // The sole purpose of this copy constructor is to make sure
51 // that the mouse_hover_ map is not copied and remains empty.
52 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
55 labelstring_(rhs.labelstring_),
56 button_dim_(rhs.button_dim_),
57 openinlined_(rhs.openinlined_)
61 InsetCollapsable::~InsetCollapsable()
63 map<BufferView const *, bool>::iterator it = mouse_hover_.begin();
64 map<BufferView const *, bool>::iterator end = mouse_hover_.end();
65 for (; it != end; ++it)
67 it->first->clearLastInset(this);
71 InsetCollapsable::CollapseStatus InsetCollapsable::status(BufferView const & bv) const
73 if (decoration() == InsetLayout::CONGLOMERATE)
75 return auto_open_[&bv] ? Open : status_;
79 InsetCollapsable::Geometry InsetCollapsable::geometry(BufferView const & bv) const
81 switch (decoration()) {
82 case InsetLayout::CLASSIC:
83 if (status(bv) == Open)
84 return openinlined_[&bv] ? LeftButton : TopButton;
87 case InsetLayout::MINIMALISTIC:
88 return status(bv) == Open ? NoButton : ButtonOnly ;
90 case InsetLayout::CONGLOMERATE:
91 return status(bv) == Open ? SubLabel : Corners ;
93 case InsetLayout::DEFAULT:
94 break; // this shouldn't happen
97 // dummy return value to shut down a warning,
103 docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
105 Dimension const dim = dimensionCollapsed(bv);
106 if (geometry(bv) == NoButton)
107 return translateIfPossible(getLayout().labelstring());
108 if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des || isOpen(bv))
111 return toolTipText();
115 void InsetCollapsable::write(ostream & os) const
131 void InsetCollapsable::read(Lexer & lex)
133 lex.setContext("InsetCollapsable::read");
136 lex >> "status" >> tmp_token;
137 if (tmp_token == "open")
140 InsetText::read(lex);
145 Dimension InsetCollapsable::dimensionCollapsed(BufferView const & bv) const
148 FontInfo labelfont(getLabelfont());
149 labelfont.realize(sane_font);
150 theFontMetrics(labelfont).buttonText(
151 buttonLabel(bv), dim.wid, dim.asc, dim.des);
156 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
158 auto_open_[mi.base.bv] = mi.base.bv->cursor().isInside(this);
160 FontInfo tmpfont = mi.base.font;
161 mi.base.font = getFont();
162 mi.base.font.realize(tmpfont);
164 BufferView const & bv = *mi.base.bv;
166 switch (geometry(bv)) {
168 InsetText::metrics(mi, dim);
171 InsetText::metrics(mi, dim);
176 InsetText::metrics(mi, dim);
177 // consider width of the inset label
178 FontInfo font(getLabelfont());
179 font.realize(sane_font);
185 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
192 if (hasFixedWidth()){
193 int const mindim = button_dim_[&bv].x2 - button_dim_[&bv].x1;
194 if (mi.base.textwidth < mindim)
195 mi.base.textwidth = mindim;
197 dim = dimensionCollapsed(bv);
198 if (geometry(bv) == TopButton || geometry(bv) == LeftButton) {
200 InsetText::metrics(mi, textdim);
201 openinlined_[&bv] = (textdim.wid + dim.wid) < mi.base.textwidth;
202 if (openinlined_[&bv]) {
203 // Correct for button width.
204 dim.wid += textdim.wid;
205 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
206 dim.asc = textdim.asc;
208 dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
209 dim.wid = max(dim.wid, textdim.wid);
215 mi.base.font = tmpfont;
219 bool InsetCollapsable::setMouseHover(BufferView const * bv, bool mouse_hover)
222 mouse_hover_[bv] = mouse_hover;
227 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
229 BufferView const & bv = *pi.base.bv;
231 auto_open_[&bv] = bv.cursor().isInside(this);
233 FontInfo tmpfont = pi.base.font;
234 pi.base.font = getFont();
235 pi.base.font.realize(tmpfont);
237 // Draw button first -- top, left or only
238 Dimension dimc = dimensionCollapsed(bv);
240 if (geometry(bv) == TopButton ||
241 geometry(bv) == LeftButton ||
242 geometry(bv) == ButtonOnly) {
243 button_dim_[&bv].x1 = x + 0;
244 button_dim_[&bv].x2 = x + dimc.width();
245 button_dim_[&bv].y1 = y - dimc.asc;
246 button_dim_[&bv].y2 = y + dimc.des;
248 FontInfo labelfont = getLabelfont();
249 labelfont.setColor(labelColor());
250 labelfont.realize(pi.base.font);
251 pi.pain.buttonText(x, y, buttonLabel(bv), labelfont,
254 button_dim_[&bv].x1 = 0;
255 button_dim_[&bv].y1 = 0;
256 button_dim_[&bv].x2 = 0;
257 button_dim_[&bv].y2 = 0;
260 Dimension const textdim = InsetText::dimension(bv);
261 int const baseline = y;
263 switch (geometry(bv)) {
265 textx = x + dimc.width();
267 InsetText::draw(pi, textx, texty);
271 texty = baseline + dimc.des + textdim.asc;
272 InsetText::draw(pi, textx, texty);
279 InsetText::draw(pi, textx, texty);
285 const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
286 InsetText::draw(pi, textx, texty);
287 const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
289 int desc = textdim.descent();
290 if (geometry(bv) == Corners)
293 const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
294 const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
295 pi.pain.line(xx1, y + desc - 4,
299 pi.pain.line(xx1, y + desc,
303 // Make status_ value visible:
304 pi.pain.line(xx1, y + desc,
307 pi.pain.line(xx2 - 4, y + desc,
311 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3,
312 y + desc - 4, Color_foreground);
314 // the label below the text. Can be toggled.
315 if (geometry(bv) == SubLabel) {
316 FontInfo font(getLabelfont());
317 font.realize(sane_font);
323 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
324 int const ww = max(textdim.wid, w);
325 pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
326 buttonLabel(bv), font, Color_none, Color_none);
329 // a visual cue when the cursor is inside the inset
330 Cursor const & cur = bv.cursor();
331 if (cur.isInside(this)) {
334 pi.pain.line(xx1, y + 4, xx1, y, Color_foreground);
335 pi.pain.line(xx1 + 4, y, xx1, y, Color_foreground);
336 pi.pain.line(xx2, y + 4, xx2, y, Color_foreground);
337 pi.pain.line(xx2 - 4, y, xx2, y, Color_foreground);
342 pi.base.font = tmpfont;
346 void InsetCollapsable::cursorPos(BufferView const & bv,
347 CursorSlice const & sl, bool boundary, int & x, int & y) const
349 if (geometry(bv) == ButtonOnly)
352 InsetText::cursorPos(bv, sl, boundary, x, y);
353 Dimension const textdim = InsetText::dimension(bv);
355 switch (geometry(bv)) {
357 x += dimensionCollapsed(bv).wid;
360 y += dimensionCollapsed(bv).des + textdim.asc;
375 bool InsetCollapsable::editable() const
377 switch (decoration()) {
378 case InsetLayout::CLASSIC:
379 case InsetLayout::MINIMALISTIC:
380 return status_ == Open;
387 bool InsetCollapsable::descendable(BufferView const & bv) const
389 return geometry(bv) != ButtonOnly;
393 bool InsetCollapsable::clickable(BufferView const & bv, int x, int y) const
395 return button_dim_[&bv].contains(x, y);
399 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
402 pos_type const max_length = 15;
403 pos_type const p_siz = paragraphs().begin()->size();
404 pos_type const n = min(max_length, p_siz);
407 for (; i < n && j < p_siz; ++j) {
408 if (paragraphs().begin()->isInset(j))
410 label += paragraphs().begin()->getChar(j);
413 if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
416 return label.empty() ? l : label;
420 void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
422 //lyxerr << "InsetCollapsable: edit left/right" << endl;
424 InsetText::edit(cur, front, entry_from);
428 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
430 //lyxerr << "InsetCollapsable: edit xy" << endl;
431 if (geometry(cur.bv()) == ButtonOnly
432 || (button_dim_[&cur.bv()].contains(x, y)
433 && geometry(cur.bv()) != NoButton))
436 return InsetText::editXY(cur, x, y);
440 void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
442 //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
443 // << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
445 bool const hitButton = clickable(cur.bv(), cmd.x(), cmd.y());
447 switch (cmd.action()) {
448 case LFUN_MOUSE_PRESS:
450 switch (cmd.button()) {
451 case mouse_button::button1:
452 case mouse_button::button3:
453 // Pass the command to the enclosing InsetText,
454 // so that the cursor gets set.
457 case mouse_button::none:
458 case mouse_button::button2:
459 case mouse_button::button4:
460 case mouse_button::button5:
462 cur.noScreenUpdate();
465 } else if (geometry(cur.bv()) != ButtonOnly)
466 InsetText::doDispatch(cur, cmd);
471 case LFUN_MOUSE_MOTION:
472 case LFUN_MOUSE_DOUBLE:
473 case LFUN_MOUSE_TRIPLE:
475 cur.noScreenUpdate();
476 else if (geometry(cur.bv()) != ButtonOnly)
477 InsetText::doDispatch(cur, cmd);
482 case LFUN_MOUSE_RELEASE:
484 // The mouse click has to be within the inset!
485 if (geometry(cur.bv()) != ButtonOnly)
486 InsetText::doDispatch(cur, cmd);
491 if (cmd.button() != mouse_button::button1) {
493 cur.noScreenUpdate();
496 // if we are selecting, we do not want to
500 // Left button is clicked, the user asks to
501 // toggle the inset visual state.
503 cur.screenUpdateFlags(Update::Force | Update::FitCursor);
504 if (geometry(cur.bv()) == ButtonOnly) {
505 setStatus(cur, Open);
509 setStatus(cur, Collapsed);
510 cur.bv().cursor() = cur;
513 case LFUN_INSET_TOGGLE:
514 if (cmd.argument() == "open")
515 setStatus(cur, Open);
516 else if (cmd.argument() == "close")
517 setStatus(cur, Collapsed);
518 else if (cmd.argument() == "toggle" || cmd.argument().empty())
520 setStatus(cur, Collapsed);
522 setStatus(cur, Open);
523 else // if assign or anything else
529 InsetText::doDispatch(cur, cmd);
535 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
536 FuncStatus & flag) const
538 switch (cmd.action()) {
539 case LFUN_INSET_TOGGLE:
540 if (cmd.argument() == "open")
541 flag.setEnabled(status_ != Open);
542 else if (cmd.argument() == "close")
543 flag.setEnabled(status_ == Open);
544 else if (cmd.argument() == "toggle" || cmd.argument().empty()) {
545 flag.setEnabled(true);
546 flag.setOnOff(status_ == Open);
548 flag.setEnabled(false);
552 return InsetText::getStatus(cur, cmd, flag);
557 void InsetCollapsable::setLabel(docstring const & l)
563 docstring const InsetCollapsable::buttonLabel(BufferView const & bv) const
565 InsetLayout const & il = getLayout();
566 docstring const label = labelstring_.empty() ?
567 translateIfPossible(il.labelstring()) : labelstring_;
568 if (!il.contentaslabel() || geometry(bv) != ButtonOnly)
570 return getNewLabel(label);
574 void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
578 if (status_ == Collapsed)
579 cur.leaveInset(*this);
583 InsetLayout::InsetDecoration InsetCollapsable::decoration() const
585 InsetLayout::InsetDecoration const dec = getLayout().decoration();
586 return dec == InsetLayout::DEFAULT ? InsetLayout::CLASSIC : dec;
590 string InsetCollapsable::contextMenu(BufferView const & bv, int x,
593 string context_menu = contextMenuName();
594 string const it_context_menu = InsetText::contextMenuName();
595 if (decoration() == InsetLayout::CONGLOMERATE)
596 return context_menu + ";" + it_context_menu;
598 string const ic_context_menu = InsetCollapsable::contextMenuName();
599 if (ic_context_menu != context_menu)
600 context_menu += ";" + ic_context_menu;
602 if (geometry(bv) == NoButton)
603 return context_menu + ";" + it_context_menu;
605 Dimension dim = dimensionCollapsed(bv);
606 if (x < xo(bv) + dim.wid && y < yo(bv) + dim.des)
609 return it_context_menu;
613 string InsetCollapsable::contextMenuName() const
615 if (decoration() == InsetLayout::CONGLOMERATE)
616 return "context-conglomerate";
618 return "context-collapsable";