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