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