2 * \file insetcollapsable.C
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"
16 #include "insettext.h"
18 #include "BufferView.h"
20 #include "dimension.h"
25 #include "WordLangTuple.h"
26 #include "funcrequest.h"
28 #include "metricsinfo.h"
30 #include "frontends/font_metrics.h"
31 #include "frontends/Painter.h"
32 #include "frontends/LyXView.h"
34 #include "support/LAssert.h"
35 #include "support/LOstream.h"
37 using namespace lyx::support;
38 using namespace lyx::graphics;
46 InsetCollapsable::InsetCollapsable(BufferParams const & bp, bool collapsed)
47 : UpdatableInset(), collapsed_(collapsed), inset(bp),
48 button_dim(0, 0, 0, 0), label("Label"),
52 in_update(false), first_after_edit(false)
55 inset.setAutoBreakRows(true);
56 inset.setDrawFrame(InsetText::ALWAYS);
57 inset.setFrameColor(LColor::collapsableframe);
58 setInsetName("Collapsable");
62 InsetCollapsable::InsetCollapsable(InsetCollapsable const & in)
63 : UpdatableInset(in), collapsed_(in.collapsed_),
64 framecolor(in.framecolor), labelfont(in.labelfont), inset(in.inset),
65 button_dim(0, 0, 0, 0), label(in.label),
67 autocollapse(in.autocollapse),
69 in_update(false), first_after_edit(false)
71 inset.init(&(in.inset));
76 bool InsetCollapsable::insertInset(BufferView * bv, InsetOld * in)
78 if (!insetAllowed(in->lyxCode())) {
79 lyxerr << "InsetCollapsable::InsertInset: "
80 "Unable to insert inset." << endl;
83 return inset.insertInset(bv, in);
87 void InsetCollapsable::write(Buffer const & buf, ostream & os) const
89 os << "collapsed " << (collapsed_ ? "true" : "false") << "\n";
90 inset.writeParagraphData(buf, os);
94 void InsetCollapsable::read(Buffer const & buf, LyXLex & lex)
98 string const token = lex.getString();
99 if (token == "collapsed") {
101 collapsed_ = lex.getBool();
103 lyxerr << "InsetCollapsable::Read: Missing collapsed!"
105 // Take countermeasures
106 lex.pushToken(token);
109 inset.read(buf, lex);
113 void InsetCollapsable::dimension_collapsed(Dimension & dim) const
115 font_metrics::buttonText(label, labelfont, dim.wid, dim.asc, dim.des);
119 int InsetCollapsable::height_collapsed() const
122 font_metrics::buttonText(label, labelfont, dim.wid, dim.asc, dim.des);
123 return dim.asc + dim.des;
127 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
129 //lyxerr << "InsetCollapsable::metrics: width: " << mi.base.textwidth << endl;
130 dimension_collapsed(dim);
133 inset.metrics(mi, insetdim);
134 dim.des += insetdim.height() + TEXT_TO_BOTTOM_OFFSET;
135 dim.wid = max(dim.wid, insetdim.wid);
141 void InsetCollapsable::draw_collapsed(PainterInfo & pi, int x, int y) const
143 pi.pain.buttonText(x, y, label, labelfont);
147 void InsetCollapsable::draw(PainterInfo & pi, int x, int y, bool inlined) const
152 Dimension dim_collapsed;
153 dimension_collapsed(dim_collapsed);
155 int const aa = ascent();
157 button_dim.x2 = dim_collapsed.width();
159 button_dim.y2 = -aa + dim_collapsed.height();
162 draw_collapsed(pi, x, y);
174 int const bl = y - aa + dim_collapsed.ascent();
177 inset.draw(pi, x, y);
179 draw_collapsed(pi, old_x, bl);
180 inset.draw(pi, x, bl + dim_collapsed.descent() + inset.ascent());
185 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
187 // by default, we are not inlined-drawing
188 draw(pi, x, y, false);
192 InsetOld::EDITABLE InsetCollapsable::editable() const
194 return collapsed_ ? IS_EDITABLE : HIGHLY_EDITABLE;
198 void InsetCollapsable::insetUnlock(BufferView * bv)
202 if (change_label_with_text) {
203 draw_label = get_new_label();
210 inset.insetUnlock(bv);
213 bv->updateInset(this);
217 FuncRequest InsetCollapsable::adjustCommand(FuncRequest const & cmd)
219 FuncRequest cmd1 = cmd;
220 cmd1.y = ascent() + cmd.y - (height_collapsed() + inset.ascent());
225 void InsetCollapsable::lfunMouseRelease(FuncRequest const & cmd)
228 BufferView * bv = cmd.view();
230 if (collapsed_ && cmd.button() != mouse_button::button3) {
232 bv->updateInset(this);
233 bv->buffer()->markDirty();
237 if (cmd.button() != mouse_button::button3 && hitButton(cmd)) {
242 bv->unlockInset(this);
244 bv->updateInset(this);
245 bv->buffer()->markDirty();
246 lyxerr << "InsetCollapsable::lfunMouseRelease\n";
247 } else if (!collapsed_ && cmd.y > button_dim.y2) {
248 ret = inset.localDispatch(adjustCommand(cmd)) == DISPATCHED;
250 if (cmd.button() == mouse_button::button3 && !ret)
255 int InsetCollapsable::latex(Buffer const & buf, ostream & os,
256 LatexRunParams const & runparams) const
258 return inset.latex(buf, os, runparams);
262 int InsetCollapsable::ascii(Buffer const & buf, ostream & os, int ll) const
264 return inset.ascii(buf, os, ll);
268 int InsetCollapsable::linuxdoc(Buffer const & buf, ostream & os) const
270 return inset.linuxdoc(buf, os);
274 int InsetCollapsable::docbook(Buffer const & buf, ostream & os, bool mixcont) const
276 return inset.docbook(buf, os, mixcont);
280 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
282 return button_dim.contained(cmd.x, cmd.y);
286 InsetOld::RESULT InsetCollapsable::localDispatch(FuncRequest const & cmd)
288 //lyxerr << "InsetCollapsable::localDispatch: "
289 // << cmd.action << " '" << cmd.argument << "'\n";
290 BufferView * bv = cmd.view();
291 switch (cmd.action) {
292 case LFUN_INSET_EDIT: {
293 if (!cmd.argument.empty()) {
294 UpdatableInset::localDispatch(cmd);
296 lyxerr << "branch collapsed_" << endl;
298 if (bv->lockInset(this)) {
299 bv->updateInset(this);
300 bv->buffer()->markDirty();
301 inset.localDispatch(cmd);
302 first_after_edit = true;
305 lyxerr << "branch not collapsed_" << endl;
306 if (bv->lockInset(this))
307 inset.localDispatch(cmd);
313 #warning Fix this properly in BufferView_pimpl::workAreaButtonRelease
315 if (cmd.button() == mouse_button::button3)
318 UpdatableInset::localDispatch(cmd);
322 // set this only here as it should be recollapsed only if
323 // it was already collapsed!
324 first_after_edit = true;
325 if (!bv->lockInset(this))
327 bv->updateInset(this);
328 bv->buffer()->markDirty();
329 inset.localDispatch(cmd);
331 FuncRequest cmd1 = cmd;
332 if (!bv->lockInset(this))
334 if (cmd.y <= button_dim.y2) {
337 cmd1.y = ascent() + cmd.y - (height_collapsed() + inset.ascent());
339 inset.localDispatch(cmd);
344 case LFUN_MOUSE_PRESS:
345 if (!collapsed_ && cmd.y > button_dim.y2)
346 inset.localDispatch(adjustCommand(cmd));
349 case LFUN_MOUSE_MOTION:
350 if (!collapsed_ && cmd.y > button_dim.y2)
351 inset.localDispatch(adjustCommand(cmd));
354 case LFUN_MOUSE_RELEASE:
355 lfunMouseRelease(cmd);
359 UpdatableInset::RESULT result = inset.localDispatch(cmd);
360 if (result >= FINISHED)
361 bv->unlockInset(this);
362 first_after_edit = false;
368 bool InsetCollapsable::lockInsetInInset(BufferView * bv, UpdatableInset * in)
372 return inset.lockInsetInInset(bv, in);
376 bool InsetCollapsable::unlockInsetInInset(BufferView * bv, UpdatableInset * in,
380 bv->unlockInset(this);
383 return inset.unlockInsetInInset(bv, in, lr);
387 int InsetCollapsable::insetInInsetY() const
389 return inset.insetInInsetY() - (top_baseline - inset.y());
393 void InsetCollapsable::validate(LaTeXFeatures & features) const
395 inset.validate(features);
399 void InsetCollapsable::getCursor(BufferView & bv, int & x, int & y) const
401 inset.getCursor(bv, x, y);
405 void InsetCollapsable::getCursorPos(BufferView * bv, int & x, int & y) const
407 inset.getCursorPos(bv, x , y);
411 UpdatableInset * InsetCollapsable::getLockingInset() const
413 UpdatableInset * in = inset.getLockingInset();
415 return const_cast<InsetCollapsable *>(this);
420 UpdatableInset * InsetCollapsable::getFirstLockingInsetOfType(InsetOld::Code c)
424 return inset.getFirstLockingInsetOfType(c);
428 void InsetCollapsable::setFont(BufferView * bv, LyXFont const & font,
429 bool toggleall, bool selectall)
431 inset.setFont(bv, font, toggleall, selectall);
435 LyXText * InsetCollapsable::getLyXText(BufferView const * bv,
436 bool const recursive) const
438 return inset.getLyXText(bv, recursive);
442 void InsetCollapsable::deleteLyXText(BufferView * bv, bool recursive) const
444 inset.deleteLyXText(bv, recursive);
448 void InsetCollapsable::getLabelList(std::vector<string> & list) const
450 inset.getLabelList(list);
454 int InsetCollapsable::scroll(bool recursive) const
456 int sx = UpdatableInset::scroll(false);
459 sx += inset.scroll(recursive);
465 ParagraphList * InsetCollapsable::getParagraphs(int i) const
467 return inset.getParagraphs(i);
471 LyXCursor const & InsetCollapsable::cursor(BufferView * bv) const
473 return inset.cursor(bv);
477 InsetOld * InsetCollapsable::getInsetFromID(int id_arg) const
480 return const_cast<InsetCollapsable *>(this);
481 return inset.getInsetFromID(id_arg);
485 void InsetCollapsable::open(BufferView * bv)
491 bv->updateInset(this);
495 void InsetCollapsable::close(BufferView * bv) const
501 bv->updateInset(this);
505 void InsetCollapsable::setLabel(string const & l) const
511 void InsetCollapsable::markErased()
517 bool InsetCollapsable::nextChange(BufferView * bv, lyx::pos_type & length)
519 bool found = inset.nextChange(bv, length);
521 if (first_after_edit && !found)
524 first_after_edit = false;
529 bool InsetCollapsable::searchForward(BufferView * bv, string const & str,
532 bool found = inset.searchForward(bv, str, cs, mw);
533 if (first_after_edit && !found)
536 first_after_edit = false;
541 bool InsetCollapsable::searchBackward(BufferView * bv, string const & str,
544 bool found = inset.searchBackward(bv, str, cs, mw);
545 if (first_after_edit && !found)
548 first_after_edit = false;
554 InsetCollapsable::selectNextWordToSpellcheck(BufferView * bv, float & value) const
556 WordLangTuple word = inset.selectNextWordToSpellcheck(bv, value);
557 if (first_after_edit && word.word().empty())
559 first_after_edit = false;
564 void InsetCollapsable::addPreview(PreviewLoader & loader) const
566 inset.addPreview(loader);
570 void InsetCollapsable::cache(BufferView * bv) const
572 view_ = bv->owner()->view();
576 BufferView * InsetCollapsable::view() const
578 return view_.lock().get();