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