src/insets/insetcollapsable.C

   1 /**
   2  * \file insetcollapsable.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alejandro Aguilar Sierra
   7  * \author Jürgen Vigna
   8  * \author Lars Gullik Bjønnes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "insetcollapsable.h"
  16
  17 #include "buffer.h"
  18 #include "BufferView.h"
  19 #include "debug.h"
  20 #include "LColor.h"
  21 #include "lyxlex.h"
  22 #include "funcrequest.h"
  23 #include "metricsinfo.h"
  24 #include "paragraph.h"
  25 #include "WordLangTuple.h"
  26
  27 #include "frontends/font_metrics.h"
  28 #include "frontends/Painter.h"
  29 #include "frontends/LyXView.h"
  30
  31
  32 using lyx::graphics::PreviewLoader;
  33
  34 using std::endl;
  35 using std::string;
  36 using std::max;
  37 using std::ostream;
  38
  39
  40 InsetCollapsable::InsetCollapsable(BufferParams const & bp, bool collapsed)
  41         : UpdatableInset(), inset(bp), collapsed_(collapsed),
  42           button_dim(0, 0, 0, 0), label("Label"),
  43 #if 0
  44         autocollapse(false),
  45 #endif
  46           in_update(false), first_after_edit(false)
  47 {
  48         inset.setOwner(this);
  49         inset.setAutoBreakRows(true);
  50         inset.setDrawFrame(InsetText::ALWAYS);
  51         inset.setFrameColor(LColor::collapsableframe);
  52         setInsetName("Collapsable");
  53 }
  54
  55
  56 InsetCollapsable::InsetCollapsable(InsetCollapsable const & in)
  57         : UpdatableInset(in), inset(in.inset), collapsed_(in.collapsed_),
  58           labelfont_(in.labelfont_), button_dim(0, 0, 0, 0), label(in.label),
  59 #if 0
  60           autocollapse(in.autocollapse),
  61 #endif
  62           in_update(false), first_after_edit(false)
  63 {
  64         inset.setOwner(this);
  65 }
  66
  67
  68 bool InsetCollapsable::insertInset(BufferView * bv, InsetOld * in)
  69 {
  70         if (!insetAllowed(in->lyxCode())) {
  71                 lyxerr << "InsetCollapsable::InsertInset: "
  72                         "Unable to insert inset." << endl;
  73                 return false;
  74         }
  75         return inset.insertInset(bv, in);
  76 }
  77
  78
  79 void InsetCollapsable::write(Buffer const & buf, ostream & os) const
  80 {
  81         os << "collapsed " << (collapsed_ ? "true" : "false") << "\n";
  82         inset.writeParagraphData(buf, os);
  83 }
  84
  85
  86 void InsetCollapsable::read(Buffer const & buf, LyXLex & lex)
  87 {
  88         if (lex.isOK()) {
  89                 lex.next();
  90                 string const token = lex.getString();
  91                 if (token == "collapsed") {
  92                         lex.next();
  93                         collapsed_ = lex.getBool();
  94                 } else {
  95                         lyxerr << "InsetCollapsable::Read: Missing collapsed!"
  96                                << endl;
  97                         // Take countermeasures
  98                         lex.pushToken(token);
  99                 }
 100         }
 101         inset.read(buf, lex);
 102 }
 103
 104
 105 void InsetCollapsable::dimension_collapsed(Dimension & dim) const
 106 {
 107         font_metrics::buttonText(label, labelfont_, dim.wid, dim.asc, dim.des);
 108 }
 109
 110
 111 int InsetCollapsable::height_collapsed() const
 112 {
 113         Dimension dim;
 114         font_metrics::buttonText(label, labelfont_, dim.wid, dim.asc, dim.des);
 115         return dim.asc + dim.des;
 116 }
 117
 118
 119 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 120 {
 121         //lyxerr << "InsetCollapsable::metrics:  width: " << mi.base.textwidth << endl;
 122         dimension_collapsed(dim);
 123         if (!collapsed_) {
 124                 Dimension insetdim;
 125                 inset.metrics(mi, insetdim);
 126                 dim.des += insetdim.height() + TEXT_TO_BOTTOM_OFFSET;
 127                 dim.wid = max(dim.wid, insetdim.wid);
 128         }
 129         dim_ = dim;
 130 }
 131
 132
 133 void InsetCollapsable::draw_collapsed(PainterInfo & pi, int x, int y) const
 134 {
 135         pi.pain.buttonText(x, y, label, labelfont_);
 136 }
 137
 138
 139 void InsetCollapsable::draw(PainterInfo & pi, int x, int y, bool inlined) const
 140 {
 141         Dimension dim_collapsed;
 142         dimension_collapsed(dim_collapsed);
 143
 144         int const aa  = ascent();
 145         button_dim.x1 = 0;
 146         button_dim.x2 = dim_collapsed.width();
 147         button_dim.y1 = -aa;
 148         button_dim.y2 = -aa + dim_collapsed.height();
 149
 150         if (!isOpen()) {
 151                 draw_collapsed(pi, x, y);
 152                 return;
 153         }
 154
 155         int old_x = x;
 156
 157         if (!owner())
 158                 x += scroll();
 159
 160         top_x = x;
 161         top_baseline = y;
 162
 163         int const bl = y - aa + dim_collapsed.ascent();
 164
 165         if (inlined) {
 166                 inset.draw(pi, x, y);
 167         } else {
 168                 draw_collapsed(pi, old_x, bl);
 169                 inset.draw(pi, x, bl + dim_collapsed.descent() + inset.ascent());
 170         }
 171 }
 172
 173
 174 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 175 {
 176         // by default, we are not inlined-drawing
 177         draw(pi, x, y, false);
 178 }
 179
 180
 181 InsetOld::EDITABLE InsetCollapsable::editable() const
 182 {
 183         return collapsed_ ? IS_EDITABLE : HIGHLY_EDITABLE;
 184 }
 185
 186
 187 void InsetCollapsable::insetUnlock(BufferView * bv)
 188 {
 189 #if 0
 190         if (autocollapse) {
 191                 if (change_label_with_text) {
 192                         draw_label = get_new_label();
 193                 } else {
 194                         draw_label = label;
 195                 }
 196                 collapsed_ = true;
 197         }
 198 #endif
 199         inset.insetUnlock(bv);
 200         if (scroll())
 201                 scroll(bv, 0.0F);
 202         bv->updateInset(this);
 203 }
 204
 205
 206 FuncRequest InsetCollapsable::adjustCommand(FuncRequest const & cmd)
 207 {
 208         FuncRequest cmd1 = cmd;
 209         cmd1.y = ascent() + cmd.y - (height_collapsed() + inset.ascent());
 210         return cmd1;
 211 }
 212
 213
 214 void InsetCollapsable::lfunMouseRelease(FuncRequest const & cmd)
 215 {
 216         bool ret = false;
 217         BufferView * bv = cmd.view();
 218
 219         if (collapsed_ && cmd.button() != mouse_button::button3) {
 220                 collapsed_ = false;
 221                 bv->updateInset(this);
 222                 bv->buffer()->markDirty();
 223                 return;
 224         }
 225
 226         if (cmd.button() != mouse_button::button3 && hitButton(cmd)) {
 227                 if (collapsed_) {
 228                         collapsed_ = false;
 229                 } else {
 230                         collapsed_ = true;
 231                         bv->unlockInset(this);
 232                 }
 233                 bv->updateInset(this);
 234                 bv->buffer()->markDirty();
 235         } else if (!collapsed_ && cmd.y > button_dim.y2) {
 236                 ret = inset.localDispatch(adjustCommand(cmd)) == DISPATCHED;
 237         }
 238         if (cmd.button() == mouse_button::button3 && !ret)
 239                 showInsetDialog(bv);
 240 }
 241
 242
 243 int InsetCollapsable::latex(Buffer const & buf, ostream & os,
 244                             LatexRunParams const & runparams) const
 245 {
 246         return inset.latex(buf, os, runparams);
 247 }
 248
 249
 250 int InsetCollapsable::ascii(Buffer const & buf, ostream & os, int ll) const
 251 {
 252         return inset.ascii(buf, os, ll);
 253 }
 254
 255
 256 int InsetCollapsable::linuxdoc(Buffer const & buf, ostream & os) const
 257 {
 258         return inset.linuxdoc(buf, os);
 259 }
 260
 261
 262 int InsetCollapsable::docbook(Buffer const & buf, ostream & os, bool mixcont) const
 263 {
 264         return inset.docbook(buf, os, mixcont);
 265 }
 266
 267
 268 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
 269 {
 270         return button_dim.contains(cmd.x, cmd.y);
 271 }
 272
 273
 274 dispatch_result InsetCollapsable::localDispatch(FuncRequest const & cmd)
 275 {
 276         //lyxerr << "InsetCollapsable::localDispatch: "
 277         //      << cmd.action << " '" << cmd.argument << "'\n";
 278         BufferView * bv = cmd.view();
 279         switch (cmd.action) {
 280                 case LFUN_INSET_EDIT: {
 281                         if (!cmd.argument.empty()) {
 282                                 UpdatableInset::localDispatch(cmd);
 283                                 if (collapsed_) {
 284                                         lyxerr << "branch collapsed_" << endl;
 285                                         collapsed_ = false;
 286                                         if (bv->lockInset(this)) {
 287                                                 bv->updateInset(this);
 288                                                 bv->buffer()->markDirty();
 289                                                 inset.localDispatch(cmd);
 290                                                 first_after_edit = true;
 291                                         }
 292                                 } else {
 293                                         lyxerr << "branch not collapsed_" << endl;
 294                                         if (bv->lockInset(this))
 295                                                 inset.localDispatch(cmd);
 296                                 }
 297                                 return DISPATCHED;
 298                         }
 299
 300 #ifdef WITH_WARNINGS
 301 #warning Fix this properly in BufferView_pimpl::workAreaButtonRelease
 302 #endif
 303                         if (cmd.button() == mouse_button::button3)
 304                                 return DISPATCHED;
 305
 306                         UpdatableInset::localDispatch(cmd);
 307
 308                         if (collapsed_) {
 309                                 collapsed_ = false;
 310                                 // set this only here as it should be recollapsed only if
 311                                 // it was already collapsed!
 312                                 first_after_edit = true;
 313                                 if (!bv->lockInset(this))
 314                                         return DISPATCHED;
 315                                 bv->updateInset(this);
 316                                 bv->buffer()->markDirty();
 317                                 inset.localDispatch(cmd);
 318                         } else {
 319                                 if (!bv->lockInset(this))
 320                                         return DISPATCHED;
 321                                 if (cmd.y <= button_dim.y2) {
 322                                         FuncRequest cmd1 = cmd;
 323                                         cmd1.y = 0;
 324                                         inset.localDispatch(cmd1);
 325                                 } else
 326                                         inset.localDispatch(adjustCommand(cmd));
 327                         }
 328                         return DISPATCHED;
 329                 }
 330
 331                 case LFUN_MOUSE_PRESS:
 332                         if (!collapsed_ && cmd.y > button_dim.y2)
 333                                 inset.localDispatch(adjustCommand(cmd));
 334                         return DISPATCHED;
 335
 336                 case LFUN_MOUSE_MOTION:
 337                         if (!collapsed_ && cmd.y > button_dim.y2)
 338                                 inset.localDispatch(adjustCommand(cmd));
 339                         return DISPATCHED;
 340
 341                 case LFUN_MOUSE_RELEASE:
 342                         lfunMouseRelease(cmd);
 343                         return DISPATCHED;
 344
 345                 default:
 346                         dispatch_result result = inset.localDispatch(cmd);
 347                         if (result >= FINISHED)
 348                                 bv->unlockInset(this);
 349                         first_after_edit = false;
 350                         return result;
 351         }
 352 }
 353
 354
 355 bool InsetCollapsable::lockInsetInInset(BufferView * bv, UpdatableInset * in)
 356 {
 357         if (&inset == in)
 358                 return true;
 359         return inset.lockInsetInInset(bv, in);
 360 }
 361
 362
 363 bool InsetCollapsable::unlockInsetInInset(BufferView * bv, UpdatableInset * in,
 364                                           bool lr)
 365 {
 366         if (&inset == in) {
 367                 bv->unlockInset(this);
 368                 return true;
 369         }
 370         return inset.unlockInsetInInset(bv, in, lr);
 371 }
 372
 373
 374 int InsetCollapsable::insetInInsetY() const
 375 {
 376         return inset.insetInInsetY() - (top_baseline - inset.y());
 377 }
 378
 379
 380 void InsetCollapsable::validate(LaTeXFeatures & features) const
 381 {
 382         inset.validate(features);
 383 }
 384
 385
 386 void InsetCollapsable::getCursor(BufferView & bv, int & x, int & y) const
 387 {
 388         inset.getCursor(bv, x, y);
 389 }
 390
 391
 392 void InsetCollapsable::getCursorPos(BufferView * bv, int & x, int & y) const
 393 {
 394         inset.getCursorPos(bv, x , y);
 395 }
 396
 397
 398 UpdatableInset * InsetCollapsable::getLockingInset() const
 399 {
 400         UpdatableInset * in = inset.getLockingInset();
 401         if (&inset == in)
 402                 return const_cast<InsetCollapsable *>(this);
 403         return in;
 404 }
 405
 406
 407 UpdatableInset * InsetCollapsable::getFirstLockingInsetOfType(InsetOld::Code c)
 408 {
 409         if (c == lyxCode())
 410                 return this;
 411         return inset.getFirstLockingInsetOfType(c);
 412 }
 413
 414
 415 void InsetCollapsable::setFont(BufferView * bv, LyXFont const & font,
 416                                bool toggleall, bool selectall)
 417 {
 418         inset.setFont(bv, font, toggleall, selectall);
 419 }
 420
 421
 422 LyXText * InsetCollapsable::getLyXText(BufferView const * bv,
 423                                        bool const recursive) const
 424 {
 425         return inset.getLyXText(bv, recursive);
 426 }
 427
 428
 429 void InsetCollapsable::deleteLyXText(BufferView * bv, bool recursive) const
 430 {
 431         inset.deleteLyXText(bv, recursive);
 432 }
 433
 434
 435 void InsetCollapsable::getLabelList(Buffer const & buffer,
 436                                     std::vector<string> & list) const
 437 {
 438         inset.getLabelList(buffer, list);
 439 }
 440
 441
 442 int InsetCollapsable::scroll(bool recursive) const
 443 {
 444         int sx = UpdatableInset::scroll(false);
 445
 446         if (recursive)
 447                 sx += inset.scroll(recursive);
 448
 449         return sx;
 450 }
 451
 452
 453 ParagraphList * InsetCollapsable::getParagraphs(int i) const
 454 {
 455         return inset.getParagraphs(i);
 456 }
 457
 458
 459 LyXCursor const & InsetCollapsable::cursor(BufferView * bv) const
 460 {
 461         return inset.cursor(bv);
 462 }
 463
 464
 465 InsetOld * InsetCollapsable::getInsetFromID(int id_arg) const
 466 {
 467         if (id_arg == id())
 468                 return const_cast<InsetCollapsable *>(this);
 469         return inset.getInsetFromID(id_arg);
 470 }
 471
 472
 473 void InsetCollapsable::open(BufferView * bv)
 474 {
 475         if (!collapsed_)
 476                 return;
 477
 478         collapsed_ = false;
 479         bv->updateInset(this);
 480 }
 481
 482
 483 void InsetCollapsable::close(BufferView * bv) const
 484 {
 485         if (collapsed_)
 486                 return;
 487
 488         collapsed_ = true;
 489         bv->updateInset(this);
 490 }
 491
 492
 493 void InsetCollapsable::setLabel(string const & l) const
 494 {
 495         label = l;
 496 }
 497
 498
 499 void InsetCollapsable::setCollapsed(bool c) const
 500 {
 501         collapsed_ = c;
 502 }
 503
 504
 505 void InsetCollapsable::markErased()
 506 {
 507         inset.markErased();
 508 }
 509
 510
 511 bool InsetCollapsable::nextChange(BufferView * bv, lyx::pos_type & length)
 512 {
 513         bool found = inset.nextChange(bv, length);
 514
 515         if (first_after_edit && !found)
 516                 close(bv);
 517         else if (!found)
 518                 first_after_edit = false;
 519         return found;
 520 }
 521
 522
 523 bool InsetCollapsable::searchForward(BufferView * bv, string const & str,
 524                                      bool cs, bool mw)
 525 {
 526         bool found = inset.searchForward(bv, str, cs, mw);
 527         if (first_after_edit && !found)
 528                 close(bv);
 529         else if (!found)
 530                 first_after_edit = false;
 531         return found;
 532 }
 533
 534
 535 bool InsetCollapsable::searchBackward(BufferView * bv, string const & str,
 536                                       bool cs, bool mw)
 537 {
 538         bool found = inset.searchBackward(bv, str, cs, mw);
 539         if (first_after_edit && !found)
 540                 close(bv);
 541         else if (!found)
 542                 first_after_edit = false;
 543         return found;
 544 }
 545
 546
 547 WordLangTuple const
 548 InsetCollapsable::selectNextWordToSpellcheck(BufferView * bv, float & value) const
 549 {
 550         WordLangTuple word = inset.selectNextWordToSpellcheck(bv, value);
 551         if (first_after_edit && word.word().empty())
 552                 close(bv);
 553         first_after_edit = false;
 554         return word;
 555 }
 556
 557
 558 void InsetCollapsable::addPreview(PreviewLoader & loader) const
 559 {
 560         inset.addPreview(loader);
 561 }