src/insets/insetcollapsable.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Processor
   5  *
   6  *          Copyright 1998-2001 The LyX Team.
   7  *
   8  * ======================================================
   9  */
  10
  11 #include <config.h>
  12
  13 #ifdef __GNUG__
  14 #pragma implementation
  15 #endif
  16
  17 #include "insetcollapsable.h"
  18 #include "gettext.h"
  19 #include "lyxfont.h"
  20 #include "BufferView.h"
  21 #include "Painter.h"
  22 #include "insets/insettext.h"
  23 #include "support/LOstream.h"
  24 #include "support/lstrings.h"
  25 #include "debug.h"
  26 #include "lyxtext.h"
  27
  28 class LyXText;
  29
  30 using std::ostream;
  31 using std::endl;
  32 using std::max;
  33
  34
  35 InsetCollapsable::InsetCollapsable(bool collapsed)
  36         : UpdatableInset(), collapsed_(collapsed),
  37           button_length(0), button_top_y(0), button_bottom_y(0),
  38           label("Label"), draw_label(label), autocollapse(true),
  39           widthCollapsed(0), oldWidth(0), need_update(FULL),
  40           inlined(false), change_label_with_text(false)
  41
  42
  43 {
  44         inset.setOwner(this);
  45         inset.setAutoBreakRows(true);
  46         inset.setDrawFrame(0, InsetText::ALWAYS);
  47         inset.setFrameColor(0, LColor::collapsableframe);
  48         setInsetName("Collapsable");
  49 }
  50
  51
  52 bool InsetCollapsable::insertInset(BufferView * bv, Inset * in)
  53 {
  54         if (!insetAllowed(in->lyxCode())) {
  55                 lyxerr << "InsetCollapsable::InsertInset: "
  56                         "Unable to insert inset." << endl;
  57                 return false;
  58         }
  59         return inset.insertInset(bv, in);
  60 }
  61
  62
  63 void InsetCollapsable::write(Buffer const * buf, ostream & os) const
  64 {
  65         os << "collapsed " << tostr(collapsed_) << "\n";
  66         inset.writeParagraphData(buf, os);
  67 }
  68
  69
  70
  71 void InsetCollapsable::read(Buffer const * buf, LyXLex & lex)
  72 {
  73         if (lex.IsOK()) {
  74                 lex.next();
  75                 string const token = lex.GetString();
  76                 if (token == "collapsed") {
  77                         lex.next();
  78                         collapsed_ = lex.GetBool();
  79                 } else {
  80                         lyxerr << "InsetCollapsable::Read: Missing collapsed!"
  81                                << endl;
  82                 }
  83         }
  84         inset.read(buf, lex);
  85         if (collapsed_ && change_label_with_text) {
  86                 draw_label = get_new_label();
  87         } else {
  88                 draw_label = label;
  89         }
  90 }
  91
  92
  93 int InsetCollapsable::ascent_collapsed(Painter & pain, LyXFont const &) const
  94 {
  95         int width = 0;
  96         int ascent = 0;
  97         int descent = 0;
  98         pain.buttonText(0, 0, draw_label, labelfont, false,
  99                         width, ascent, descent);
 100         return ascent;
 101 }
 102
 103
 104 int InsetCollapsable::descent_collapsed(Painter & pain, LyXFont const &) const
 105 {
 106         int width = 0;
 107         int ascent = 0;
 108         int descent = 0;
 109         pain.buttonText(0, 0, draw_label, labelfont, false,
 110                         width, ascent, descent);
 111         return descent;
 112 }
 113
 114
 115 int InsetCollapsable::width_collapsed(Painter & pain, LyXFont const &) const
 116 {
 117         int width;
 118         int ascent;
 119         int descent;
 120         pain.buttonText(TEXT_TO_INSET_OFFSET, 0, draw_label, labelfont, false,
 121                         width, ascent, descent);
 122         return width + (2*TEXT_TO_INSET_OFFSET);
 123 }
 124
 125
 126 int InsetCollapsable::ascent(BufferView * bv, LyXFont const & font) const
 127 {
 128         return ascent_collapsed(bv->painter(), font);
 129 }
 130
 131
 132 int InsetCollapsable::descent(BufferView * bv, LyXFont const & font) const
 133 {
 134         if (collapsed_)
 135                 return descent_collapsed(bv->painter(), font);
 136
 137         return descent_collapsed(bv->painter(), font)
 138                 + inset.descent(bv, font)
 139                 + inset.ascent(bv, font)
 140                 + TEXT_TO_BOTTOM_OFFSET;
 141 }
 142
 143
 144 int InsetCollapsable::width(BufferView * bv, LyXFont const & font) const
 145 {
 146         widthCollapsed = width_collapsed(bv->painter(), font);
 147
 148         if (collapsed_)
 149                 return widthCollapsed;
 150
 151         return (inset.width(bv, font) > widthCollapsed) ?
 152                 inset.width(bv, font) : widthCollapsed;
 153 }
 154
 155
 156 void InsetCollapsable::draw_collapsed(Painter & pain, LyXFont const &,
 157                                       int baseline, float & x) const
 158 {
 159         int width = 0;
 160         pain.buttonText(int(x) + TEXT_TO_INSET_OFFSET,
 161                         baseline, draw_label, labelfont, true, width);
 162         x += width + TEXT_TO_INSET_OFFSET;
 163 }
 164
 165
 166 void InsetCollapsable::draw(BufferView * bv, LyXFont const & f,
 167                             int baseline, float & x, bool cleared) const
 168 {
 169         if (nodraw())
 170                 return;
 171
 172         Painter & pain = bv->painter();
 173
 174         if (!widthCollapsed)
 175                 widthCollapsed = width_collapsed(pain, f);
 176
 177         button_length = widthCollapsed;
 178         button_top_y = -ascent(bv, f);
 179         button_bottom_y = -ascent(bv, f) + ascent_collapsed(pain,f) +
 180                 descent_collapsed(pain, f);
 181
 182         if (collapsed_) {
 183                 draw_collapsed(pain, f, baseline, x);
 184                 x += TEXT_TO_INSET_OFFSET;
 185                 return;
 186         }
 187
 188         float old_x = x;
 189
 190 #if 0
 191         UpdatableInset::draw(bv, f, baseline, x, cleared);
 192 #else
 193         if (!owner())
 194                 x += static_cast<float>(scroll());
 195 #endif
 196         if (!cleared && (inset.need_update == InsetText::FULL ||
 197                          inset.need_update == InsetText::INIT ||
 198                          top_x != int(x) ||
 199                          top_baseline != baseline))
 200         {
 201 #if 1
 202                 // we don't need anymore to clear here we just have to tell
 203                 // the underlying LyXText that it should do the RowClear!
 204                 inset.setUpdateStatus(bv, InsetText::FULL);
 205                 bv->text->status(bv, LyXText::CHANGED_IN_DRAW);
 206                 return;
 207 #else
 208                 int w =  owner() ? width(bv, f) : pain.paperWidth();
 209                 int h = ascent(bv, f) + descent(bv, f);
 210                 int const tx = (needFullRow() && !owner()) ? 0 : int(x);
 211                 int const ty = max(0, baseline - ascent(bv, f));
 212
 213                 if ((ty + h) > pain.paperHeight())
 214                         h = pain.paperHeight();
 215                 if ((top_x + w) > pain.paperWidth())
 216                         w = pain.paperWidth();
 217                 if (baseline < 0)
 218                         h += (baseline - ascent(bv, f));
 219                 pain.fillRectangle(tx, ty - 1, w, h + 2);
 220                 cleared = true;
 221 #endif
 222         }
 223
 224         top_x = int(x);
 225         top_baseline = baseline;
 226
 227         int const bl = baseline - ascent(bv, f) + ascent_collapsed(pain, f);
 228
 229         draw_collapsed(pain, f, bl, old_x);
 230         inset.draw(bv, f,
 231                    bl + descent_collapsed(pain, f) + inset.ascent(bv, f),
 232                    x, cleared);
 233         need_update = NONE;
 234 }
 235
 236
 237 void InsetCollapsable::edit(BufferView * bv, int xp, int yp,
 238                             unsigned int button)
 239 {
 240         UpdatableInset::edit(bv, xp, yp, button);
 241
 242         if (collapsed_) {
 243                 draw_label = label;
 244                 collapsed_ = false;
 245                 if (!bv->lockInset(this))
 246                         return;
 247                 bv->updateInset(this, false);
 248                 inset.edit(bv, 0, 0, button);
 249         } else {
 250                 if (!bv->lockInset(this))
 251                         return;
 252                 LyXFont font(LyXFont::ALL_SANE);
 253                 int yy = ascent(bv, font) + yp -
 254                     (ascent_collapsed(bv->painter(), font) +
 255                      descent_collapsed(bv->painter(), font) +
 256                      inset.ascent(bv, font));
 257                 inset.edit(bv, xp, yy, button);
 258         }
 259 }
 260
 261
 262 void InsetCollapsable::edit(BufferView * bv, bool front)
 263 {
 264         UpdatableInset::edit(bv, front);
 265
 266         if (collapsed_) {
 267                 draw_label = label;
 268                 collapsed_ = false;
 269                 if (!bv->lockInset(this))
 270                         return;
 271                 bv->updateInset(this, false);
 272                 inset.edit(bv, front);
 273         } else {
 274                 if (!bv->lockInset(this))
 275                         return;
 276                 inset.edit(bv, front);
 277         }
 278 }
 279
 280
 281 Inset::EDITABLE InsetCollapsable::editable() const
 282 {
 283         if (collapsed_)
 284                 return IS_EDITABLE;
 285         return HIGHLY_EDITABLE;
 286 }
 287
 288
 289 void InsetCollapsable::insetUnlock(BufferView * bv)
 290 {
 291         if (autocollapse) {
 292                 if (change_label_with_text) {
 293                         draw_label = get_new_label();
 294                 } else {
 295                         draw_label = label;
 296                 }
 297                 collapsed_ = true;
 298         }
 299         inset.insetUnlock(bv);
 300         if (scroll())
 301                 scroll(bv, 0.0F);
 302         bv->updateInset(this, false);
 303 }
 304
 305
 306 void InsetCollapsable::insetButtonPress(BufferView * bv, int x, int y,
 307                                         int button)
 308 {
 309         if (!collapsed_ && (y > button_bottom_y)) {
 310                 LyXFont font(LyXFont::ALL_SANE);
 311                 int yy = ascent(bv, font) + y -
 312                     (ascent_collapsed(bv->painter(), font) +
 313                      descent_collapsed(bv->painter(), font) +
 314                      inset.ascent(bv, font));
 315                 inset.insetButtonPress(bv, x, yy, button);
 316         }
 317 }
 318
 319
 320 void InsetCollapsable::insetButtonRelease(BufferView * bv,
 321                                           int x, int y, int button)
 322 {
 323         if ((x >= 0)  && (x < button_length) &&
 324             (y >= button_top_y) &&  (y <= button_bottom_y)) {
 325                 if (collapsed_) {
 326                         draw_label = label;
 327                         collapsed_ = false;
 328                         inset.insetButtonRelease(bv, 0, 0, button);
 329                         bv->updateInset(this, false);
 330                 } else {
 331                         if (change_label_with_text) {
 332                                 draw_label = get_new_label();
 333                         } else {
 334                                 draw_label = label;
 335                         }
 336                         collapsed_ = true;
 337                         bv->unlockInset(this);
 338                         bv->updateInset(this, false);
 339                 }
 340         } else if (!collapsed_ && (y > button_top_y)) {
 341                 LyXFont font(LyXFont::ALL_SANE);
 342                 int yy = ascent(bv, font) + y -
 343                     (ascent_collapsed(bv->painter(), font) +
 344                      descent_collapsed(bv->painter(), font) +
 345                      inset.ascent(bv, font));
 346                 inset.insetButtonRelease(bv, x, yy, button);
 347         }
 348 }
 349
 350
 351 void InsetCollapsable::insetMotionNotify(BufferView * bv,
 352                                          int x, int y, int state)
 353 {
 354         if (x > button_bottom_y) {
 355                 LyXFont font(LyXFont::ALL_SANE);
 356                 int yy = ascent(bv, font) + y -
 357                     (ascent_collapsed(bv->painter(), font) +
 358                      descent_collapsed(bv->painter(), font) +
 359                      inset.ascent(bv, font));
 360                 inset.insetMotionNotify(bv, x, yy, state);
 361         }
 362 }
 363
 364
 365 void InsetCollapsable::insetKeyPress(XKeyEvent * xke)
 366 {
 367         inset.insetKeyPress(xke);
 368 }
 369
 370
 371 int InsetCollapsable::latex(Buffer const * buf, ostream & os,
 372                             bool fragile, bool free_spc) const
 373 {
 374         return inset.latex(buf, os, fragile, free_spc);
 375 }
 376
 377
 378 int InsetCollapsable::getMaxWidth(BufferView * bv,
 379                                   UpdatableInset const * inset) const
 380 {
 381         int const w = UpdatableInset::getMaxWidth(bv, inset);
 382
 383         if (w < 0) {
 384                 // What does a negative max width signify? (Lgb)
 385                 // Use the max width of the draw-area (Jug)
 386                 return w;
 387         }
 388         // should be at least 30 pixels !!!
 389         return max(30, w - widthCollapsed);
 390 }
 391
 392
 393 void InsetCollapsable::update(BufferView * bv, LyXFont const & font,
 394                               bool reinit)
 395 {
 396 #if 0
 397         if (reinit) {
 398                 need_update = FULL;
 399                 if (owner())
 400                         owner()->update(bv, font, true);
 401                 return;
 402         }
 403         if (!widthCollapsed) {
 404                 widthCollapsed = width_collapsed(bv->painter(), font);
 405                 inset.resizeLyXText(bv);
 406                 need_update = FULL;
 407                 if (owner()) {
 408                         owner()->update(bv, font);
 409                         return;
 410                 }
 411         }
 412         if (oldWidth != width(bv, font)) {
 413                 oldWidth = width(bv, font);
 414                 inset.resizeLyXText(bv);
 415                 need_update = FULL;
 416                 if (owner()) {
 417                         owner()->update(bv, font);
 418                         return;
 419                 }
 420         }
 421 #else
 422         if (!widthCollapsed)
 423                 widthCollapsed = width_collapsed(bv->painter(), font);
 424         inset.update(bv, font, reinit);
 425 #endif
 426 }
 427
 428
 429 UpdatableInset::RESULT
 430 InsetCollapsable::localDispatch(BufferView * bv, kb_action action,
 431                                 string const & arg)
 432 {
 433         UpdatableInset::RESULT result = inset.localDispatch(bv, action, arg);
 434         if (result == FINISHED)
 435                 bv->unlockInset(this);
 436         return result;
 437 }
 438
 439
 440 bool InsetCollapsable::lockInsetInInset(BufferView * bv, UpdatableInset * in)
 441 {
 442         if (&inset == in)
 443                 return true;
 444         return inset.lockInsetInInset(bv, in);
 445 }
 446
 447
 448 bool InsetCollapsable::unlockInsetInInset(BufferView * bv, UpdatableInset * in,
 449                                           bool lr)
 450 {
 451         if (&inset == in) {
 452                 bv->unlockInset(this);
 453                 return true;
 454         }
 455         return inset.unlockInsetInInset(bv, in, lr);
 456 }
 457
 458
 459 bool InsetCollapsable::updateInsetInInset(BufferView * bv, Inset *in)
 460 {
 461         if (&inset == in)
 462                 return true;
 463         return inset.updateInsetInInset(bv, in);
 464 }
 465
 466
 467 unsigned int InsetCollapsable::insetInInsetY()
 468 {
 469         return inset.insetInInsetY() - (top_baseline - inset.y());
 470 }
 471
 472
 473 void InsetCollapsable::validate(LaTeXFeatures & features) const
 474 {
 475         inset.validate(features);
 476 }
 477
 478
 479 void InsetCollapsable::getCursorPos(BufferView * bv, int & x, int & y) const
 480 {
 481         inset.getCursorPos(bv, x , y);
 482 }
 483
 484
 485 void InsetCollapsable::toggleInsetCursor(BufferView * bv)
 486 {
 487         inset.toggleInsetCursor(bv);
 488 }
 489
 490
 491 void InsetCollapsable::showInsetCursor(BufferView * bv, bool show)
 492 {
 493         inset.showInsetCursor(bv, show);
 494 }
 495
 496
 497 void InsetCollapsable::hideInsetCursor(BufferView * bv)
 498 {
 499         inset.hideInsetCursor(bv);
 500 }
 501
 502
 503 UpdatableInset * InsetCollapsable::getLockingInset() const
 504 {
 505         UpdatableInset * in = inset.getLockingInset();
 506         if (const_cast<InsetText *>(&inset) == in)
 507                 return const_cast<InsetCollapsable *>(this);
 508         return in;
 509 }
 510
 511
 512 UpdatableInset * InsetCollapsable::getFirstLockingInsetOfType(Inset::Code c)
 513 {
 514         if (c == lyxCode())
 515                 return this;
 516         return inset.getFirstLockingInsetOfType(c);
 517 }
 518
 519
 520 void InsetCollapsable::setFont(BufferView * bv, LyXFont const & font,
 521                                bool toggleall, bool selectall)
 522 {
 523         inset.setFont(bv, font, toggleall, selectall);
 524 }
 525
 526
 527 bool InsetCollapsable::doClearArea() const
 528 {
 529         return inset.doClearArea();
 530 }
 531
 532
 533 LyXText * InsetCollapsable::getLyXText(BufferView const * bv,
 534                                        bool const recursive) const
 535 {
 536         return inset.getLyXText(bv, recursive);
 537 }
 538
 539
 540 void InsetCollapsable::deleteLyXText(BufferView * bv, bool recursive) const
 541 {
 542         inset.deleteLyXText(bv, recursive);
 543 }
 544
 545
 546 void InsetCollapsable::resizeLyXText(BufferView * bv, bool force) const
 547 {
 548         inset.resizeLyXText(bv, force);
 549         LyXFont font(LyXFont::ALL_SANE);
 550         oldWidth = width(bv, font);
 551 }
 552
 553
 554 std::vector<string> const InsetCollapsable::getLabelList() const
 555 {
 556         return inset.getLabelList();
 557 }
 558
 559
 560 bool InsetCollapsable::nodraw() const
 561 {
 562         return inset.nodraw();
 563 }
 564
 565
 566 int InsetCollapsable::scroll(bool recursive) const
 567 {
 568         int sx = UpdatableInset::scroll(false);
 569
 570         if (recursive)
 571                 sx += inset.scroll(recursive);
 572
 573         return sx;
 574 }
 575
 576
 577 Paragraph * InsetCollapsable::getParFromID(int id) const
 578 {
 579         return inset.getParFromID(id);
 580 }
 581
 582
 583 Paragraph * InsetCollapsable::firstParagraph() const
 584 {
 585         return inset.firstParagraph();
 586 }
 587
 588
 589 LyXCursor const & InsetCollapsable::cursor(BufferView * bv) const
 590 {
 591         return inset.cursor(bv);
 592 }
 593
 594
 595 Inset * InsetCollapsable::getInsetFromID(int id_arg) const
 596 {
 597         if (id_arg == id())
 598                 return const_cast<InsetCollapsable *>(this);
 599         return inset.getInsetFromID(id_arg);
 600 }
 601
 602 void InsetCollapsable::open(BufferView * bv, bool flag)
 603 {
 604         if (flag == !collapsed_)
 605                 return;
 606         collapsed_ = !flag;
 607         if (collapsed_ && change_label_with_text) {
 608                 draw_label = get_new_label();
 609         } else {
 610                 draw_label = label;
 611         }
 612         bv->updateInset(this, false);
 613 }
 614
 615
 616 void InsetCollapsable::setLabel(string const & l, bool flag)
 617 {
 618         label = l;
 619         change_label_with_text = flag;
 620         if (collapsed_ && change_label_with_text) {
 621                 draw_label = get_new_label();
 622         } else {
 623                 draw_label = label;
 624         }
 625 }
 626
 627
 628 string InsetCollapsable::get_new_label() const
 629 {
 630         string la;
 631
 632         int n = std::min(10, inset.paragraph()->size());
 633         int i,j;
 634         for(i=0,j=0; i < n && j < inset.paragraph()->size(); ++j) {
 635                 if (inset.paragraph()->isInset(j))
 636                         continue;
 637                 la += inset.paragraph()->getChar(j);
 638                 ++i;
 639         }
 640         if ((i > 0) && (j < inset.paragraph()->size()))
 641                 la += "...";
 642         if (la.empty())
 643                 la = label;
 644         return la;
 645 }