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