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::min;
  39 using std::ostream;
  40
  41
  42 InsetCollapsable::InsetCollapsable(BufferParams const & bp, bool collapsed)
  43         : UpdatableInset(), inset(bp), status_(collapsed ? Collapsed : Open),
  44           label("Label")
  45 #if 0
  46         ,autocollapse(false)
  47 #endif
  48 {
  49         inset.setOwner(this);
  50         inset.setAutoBreakRows(true);
  51         inset.setDrawFrame(InsetText::ALWAYS);
  52         inset.setFrameColor(LColor::collapsableframe);
  53         setInsetName("Collapsable");
  54 }
  55
  56
  57 InsetCollapsable::InsetCollapsable(InsetCollapsable const & in)
  58         : UpdatableInset(in), inset(in.inset), status_(in.status_),
  59           labelfont_(in.labelfont_), label(in.label)
  60 #if 0
  61           ,autocollapse(in.autocollapse)
  62 #endif
  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 " << (status_ == Collapsed ? "true" : "false") << "\n";
  82         inset.text_.write(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                         status_ = lex.getBool() ? Collapsed : Open;
  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         if (status_ == Inlined) {
 123                 inset.metrics(mi, dim);
 124         } else {
 125                 dimension_collapsed(dim);
 126                 if (status_ == Open) {
 127                         Dimension insetdim;
 128                         inset.metrics(mi, insetdim);
 129                         dim.des += insetdim.height() + TEXT_TO_BOTTOM_OFFSET;
 130                         dim.wid = max(dim.wid, insetdim.wid);
 131                 }
 132         }
 133         dim_ = dim;
 134         //lyxerr << "InsetCollapsable::metrics:  dim.wid: " << dim.wid << endl;
 135 }
 136
 137
 138 void InsetCollapsable::draw_collapsed(PainterInfo & pi, int x, int y) const
 139 {
 140         pi.pain.buttonText(x, y, label, labelfont_);
 141 }
 142
 143
 144 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 145 {
 146         xo_ = x;
 147         yo_ = y;
 148
 149         if (status_ == Inlined) {
 150                 inset.draw(pi, x, y);
 151         } else {
 152                 Dimension dimc;
 153                 dimension_collapsed(dimc);
 154
 155                 int const aa  = ascent();
 156                 button_dim.x1 = 0;
 157                 button_dim.x2 = dimc.width();
 158                 button_dim.y1 = -aa;
 159                 button_dim.y2 = -aa + dimc.height();
 160
 161                 draw_collapsed(pi, x, y);
 162                 if (status_ == Open) {
 163                         if (!owner())
 164                                 x += scroll();
 165                         inset.draw(pi, x, y - aa + dimc.height() + inset.ascent());
 166                 }
 167         }
 168 }
 169
 170
 171 InsetOld::EDITABLE InsetCollapsable::editable() const
 172 {
 173         return status_ != Collapsed ? HIGHLY_EDITABLE : IS_EDITABLE;
 174 }
 175
 176
 177 bool InsetCollapsable::descendable() const
 178 {
 179         return status_ != Collapsed;
 180 }
 181
 182
 183 FuncRequest InsetCollapsable::adjustCommand(FuncRequest const & cmd)
 184 {
 185         FuncRequest cmd1 = cmd;
 186         cmd1.y += ascent() - height_collapsed();
 187         return cmd1;
 188 }
 189
 190
 191 DispatchResult InsetCollapsable::lfunMouseRelease(FuncRequest const & cmd)
 192 {
 193         BufferView * bv = cmd.view();
 194
 195         if (cmd.button() == mouse_button::button3) {
 196                 lyxerr << "InsetCollapsable::lfunMouseRelease 0" << endl;
 197                 if (hitButton(cmd))
 198                         showInsetDialog(bv);
 199                 return DispatchResult(true, true);
 200         }
 201
 202         if (status_ == Collapsed) {
 203                 lyxerr << "InsetCollapsable::lfunMouseRelease 1" << endl;
 204                 setStatus(Open);
 205                 edit(bv, true);
 206                 return DispatchResult(true, true);
 207         }
 208
 209         if (hitButton(cmd)) {
 210                 if (status_ == Open) {
 211                         setStatus(Collapsed);
 212                         lyxerr << "InsetCollapsable::lfunMouseRelease 2" << endl;
 213                         return DispatchResult(false, FINISHED_RIGHT);
 214                 }
 215                 setStatus(Open);
 216                 lyxerr << "InsetCollapsable::lfunMouseRelease 3" << endl;
 217         } else if (status_ == Open && cmd.y > button_dim.y2) {
 218                 lyxerr << "InsetCollapsable::lfunMouseRelease 4" << endl;
 219                 return inset.dispatch(adjustCommand(cmd));
 220         }
 221
 222         lyxerr << "InsetCollapsable::lfunMouseRelease 5" << endl;
 223         return DispatchResult(true, true);
 224 }
 225
 226
 227 int InsetCollapsable::latex(Buffer const & buf, ostream & os,
 228                             OutputParams const & runparams) const
 229 {
 230         return inset.latex(buf, os, runparams);
 231 }
 232
 233
 234 int InsetCollapsable::plaintext(Buffer const & buf, ostream & os,
 235                             OutputParams const & runparams) const
 236 {
 237         return inset.plaintext(buf, os, runparams);
 238 }
 239
 240
 241 int InsetCollapsable::linuxdoc(Buffer const & buf, ostream & os,
 242                                OutputParams const & runparams) const
 243 {
 244         return inset.linuxdoc(buf, os, runparams);
 245 }
 246
 247
 248 int InsetCollapsable::docbook(Buffer const & buf, ostream & os,
 249                               OutputParams const & runparams) const
 250 {
 251         return inset.docbook(buf, os, runparams);
 252 }
 253
 254
 255 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
 256 {
 257         return button_dim.contains(cmd.x, cmd.y);
 258 }
 259
 260
 261 string const InsetCollapsable::getNewLabel(string const & l) const
 262 {
 263         string la;
 264         pos_type const max_length = 15;
 265         pos_type const p_siz = inset.paragraphs().begin()->size();
 266         pos_type const n = min(max_length, p_siz);
 267         pos_type i = 0;
 268         pos_type j = 0;
 269         for( ; i < n && j < p_siz; ++j) {
 270                 if (inset.paragraphs().begin()->isInset(j))
 271                         continue;
 272                 la += inset.paragraphs().begin()->getChar(j);
 273                 ++i;
 274         }
 275         if (inset.paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
 276                 la += "...";
 277         }
 278         if (la.empty()) {
 279                 la = l;
 280         }
 281         return la;
 282 }
 283
 284
 285 void InsetCollapsable::edit(BufferView * bv, bool left)
 286 {
 287         lyxerr << "InsetCollapsable: edit left/right" << endl;
 288         inset.edit(bv, left);
 289         setStatus(Open);
 290         bv->cursor().push(this);
 291 }
 292
 293
 294 void InsetCollapsable::edit(BufferView * bv, int x, int y)
 295 {
 296         lyxerr << "InsetCollapsable: edit xy" << endl;
 297         if (status_ == Collapsed) {
 298                 setStatus(Open);
 299         } else {
 300                 if (y <= button_dim.y2)
 301                         y = 0;
 302                 else
 303                         y += inset.ascent() - height_collapsed();
 304         }
 305         inset.edit(bv, x, y);
 306         bv->cursor().push(this);
 307 }
 308
 309
 310 DispatchResult
 311 InsetCollapsable::priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &)
 312 {
 313         //lyxerr << "\nInsetCollapsable::priv_dispatch (begin): cmd: " << cmd
 314         //      << "  button y: " << button_dim.y2 << endl;
 315         switch (cmd.action) {
 316                 case LFUN_MOUSE_PRESS:
 317                         if (!status_ && cmd.y > button_dim.y2)
 318                                 inset.dispatch(adjustCommand(cmd));
 319                         return DispatchResult(true, true);
 320
 321                 case LFUN_MOUSE_MOTION:
 322                         if (!status_)
 323                                 inset.dispatch(adjustCommand(cmd));
 324                         return DispatchResult(true, true);
 325
 326                 case LFUN_MOUSE_RELEASE:
 327                         if (!status_ && cmd.y > button_dim.y2)
 328                                 inset.dispatch(adjustCommand(cmd));
 329                         else
 330                                 return lfunMouseRelease(cmd);
 331                         return DispatchResult(true, true);
 332
 333                 case LFUN_INSET_TOGGLE:
 334                         if (inset.text_.toggleInset())
 335                                 return DispatchResult(true, true);
 336                         close();
 337                         return DispatchResult(false, FINISHED_RIGHT);
 338
 339                 default:
 340                         return inset.dispatch(adjustCommand(cmd));
 341         }
 342         //lyxerr << "InsetCollapsable::priv_dispatch (end)" << endl;
 343 }
 344
 345
 346 void InsetCollapsable::validate(LaTeXFeatures & features) const
 347 {
 348         inset.validate(features);
 349 }
 350
 351
 352 void InsetCollapsable::getCursorPos(int & x, int & y) const
 353 {
 354         inset.getCursorPos(x, y);
 355         if (status_ != Inlined)
 356                 y += - ascent() + height_collapsed() + inset.ascent();
 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(false);
 373
 374         return sx;
 375 }
 376
 377
 378 int InsetCollapsable::numParagraphs() const
 379 {
 380         return inset.numParagraphs();
 381 }
 382
 383
 384 LyXText * InsetCollapsable::getText(int i) const
 385 {
 386         return inset.getText(i);
 387 }
 388
 389
 390 void InsetCollapsable::open()
 391 {
 392         setStatus(Open);
 393 }
 394
 395
 396 void InsetCollapsable::close()
 397 {
 398         setStatus(Collapsed);
 399 }
 400
 401
 402 void InsetCollapsable::setLabel(string const & l) const
 403 {
 404         label = l;
 405 }
 406
 407
 408 void InsetCollapsable::setStatus(CollapseStatus s)
 409 {
 410         status_ = s;
 411 }
 412
 413
 414 void InsetCollapsable::markErased()
 415 {
 416         inset.markErased();
 417 }
 418
 419
 420 void InsetCollapsable::addPreview(PreviewLoader & loader) const
 421 {
 422         inset.addPreview(loader);
 423 }
 424
 425
 426 bool InsetCollapsable::insetAllowed(InsetOld::Code code) const
 427 {
 428         return inset.insetAllowed(code);
 429 }
 430
 431
 432 void InsetCollapsable::setLabelFont(LyXFont & f)
 433 {
 434         labelfont_ = f;
 435 }
 436
 437
 438 #if 0
 439 void InsetCollapsable::setAutoCollapse(bool f)
 440 {
 441         autocollapse = f;
 442 }
 443 #endif
 444
 445
 446 void InsetCollapsable::scroll(BufferView * bv, float sx) const
 447 {
 448         UpdatableInset::scroll(bv, sx);
 449 }
 450
 451
 452 void InsetCollapsable::scroll(BufferView * bv, int offset) const
 453 {
 454         UpdatableInset::scroll(bv, offset);
 455 }
 456
 457
 458 Box const & InsetCollapsable::buttonDim() const
 459 {
 460         return button_dim;
 461 }
 462
 463
 464 void InsetCollapsable::setBackgroundColor(LColor_color color)
 465 {
 466         InsetOld::setBackgroundColor(color);
 467         inset.setBackgroundColor(color);
 468 }