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