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