src/insets/insetcollapsable.C

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