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