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 (!insertInsetAllowed(in)) {
  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 = 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 && autocollapse) {
 233                 collapsed = false;
 234                 if (!bv->lockInset(this))
 235                         return;
 236                 bv->updateInset(this, false);
 237                 inset.edit(bv, 0, 0, button);
 238         } else if (!collapsed) {
 239                 if (!bv->lockInset(this))
 240                         return;
 241                 inset.edit(bv, xp, yp + (top_baseline - inset.y()), button);
 242         }
 243 }
 244
 245
 246 Inset::EDITABLE InsetCollapsable::editable() const
 247 {
 248         if (collapsed)
 249                 return IS_EDITABLE;
 250         return HIGHLY_EDITABLE;
 251 }
 252
 253
 254 void InsetCollapsable::insetUnlock(BufferView * bv)
 255 {
 256         if (autocollapse) {
 257                 collapsed = true;
 258         }
 259         inset.insetUnlock(bv);
 260         if (scroll())
 261                 scroll(bv, 0.0F);
 262         bv->updateInset(this, false);
 263 }
 264
 265
 266 void InsetCollapsable::insetButtonPress(BufferView * bv, int x, int y,
 267                                         int button)
 268 {
 269         if (!collapsed && (y > button_bottom_y)) {
 270                 inset.insetButtonPress(bv, x, y + (top_baseline - inset.y()),
 271                                        button);
 272         }
 273 }
 274
 275
 276 void InsetCollapsable::insetButtonRelease(BufferView * bv,
 277                                           int x, int y, int button)
 278 {
 279         if ((x >= 0)  && (x < button_length) &&
 280             (y >= button_top_y) &&  (y <= button_bottom_y)) {
 281                 if (collapsed) {
 282                         collapsed = false;
 283                         inset.insetButtonRelease(bv, 0, 0, button);
 284                         bv->updateInset(this, false);
 285                 } else {
 286                         collapsed = true;
 287                         bv->unlockInset(this);
 288                         bv->updateInset(this, false);
 289                 }
 290         } else if (!collapsed && (y > button_top_y)) {
 291                 inset.insetButtonRelease(bv, x, y + (top_baseline-inset.y()),
 292                                          button);
 293         }
 294 }
 295
 296
 297 void InsetCollapsable::insetMotionNotify(BufferView * bv,
 298                                          int x, int y, int state)
 299 {
 300         if (x > button_bottom_y) {
 301                 inset.insetMotionNotify(bv, x, y + (top_baseline - inset.y()),
 302                                         state);
 303         }
 304 }
 305
 306
 307 void InsetCollapsable::insetKeyPress(XKeyEvent * xke)
 308 {
 309         inset.insetKeyPress(xke);
 310 }
 311
 312
 313 int InsetCollapsable::latex(Buffer const * buf, ostream & os,
 314                             bool fragile, bool free_spc) const
 315 {
 316         return inset.latex(buf, os, fragile, free_spc);
 317 }
 318
 319
 320 int InsetCollapsable::getMaxWidth(BufferView * bv,
 321                                   UpdatableInset const * inset) const
 322 {
 323         int const w = UpdatableInset::getMaxWidth(bv, inset);
 324
 325         if (w < 0) {
 326                 // What does a negative max width signify? (Lgb)
 327                 // Use the max width of the draw-area (Jug)
 328                 return w;
 329         }
 330         // should be at least 30 pixels !!!
 331         return max(30, w - widthCollapsed);
 332 }
 333
 334
 335 void InsetCollapsable::update(BufferView * bv, LyXFont const & font,
 336                               bool reinit)
 337 {
 338         if (reinit) {
 339                 need_update = FULL;
 340                 if (owner())
 341                         owner()->update(bv, font, true);
 342                 return;
 343         }
 344         if (!widthCollapsed) {
 345                 widthCollapsed = width_collapsed(bv->painter(), font);
 346                 inset.resizeLyXText(bv);
 347                 need_update = FULL;
 348                 if (owner()) {
 349                         owner()->update(bv, font);
 350                         return;
 351                 }
 352         }
 353         if (oldWidth != width(bv, font)) {
 354                 oldWidth = width(bv, font);
 355                 inset.resizeLyXText(bv);
 356                 need_update = FULL;
 357                 if (owner()) {
 358                         owner()->update(bv, font);
 359                         return;
 360                 }
 361         }
 362         inset.update(bv, font);
 363 }
 364
 365
 366 UpdatableInset::RESULT
 367 InsetCollapsable::localDispatch(BufferView * bv, kb_action action,
 368                                 string const & arg)
 369 {
 370         UpdatableInset::RESULT result = inset.localDispatch(bv, action, arg);
 371         if (result == FINISHED)
 372                 bv->unlockInset(this);
 373         return result;
 374 }
 375
 376
 377 bool InsetCollapsable::lockInsetInInset(BufferView * bv, UpdatableInset * in)
 378 {
 379         if (&inset == in)
 380                 return true;
 381         return inset.lockInsetInInset(bv, in);
 382 }
 383
 384
 385 bool InsetCollapsable::unlockInsetInInset(BufferView * bv, UpdatableInset * in,
 386                                           bool lr)
 387 {
 388         if (&inset == in) {
 389                 bv->unlockInset(this);
 390                 return true;
 391         }
 392         return inset.unlockInsetInInset(bv, in, lr);
 393 }
 394
 395
 396 bool InsetCollapsable::updateInsetInInset(BufferView * bv, Inset *in)
 397 {
 398         if (&inset == in)
 399                 return true;
 400         return inset.updateInsetInInset(bv, in);
 401 }
 402
 403
 404 unsigned int InsetCollapsable::insetInInsetY()
 405 {
 406         return inset.insetInInsetY() - (top_baseline - inset.y());
 407 }
 408
 409
 410 void InsetCollapsable::validate(LaTeXFeatures & features) const
 411 {
 412         inset.validate(features);
 413 }
 414
 415
 416 void InsetCollapsable::getCursorPos(BufferView * bv, int & x, int & y) const
 417 {
 418         inset.getCursorPos(bv, x , y);
 419 }
 420
 421
 422 void InsetCollapsable::toggleInsetCursor(BufferView * bv)
 423 {
 424         inset.toggleInsetCursor(bv);
 425 }
 426
 427
 428 UpdatableInset * InsetCollapsable::getLockingInset()
 429 {
 430         UpdatableInset * in = inset.getLockingInset();
 431         if (&inset == in)
 432                 return this;
 433         return in;
 434 }
 435
 436
 437 UpdatableInset * InsetCollapsable::getFirstLockingInsetOfType(Inset::Code c)
 438 {
 439         if (c == lyxCode())
 440                 return this;
 441         return inset.getFirstLockingInsetOfType(c);
 442 }
 443
 444
 445 void InsetCollapsable::setFont(BufferView * bv, LyXFont const & font,
 446                                bool toggleall, bool selectall)
 447 {
 448         inset.setFont(bv, font, toggleall, selectall);
 449 }
 450
 451
 452 bool InsetCollapsable::doClearArea() const
 453 {
 454         return inset.doClearArea();
 455 }
 456
 457
 458 LyXText * InsetCollapsable::getLyXText(BufferView const * bv,
 459                                        bool const recursive) const
 460 {
 461         return inset.getLyXText(bv, recursive);
 462 }
 463
 464
 465 void InsetCollapsable::deleteLyXText(BufferView * bv, bool recursive) const
 466 {
 467         inset.deleteLyXText(bv, recursive);
 468 }
 469
 470
 471 void InsetCollapsable::resizeLyXText(BufferView * bv, bool force) const
 472 {
 473         inset.resizeLyXText(bv, force);
 474         LyXFont font(LyXFont::ALL_SANE);
 475         oldWidth = width(bv, font);
 476 }
 477
 478
 479 std::vector<string> const InsetCollapsable::getLabelList() const
 480 {
 481         return inset.getLabelList();
 482 }
 483
 484
 485 bool InsetCollapsable::nodraw() const
 486 {
 487         return inset.nodraw();
 488 }
 489
 490
 491 int InsetCollapsable::scroll(bool recursive) const
 492 {
 493         int sx = UpdatableInset::scroll(false);
 494
 495         if (recursive)
 496                 sx += inset.scroll(recursive);
 497
 498         return sx;
 499 }