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 InsetCollapsable::InsetCollapsable()
  35         : UpdatableInset(), inset(new InsetText)
  36 {
  37         //inset = new InsetText;
  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::footnoteframe);
  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 Inset * InsetCollapsable::Clone(Buffer const &) const
  53 {
  54     InsetCollapsable * result = new InsetCollapsable();
  55     result->inset->init(inset);
  56     result->inset->setOwner(result);
  57
  58     result->collapsed = collapsed;
  59     return result;
  60 }
  61
  62
  63 bool InsetCollapsable::InsertInset(BufferView * bv, Inset * in)
  64 {
  65     if (!InsertInsetAllowed(in)) {
  66         lyxerr << "InsetCollapsable::InsertInset: "
  67                 "Unable to insert inset." << endl;
  68         return false;
  69     }
  70
  71     return inset->InsertInset(bv, in);
  72 }
  73
  74
  75 void InsetCollapsable::Write(Buffer const * buf, ostream & os) const
  76 {
  77     os << "collapsed " << tostr(collapsed) << "\n";
  78     inset->WriteParagraphData(buf, os);
  79 }
  80
  81
  82
  83 void InsetCollapsable::Read(Buffer const * buf, LyXLex & lex)
  84 {
  85     if (lex.IsOK()) {
  86         lex.next();
  87         string const token = lex.GetString();
  88         if (token == "collapsed") {
  89             lex.next();
  90             collapsed = lex.GetBool();
  91         } else {
  92                 lyxerr << "InsetCollapsable::Read: Missing collapsed!"
  93                        << endl;
  94         }
  95     }
  96     inset->Read(buf, lex);
  97 }
  98
  99
 100 int InsetCollapsable::ascent_collapsed(Painter & pain, LyXFont const &) const
 101 {
 102     int width = 0;
 103     int ascent = 0;
 104     int descent = 0;
 105     pain.buttonText(0, 0, label, labelfont, false,
 106                     width, ascent, descent);
 107     return ascent;
 108 }
 109
 110
 111 int InsetCollapsable::descent_collapsed(Painter & pain, LyXFont const &) const
 112 {
 113     int width = 0;
 114     int ascent = 0;
 115     int descent = 0;
 116     pain.buttonText(0, 0, label, labelfont, false,
 117                     width, ascent, descent);
 118     return descent;
 119 }
 120
 121
 122 int InsetCollapsable::width_collapsed(Painter & pain, LyXFont const &) const
 123 {
 124     int width;
 125     int ascent;
 126     int descent;
 127     pain.buttonText(TEXT_TO_INSET_OFFSET, 0, label, labelfont, false,
 128                     width, ascent, descent);
 129     return width + (2*TEXT_TO_INSET_OFFSET);
 130 }
 131
 132
 133 int InsetCollapsable::ascent(BufferView * bv, LyXFont const & font) const
 134 {
 135     return ascent_collapsed(bv->painter(), font);
 136 }
 137
 138
 139 int InsetCollapsable::descent(BufferView * bv, LyXFont const & font) const
 140 {
 141     if (collapsed)
 142         return descent_collapsed(bv->painter(), font);
 143
 144     return descent_collapsed(bv->painter(), font) + inset->descent(bv, font) +
 145         inset->ascent(bv, font) + TEXT_TO_BOTTOM_OFFSET;
 146 }
 147
 148
 149 int InsetCollapsable::width(BufferView * bv, LyXFont const & font) const
 150 {
 151     if (collapsed)
 152         return widthCollapsed;
 153
 154     return (inset->width(bv, font) > widthCollapsed) ?
 155         inset->width(bv, font) : widthCollapsed;
 156 }
 157
 158
 159 void InsetCollapsable::draw_collapsed(Painter & pain, LyXFont const &,
 160                                       int baseline, float & x) const
 161 {
 162     int width = 0;
 163     pain.buttonText(int(x) + TEXT_TO_INSET_OFFSET,
 164                     baseline, label, labelfont, true, width);
 165     x += width + TEXT_TO_INSET_OFFSET;
 166 }
 167
 168
 169 void InsetCollapsable::draw(BufferView * bv, LyXFont const & f,
 170                             int baseline, float & x, bool cleared) const
 171 {
 172     Painter & pain = bv->painter();
 173
 174     button_length = widthCollapsed;
 175     button_top_y = -ascent(bv, f);
 176     button_bottom_y = -ascent(bv, f) + ascent_collapsed(pain,f) +
 177         descent_collapsed(pain, f);
 178     if (collapsed) {
 179         draw_collapsed(pain, f, baseline, x);
 180         x += TEXT_TO_INSET_OFFSET;
 181         return;
 182     }
 183
 184     if (!cleared && ((inset->need_update == InsetText::FULL) ||
 185                      (inset->need_update == InsetText::INIT) ||
 186                      (top_x != int(x)) || (top_baseline != baseline))) {
 187         int w =  owner() ? width(bv, f) : pain.paperWidth();
 188         int h = ascent(bv, f) + descent(bv, f);
 189         int tx = (needFullRow() && !owner()) ? 0 : int(x);
 190         int ty = max(0, baseline - ascent(bv, f));
 191
 192         if ((ty + h) > pain.paperHeight())
 193             h = pain.paperHeight();
 194         if ((top_x + w) > pain.paperWidth())
 195             w = pain.paperWidth();
 196         if (baseline < 0)
 197             h += (baseline - ascent(bv, f));
 198         pain.fillRectangle(tx, ty - 1, w, h + 2);
 199         cleared = true;
 200     }
 201
 202     top_x = int(x);
 203     top_baseline = baseline;
 204
 205     float dummy = x;
 206     int bl = baseline - ascent(bv, f) + ascent_collapsed(pain, f);
 207
 208     draw_collapsed(pain, f, bl, dummy);
 209     inset->draw(bv, f,
 210                 bl + descent_collapsed(pain, f) + inset->ascent(bv, f),
 211                 x, cleared);
 212     need_update = NONE;
 213 }
 214
 215
 216 void InsetCollapsable::Edit(BufferView * bv, int xp, int yp, unsigned int button)
 217 {
 218     UpdatableInset::Edit(bv, xp, yp, button);
 219
 220     if (collapsed && autocollapse) {
 221         collapsed = false;
 222         if (!bv->lockInset(this))
 223             return;
 224         bv->updateInset(this, false);
 225         inset->Edit(bv, 0, 0, button);
 226     } else if (!collapsed) {
 227         if (!bv->lockInset(this))
 228             return;
 229         inset->Edit(bv, xp, yp+(top_baseline - inset->y()), button);
 230     }
 231 }
 232
 233
 234 Inset::EDITABLE InsetCollapsable::Editable() const
 235 {
 236         if (collapsed)
 237                 return IS_EDITABLE;
 238         return HIGHLY_EDITABLE;
 239 }
 240
 241
 242 void InsetCollapsable::InsetUnlock(BufferView * bv)
 243 {
 244     if (autocollapse) {
 245         collapsed = true;
 246     }
 247     inset->InsetUnlock(bv);
 248     bv->updateInset(this, false);
 249 }
 250
 251
 252 void InsetCollapsable::InsetButtonPress(BufferView * bv,int x,int y,int button)
 253 {
 254     if (!collapsed && (y > button_bottom_y)) {
 255         inset->InsetButtonPress(bv, x, y+(top_baseline - inset->y()), button);
 256     }
 257 }
 258
 259
 260 void InsetCollapsable::InsetButtonRelease(BufferView * bv,
 261                                           int x, int y, int button)
 262 {
 263     if ((x >= 0)  && (x < button_length) &&
 264         (y >= button_top_y) &&  (y <= button_bottom_y)) {
 265         if (collapsed) {
 266             collapsed = false;
 267             inset->InsetButtonRelease(bv, 0, 0, button);
 268             bv->updateInset(this, false);
 269         } else {
 270             collapsed = true;
 271             bv->unlockInset(this);
 272             bv->updateInset(this, false);
 273         }
 274     } else if (!collapsed && (y > button_top_y)) {
 275         inset->InsetButtonRelease(bv, x, y+(top_baseline-inset->y()), button);
 276     }
 277 }
 278
 279
 280 void InsetCollapsable::InsetMotionNotify(BufferView * bv,
 281                                          int x, int y, int state)
 282 {
 283     if (x > button_bottom_y) {
 284         inset->InsetMotionNotify(bv, x, y+(top_baseline - inset->y()), state);
 285     }
 286 }
 287
 288
 289 void InsetCollapsable::InsetKeyPress(XKeyEvent * xke)
 290 {
 291     inset->InsetKeyPress(xke);
 292 }
 293
 294
 295 int InsetCollapsable::Latex(Buffer const * buf, ostream & os,
 296                             bool fragile, bool free_spc) const
 297 {
 298     return inset->Latex(buf, os, fragile, free_spc);
 299 }
 300
 301
 302 int InsetCollapsable::getMaxWidth(Painter & pain,
 303                                   UpdatableInset const * inset) const
 304 {
 305     int const w = UpdatableInset::getMaxWidth(pain, inset);
 306
 307     if (w < 0) {
 308         // What does a negative max width signify? (Lgb)
 309         // Use the max width of the draw-area (Jug)
 310         return w;
 311     }
 312     // should be at least 30 pixels !!!
 313     return max(30, w - widthCollapsed);
 314 }
 315
 316
 317 void InsetCollapsable::update(BufferView * bv, LyXFont const & font,
 318                               bool reinit)
 319 {
 320     if (reinit) {
 321         need_update = FULL;
 322         if (owner())
 323             owner()->update(bv, font, true);
 324         return;
 325     }
 326     if (!widthCollapsed) {
 327         widthCollapsed = width_collapsed(bv->painter(), font);
 328         inset->resizeLyXText(bv);
 329         need_update = FULL;
 330         if (owner()) {
 331                 owner()->update(bv, font);
 332                 return;
 333         }
 334     }
 335     if (oldWidth != width(bv, font)) {
 336         oldWidth = width(bv, font);
 337         inset->resizeLyXText(bv);
 338         need_update = FULL;
 339         if (owner()) {
 340                 owner()->update(bv, font);
 341                 return;
 342         }
 343     }
 344     inset->update(bv, font);
 345 }
 346
 347
 348 UpdatableInset::RESULT
 349 InsetCollapsable::LocalDispatch(BufferView * bv, kb_action action,
 350                                 string const & arg)
 351 {
 352     UpdatableInset::RESULT result = inset->LocalDispatch(bv, action, arg);
 353     if (result == FINISHED)
 354         bv->unlockInset(this);
 355     return result;
 356 }
 357
 358
 359 bool InsetCollapsable::LockInsetInInset(BufferView * bv, UpdatableInset * in)
 360 {
 361     if (inset == in)
 362         return true;
 363     return inset->LockInsetInInset(bv, in);
 364 }
 365
 366
 367 bool InsetCollapsable::UnlockInsetInInset(BufferView * bv, UpdatableInset * in,
 368                                           bool lr)
 369 {
 370     if (inset == in) {
 371         bv->unlockInset(this);
 372         return true;
 373     }
 374     return inset->UnlockInsetInInset(bv, in, lr);
 375 }
 376
 377
 378 bool InsetCollapsable::UpdateInsetInInset(BufferView * bv, Inset *in)
 379 {
 380     if (in == inset)
 381         return true;
 382     return inset->UpdateInsetInInset(bv, in);
 383 }
 384
 385
 386 unsigned int InsetCollapsable::InsetInInsetY()
 387 {
 388     return inset->InsetInInsetY() - (top_baseline - inset->y());
 389 }
 390
 391
 392 void InsetCollapsable::Validate(LaTeXFeatures & features) const
 393 {
 394     inset->Validate(features);
 395 }
 396
 397
 398 void InsetCollapsable::GetCursorPos(BufferView * bv, int & x, int & y) const
 399 {
 400     inset->GetCursorPos(bv, x , y);
 401 }
 402
 403
 404 void InsetCollapsable::ToggleInsetCursor(BufferView * bv)
 405 {
 406     inset->ToggleInsetCursor(bv);
 407 }
 408
 409
 410 UpdatableInset * InsetCollapsable::GetLockingInset()
 411 {
 412     UpdatableInset * in = inset->GetLockingInset();
 413     if (inset == in)
 414         return this;
 415     return in;
 416 }
 417
 418
 419 UpdatableInset * InsetCollapsable::GetFirstLockingInsetOfType(Inset::Code c)
 420 {
 421     if (c == LyxCode())
 422         return this;
 423     return inset->GetFirstLockingInsetOfType(c);
 424 }
 425
 426
 427 void InsetCollapsable::SetFont(BufferView * bv,
 428                                LyXFont const & font, bool toggleall)
 429 {
 430     inset->SetFont(bv, font, toggleall);
 431 }
 432
 433
 434 bool InsetCollapsable::doClearArea() const
 435 {
 436     return inset->doClearArea();
 437 }
 438
 439
 440 LyXText * InsetCollapsable::getLyXText(BufferView const * bv,
 441                                        bool const recursive) const
 442 {
 443     return inset->getLyXText(bv, recursive);
 444 }
 445
 446
 447 void InsetCollapsable::deleteLyXText(BufferView * bv, bool recursive) const
 448 {
 449     inset->deleteLyXText(bv, recursive);
 450 }
 451
 452
 453 void InsetCollapsable::resizeLyXText(BufferView * bv) const
 454 {
 455     inset->resizeLyXText(bv);
 456     LyXFont font(LyXFont::ALL_SANE);
 457     oldWidth = width(bv, font);
 458 }