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,
  43         CollapseStatus status)
  44         : inset(bp), label("Label"), status_(status)
  45 {
  46         inset.setOwner(this);
  47         inset.setAutoBreakRows(true);
  48         inset.setDrawFrame(InsetText::ALWAYS);
  49         inset.setFrameColor(LColor::collapsableframe);
  50         setInsetName("Collapsable");
  51         setButtonLabel();
  52 }
  53
  54
  55 InsetCollapsable::InsetCollapsable(InsetCollapsable const & in)
  56         : UpdatableInset(in), inset(in.inset),
  57           labelfont_(in.labelfont_), label(in.label), status_(in.status_)
  58 {
  59         inset.setOwner(this);
  60         setButtonLabel();
  61 }
  62
  63
  64 void InsetCollapsable::write(Buffer const & buf, ostream & os) const
  65 {
  66         os << "status ";
  67         switch (status_) {
  68         case Open:
  69                 os << "open";
  70                 break;
  71         case Collapsed:
  72                 os << "collapsed";
  73                 break;
  74         case Inlined:
  75                 os << "inlined";
  76                 break;
  77         }
  78         os << "\n";
  79         inset.text_.write(buf, os);
  80 }
  81
  82
  83 void InsetCollapsable::read(Buffer const & buf, LyXLex & lex)
  84 {
  85         bool token_found = false;
  86         if (lex.isOK()) {
  87                 lex.next();
  88                 string const token = lex.getString();
  89                 if (token == "status") {
  90                         lex.next();
  91                         string const tmp_token = lex.getString();
  92
  93                         if (tmp_token == "inlined") {
  94                                 status_ = Inlined;
  95                                 token_found = true;
  96                         } else if (tmp_token == "collapsed") {
  97                                 status_ = Collapsed;
  98                                 token_found = true;
  99                         } else if (tmp_token == "open") {
 100                                 status_ = Open;
 101                                 token_found = true;
 102                         } else {
 103                                 lyxerr << "InsetCollapsable::read: Missing status!"
 104                                        << endl;
 105                                 // Take countermeasures
 106                                 lex.pushToken(token);
 107                         }
 108                 } else {
 109                         lyxerr << "InsetCollapsable::Read: Missing 'status'-tag!"
 110                                    << endl;
 111                         // take countermeasures
 112                         lex.pushToken(token);
 113                 }
 114         }
 115         inset.read(buf, lex);
 116
 117         if (!token_found)
 118                 status_ = isOpen() ? Open : Collapsed;
 119
 120         setButtonLabel();
 121 }
 122
 123
 124 void InsetCollapsable::dimension_collapsed(Dimension & dim) const
 125 {
 126         font_metrics::buttonText(label, labelfont_, dim.wid, dim.asc, dim.des);
 127 }
 128
 129
 130 int InsetCollapsable::height_collapsed() const
 131 {
 132         Dimension dim;
 133         font_metrics::buttonText(label, labelfont_, dim.wid, dim.asc, dim.des);
 134         return dim.asc + dim.des;
 135 }
 136
 137
 138 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 139 {
 140         if (status_ == Inlined) {
 141                 inset.metrics(mi, dim);
 142         } else {
 143                 dimension_collapsed(dim);
 144                 if (status_ == Open) {
 145                         Dimension insetdim;
 146                         inset.metrics(mi, insetdim);
 147                         dim.des += insetdim.height() + TEXT_TO_BOTTOM_OFFSET;
 148                         dim.wid = max(dim.wid, insetdim.wid);
 149                 }
 150         }
 151         dim_ = dim;
 152 }
 153
 154
 155 void InsetCollapsable::draw_collapsed(PainterInfo & pi, int x, int y) const
 156 {
 157         pi.pain.buttonText(x, y, label, labelfont_);
 158 }
 159
 160
 161 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 162 {
 163         setPosCache(pi, x, y);
 164
 165         if (status_ == Inlined) {
 166                 inset.draw(pi, x, y);
 167         } else {
 168                 Dimension dimc;
 169                 dimension_collapsed(dimc);
 170                 int const aa  = ascent();
 171                 button_dim.x1 = x + 0;
 172                 button_dim.x2 = x + dimc.width();
 173                 button_dim.y1 = y - aa + pi.base.bv->top_y();
 174                 button_dim.y2 = y - aa + pi.base.bv->top_y() + dimc.height();
 175
 176                 draw_collapsed(pi, x, y);
 177                 if (status_ == Open) {
 178                         if (!owner())
 179                                 x += scroll();
 180                         inset.draw(pi, x, y - aa + dimc.height() + inset.ascent());
 181                 }
 182         }
 183 }
 184
 185
 186 void InsetCollapsable::drawSelection(PainterInfo & pi, int x, int y) const
 187 {
 188         inset.drawSelection(pi, x, y);
 189 }
 190
 191
 192 InsetOld::EDITABLE InsetCollapsable::editable() const
 193 {
 194         return status_ != Collapsed ? HIGHLY_EDITABLE : IS_EDITABLE;
 195 }
 196
 197
 198 bool InsetCollapsable::descendable() const
 199 {
 200         return status_ != Collapsed;
 201 }
 202
 203
 204 void InsetCollapsable::lfunMouseRelease(LCursor & cur, FuncRequest const & cmd)
 205 {
 206         if (cmd.button() == mouse_button::button3) {
 207                 showInsetDialog(&cur.bv());
 208                 return;
 209         }
 210
 211         switch (status_) {
 212
 213         case Collapsed:
 214                 lyxerr << "InsetCollapsable::lfunMouseRelease 1" << endl;
 215                 setStatus(Open);
 216                 edit(cur, true);
 217                 break;
 218
 219         case Open: {
 220                 FuncRequest cmd1 = cmd;
 221                 if (hitButton(cmd1)) {
 222                         lyxerr << "InsetCollapsable::lfunMouseRelease 2" << endl;
 223                         setStatus(Collapsed);
 224                         cur.dispatched(FINISHED_RIGHT);
 225                         break;
 226                 }
 227                 lyxerr << "InsetCollapsable::lfunMouseRelease 3" << endl;
 228                 inset.dispatch(cur, cmd);
 229                 break;
 230         }
 231
 232         case Inlined:
 233                 inset.dispatch(cur, cmd);
 234                 break;
 235         }
 236 }
 237
 238
 239 int InsetCollapsable::latex(Buffer const & buf, ostream & os,
 240                             OutputParams const & runparams) const
 241 {
 242         return inset.latex(buf, os, runparams);
 243 }
 244
 245
 246 int InsetCollapsable::plaintext(Buffer const & buf, ostream & os,
 247                             OutputParams const & runparams) const
 248 {
 249         return inset.plaintext(buf, os, runparams);
 250 }
 251
 252
 253 int InsetCollapsable::linuxdoc(Buffer const & buf, ostream & os,
 254                                OutputParams const & runparams) const
 255 {
 256         return inset.linuxdoc(buf, os, runparams);
 257 }
 258
 259
 260 int InsetCollapsable::docbook(Buffer const & buf, ostream & os,
 261                               OutputParams const & runparams) const
 262 {
 263         return inset.docbook(buf, os, runparams);
 264 }
 265
 266
 267 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
 268 {
 269         return button_dim.contains(cmd.x, cmd.y);
 270 }
 271
 272
 273 string const InsetCollapsable::getNewLabel(string const & l) const
 274 {
 275         string label;
 276         pos_type const max_length = 15;
 277         pos_type const p_siz = inset.paragraphs().begin()->size();
 278         pos_type const n = min(max_length, p_siz);
 279         pos_type i = 0;
 280         pos_type j = 0;
 281         for( ; i < n && j < p_siz; ++j) {
 282                 if (inset.paragraphs().begin()->isInset(j))
 283                         continue;
 284                 label += inset.paragraphs().begin()->getChar(j);
 285                 ++i;
 286         }
 287         if (inset.paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
 288                 label += "...";
 289         }
 290         return label.empty() ? l : label;
 291 }
 292
 293
 294 void InsetCollapsable::edit(LCursor & cur, bool left)
 295 {
 296         //lyxerr << "InsetCollapsable: edit left/right" << endl;
 297         cur.push(this);
 298         inset.edit(cur, left);
 299         open();
 300 }
 301
 302
 303 InsetBase * InsetCollapsable::editXY(LCursor & cur, int x, int y)
 304 {
 305         cur.push(this);
 306         //lyxerr << "InsetCollapsable: edit xy" << endl;
 307         if (status_ == Collapsed) {
 308                 setStatus(Open);
 309                 inset.edit(cur, true);
 310 #warning look here
 311 //we are not calling edit(x,y) because there are no coordinates in the
 312 //inset yet. I personally think it's ok. (ab)
 313                 return this;
 314         }
 315         return inset.editXY(cur, x, y);
 316 }
 317
 318
 319 void InsetCollapsable::priv_dispatch(LCursor & cur, FuncRequest const & cmd)
 320 {
 321         //lyxerr << "\nInsetCollapsable::priv_dispatch (begin): cmd: " << cmd
 322         //      << "  button y: " << button_dim.y2 << endl;
 323         switch (cmd.action) {
 324                 case LFUN_MOUSE_PRESS:
 325                         if (status_ == Inlined)
 326                                 inset.dispatch(cur, cmd);
 327                         else if (status_ == Open && cmd.y > button_dim.y2)
 328                                 inset.dispatch(cur, cmd);
 329                         break;
 330
 331                 case LFUN_MOUSE_MOTION:
 332                         if (status_ == Inlined)
 333                                 inset.dispatch(cur, cmd);
 334                         else if (status_ == Open && cmd.y > button_dim.y2)
 335                                 inset.dispatch(cur, cmd);
 336                         break;
 337
 338                 case LFUN_MOUSE_RELEASE:
 339                         lfunMouseRelease(cur, cmd);
 340                         break;
 341
 342                 case LFUN_INSET_TOGGLE:
 343                         if (inset.text_.toggleInset(cur))
 344                                 break;
 345                         if (status_ == Open) {
 346                                 setStatus(Inlined);
 347                                 break;
 348                         }
 349                         setStatus(Collapsed);
 350                         cur.dispatched(FINISHED_RIGHT);
 351                         break;
 352
 353                 default:
 354                         inset.dispatch(cur, cmd);
 355                         break;
 356         }
 357 }
 358
 359
 360 void InsetCollapsable::validate(LaTeXFeatures & features) const
 361 {
 362         inset.validate(features);
 363 }
 364
 365
 366 void InsetCollapsable::getCursorPos(CursorSlice const & cur,
 367         int & x, int & y) const
 368 {
 369         inset.getCursorPos(cur, x, y);
 370 }
 371
 372
 373 void InsetCollapsable::getLabelList(Buffer const & buffer,
 374                                     std::vector<string> & list) const
 375 {
 376         inset.getLabelList(buffer, list);
 377 }
 378
 379
 380 int InsetCollapsable::scroll(bool recursive) const
 381 {
 382         int sx = UpdatableInset::scroll(false);
 383
 384         if (recursive)
 385                 sx += inset.scroll(false);
 386
 387         return sx;
 388 }
 389
 390
 391 size_t InsetCollapsable::nargs() const
 392 {
 393         return inset.nargs();
 394 }
 395
 396
 397 LyXText * InsetCollapsable::getText(int i) const
 398 {
 399         return inset.getText(i);
 400 }
 401
 402
 403 void InsetCollapsable::open()
 404 {
 405         if (status_ == Collapsed)   // ...but not inlined
 406                 setStatus(Open);
 407 }
 408
 409
 410 void InsetCollapsable::close()
 411 {
 412         setStatus(Collapsed);
 413 }
 414
 415
 416 void InsetCollapsable::setLabel(string const & l)
 417 {
 418         label = l;
 419 }
 420
 421
 422 void InsetCollapsable::setStatus(CollapseStatus st)
 423 {
 424         status_ = st;
 425         setButtonLabel();
 426 }
 427
 428
 429 void InsetCollapsable::markErased()
 430 {
 431         inset.markErased();
 432 }
 433
 434
 435 void InsetCollapsable::addPreview(PreviewLoader & loader) const
 436 {
 437         inset.addPreview(loader);
 438 }
 439
 440
 441 bool InsetCollapsable::insetAllowed(InsetOld::Code code) const
 442 {
 443         return inset.insetAllowed(code);
 444 }
 445
 446
 447 void InsetCollapsable::setLabelFont(LyXFont & font)
 448 {
 449         labelfont_ = font;
 450 }
 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 Box const & InsetCollapsable::buttonDim() const
 466 {
 467         return button_dim;
 468 }
 469
 470
 471 void InsetCollapsable::setBackgroundColor(LColor_color color)
 472 {
 473         InsetOld::setBackgroundColor(color);
 474         inset.setBackgroundColor(color);
 475 }