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), collapsed_(collapsed), label("Label")
  44 #if 0
  45         ,autocollapse(false)
  46 #endif
  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_), label(in.label)
  59 #if 0
  60           ,autocollapse(in.autocollapse)
  61 #endif
  62 {
  63         inset.setOwner(this);
  64 }
  65
  66
  67 bool InsetCollapsable::insertInset(BufferView * bv, InsetOld * in)
  68 {
  69         if (!insetAllowed(in->lyxCode())) {
  70                 lyxerr << "InsetCollapsable::InsertInset: "
  71                         "Unable to insert inset." << endl;
  72                 return false;
  73         }
  74         return inset.insertInset(bv, in);
  75 }
  76
  77
  78 void InsetCollapsable::write(Buffer const & buf, ostream & os) const
  79 {
  80         os << "collapsed " << (collapsed_ ? "true" : "false") << "\n";
  81         inset.writeParagraphData(buf, os);
  82 }
  83
  84
  85 void InsetCollapsable::read(Buffer const & buf, LyXLex & lex)
  86 {
  87         if (lex.isOK()) {
  88                 lex.next();
  89                 string const token = lex.getString();
  90                 if (token == "collapsed") {
  91                         lex.next();
  92                         collapsed_ = lex.getBool();
  93                 } else {
  94                         lyxerr << "InsetCollapsable::Read: Missing collapsed!"
  95                                << endl;
  96                         // Take countermeasures
  97                         lex.pushToken(token);
  98                 }
  99         }
 100         inset.read(buf, lex);
 101 }
 102
 103
 104 void InsetCollapsable::dimension_collapsed(Dimension & dim) const
 105 {
 106         font_metrics::buttonText(label, labelfont_, dim.wid, dim.asc, dim.des);
 107 }
 108
 109
 110 int InsetCollapsable::height_collapsed() const
 111 {
 112         Dimension dim;
 113         font_metrics::buttonText(label, labelfont_, dim.wid, dim.asc, dim.des);
 114         return dim.asc + dim.des;
 115 }
 116
 117
 118 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 119 {
 120         //lyxerr << "InsetCollapsable::metrics:  width: " << mi.base.textwidth << endl;
 121         dimension_collapsed(dim);
 122         if (!collapsed_) {
 123                 Dimension insetdim;
 124                 inset.metrics(mi, insetdim);
 125                 dim.des += insetdim.height() + TEXT_TO_BOTTOM_OFFSET;
 126                 dim.wid = max(dim.wid, insetdim.wid);
 127         }
 128         dim_ = dim;
 129         //lyxerr << "InsetCollapsable::metrics:  dim.wid: " << dim.wid << endl;
 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         xo_ = x;
 151         yo_ = y;
 152
 153         if (collapsed_) {
 154                 draw_collapsed(pi, x, y);
 155                 return;
 156         }
 157
 158         int old_x = x;
 159
 160         if (!owner())
 161                 x += scroll();
 162
 163         if (inlined) {
 164                 inset.draw(pi, x, y);
 165         } else {
 166                 int const bl = y - aa + dim_collapsed.ascent();
 167                 draw_collapsed(pi, old_x, bl);
 168                 inset.draw(pi, x, bl + dim_collapsed.descent() + inset.ascent());
 169         }
 170 }
 171
 172
 173 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 174 {
 175         // by default we don't draw inline
 176         draw(pi, x, y, false);
 177 }
 178
 179
 180 InsetOld::EDITABLE InsetCollapsable::editable() const
 181 {
 182         return collapsed_ ? IS_EDITABLE : HIGHLY_EDITABLE;
 183 }
 184
 185
 186 FuncRequest InsetCollapsable::adjustCommand(FuncRequest const & cmd)
 187 {
 188         FuncRequest cmd1 = cmd;
 189         cmd1.y += ascent() - height_collapsed();
 190         return cmd1;
 191 }
 192
 193
 194 DispatchResult InsetCollapsable::lfunMouseRelease(FuncRequest const & cmd)
 195 {
 196         BufferView * bv = cmd.view();
 197
 198         if (cmd.button() == mouse_button::button3) {
 199                 lyxerr << "InsetCollapsable::lfunMouseRelease 0" << endl;
 200                 if (hitButton(cmd))
 201                         showInsetDialog(bv);
 202                 return DispatchResult(true, true);
 203         }
 204
 205         if (collapsed_) {
 206                 lyxerr << "InsetCollapsable::lfunMouseRelease 1" << endl;
 207                 collapsed_ = false;
 208                 edit(bv, true);
 209                 return DispatchResult(true, true);
 210         }
 211
 212         if (hitButton(cmd)) {
 213                 if (!collapsed_) {
 214                         collapsed_ = true;
 215                         lyxerr << "InsetCollapsable::lfunMouseRelease 2" << endl;
 216                         return DispatchResult(false, FINISHED_RIGHT);
 217                 }
 218                 collapsed_ = false;
 219                 lyxerr << "InsetCollapsable::lfunMouseRelease 3" << endl;
 220         } else if (!collapsed_ && cmd.y > button_dim.y2) {
 221                 lyxerr << "InsetCollapsable::lfunMouseRelease 4" << endl;
 222                 return inset.dispatch(adjustCommand(cmd));
 223         }
 224
 225         lyxerr << "InsetCollapsable::lfunMouseRelease 5" << endl;
 226         return DispatchResult(true, true);
 227 }
 228
 229
 230 int InsetCollapsable::latex(Buffer const & buf, ostream & os,
 231                             OutputParams const & runparams) const
 232 {
 233         return inset.latex(buf, os, runparams);
 234 }
 235
 236
 237 int InsetCollapsable::plaintext(Buffer const & buf, ostream & os,
 238                             OutputParams const & runparams) const
 239 {
 240         return inset.plaintext(buf, os, runparams);
 241 }
 242
 243
 244 int InsetCollapsable::linuxdoc(Buffer const & buf, ostream & os,
 245                                OutputParams const & runparams) const
 246 {
 247         return inset.linuxdoc(buf, os, runparams);
 248 }
 249
 250
 251 int InsetCollapsable::docbook(Buffer const & buf, ostream & os,
 252                               OutputParams const & runparams) const
 253 {
 254         return inset.docbook(buf, os, runparams);
 255 }
 256
 257
 258 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
 259 {
 260         return button_dim.contains(cmd.x, cmd.y);
 261 }
 262
 263
 264 string const InsetCollapsable::getNewLabel(string const & l) const
 265 {
 266         string la;
 267         pos_type const max_length = 15;
 268         pos_type const p_siz = inset.paragraphs().begin()->size();
 269         pos_type const n = min(max_length, p_siz);
 270         pos_type i = 0;
 271         pos_type j = 0;
 272         for( ; i < n && j < p_siz; ++j) {
 273                 if (inset.paragraphs().begin()->isInset(j))
 274                         continue;
 275                 la += inset.paragraphs().begin()->getChar(j);
 276                 ++i;
 277         }
 278         if (inset.paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
 279                 la += "...";
 280         }
 281         if (la.empty()) {
 282                 la = l;
 283         }
 284         return la;
 285 }
 286
 287
 288 void InsetCollapsable::edit(BufferView * bv, bool left)
 289 {
 290         lyxerr << "InsetCollapsable: edit left/right" << endl;
 291         inset.edit(bv, left);
 292         open();
 293         bv->cursor().push(this);
 294 }
 295
 296
 297 void InsetCollapsable::edit(BufferView * bv, int x, int y)
 298 {
 299         lyxerr << "InsetCollapsable: edit xy" << endl;
 300         if (collapsed_) {
 301                 collapsed_ = false;
 302         } else {
 303                 if (y <= button_dim.y2)
 304                         y = 0;
 305                 else
 306                         y += inset.ascent() - height_collapsed();
 307         }
 308         inset.edit(bv, x, y);
 309         bv->cursor().push(this);
 310 }
 311
 312
 313 DispatchResult
 314 InsetCollapsable::priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &)
 315 {
 316         lyxerr << "\nInsetCollapsable::priv_dispatch (begin): cmd: " << cmd
 317                 << "  button y: " << button_dim.y2 << endl;
 318         switch (cmd.action) {
 319                 case LFUN_MOUSE_PRESS:
 320                         if (!collapsed_ && cmd.y > button_dim.y2)
 321                                 inset.dispatch(adjustCommand(cmd));
 322                         return DispatchResult(true, true);
 323
 324                 case LFUN_MOUSE_MOTION:
 325                         if (!collapsed_)
 326                                 inset.dispatch(adjustCommand(cmd));
 327                         return DispatchResult(true, true);
 328
 329                 case LFUN_MOUSE_RELEASE:
 330                         if (!collapsed_ && cmd.y > button_dim.y2)
 331                                 inset.dispatch(adjustCommand(cmd));
 332                         else
 333                                 return lfunMouseRelease(cmd);
 334                         return DispatchResult(true, true);
 335
 336                 case LFUN_INSET_TOGGLE:
 337                         if (!inset.text_.toggleInset())
 338                                 close();
 339                         return DispatchResult(true, true);
 340
 341                 default:
 342                         return inset.dispatch(adjustCommand(cmd));
 343         }
 344         lyxerr << "InsetCollapsable::priv_dispatch (end)" << endl;
 345 }
 346
 347
 348 void InsetCollapsable::validate(LaTeXFeatures & features) const
 349 {
 350         inset.validate(features);
 351 }
 352
 353
 354 void InsetCollapsable::getCursorPos(int & x, int & y) const
 355 {
 356         inset.getCursorPos(x, y);
 357         y += - ascent() + height_collapsed() + inset.ascent();
 358 }
 359
 360
 361 void InsetCollapsable::getLabelList(Buffer const & buffer,
 362                                     std::vector<string> & list) const
 363 {
 364         inset.getLabelList(buffer, list);
 365 }
 366
 367
 368 int InsetCollapsable::scroll(bool recursive) const
 369 {
 370         int sx = UpdatableInset::scroll(false);
 371
 372         if (recursive)
 373                 sx += inset.scroll(false);
 374
 375         return sx;
 376 }
 377
 378
 379 ParagraphList * InsetCollapsable::getParagraphs(int i) const
 380 {
 381         return inset.getParagraphs(i);
 382 }
 383
 384
 385 int InsetCollapsable::numParagraphs() const
 386 {
 387         return inset.numParagraphs();
 388 }
 389
 390
 391 LyXText * InsetCollapsable::getText(int i) const
 392 {
 393         return inset.getText(i);
 394 }
 395
 396
 397 void InsetCollapsable::open()
 398 {
 399         collapsed_ = false;
 400 }
 401
 402
 403 void InsetCollapsable::close() const
 404 {
 405         collapsed_ = true;
 406 }
 407
 408
 409 void InsetCollapsable::setLabel(string const & l) const
 410 {
 411         label = l;
 412 }
 413
 414
 415 void InsetCollapsable::setCollapsed(bool c) const
 416 {
 417         collapsed_ = c;
 418 }
 419
 420
 421 void InsetCollapsable::markErased()
 422 {
 423         inset.markErased();
 424 }
 425
 426
 427 void InsetCollapsable::addPreview(PreviewLoader & loader) const
 428 {
 429         inset.addPreview(loader);
 430 }
 431
 432
 433 bool InsetCollapsable::insetAllowed(InsetOld::Code code) const
 434 {
 435         return inset.insetAllowed(code);
 436 }
 437
 438
 439 void InsetCollapsable::setLabelFont(LyXFont & f)
 440 {
 441         labelfont_ = f;
 442 }
 443
 444
 445 #if 0
 446 void InsetCollapsable::setAutoCollapse(bool f)
 447 {
 448         autocollapse = f;
 449 }
 450 #endif
 451
 452
 453 void InsetCollapsable::scroll(BufferView * bv, float sx) const
 454 {
 455         UpdatableInset::scroll(bv, sx);
 456 }
 457
 458
 459 void InsetCollapsable::scroll(BufferView * bv, int offset) const
 460 {
 461         UpdatableInset::scroll(bv, offset);
 462 }
 463
 464
 465 bool InsetCollapsable::isOpen() const
 466 {
 467         return !collapsed_;
 468 }
 469
 470
 471 Box const & InsetCollapsable::buttonDim() const
 472 {
 473         return button_dim;
 474 }
 475
 476
 477 void InsetCollapsable::setBackgroundColor(LColor_color color)
 478 {
 479         InsetOld::setBackgroundColor(color);
 480         inset.setBackgroundColor(color);
 481 }