src/insets/insetcollapsable.C

   1 /**
   2  * \file insetcollapsable.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alejandro Aguilar Sierra
   7  * \author Jürgen Vigna
   8  * \author Lars Gullik Bjønnes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "insetcollapsable.h"
  16
  17 #include "buffer.h"
  18 #include "BufferView.h"
  19 #include "debug.h"
  20 #include "dispatchresult.h"
  21 #include "LColor.h"
  22 #include "lyxlex.h"
  23 #include "funcrequest.h"
  24 #include "metricsinfo.h"
  25 #include "paragraph.h"
  26
  27 #include "frontends/font_metrics.h"
  28 #include "frontends/Painter.h"
  29 #include "frontends/LyXView.h"
  30
  31
  32 using lyx::graphics::PreviewLoader;
  33
  34 using std::endl;
  35 using std::string;
  36 using std::max;
  37 using std::ostream;
  38
  39
  40 InsetCollapsable::InsetCollapsable(BufferParams const & bp, bool collapsed)
  41         : UpdatableInset(), inset(bp), collapsed_(collapsed),
  42           button_dim(0, 0, 0, 0), label("Label"),
  43 #if 0
  44         autocollapse(false),
  45 #endif
  46           in_update(false), first_after_edit(false)
  47 {
  48         inset.setOwner(this);
  49         inset.setAutoBreakRows(true);
  50         inset.setDrawFrame(InsetText::ALWAYS);
  51         inset.setFrameColor(LColor::collapsableframe);
  52         setInsetName("Collapsable");
  53 }
  54
  55
  56 InsetCollapsable::InsetCollapsable(InsetCollapsable const & in)
  57         : UpdatableInset(in), inset(in.inset), collapsed_(in.collapsed_),
  58           labelfont_(in.labelfont_), button_dim(0, 0, 0, 0), label(in.label),
  59 #if 0
  60           autocollapse(in.autocollapse),
  61 #endif
  62           in_update(false), first_after_edit(false)
  63 {
  64         inset.setOwner(this);
  65 }
  66
  67
  68 bool InsetCollapsable::insertInset(BufferView * bv, InsetOld * in)
  69 {
  70         if (!insetAllowed(in->lyxCode())) {
  71                 lyxerr << "InsetCollapsable::InsertInset: "
  72                         "Unable to insert inset." << endl;
  73                 return false;
  74         }
  75         return inset.insertInset(bv, in);
  76 }
  77
  78
  79 void InsetCollapsable::write(Buffer const & buf, ostream & os) const
  80 {
  81         os << "collapsed " << (collapsed_ ? "true" : "false") << "\n";
  82         inset.writeParagraphData(buf, os);
  83 }
  84
  85
  86 void InsetCollapsable::read(Buffer const & buf, LyXLex & lex)
  87 {
  88         if (lex.isOK()) {
  89                 lex.next();
  90                 string const token = lex.getString();
  91                 if (token == "collapsed") {
  92                         lex.next();
  93                         collapsed_ = lex.getBool();
  94                 } else {
  95                         lyxerr << "InsetCollapsable::Read: Missing collapsed!"
  96                                << endl;
  97                         // Take countermeasures
  98                         lex.pushToken(token);
  99                 }
 100         }
 101         inset.read(buf, lex);
 102 }
 103
 104
 105 void InsetCollapsable::dimension_collapsed(Dimension & dim) const
 106 {
 107         font_metrics::buttonText(label, labelfont_, dim.wid, dim.asc, dim.des);
 108 }
 109
 110
 111 int InsetCollapsable::height_collapsed() const
 112 {
 113         Dimension dim;
 114         font_metrics::buttonText(label, labelfont_, dim.wid, dim.asc, dim.des);
 115         return dim.asc + dim.des;
 116 }
 117
 118
 119 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 120 {
 121         //lyxerr << "InsetCollapsable::metrics:  width: " << mi.base.textwidth << endl;
 122         dimension_collapsed(dim);
 123         if (!collapsed_) {
 124                 Dimension insetdim;
 125                 inset.metrics(mi, insetdim);
 126                 dim.des += insetdim.height() + TEXT_TO_BOTTOM_OFFSET;
 127                 dim.wid = max(dim.wid, insetdim.wid);
 128         }
 129         dim_ = dim;
 130 }
 131
 132
 133 void InsetCollapsable::draw_collapsed(PainterInfo & pi, int x, int y) const
 134 {
 135         pi.pain.buttonText(x, y, label, labelfont_);
 136 }
 137
 138
 139 void InsetCollapsable::draw(PainterInfo & pi, int x, int y, bool inlined) const
 140 {
 141         Dimension dim_collapsed;
 142         dimension_collapsed(dim_collapsed);
 143
 144         int const aa  = ascent();
 145         button_dim.x1 = 0;
 146         button_dim.x2 = dim_collapsed.width();
 147         button_dim.y1 = -aa;
 148         button_dim.y2 = -aa + dim_collapsed.height();
 149
 150         if (!isOpen()) {
 151                 draw_collapsed(pi, x, y);
 152                 return;
 153         }
 154
 155         int old_x = x;
 156
 157         if (!owner())
 158                 x += scroll();
 159
 160         top_x = x;
 161         top_baseline = y;
 162
 163         int const bl = y - aa + dim_collapsed.ascent();
 164
 165         if (inlined) {
 166                 inset.draw(pi, x, y);
 167         } else {
 168                 draw_collapsed(pi, old_x, bl);
 169                 inset.draw(pi, x, bl + dim_collapsed.descent() + inset.ascent());
 170         }
 171 }
 172
 173
 174 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 175 {
 176         // by default, we are not inlined-drawing
 177         draw(pi, x, y, false);
 178 }
 179
 180
 181 InsetOld::EDITABLE InsetCollapsable::editable() const
 182 {
 183         return collapsed_ ? IS_EDITABLE : HIGHLY_EDITABLE;
 184 }
 185
 186
 187 void InsetCollapsable::insetUnlock(BufferView * bv)
 188 {
 189 #if 0
 190         if (autocollapse) {
 191                 if (change_label_with_text) {
 192                         draw_label = get_new_label();
 193                 } else {
 194                         draw_label = label;
 195                 }
 196                 collapsed_ = true;
 197         }
 198 #endif
 199         inset.insetUnlock(bv);
 200         if (scroll())
 201                 scroll(bv, 0.0F);
 202         bv->updateInset(this);
 203 }
 204
 205
 206 FuncRequest InsetCollapsable::adjustCommand(FuncRequest const & cmd)
 207 {
 208         FuncRequest cmd1 = cmd;
 209         cmd1.y = ascent() + cmd.y - (height_collapsed() + inset.ascent());
 210         return cmd1;
 211 }
 212
 213
 214 void InsetCollapsable::lfunMouseRelease(FuncRequest const & cmd)
 215 {
 216         bool ret = false;
 217         BufferView * bv = cmd.view();
 218
 219         if (collapsed_ && cmd.button() != mouse_button::button3) {
 220                 collapsed_ = false;
 221                 bv->updateInset(this);
 222                 bv->buffer()->markDirty();
 223                 return;
 224         }
 225
 226         if (cmd.button() != mouse_button::button3 && hitButton(cmd)) {
 227                 if (collapsed_) {
 228                         collapsed_ = false;
 229                 } else {
 230                         collapsed_ = true;
 231                         bv->unlockInset(this);
 232                 }
 233                 bv->updateInset(this);
 234                 bv->buffer()->markDirty();
 235         } else if (!collapsed_ && cmd.y > button_dim.y2) {
 236                 ret = inset.dispatch(adjustCommand(cmd)) == DispatchResult(true, true);
 237         }
 238         if (cmd.button() == mouse_button::button3 && !ret)
 239                 showInsetDialog(bv);
 240 }
 241
 242
 243 int InsetCollapsable::latex(Buffer const & buf, ostream & os,
 244                             LatexRunParams const & runparams) const
 245 {
 246         return inset.latex(buf, os, runparams);
 247 }
 248
 249
 250 int InsetCollapsable::ascii(Buffer const & buf, ostream & os,
 251                             LatexRunParams const & runparams) const
 252 {
 253         return inset.ascii(buf, os, runparams);
 254 }
 255
 256
 257 int InsetCollapsable::linuxdoc(Buffer const & buf, ostream & os,
 258                                LatexRunParams const & runparams) const
 259 {
 260         return inset.linuxdoc(buf, os, runparams);
 261 }
 262
 263
 264 int InsetCollapsable::docbook(Buffer const & buf, ostream & os,
 265                               LatexRunParams const & runparams) const
 266 {
 267         return inset.docbook(buf, os, runparams);
 268 }
 269
 270
 271 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
 272 {
 273         return button_dim.contains(cmd.x, cmd.y);
 274 }
 275
 276
 277 void InsetCollapsable::edit(BufferView * bv, bool left)
 278 {
 279         lyxerr << "InsetCollapsable: edit" << endl;
 280         if (!bv->lockInset(this))
 281                 lyxerr << "InsetCollapsable: can't lock" << endl;
 282         inset.edit(bv, left);
 283         first_after_edit = true;
 284         open(bv);
 285 }
 286
 287 /*
 288         if (!cmd.argument.empty()) {
 289                 UpdatableInset::edit(
 290                 if (collapsed_) {
 291                         lyxerr << "branch collapsed_" << endl;
 292                         collapsed_ = false;
 293                         if (bv->lockInset(this)) {
 294                                 bv->updateInset(this);
 295                                 bv->buffer()->markDirty();
 296                                 inset.dispatch(cmd);
 297                                 first_after_edit = true;
 298                         }
 299                 } else {
 300                         lyxerr << "branch not collapsed_" << endl;
 301                         if (bv->lockInset(this))
 302                                 inset.dispatch(cmd);
 303                 }
 304                 return;
 305         }
 306         UpdatableInset::edit(cmd, idx, pos);
 307 */
 308
 309
 310 void InsetCollapsable::edit(BufferView * bv, int x, int y)
 311 {
 312         if (collapsed_) {
 313                 collapsed_ = false;
 314                 // set this only here as it should be recollapsed only if
 315                 // it was already collapsed!
 316                 first_after_edit = true;
 317                 if (!bv->lockInset(this))
 318                         return;
 319                 bv->updateInset(this);
 320                 bv->buffer()->markDirty();
 321                 inset.edit(bv, x, y);
 322         } else {
 323                 if (!bv->lockInset(this))
 324                         return;
 325                 if (y <= button_dim.y2)
 326                         inset.edit(bv, x, 0);
 327                 else
 328                         inset.edit(bv, x,
 329                                 ascent() + y - (height_collapsed() + inset.ascent()));
 330         }
 331 }
 332
 333
 334 DispatchResult
 335 InsetCollapsable::priv_dispatch(FuncRequest const & cmd,
 336                                 idx_type & idx, pos_type & pos)
 337 {
 338         //lyxerr << "InsetCollapsable::localDispatch: "
 339         //      << cmd.action << " '" << cmd.argument << "'\n";
 340         BufferView * bv = cmd.view();
 341         switch (cmd.action) {
 342                 case LFUN_MOUSE_PRESS:
 343                         if (!collapsed_ && cmd.y > button_dim.y2)
 344                                 inset.dispatch(adjustCommand(cmd));
 345                         return DispatchResult(true, true);
 346
 347                 case LFUN_MOUSE_MOTION:
 348                         if (!collapsed_ && cmd.y > button_dim.y2)
 349                                 inset.dispatch(adjustCommand(cmd));
 350                         return DispatchResult(true, true);
 351
 352                 case LFUN_MOUSE_RELEASE:
 353                         lfunMouseRelease(cmd);
 354                         return DispatchResult(true, true);
 355
 356                 default:
 357                         DispatchResult const result = inset.dispatch(cmd);
 358                         first_after_edit = false;
 359                         return result;
 360         }
 361 }
 362
 363
 364 bool InsetCollapsable::lockInsetInInset(BufferView * bv, UpdatableInset * in)
 365 {
 366         if (&inset == in)
 367                 return true;
 368         return inset.lockInsetInInset(bv, in);
 369 }
 370
 371
 372 bool InsetCollapsable::unlockInsetInInset(BufferView * bv, UpdatableInset * in,
 373                                           bool lr)
 374 {
 375         if (&inset == in) {
 376                 bv->unlockInset(this);
 377                 return true;
 378         }
 379         return inset.unlockInsetInInset(bv, in, lr);
 380 }
 381
 382
 383 int InsetCollapsable::insetInInsetY() const
 384 {
 385         return inset.insetInInsetY() - (top_baseline - inset.y());
 386 }
 387
 388
 389 void InsetCollapsable::validate(LaTeXFeatures & features) const
 390 {
 391         inset.validate(features);
 392 }
 393
 394
 395 void InsetCollapsable::getCursor(BufferView & bv, int & x, int & y) const
 396 {
 397         inset.getCursor(bv, x, y);
 398 }
 399
 400
 401 void InsetCollapsable::getCursorPos(BufferView * bv, int & x, int & y) const
 402 {
 403         inset.getCursorPos(bv, x , y);
 404 }
 405
 406
 407 UpdatableInset * InsetCollapsable::getLockingInset() const
 408 {
 409         UpdatableInset * in = inset.getLockingInset();
 410         if (&inset == in)
 411                 return const_cast<InsetCollapsable *>(this);
 412         return in;
 413 }
 414
 415
 416 UpdatableInset * InsetCollapsable::getFirstLockingInsetOfType(InsetOld::Code c)
 417 {
 418         if (c == lyxCode())
 419                 return this;
 420         return inset.getFirstLockingInsetOfType(c);
 421 }
 422
 423
 424 void InsetCollapsable::setFont(BufferView * bv, LyXFont const & font,
 425                                bool toggleall, bool selectall)
 426 {
 427         inset.setFont(bv, font, toggleall, selectall);
 428 }
 429
 430
 431 LyXText * InsetCollapsable::getLyXText(BufferView const * bv,
 432                                        bool const recursive) const
 433 {
 434         return inset.getLyXText(bv, recursive);
 435 }
 436
 437
 438 void InsetCollapsable::deleteLyXText(BufferView * bv, bool recursive) const
 439 {
 440         inset.deleteLyXText(bv, recursive);
 441 }
 442
 443
 444 void InsetCollapsable::getLabelList(Buffer const & buffer,
 445                                     std::vector<string> & list) const
 446 {
 447         inset.getLabelList(buffer, list);
 448 }
 449
 450
 451 int InsetCollapsable::scroll(bool recursive) const
 452 {
 453         int sx = UpdatableInset::scroll(false);
 454
 455         if (recursive)
 456                 sx += inset.scroll(recursive);
 457
 458         return sx;
 459 }
 460
 461
 462 ParagraphList * InsetCollapsable::getParagraphs(int i) const
 463 {
 464         return inset.getParagraphs(i);
 465 }
 466
 467
 468 int InsetCollapsable::numParagraphs() const
 469 {
 470         return inset.numParagraphs();
 471 }
 472
 473
 474 LyXText * InsetCollapsable::getText(int i) const
 475 {
 476         return inset.getText(i);
 477 }
 478
 479
 480 LyXCursor const & InsetCollapsable::cursor(BufferView * bv) const
 481 {
 482         return inset.cursor(bv);
 483 }
 484
 485
 486 void InsetCollapsable::open(BufferView * bv)
 487 {
 488         if (!collapsed_)
 489                 return;
 490
 491         collapsed_ = false;
 492         bv->updateInset(this);
 493 }
 494
 495
 496 void InsetCollapsable::close(BufferView * bv) const
 497 {
 498         if (collapsed_)
 499                 return;
 500
 501         collapsed_ = true;
 502         bv->updateInset(this);
 503 }
 504
 505
 506 void InsetCollapsable::setLabel(string const & l) const
 507 {
 508         label = l;
 509 }
 510
 511
 512 void InsetCollapsable::setCollapsed(bool c) const
 513 {
 514         collapsed_ = c;
 515 }
 516
 517
 518 void InsetCollapsable::markErased()
 519 {
 520         inset.markErased();
 521 }
 522
 523
 524 void InsetCollapsable::addPreview(PreviewLoader & loader) const
 525 {
 526         inset.addPreview(loader);
 527 }