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 } else if (!collapsed_ && cmd.y > button_dim.y2) {
247 ret = inset.localDispatch(adjustCommand(cmd)) == DISPATCHED;
249 if (cmd.button() == mouse_button::button3 && !ret)
254 int InsetCollapsable::latex(Buffer const & buf, ostream & os,
255 LatexRunParams const & runparams) const
257 return inset.latex(buf, os, runparams);
261 int InsetCollapsable::ascii(Buffer const & buf, ostream & os, int ll) const
263 return inset.ascii(buf, os, ll);
267 int InsetCollapsable::linuxdoc(Buffer const & buf, ostream & os) const
269 return inset.linuxdoc(buf, os);
273 int InsetCollapsable::docbook(Buffer const & buf, ostream & os, bool mixcont) const
275 return inset.docbook(buf, os, mixcont);
279 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
281 return button_dim.contained(cmd.x, cmd.y);
285 InsetOld::RESULT InsetCollapsable::localDispatch(FuncRequest const & cmd)
287 //lyxerr << "InsetCollapsable::localDispatch: "
288 // << cmd.action << " '" << cmd.argument << "'\n";
289 BufferView * bv = cmd.view();
290 switch (cmd.action) {
291 case LFUN_INSET_EDIT: {
292 if (!cmd.argument.empty()) {
293 UpdatableInset::localDispatch(cmd);
295 lyxerr << "branch collapsed_" << endl;
297 if (bv->lockInset(this)) {
298 bv->updateInset(this);
299 bv->buffer()->markDirty();
300 inset.localDispatch(cmd);
301 first_after_edit = true;
304 lyxerr << "branch not collapsed_" << endl;
305 if (bv->lockInset(this))
306 inset.localDispatch(cmd);
312 #warning Fix this properly in BufferView_pimpl::workAreaButtonRelease
314 if (cmd.button() == mouse_button::button3)
317 UpdatableInset::localDispatch(cmd);
321 // set this only here as it should be recollapsed only if
322 // it was already collapsed!
323 first_after_edit = true;
324 if (!bv->lockInset(this))
326 bv->updateInset(this);
327 bv->buffer()->markDirty();
328 inset.localDispatch(cmd);
330 FuncRequest cmd1 = cmd;
331 if (!bv->lockInset(this))
333 if (cmd.y <= button_dim.y2) {
336 cmd1.y = ascent() + cmd.y - (height_collapsed() + inset.ascent());
338 inset.localDispatch(cmd);
343 case LFUN_MOUSE_PRESS:
344 if (!collapsed_ && cmd.y > button_dim.y2)
345 inset.localDispatch(adjustCommand(cmd));
348 case LFUN_MOUSE_MOTION:
349 if (!collapsed_ && cmd.y > button_dim.y2)
350 inset.localDispatch(adjustCommand(cmd));
353 case LFUN_MOUSE_RELEASE:
354 lfunMouseRelease(cmd);
358 UpdatableInset::RESULT result = inset.localDispatch(cmd);
359 if (result >= FINISHED)
360 bv->unlockInset(this);
361 first_after_edit = false;
367 bool InsetCollapsable::lockInsetInInset(BufferView * bv, UpdatableInset * in)
371 return inset.lockInsetInInset(bv, in);
375 bool InsetCollapsable::unlockInsetInInset(BufferView * bv, UpdatableInset * in,
379 bv->unlockInset(this);
382 return inset.unlockInsetInInset(bv, in, lr);
386 int InsetCollapsable::insetInInsetY() const
388 return inset.insetInInsetY() - (top_baseline - inset.y());
392 void InsetCollapsable::validate(LaTeXFeatures & features) const
394 inset.validate(features);
398 void InsetCollapsable::getCursor(BufferView & bv, int & x, int & y) const
400 inset.getCursor(bv, x, y);
404 void InsetCollapsable::getCursorPos(BufferView * bv, int & x, int & y) const
406 inset.getCursorPos(bv, x , y);
410 UpdatableInset * InsetCollapsable::getLockingInset() const
412 UpdatableInset * in = inset.getLockingInset();
414 return const_cast<InsetCollapsable *>(this);
419 UpdatableInset * InsetCollapsable::getFirstLockingInsetOfType(InsetOld::Code c)
423 return inset.getFirstLockingInsetOfType(c);
427 void InsetCollapsable::setFont(BufferView * bv, LyXFont const & font,
428 bool toggleall, bool selectall)
430 inset.setFont(bv, font, toggleall, selectall);
434 LyXText * InsetCollapsable::getLyXText(BufferView const * bv,
435 bool const recursive) const
437 return inset.getLyXText(bv, recursive);
441 void InsetCollapsable::deleteLyXText(BufferView * bv, bool recursive) const
443 inset.deleteLyXText(bv, recursive);
447 void InsetCollapsable::getLabelList(std::vector<string> & list) const
449 inset.getLabelList(list);
453 int InsetCollapsable::scroll(bool recursive) const
455 int sx = UpdatableInset::scroll(false);
458 sx += inset.scroll(recursive);
464 ParagraphList * InsetCollapsable::getParagraphs(int i) const
466 return inset.getParagraphs(i);
470 LyXCursor const & InsetCollapsable::cursor(BufferView * bv) const
472 return inset.cursor(bv);
476 InsetOld * InsetCollapsable::getInsetFromID(int id_arg) const
479 return const_cast<InsetCollapsable *>(this);
480 return inset.getInsetFromID(id_arg);
484 void InsetCollapsable::open(BufferView * bv)
490 bv->updateInset(this);
494 void InsetCollapsable::close(BufferView * bv) const
500 bv->updateInset(this);
504 void InsetCollapsable::setLabel(string const & l) const
510 void InsetCollapsable::markErased()
516 bool InsetCollapsable::nextChange(BufferView * bv, lyx::pos_type & length)
518 bool found = inset.nextChange(bv, length);
520 if (first_after_edit && !found)
523 first_after_edit = false;
528 bool InsetCollapsable::searchForward(BufferView * bv, string const & str,
531 bool found = inset.searchForward(bv, str, cs, mw);
532 if (first_after_edit && !found)
535 first_after_edit = false;
540 bool InsetCollapsable::searchBackward(BufferView * bv, string const & str,
543 bool found = inset.searchBackward(bv, str, cs, mw);
544 if (first_after_edit && !found)
547 first_after_edit = false;
553 InsetCollapsable::selectNextWordToSpellcheck(BufferView * bv, float & value) const
555 WordLangTuple word = inset.selectNextWordToSpellcheck(bv, value);
556 if (first_after_edit && word.word().empty())
558 first_after_edit = false;
563 void InsetCollapsable::addPreview(PreviewLoader & loader) const
565 inset.addPreview(loader);
569 void InsetCollapsable::cache(BufferView * bv) const
571 view_ = bv->owner()->view();
575 BufferView * InsetCollapsable::view() const
577 return view_.lock().get();