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