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                 return DispatchResult(true, true);
 209         }
 210
 211         if (hitButton(cmd)) {
 212                 if (!collapsed_) {
 213                         collapsed_ = true;
 214                         lyxerr << "InsetCollapsable::lfunMouseRelease 2" << endl;
 215                         return DispatchResult(false, FINISHED_RIGHT);
 216                 }
 217                 collapsed_ = false;
 218                 lyxerr << "InsetCollapsable::lfunMouseRelease 3" << endl;
 219         } else if (!collapsed_ && cmd.y > button_dim.y2) {
 220                 lyxerr << "InsetCollapsable::lfunMouseRelease 4" << endl;
 221                 return inset.dispatch(adjustCommand(cmd));
 222         }
 223
 224         lyxerr << "InsetCollapsable::lfunMouseRelease 5" << endl;
 225         return DispatchResult(true, true);
 226 }
 227
 228
 229 int InsetCollapsable::latex(Buffer const & buf, ostream & os,
 230                             OutputParams const & runparams) const
 231 {
 232         return inset.latex(buf, os, runparams);
 233 }
 234
 235
 236 int InsetCollapsable::plaintext(Buffer const & buf, ostream & os,
 237                             OutputParams const & runparams) const
 238 {
 239         return inset.plaintext(buf, os, runparams);
 240 }
 241
 242
 243 int InsetCollapsable::linuxdoc(Buffer const & buf, ostream & os,
 244                                OutputParams const & runparams) const
 245 {
 246         return inset.linuxdoc(buf, os, runparams);
 247 }
 248
 249
 250 int InsetCollapsable::docbook(Buffer const & buf, ostream & os,
 251                               OutputParams const & runparams) const
 252 {
 253         return inset.docbook(buf, os, runparams);
 254 }
 255
 256
 257 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
 258 {
 259         return button_dim.contains(cmd.x, cmd.y);
 260 }
 261
 262
 263 void InsetCollapsable::edit(BufferView * bv, bool left)
 264 {
 265         lyxerr << "InsetCollapsable: edit left/right" << endl;
 266         inset.edit(bv, left);
 267         open(bv);
 268         bv->cursor().push(this);
 269 }
 270
 271
 272 void InsetCollapsable::edit(BufferView * bv, int x, int y)
 273 {
 274         lyxerr << "InsetCollapsable: edit xy" << endl;
 275         if (collapsed_) {
 276                 collapsed_ = false;
 277                 // set this only here as it should be recollapsed only if
 278                 // it was already collapsed!
 279                 inset.edit(bv, x, y);
 280         } else {
 281                 if (y <= button_dim.y2)
 282                         inset.edit(bv, x, 0);
 283                 else
 284                         inset.edit(bv, x, ascent() + y - height_collapsed() + inset.ascent());
 285         }
 286         bv->cursor().push(this);
 287 }
 288
 289
 290 DispatchResult
 291 InsetCollapsable::priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &)
 292 {
 293         lyxerr << "\nInsetCollapsable::priv_dispatch (begin): cmd: " << cmd
 294                 << "  button y: " << button_dim.y2 << endl;
 295         switch (cmd.action) {
 296                 case LFUN_MOUSE_PRESS:
 297                         if (!collapsed_ && cmd.y > button_dim.y2)
 298                                 inset.dispatch(adjustCommand(cmd));
 299                         return DispatchResult(true, true);
 300
 301                 case LFUN_MOUSE_MOTION:
 302                         if (!collapsed_ && cmd.y > button_dim.y2)
 303                                 inset.dispatch(adjustCommand(cmd));
 304                         return DispatchResult(true, true);
 305
 306                 case LFUN_MOUSE_RELEASE:
 307                         if (!collapsed_ && cmd.y > button_dim.y2)
 308                                 inset.dispatch(adjustCommand(cmd));
 309                         else
 310                                 return lfunMouseRelease(cmd);
 311                         return DispatchResult(true, true);
 312
 313                 default:
 314                         return inset.dispatch(cmd);
 315         }
 316         lyxerr << "InsetCollapsable::priv_dispatch (end)" << endl;
 317 }
 318
 319
 320 int InsetCollapsable::insetInInsetY() const
 321 {
 322         return inset.y() - yo_ + inset.insetInInsetY();
 323 }
 324
 325
 326 void InsetCollapsable::validate(LaTeXFeatures & features) const
 327 {
 328         inset.validate(features);
 329 }
 330
 331
 332 void InsetCollapsable::getCursorPos(BufferView * bv, int & x, int & y) const
 333 {
 334         inset.getCursorPos(bv, x , y);
 335         y += - ascent() + height_collapsed() + inset.ascent();
 336 }
 337
 338
 339 void InsetCollapsable::setFont(BufferView * bv, LyXFont const & font,
 340                                bool toggleall, bool selectall)
 341 {
 342         inset.setFont(bv, font, toggleall, selectall);
 343 }
 344
 345
 346 void InsetCollapsable::deleteLyXText(BufferView * bv) const
 347 {
 348         inset.deleteLyXText(bv);
 349 }
 350
 351
 352 void InsetCollapsable::getLabelList(Buffer const & buffer,
 353                                     std::vector<string> & list) const
 354 {
 355         inset.getLabelList(buffer, list);
 356 }
 357
 358
 359 int InsetCollapsable::scroll(bool recursive) const
 360 {
 361         int sx = UpdatableInset::scroll(false);
 362
 363         if (recursive)
 364                 sx += inset.scroll(recursive);
 365
 366         return sx;
 367 }
 368
 369
 370 ParagraphList * InsetCollapsable::getParagraphs(int i) const
 371 {
 372         return inset.getParagraphs(i);
 373 }
 374
 375
 376 int InsetCollapsable::numParagraphs() const
 377 {
 378         return inset.numParagraphs();
 379 }
 380
 381
 382 LyXText * InsetCollapsable::getText(int i) const
 383 {
 384         return inset.getText(i);
 385 }
 386
 387
 388 void InsetCollapsable::open(BufferView * bv)
 389 {
 390         if (!collapsed_)
 391                 return;
 392
 393         collapsed_ = false;
 394 }
 395
 396
 397 void InsetCollapsable::close(BufferView * bv) const
 398 {
 399         if (collapsed_)
 400                 return;
 401
 402         collapsed_ = true;
 403 }
 404
 405
 406 void InsetCollapsable::setLabel(string const & l) const
 407 {
 408         label = l;
 409 }
 410
 411
 412 void InsetCollapsable::setCollapsed(bool c) const
 413 {
 414         collapsed_ = c;
 415 }
 416
 417
 418 void InsetCollapsable::markErased()
 419 {
 420         inset.markErased();
 421 }
 422
 423
 424 void InsetCollapsable::addPreview(PreviewLoader & loader) const
 425 {
 426         inset.addPreview(loader);
 427 }
 428
 429
 430 bool InsetCollapsable::insetAllowed(InsetOld::Code code) const
 431 {
 432         return inset.insetAllowed(code);
 433 }
 434
 435
 436 void InsetCollapsable::fitInsetCursor(BufferView * bv) const
 437 {
 438         inset.fitInsetCursor(bv);
 439 }
 440
 441
 442 void InsetCollapsable::setLabelFont(LyXFont & f)
 443 {
 444         labelfont_ = f;
 445 }
 446
 447 #if 0
 448 void InsetCollapsable::setAutoCollapse(bool f)
 449 {
 450         autocollapse = f;
 451 }
 452 #endif
 453
 454 void InsetCollapsable::scroll(BufferView *bv, float sx) const
 455 {
 456         UpdatableInset::scroll(bv, sx);
 457 }
 458
 459
 460 void InsetCollapsable::scroll(BufferView *bv, int offset) const
 461 {
 462         UpdatableInset::scroll(bv, offset);
 463 }
 464
 465
 466 bool InsetCollapsable::isOpen() const
 467 {
 468         return !collapsed_;
 469 }
 470
 471
 472 Box const & InsetCollapsable::buttonDim() const
 473 {
 474         return button_dim;
 475 }
 476