src/insets/InsetCollapsable.cpp

   1 /**
   2  * \file InsetCollapsable.cpp
   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 "Dimension.h"
  21 #include "FuncRequest.h"
  22 #include "FuncStatus.h"
  23 #include "InsetLayout.h"
  24 #include "Lexer.h"
  25 #include "MetricsInfo.h"
  26 #include "OutputParams.h"
  27 #include "TocBackend.h"
  28
  29 #include "frontends/FontMetrics.h"
  30 #include "frontends/Painter.h"
  31
  32 #include "support/debug.h"
  33 #include "support/docstream.h"
  34 #include "support/gettext.h"
  35 #include "support/lassert.h"
  36 #include "support/lstrings.h"
  37 #include "support/RefChanger.h"
  38
  39 using namespace std;
  40
  41
  42 namespace lyx {
  43
  44 InsetCollapsable::InsetCollapsable(Buffer * buf, InsetText::UsePlain ltype)
  45         : InsetText(buf, ltype), status_(Open)
  46 {
  47         setDrawFrame(true);
  48         setFrameColor(Color_collapsableframe);
  49 }
  50
  51
  52 // The sole purpose of this copy constructor is to make sure
  53 // that the view_ map is not copied and remains empty.
  54 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
  55         : InsetText(rhs),
  56           status_(rhs.status_),
  57           labelstring_(rhs.labelstring_)
  58 {}
  59
  60
  61 InsetCollapsable::~InsetCollapsable()
  62 {
  63         map<BufferView const *, View>::iterator it = view_.begin();
  64         map<BufferView const *, View>::iterator end = view_.end();
  65         for (; it != end; ++it)
  66                 if (it->second.mouse_hover_)
  67                         it->first->clearLastInset(this);
  68 }
  69
  70
  71 InsetCollapsable::CollapseStatus InsetCollapsable::status(BufferView const & bv) const
  72 {
  73         if (decoration() == InsetLayout::CONGLOMERATE)
  74                 return status_;
  75         return view_[&bv].auto_open_ ? Open : status_;
  76 }
  77
  78
  79 InsetCollapsable::Geometry InsetCollapsable::geometry(BufferView const & bv) const
  80 {
  81         switch (decoration()) {
  82         case InsetLayout::CLASSIC:
  83                 if (status(bv) == Open)
  84                         return view_[&bv].openinlined_ ? LeftButton : TopButton;
  85                 return ButtonOnly;
  86
  87         case InsetLayout::MINIMALISTIC:
  88                 return status(bv) == Open ? NoButton : ButtonOnly ;
  89
  90         case InsetLayout::CONGLOMERATE:
  91                 return status(bv) == Open ? SubLabel : Corners ;
  92
  93         case InsetLayout::DEFAULT:
  94                 break; // this shouldn't happen
  95         }
  96
  97         // dummy return value to shut down a warning,
  98         // this is dead code.
  99         return NoButton;
 100 }
 101
 102
 103 docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
 104 {
 105         Dimension const dim = dimensionCollapsed(bv);
 106         if (geometry(bv) == NoButton)
 107                 return translateIfPossible(getLayout().labelstring());
 108         if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des || isOpen(bv))
 109                 return docstring();
 110
 111         return toolTipText();
 112 }
 113
 114
 115 void InsetCollapsable::write(ostream & os) const
 116 {
 117         os << "status ";
 118         switch (status_) {
 119         case Open:
 120                 os << "open";
 121                 break;
 122         case Collapsed:
 123                 os << "collapsed";
 124                 break;
 125         }
 126         os << "\n";
 127         text().write(os);
 128 }
 129
 130
 131 void InsetCollapsable::read(Lexer & lex)
 132 {
 133         lex.setContext("InsetCollapsable::read");
 134         string tmp_token;
 135         status_ = Collapsed;
 136         lex >> "status" >> tmp_token;
 137         if (tmp_token == "open")
 138                 status_ = Open;
 139
 140         InsetText::read(lex);
 141         setButtonLabel();
 142 }
 143
 144
 145 Dimension InsetCollapsable::dimensionCollapsed(BufferView const & bv) const
 146 {
 147         Dimension dim;
 148         FontInfo labelfont(getLabelfont());
 149         labelfont.realize(sane_font);
 150         theFontMetrics(labelfont).buttonText(
 151                 buttonLabel(bv), dim.wid, dim.asc, dim.des);
 152         return dim;
 153 }
 154
 155
 156 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 157 {
 158         view_[mi.base.bv].auto_open_ = mi.base.bv->cursor().isInside(this);
 159
 160         FontInfo tmpfont = mi.base.font;
 161         mi.base.font = getFont();
 162         mi.base.font.realize(tmpfont);
 163
 164         BufferView const & bv = *mi.base.bv;
 165
 166         switch (geometry(bv)) {
 167         case NoButton:
 168                 InsetText::metrics(mi, dim);
 169                 break;
 170         case Corners:
 171                 InsetText::metrics(mi, dim);
 172                 dim.des -= 3;
 173                 dim.asc -= 1;
 174                 break;
 175         case SubLabel: {
 176                 InsetText::metrics(mi, dim);
 177                 // consider width of the inset label
 178                 FontInfo font(getLabelfont());
 179                 font.realize(sane_font);
 180                 font.decSize();
 181                 font.decSize();
 182                 int w = 0;
 183                 int a = 0;
 184                 int d = 0;
 185                 theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
 186                 dim.des += a + d;
 187                 break;
 188                 }
 189         case TopButton:
 190         case LeftButton:
 191         case ButtonOnly:
 192                 if (hasFixedWidth()){
 193                         int const mindim = view_[&bv].button_dim_.x2 - view_[&bv].button_dim_.x1;
 194                         if (mi.base.textwidth < mindim)
 195                                 mi.base.textwidth = mindim;
 196                 }
 197                 dim = dimensionCollapsed(bv);
 198                 if (geometry(bv) == TopButton || geometry(bv) == LeftButton) {
 199                         Dimension textdim;
 200                         InsetText::metrics(mi, textdim);
 201                         view_[&bv].openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
 202                         if (view_[&bv].openinlined_) {
 203                                 // Correct for button width.
 204                                 dim.wid += textdim.wid;
 205                                 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
 206                                 dim.asc = textdim.asc;
 207                         } else {
 208                                 dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
 209                                 dim.wid = max(dim.wid, textdim.wid);
 210                         }
 211                 }
 212                 break;
 213         }
 214
 215         mi.base.font = tmpfont;
 216 }
 217
 218
 219 bool InsetCollapsable::setMouseHover(BufferView const * bv, bool mouse_hover)
 220         const
 221 {
 222         view_[bv].mouse_hover_ = mouse_hover;
 223         return true;
 224 }
 225
 226
 227 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 228 {
 229         BufferView const & bv = *pi.base.bv;
 230
 231         view_[&bv].auto_open_ = bv.cursor().isInside(this);
 232
 233         Changer dummy = pi.base.font.change(getFont(), true);
 234
 235         // Draw button first -- top, left or only
 236         Dimension dimc = dimensionCollapsed(bv);
 237
 238         if (geometry(bv) == TopButton ||
 239             geometry(bv) == LeftButton ||
 240             geometry(bv) == ButtonOnly) {
 241                 view_[&bv].button_dim_.x1 = x + 0;
 242                 view_[&bv].button_dim_.x2 = x + dimc.width();
 243                 view_[&bv].button_dim_.y1 = y - dimc.asc;
 244                 view_[&bv].button_dim_.y2 = y + dimc.des;
 245
 246                 FontInfo labelfont = getLabelfont();
 247                 labelfont.setColor(labelColor());
 248                 labelfont.realize(pi.base.font);
 249                 pi.pain.buttonText(x, y, buttonLabel(bv), labelfont,
 250                                    view_[&bv].mouse_hover_);
 251                 // Draw the change tracking cue on the label, unless RowPainter already
 252                 // takes care of it.
 253                 if (canPaintChange(bv))
 254                         pi.change_.paintCue(pi, x, y, x + dimc.width(), labelfont);
 255         } else {
 256                 view_[&bv].button_dim_.x1 = 0;
 257                 view_[&bv].button_dim_.y1 = 0;
 258                 view_[&bv].button_dim_.x2 = 0;
 259                 view_[&bv].button_dim_.y2 = 0;
 260         }
 261
 262         Dimension const textdim = dimensionHelper(bv);
 263         int const baseline = y;
 264         int textx, texty;
 265         Geometry g = geometry(bv);
 266         switch (g) {
 267         case LeftButton:
 268         case TopButton: {
 269                 if (g == LeftButton) {
 270                         textx = x + dimc.width();
 271                         texty = baseline;
 272                 } else {
 273                         textx = x;
 274                         texty = baseline + dimc.des + textdim.asc;
 275                 }
 276                 // Do not draw the cue for INSERTED -- it is already in the button and
 277                 // that's enough.
 278                 Changer dummy = (pi.change_.type == Change::INSERTED)
 279                         ? make_change(pi.change_, Change())
 280                         : Changer();
 281                 InsetText::draw(pi, textx, texty);
 282                 break;
 283         }
 284         case ButtonOnly:
 285                 break;
 286         case NoButton:
 287                 textx = x;
 288                 texty = baseline;
 289                 InsetText::draw(pi, textx, texty);
 290                 break;
 291         case SubLabel:
 292         case Corners:
 293                 textx = x;
 294                 texty = baseline;
 295                 {       // We will take care of the frame and the change tracking cue
 296                         // ourselves, below.
 297                         Changer dummy = make_change(pi.change_, Change());
 298                         const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
 299                         InsetText::draw(pi, textx, texty);
 300                         const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
 301                 }
 302
 303                 int desc = textdim.descent();
 304                 if (g == Corners)
 305                         desc -= 3;
 306
 307                 // Colour the frame according to the change type. (Like for tables.)
 308                 Color colour = pi.change_.changed() ? pi.change_.color()
 309                                                     : Color_foreground;
 310                 const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
 311                 const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
 312                 pi.pain.line(xx1, y + desc - 4,
 313                              xx1, y + desc, colour);
 314                 if (status_ == Open)
 315                         pi.pain.line(xx1, y + desc,
 316                                      xx2, y + desc, colour);
 317                 else {
 318                         // Make status_ value visible:
 319                         pi.pain.line(xx1, y + desc,
 320                                      xx1 + 4, y + desc, colour);
 321                         pi.pain.line(xx2 - 4, y + desc,
 322                                      xx2, y + desc, colour);
 323                 }
 324                 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3,
 325                              y + desc - 4, colour);
 326
 327                 // the label below the text. Can be toggled.
 328                 if (g == SubLabel) {
 329                         FontInfo font(getLabelfont());
 330                         if (pi.change_.changed())
 331                                 font.setPaintColor(colour);
 332                         font.realize(sane_font);
 333                         font.decSize();
 334                         font.decSize();
 335                         int w = 0;
 336                         int a = 0;
 337                         int d = 0;
 338                         Color const col = pi.full_repaint ? Color_none : pi.backgroundColor(this);
 339                         theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
 340                         int const ww = max(textdim.wid, w);
 341                         pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
 342                                          buttonLabel(bv), font, col, Color_none);
 343                 }
 344
 345                 int const y1 = y - textdim.asc + 3;
 346                 // a visual cue when the cursor is inside the inset
 347                 Cursor const & cur = bv.cursor();
 348                 if (cur.isInside(this)) {
 349                         pi.pain.line(xx1, y1 + 4, xx1, y1, colour);
 350                         pi.pain.line(xx1 + 4, y1, xx1, y1, colour);
 351                         pi.pain.line(xx2, y1 + 4, xx2, y1, colour);
 352                         pi.pain.line(xx2 - 4, y1, xx2, y1, colour);
 353                 }
 354                 // Strike through the inset if deleted and not already handled by
 355                 // RowPainter.
 356                 if (pi.change_.deleted() && canPaintChange(bv))
 357                         pi.change_.paintCue(pi, xx1, y1, xx2, y + desc);
 358                 break;
 359         }
 360 }
 361
 362
 363 void InsetCollapsable::cursorPos(BufferView const & bv,
 364                 CursorSlice const & sl, bool boundary, int & x, int & y) const
 365 {
 366         if (geometry(bv) == ButtonOnly)
 367                 status_ = Open;
 368
 369         InsetText::cursorPos(bv, sl, boundary, x, y);
 370         Dimension const textdim = dimensionHelper(bv);
 371
 372         switch (geometry(bv)) {
 373         case LeftButton:
 374                 x += dimensionCollapsed(bv).wid;
 375                 break;
 376         case TopButton: {
 377                 y += dimensionCollapsed(bv).des + textdim.asc;
 378                 break;
 379         }
 380         case NoButton:
 381         case SubLabel:
 382         case Corners:
 383                 // Do nothing
 384                 break;
 385         case ButtonOnly:
 386                 // Cannot get here
 387                 break;
 388         }
 389 }
 390
 391
 392 bool InsetCollapsable::editable() const
 393 {
 394         switch (decoration()) {
 395         case InsetLayout::CLASSIC:
 396         case InsetLayout::MINIMALISTIC:
 397                 return status_ == Open;
 398         default:
 399                 return true;
 400         }
 401 }
 402
 403
 404 bool InsetCollapsable::descendable(BufferView const & bv) const
 405 {
 406         return geometry(bv) != ButtonOnly;
 407 }
 408
 409
 410 bool InsetCollapsable::clickable(BufferView const & bv, int x, int y) const
 411 {
 412         return view_[&bv].button_dim_.contains(x, y);
 413 }
 414
 415
 416 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
 417 {
 418         docstring label;
 419         pos_type const max_length = 15;
 420         pos_type const p_siz = paragraphs().begin()->size();
 421         pos_type const n = min(max_length, p_siz);
 422         pos_type i = 0;
 423         pos_type j = 0;
 424         for (; i < n && j < p_siz; ++j) {
 425                 if (paragraphs().begin()->isInset(j))
 426                         continue;
 427                 label += paragraphs().begin()->getChar(j);
 428                 ++i;
 429         }
 430         if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
 431                 label += "...";
 432         }
 433         return label.empty() ? l : label;
 434 }
 435
 436
 437 void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
 438 {
 439         //lyxerr << "InsetCollapsable: edit left/right" << endl;
 440         cur.push(*this);
 441         InsetText::edit(cur, front, entry_from);
 442 }
 443
 444
 445 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
 446 {
 447         //lyxerr << "InsetCollapsable: edit xy" << endl;
 448         if (geometry(cur.bv()) == ButtonOnly
 449             || (view_[&cur.bv()].button_dim_.contains(x, y)
 450                 && geometry(cur.bv()) != NoButton))
 451                 return this;
 452         cur.push(*this);
 453         return InsetText::editXY(cur, x, y);
 454 }
 455
 456
 457 void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
 458 {
 459         //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
 460         //      << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
 461
 462         bool const hitButton = clickable(cur.bv(), cmd.x(), cmd.y());
 463
 464         switch (cmd.action()) {
 465         case LFUN_MOUSE_PRESS:
 466                 if (hitButton) {
 467                         switch (cmd.button()) {
 468                         case mouse_button::button1:
 469                         case mouse_button::button3:
 470                                 // Pass the command to the enclosing InsetText,
 471                                 // so that the cursor gets set.
 472                                 cur.undispatched();
 473                                 break;
 474                         case mouse_button::none:
 475                         case mouse_button::button2:
 476                         case mouse_button::button4:
 477                         case mouse_button::button5:
 478                                 // Nothing to do.
 479                                 cur.noScreenUpdate();
 480                                 break;
 481                         }
 482                 } else if (geometry(cur.bv()) != ButtonOnly)
 483                         InsetText::doDispatch(cur, cmd);
 484                 else
 485                         cur.undispatched();
 486                 break;
 487
 488         case LFUN_MOUSE_MOTION:
 489         case LFUN_MOUSE_DOUBLE:
 490         case LFUN_MOUSE_TRIPLE:
 491                 if (hitButton)
 492                         cur.noScreenUpdate();
 493                 else if (geometry(cur.bv()) != ButtonOnly)
 494                         InsetText::doDispatch(cur, cmd);
 495                 else
 496                         cur.undispatched();
 497                 break;
 498
 499         case LFUN_MOUSE_RELEASE:
 500                 if (!hitButton) {
 501                         // The mouse click has to be within the inset!
 502                         if (geometry(cur.bv()) != ButtonOnly)
 503                                 InsetText::doDispatch(cur, cmd);
 504                         else
 505                                 cur.undispatched();
 506                         break;
 507                 }
 508                 if (cmd.button() != mouse_button::button1) {
 509                         // Nothing to do.
 510                         cur.noScreenUpdate();
 511                         break;
 512                 }
 513                 // if we are selecting, we do not want to
 514                 // toggle the inset.
 515                 if (cur.selection())
 516                         break;
 517                 // Left button is clicked, the user asks to
 518                 // toggle the inset visual state.
 519                 cur.dispatched();
 520                 cur.screenUpdateFlags(Update::Force | Update::FitCursor);
 521                 if (geometry(cur.bv()) == ButtonOnly) {
 522                         setStatus(cur, Open);
 523                         edit(cur, true);
 524                 }
 525                 else
 526                         setStatus(cur, Collapsed);
 527                 cur.bv().cursor() = cur;
 528                 break;
 529
 530         case LFUN_INSET_TOGGLE:
 531                 if (cmd.argument() == "open")
 532                         setStatus(cur, Open);
 533                 else if (cmd.argument() == "close")
 534                         setStatus(cur, Collapsed);
 535                 else if (cmd.argument() == "toggle" || cmd.argument().empty())
 536                         if (status_ == Open)
 537                                 setStatus(cur, Collapsed);
 538                         else
 539                                 setStatus(cur, Open);
 540                 else // if assign or anything else
 541                         cur.undispatched();
 542                 cur.dispatched();
 543                 break;
 544
 545         default:
 546                 InsetText::doDispatch(cur, cmd);
 547                 break;
 548         }
 549 }
 550
 551
 552 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
 553                 FuncStatus & flag) const
 554 {
 555         switch (cmd.action()) {
 556         case LFUN_INSET_TOGGLE:
 557                 if (cmd.argument() == "open")
 558                         flag.setEnabled(status_ != Open);
 559                 else if (cmd.argument() == "close")
 560                         flag.setEnabled(status_ == Open);
 561                 else if (cmd.argument() == "toggle" || cmd.argument().empty()) {
 562                         flag.setEnabled(true);
 563                         flag.setOnOff(status_ == Open);
 564                 } else
 565                         flag.setEnabled(false);
 566                 return true;
 567
 568         default:
 569                 return InsetText::getStatus(cur, cmd, flag);
 570         }
 571 }
 572
 573
 574 void InsetCollapsable::setLabel(docstring const & l)
 575 {
 576         labelstring_ = l;
 577 }
 578
 579
 580 docstring InsetCollapsable::getLabel() const
 581 {
 582         InsetLayout const & il = getLayout();
 583         return labelstring_.empty() ?
 584                 translateIfPossible(il.labelstring()) : labelstring_;
 585 }
 586
 587
 588 docstring const InsetCollapsable::buttonLabel(BufferView const & bv) const
 589 {
 590         InsetLayout const & il = getLayout();
 591         docstring const label = getLabel();
 592         if (!il.contentaslabel() || geometry(bv) != ButtonOnly)
 593                 return label;
 594         return getNewLabel(label);
 595 }
 596
 597
 598 void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
 599 {
 600         status_ = status;
 601         setButtonLabel();
 602         if (status_ == Collapsed)
 603                 cur.leaveInset(*this);
 604 }
 605
 606
 607 InsetLayout::InsetDecoration InsetCollapsable::decoration() const
 608 {
 609         InsetLayout::InsetDecoration const dec = getLayout().decoration();
 610         return dec == InsetLayout::DEFAULT ? InsetLayout::CLASSIC : dec;
 611 }
 612
 613
 614 string InsetCollapsable::contextMenu(BufferView const & bv, int x,
 615         int y) const
 616 {
 617         string context_menu = contextMenuName();
 618         string const it_context_menu = InsetText::contextMenuName();
 619         if (decoration() == InsetLayout::CONGLOMERATE)
 620                 return context_menu + ";" + it_context_menu;
 621
 622         string const ic_context_menu = InsetCollapsable::contextMenuName();
 623         if (ic_context_menu != context_menu)
 624                 context_menu += ";" + ic_context_menu;
 625
 626         if (geometry(bv) == NoButton)
 627                 return context_menu + ";" + it_context_menu;
 628
 629         Dimension dim = dimensionCollapsed(bv);
 630         if (x < xo(bv) + dim.wid && y < yo(bv) + dim.des)
 631                 return context_menu;
 632
 633         return it_context_menu;
 634 }
 635
 636
 637 string InsetCollapsable::contextMenuName() const
 638 {
 639         if (decoration() == InsetLayout::CONGLOMERATE)
 640                 return "context-conglomerate";
 641         else
 642                 return "context-collapsable";
 643 }
 644
 645
 646 bool InsetCollapsable::canPaintChange(BufferView const & bv) const
 647 {
 648         // return false to let RowPainter draw the change tracking cue consistently
 649         // with the surrounding text, when the inset is inline: for buttons, for
 650         // non-allowMultiPar insets.
 651         switch (geometry(bv)) {
 652         case Corners:
 653         case SubLabel:
 654                 return allowMultiPar();
 655         case ButtonOnly:
 656                 return false;
 657         default:
 658                 break;
 659         }
 660         return true;
 661 }
 662
 663
 664 void InsetCollapsable::addToToc(DocIterator const & cpit, bool output_active,
 665                                 UpdateType utype) const
 666 {
 667         bool doing_output = output_active && producesOutput();
 668         InsetLayout const & layout = getLayout();
 669         if (layout.addToToc()) {
 670                 TocBuilder & b = buffer().tocBackend().builder(layout.tocType());
 671                 // Cursor inside the inset
 672                 DocIterator pit = cpit;
 673                 pit.push_back(CursorSlice(const_cast<InsetCollapsable &>(*this)));
 674                 docstring const label = getLabel();
 675                 b.pushItem(pit, label + (label.empty() ? "" : ": "), output_active);
 676                 // Proceed with the rest of the inset.
 677                 InsetText::addToToc(cpit, doing_output, utype);
 678                 if (layout.isTocCaption()) {
 679                         docstring str;
 680                         text().forOutliner(str, TOC_ENTRY_LENGTH);
 681                         b.argumentItem(str);
 682                 }
 683                 b.pop();
 684         } else
 685                 InsetText::addToToc(cpit, doing_output, utype);
 686 }
 687
 688
 689
 690 } // namespace lyx