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 "FuncStatus.h"
  25 #include "InsetLayout.h"
  26 #include "Language.h"
  27 #include "LaTeXFeatures.h"
  28 #include "Lexer.h"
  29 #include "FuncRequest.h"
  30 #include "MetricsInfo.h"
  31 #include "ParagraphParameters.h"
  32 #include "TextClass.h"
  33
  34 #include "frontends/FontMetrics.h"
  35 #include "frontends/Painter.h"
  36
  37 #include "support/debug.h"
  38 #include "support/docstream.h"
  39 #include "support/gettext.h"
  40
  41 using namespace std;
  42
  43 namespace lyx {
  44
  45
  46 InsetCollapsable::CollapseStatus InsetCollapsable::status() const
  47 {
  48         if (decoration() == InsetLayout::Conglomerate)
  49                 return status_;
  50         return autoOpen_ ? Open : status_;
  51 }
  52
  53
  54 InsetCollapsable::Geometry InsetCollapsable::geometry() const
  55 {
  56         switch (decoration()) {
  57         case InsetLayout::Classic:
  58                 if (status() == Open)
  59                         return openinlined_ ? LeftButton : TopButton;
  60                 return ButtonOnly;
  61
  62         case InsetLayout::Minimalistic:
  63                 return status() == Open ? NoButton : ButtonOnly ;
  64
  65         case InsetLayout::Conglomerate:
  66                 return status() == Open ? SubLabel : Corners ;
  67
  68         case InsetLayout::Default:
  69                 break; // this shouldn't happen
  70         }
  71
  72         // dummy return value to shut down a warning,
  73         // this is dead code.
  74         return NoButton;
  75 }
  76
  77
  78 InsetCollapsable::InsetCollapsable(Buffer const & buf,
  79                 CollapseStatus status, DocumentClass * dc)
  80         : InsetText(buf), status_(status),
  81           openinlined_(false), autoOpen_(false), mouse_hover_(false)
  82 {
  83         setLayout(dc);
  84         setAutoBreakRows(true);
  85         setDrawFrame(true);
  86         setFrameColor(Color_collapsableframe);
  87         paragraphs().back().setLayout(buf.params().documentClass().emptyLayout());
  88 }
  89
  90
  91 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
  92         : InsetText(rhs),
  93                 layout_(rhs.layout_),
  94                 labelstring_(rhs.labelstring_),
  95                 button_dim(rhs.button_dim),
  96                 status_(rhs.status_),
  97                 openinlined_(rhs.openinlined_),
  98                 autoOpen_(rhs.autoOpen_),
  99                 // the sole purpose of this copy constructor
 100                 mouse_hover_(false)
 101 {
 102 }
 103
 104
 105 docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
 106 {
 107         Dimension dim = dimensionCollapsed();
 108         if (geometry() == NoButton)
 109                 return layout_->labelstring();
 110         if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des)
 111                 return docstring();
 112
 113         switch (status_) {
 114         case Open:
 115                 return _("Left-click to collapse the inset");
 116         case Collapsed:
 117                 return _("Left-click to open the inset");
 118         }
 119         return docstring();
 120 }
 121
 122
 123 void InsetCollapsable::setLayout(BufferParams const & bp)
 124 {
 125         setLayout(bp.documentClassPtr());
 126 }
 127
 128
 129 void InsetCollapsable::setLayout(DocumentClass const * const dc)
 130 {
 131         if (dc) {
 132                 layout_ = &(dc->insetLayout(name()));
 133                 labelstring_ = layout_->labelstring();
 134         } else {
 135                 layout_ = &DocumentClass::emptyInsetLayout();
 136                 labelstring_ = _("UNDEFINED");
 137         }
 138
 139         setButtonLabel();
 140 }
 141
 142
 143 void InsetCollapsable::write(ostream & os) const
 144 {
 145         os << "status ";
 146         switch (status_) {
 147         case Open:
 148                 os << "open";
 149                 break;
 150         case Collapsed:
 151                 os << "collapsed";
 152                 break;
 153         }
 154         os << "\n";
 155         text_.write(buffer(), os);
 156 }
 157
 158
 159 void InsetCollapsable::read(Lexer & lex)
 160 {
 161         bool token_found = false;
 162         if (lex.isOK()) {
 163                 lex.next();
 164                 string const token = lex.getString();
 165                 if (token == "status") {
 166                         lex.next();
 167                         string const tmp_token = lex.getString();
 168
 169                         if (tmp_token == "collapsed") {
 170                                 status_ = Collapsed;
 171                                 token_found = true;
 172                         } else if (tmp_token == "open") {
 173                                 status_ = Open;
 174                                 token_found = true;
 175                         } else {
 176                                 lyxerr << "InsetCollapsable::read: Missing status!"
 177                                        << endl;
 178                                 // Take countermeasures
 179                                 lex.pushToken(token);
 180                         }
 181                 } else {
 182                         LYXERR0("InsetCollapsable::read: Missing 'status'-tag!");
 183                         // take countermeasures
 184                         lex.pushToken(token);
 185                 }
 186         }
 187         // this must be set before we enter InsetText::read()
 188         setLayout(buffer().params());
 189
 190         InsetText::read(lex);
 191
 192         if (!token_found)
 193                 status_ = isOpen() ? Open : Collapsed;
 194
 195         // Force default font, if so requested
 196         // This avoids paragraphs in buffer language that would have a
 197         // foreign language after a document language change, and it ensures
 198         // that all new text in ERT and similar gets the "latex" language,
 199         // since new text inherits the language from the last position of the
 200         // existing text.  As a side effect this makes us also robust against
 201         // bugs in LyX that might lead to font changes in ERT in .lyx files.
 202         resetParagraphsFont();
 203 }
 204
 205
 206 Dimension InsetCollapsable::dimensionCollapsed() const
 207 {
 208         BOOST_ASSERT(layout_);
 209         Dimension dim;
 210         theFontMetrics(layout_->labelfont()).buttonText(
 211                 labelstring_, dim.wid, dim.asc, dim.des);
 212         return dim;
 213 }
 214
 215
 216 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 217 {
 218         BOOST_ASSERT(layout_);
 219
 220         autoOpen_ = mi.base.bv->cursor().isInside(this);
 221
 222         FontInfo tmpfont = mi.base.font;
 223         mi.base.font = layout_->font();
 224         mi.base.font.realize(tmpfont);
 225
 226         switch (geometry()) {
 227         case NoButton:
 228                 InsetText::metrics(mi, dim);
 229                 break;
 230         case Corners:
 231                 InsetText::metrics(mi, dim);
 232                 dim.des -= 3;
 233                 dim.asc -= 1;
 234                 break;
 235         case SubLabel: {
 236                 InsetText::metrics(mi, dim);
 237                 // consider width of the inset label
 238                 FontInfo font(layout_->labelfont());
 239                 font.realize(sane_font);
 240                 font.decSize();
 241                 font.decSize();
 242                 int w = 0;
 243                 int a = 0;
 244                 int d = 0;
 245                 theFontMetrics(font).rectText(labelstring_, w, a, d);
 246                 dim.des += a + d;
 247                 break;
 248                 }
 249         case TopButton:
 250         case LeftButton:
 251         case ButtonOnly:
 252                 dim = dimensionCollapsed();
 253                 if (geometry() == TopButton || geometry() == LeftButton) {
 254                         Dimension textdim;
 255                         InsetText::metrics(mi, textdim);
 256                         openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
 257                         if (openinlined_) {
 258                                 // Correct for button width.
 259                                 dim.wid += textdim.wid;
 260                                 dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
 261                                 dim.asc = textdim.asc;
 262                         } else {
 263                                 dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
 264                                 dim.wid = max(dim.wid, textdim.wid);
 265                         }
 266                 }
 267                 break;
 268         }
 269
 270         mi.base.font = tmpfont;
 271 }
 272
 273
 274 bool InsetCollapsable::setMouseHover(bool mouse_hover)
 275 {
 276         mouse_hover_ = mouse_hover;
 277         return true;
 278 }
 279
 280
 281 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 282 {
 283         BOOST_ASSERT(layout_);
 284
 285         autoOpen_ = pi.base.bv->cursor().isInside(this);
 286         ColorCode const old_color = pi.background_color;
 287         pi.background_color = backgroundColor();
 288
 289         FontInfo tmpfont = pi.base.font;
 290         pi.base.font = layout_->font();
 291         pi.base.font.realize(tmpfont);
 292
 293         // Draw button first -- top, left or only
 294         Dimension dimc = dimensionCollapsed();
 295
 296         if (geometry() == TopButton ||
 297             geometry() == LeftButton ||
 298             geometry() == ButtonOnly) {
 299                 button_dim.x1 = x + 0;
 300                 button_dim.x2 = x + dimc.width();
 301                 button_dim.y1 = y - dimc.asc;
 302                 button_dim.y2 = y + dimc.des;
 303
 304                 pi.pain.buttonText(x, y, labelstring_, layout_->labelfont(),
 305                         mouse_hover_);
 306         } else {
 307                 button_dim.x1 = 0;
 308                 button_dim.y1 = 0;
 309                 button_dim.x2 = 0;
 310                 button_dim.y2 = 0;
 311         }
 312
 313         Dimension const textdim = InsetText::dimension(*pi.base.bv);
 314         int const baseline = y;
 315         int textx, texty;
 316         switch (geometry()) {
 317         case LeftButton:
 318                 textx = x + dimc.width();
 319                 texty = baseline;
 320                 InsetText::draw(pi, textx, texty);
 321                 break;
 322         case TopButton:
 323                 textx = x;
 324                 texty = baseline + dimc.des + textdim.asc;
 325                 InsetText::draw(pi, textx, texty);
 326                 break;
 327         case ButtonOnly:
 328                 break;
 329         case NoButton:
 330                 textx = x;
 331                 texty = baseline;
 332                 InsetText::draw(pi, textx, texty);
 333                 break;
 334         case SubLabel:
 335         case Corners:
 336                 textx = x;
 337                 texty = baseline;
 338                 const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
 339                 InsetText::draw(pi, textx, texty);
 340                 const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
 341
 342                 int desc = textdim.descent();
 343                 if (geometry() == Corners)
 344                         desc -= 3;
 345
 346                 const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
 347                 const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
 348                 pi.pain.line(xx1, y + desc - 4,
 349                              xx1, y + desc,
 350                         layout_->labelfont().color());
 351                 if (status_ == Open)
 352                         pi.pain.line(xx1, y + desc,
 353                                 xx2, y + desc,
 354                                 layout_->labelfont().color());
 355                 else {
 356                         // Make status_ value visible:
 357                         pi.pain.line(xx1, y + desc,
 358                                 xx1 + 4, y + desc,
 359                                 layout_->labelfont().color());
 360                         pi.pain.line(xx2 - 4, y + desc,
 361                                 xx2, y + desc,
 362                                 layout_->labelfont().color());
 363                 }
 364                 pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3,
 365                         y + desc - 4, layout_->labelfont().color());
 366
 367                 // the label below the text. Can be toggled.
 368                 if (geometry() == SubLabel) {
 369                         FontInfo font(layout_->labelfont());
 370                         font.realize(sane_font);
 371                         font.decSize();
 372                         font.decSize();
 373                         int w = 0;
 374                         int a = 0;
 375                         int d = 0;
 376                         theFontMetrics(font).rectText(labelstring_, w, a, d);
 377                         int const ww = max(textdim.wid, w);
 378                         pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
 379                                 labelstring_, font, Color_none, Color_none);
 380                         desc += d;
 381                 }
 382
 383                 // a visual cue when the cursor is inside the inset
 384                 Cursor & cur = pi.base.bv->cursor();
 385                 if (cur.isInside(this)) {
 386                         y -= textdim.asc;
 387                         y += 3;
 388                         pi.pain.line(xx1, y + 4, xx1, y, layout_->labelfont().color());
 389                         pi.pain.line(xx1 + 4, y, xx1, y, layout_->labelfont().color());
 390                         pi.pain.line(xx2, y + 4, xx2, y,
 391                                 layout_->labelfont().color());
 392                         pi.pain.line(xx2 - 4, y, xx2, y,
 393                                 layout_->labelfont().color());
 394                 }
 395                 break;
 396         }
 397         pi.background_color = old_color;
 398
 399         pi.base.font = tmpfont;
 400 }
 401
 402
 403 void InsetCollapsable::cursorPos(BufferView const & bv,
 404                 CursorSlice const & sl, bool boundary, int & x, int & y) const
 405 {
 406         if (geometry() == ButtonOnly)
 407                 status_ = Open;
 408         BOOST_ASSERT(geometry() != ButtonOnly);
 409
 410         InsetText::cursorPos(bv, sl, boundary, x, y);
 411         Dimension const textdim = InsetText::dimension(bv);
 412
 413         switch (geometry()) {
 414         case LeftButton:
 415                 x += dimensionCollapsed().wid;
 416                 break;
 417         case TopButton: {
 418                 y += dimensionCollapsed().des + textdim.asc;
 419                 break;
 420         }
 421         case NoButton:
 422         case SubLabel:
 423         case Corners:
 424                 // Do nothing
 425                 break;
 426         case ButtonOnly:
 427                 // Cannot get here
 428                 break;
 429         }
 430 }
 431
 432
 433 Inset::EDITABLE InsetCollapsable::editable() const
 434 {
 435         return geometry() != ButtonOnly? HIGHLY_EDITABLE : IS_EDITABLE;
 436 }
 437
 438
 439 bool InsetCollapsable::descendable() const
 440 {
 441         return geometry() != ButtonOnly;
 442 }
 443
 444
 445 bool InsetCollapsable::hitButton(FuncRequest const & cmd) const
 446 {
 447         return button_dim.contains(cmd.x, cmd.y);
 448 }
 449
 450
 451 docstring const InsetCollapsable::getNewLabel(docstring const & l) const
 452 {
 453         docstring label;
 454         pos_type const max_length = 15;
 455         pos_type const p_siz = paragraphs().begin()->size();
 456         pos_type const n = min(max_length, p_siz);
 457         pos_type i = 0;
 458         pos_type j = 0;
 459         for (; i < n && j < p_siz; ++j) {
 460                 if (paragraphs().begin()->isInset(j))
 461                         continue;
 462                 label += paragraphs().begin()->getChar(j);
 463                 ++i;
 464         }
 465         if (paragraphs().size() > 1 || (i > 0 && j < p_siz)) {
 466                 label += "...";
 467         }
 468         return label.empty() ? l : label;
 469 }
 470
 471
 472 void InsetCollapsable::edit(
 473                 Cursor & cur, bool front, EntryDirection entry_from)
 474 {
 475         //lyxerr << "InsetCollapsable: edit left/right" << endl;
 476         cur.push(*this);
 477         InsetText::edit(cur, front, entry_from);
 478 }
 479
 480
 481 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
 482 {
 483         //lyxerr << "InsetCollapsable: edit xy" << endl;
 484         if (geometry() == ButtonOnly
 485          || (button_dim.contains(x, y)
 486           && geometry() != NoButton))
 487                 return this;
 488         cur.push(*this);
 489         return InsetText::editXY(cur, x, y);
 490 }
 491
 492
 493 void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
 494 {
 495         //lyxerr << "InsetCollapsable::doDispatch (begin): cmd: " << cmd
 496         //      << " cur: " << cur << " bvcur: " << cur.bv().cursor() << endl;
 497
 498         switch (cmd.action) {
 499         case LFUN_MOUSE_PRESS:
 500                 if (hitButton(cmd) && geometry() != NoButton) {
 501                         switch (cmd.button()) {
 502                         case mouse_button::button1:
 503                                 // reset selection if necessary (see bug 3060)
 504                                 if (cur.selection())
 505                                         cur.bv().cursor().clearSelection();
 506                                 else
 507                                         cur.noUpdate();
 508                                 cur.dispatched();
 509                                 return;
 510                         case mouse_button::button2:
 511                         case mouse_button::button3:
 512                                 // Nothing to do.
 513                                 cur.undispatched();
 514                                 return;
 515                         case mouse_button::none:
 516                         case mouse_button::button4:
 517                         case mouse_button::button5:
 518                                 break;
 519                         }
 520                 }
 521                 if (geometry() == NoButton
 522                         || (geometry() != ButtonOnly && !hitButton(cmd)))
 523                         InsetText::doDispatch(cur, cmd);
 524                 else
 525                         cur.undispatched();
 526                 break;
 527
 528         case LFUN_MOUSE_MOTION:
 529         case LFUN_MOUSE_DOUBLE:
 530         case LFUN_MOUSE_TRIPLE:
 531                 if (geometry() == NoButton)
 532                         InsetText::doDispatch(cur, cmd);
 533                 else if (geometry() != ButtonOnly
 534                      && !hitButton(cmd))
 535                         InsetText::doDispatch(cur, cmd);
 536                 else
 537                         cur.undispatched();
 538                 break;
 539
 540         case LFUN_MOUSE_RELEASE:
 541                 if (geometry() == NoButton || !hitButton(cmd)) {
 542                         // The mouse click has to be within the inset!
 543                         InsetText::doDispatch(cur, cmd);
 544                         break;
 545                 }
 546                 if (cmd.button() != mouse_button::button1) {
 547                         cur.dispatched();
 548                         break;
 549                 }
 550                 // if we are selecting, we do not want to
 551                 // toggle the inset.
 552                 if (cur.selection())
 553                         break;
 554                 // Left button is clicked, the user asks to
 555                 // toggle the inset visual state.
 556                 cur.dispatched();
 557                 cur.updateFlags(Update::Force | Update::FitCursor);
 558                 if (geometry() == ButtonOnly) {
 559                         setStatus(cur, Open);
 560                         edit(cur, true);
 561                 }
 562                 else
 563                         setStatus(cur, Collapsed);
 564                 cur.bv().cursor() = cur;
 565                 break;
 566
 567         case LFUN_INSET_TOGGLE:
 568                 if (cmd.argument() == "open")
 569                         setStatus(cur, Open);
 570                 else if (cmd.argument() == "close")
 571                         setStatus(cur, Collapsed);
 572                 else if (cmd.argument() == "toggle" || cmd.argument().empty())
 573                         if (status_ == Open) {
 574                                 setStatus(cur, Collapsed);
 575                                 if (geometry() == ButtonOnly)
 576                                         cur.top().forwardPos();
 577                         } else
 578                                 setStatus(cur, Open);
 579                 else // if assign or anything else
 580                         cur.undispatched();
 581                 cur.dispatched();
 582                 break;
 583
 584         case LFUN_PASTE:
 585         case LFUN_CLIPBOARD_PASTE:
 586         case LFUN_PRIMARY_SELECTION_PASTE: {
 587                 InsetText::doDispatch(cur, cmd);
 588                 // Since we can only store plain text, we must reset all
 589                 // attributes.
 590                 // FIXME: Change only the pasted paragraphs
 591
 592                 resetParagraphsFont();
 593                 break;
 594         }
 595
 596         default:
 597                 if (layout_ && layout_->isForceLtr()) {
 598                         // Force any new text to latex_language
 599                         // FIXME: This should only be necessary in constructor, but
 600                         // new paragraphs that are created by pressing enter at the
 601                         // start of an existing paragraph get the buffer language
 602                         // and not latex_language, so we take this brute force
 603                         // approach.
 604                         cur.current_font.setLanguage(latex_language);
 605                         cur.real_current_font.setLanguage(latex_language);
 606                 }
 607                 InsetText::doDispatch(cur, cmd);
 608                 break;
 609         }
 610 }
 611
 612
 613 bool InsetCollapsable::allowMultiPar() const
 614 {
 615         return layout_->isMultiPar();
 616 }
 617
 618
 619 void InsetCollapsable::resetParagraphsFont()
 620 {
 621         Font font;
 622         font.fontInfo() = inherit_font;
 623         if (layout_->isForceLtr())
 624                 font.setLanguage(latex_language);
 625         if (layout_->isPassThru()) {
 626                 ParagraphList::iterator par = paragraphs().begin();
 627                 ParagraphList::iterator const end = paragraphs().end();
 628                 while (par != end) {
 629                         par->resetFonts(font);
 630                         par->params().clear();
 631                         ++par;
 632                 }
 633         }
 634 }
 635
 636
 637 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
 638                 FuncStatus & flag) const
 639 {
 640         switch (cmd.action) {
 641         // suppress these
 642         case LFUN_ACCENT_ACUTE:
 643         case LFUN_ACCENT_BREVE:
 644         case LFUN_ACCENT_CARON:
 645         case LFUN_ACCENT_CEDILLA:
 646         case LFUN_ACCENT_CIRCLE:
 647         case LFUN_ACCENT_CIRCUMFLEX:
 648         case LFUN_ACCENT_DOT:
 649         case LFUN_ACCENT_GRAVE:
 650         case LFUN_ACCENT_HUNGARIAN_UMLAUT:
 651         case LFUN_ACCENT_MACRON:
 652         case LFUN_ACCENT_OGONEK:
 653         case LFUN_ACCENT_SPECIAL_CARON:
 654         case LFUN_ACCENT_TIE:
 655         case LFUN_ACCENT_TILDE:
 656         case LFUN_ACCENT_UMLAUT:
 657         case LFUN_ACCENT_UNDERBAR:
 658         case LFUN_ACCENT_UNDERDOT:
 659         case LFUN_APPENDIX:
 660         case LFUN_BIBITEM_INSERT:
 661         case LFUN_BOX_INSERT:
 662         case LFUN_BRANCH_INSERT:
 663         case LFUN_NEW_LINE:
 664         case LFUN_CAPTION_INSERT:
 665         case LFUN_DEPTH_DECREMENT:
 666         case LFUN_DEPTH_INCREMENT:
 667         case LFUN_ENVIRONMENT_INSERT:
 668         case LFUN_ERT_INSERT:
 669         case LFUN_FILE_INSERT:
 670         case LFUN_FLEX_INSERT:
 671         case LFUN_FLOAT_INSERT:
 672         case LFUN_FLOAT_LIST:
 673         case LFUN_FLOAT_WIDE_INSERT:
 674         case LFUN_FONT_BOLD:
 675         case LFUN_FONT_TYPEWRITER:
 676         case LFUN_FONT_DEFAULT:
 677         case LFUN_FONT_EMPH:
 678         case LFUN_FONT_FREE_APPLY:
 679         case LFUN_FONT_FREE_UPDATE:
 680         case LFUN_FONT_NOUN:
 681         case LFUN_FONT_ROMAN:
 682         case LFUN_FONT_SANS:
 683         case LFUN_FONT_FRAK:
 684         case LFUN_FONT_ITAL:
 685         case LFUN_FONT_SIZE:
 686         case LFUN_FONT_STATE:
 687         case LFUN_FONT_UNDERLINE:
 688         case LFUN_FOOTNOTE_INSERT:
 689         case LFUN_HYPERLINK_INSERT:
 690         case LFUN_INDEX_INSERT:
 691         case LFUN_INDEX_PRINT:
 692         case LFUN_INSET_INSERT:
 693         case LFUN_LABEL_GOTO:
 694         case LFUN_LABEL_INSERT:
 695         case LFUN_LINE_INSERT:
 696         case LFUN_NEWPAGE_INSERT:
 697         case LFUN_LAYOUT:
 698         case LFUN_LAYOUT_PARAGRAPH:
 699         case LFUN_LAYOUT_TABULAR:
 700         case LFUN_MARGINALNOTE_INSERT:
 701         case LFUN_MATH_DISPLAY:
 702         case LFUN_MATH_INSERT:
 703         case LFUN_MATH_MATRIX:
 704         case LFUN_MATH_MODE:
 705         case LFUN_MENU_OPEN:
 706         case LFUN_NOACTION:
 707         case LFUN_NOMENCL_INSERT:
 708         case LFUN_NOMENCL_PRINT:
 709         case LFUN_NOTE_INSERT:
 710         case LFUN_NOTE_NEXT:
 711         case LFUN_OPTIONAL_INSERT:
 712         case LFUN_PARAGRAPH_PARAMS:
 713         case LFUN_PARAGRAPH_PARAMS_APPLY:
 714         case LFUN_PARAGRAPH_SPACING:
 715         case LFUN_PARAGRAPH_UPDATE:
 716         case LFUN_REFERENCE_NEXT:
 717         case LFUN_SERVER_GOTO_FILE_ROW:
 718         case LFUN_SERVER_NOTIFY:
 719         case LFUN_SERVER_SET_XY:
 720         case LFUN_SPACE_INSERT:
 721         case LFUN_SPECIALCHAR_INSERT:
 722         case LFUN_TABULAR_INSERT:
 723         case LFUN_TOC_INSERT:
 724         case LFUN_WRAP_INSERT:
 725                 if (layout_->isPassThru()) {
 726                         flag.enabled(false);
 727                         return true;
 728                 } else
 729                         return InsetText::getStatus(cur, cmd, flag);
 730
 731         case LFUN_INSET_TOGGLE:
 732                 if ((cmd.argument() == "open" && status_ != Open)
 733                       || (cmd.argument() == "close" && status_ == Open)
 734                       || cmd.argument() == "toggle" || cmd.argument().empty())
 735                                 flag.enabled(true);
 736                 else
 737                         flag.enabled(false);
 738                 return true;
 739
 740         case LFUN_LANGUAGE:
 741                 flag.enabled(!layout_->isForceLtr());
 742                 return InsetText::getStatus(cur, cmd, flag);
 743
 744         case LFUN_BREAK_PARAGRAPH:
 745         case LFUN_BREAK_PARAGRAPH_SKIP:
 746                 flag.enabled(layout_->isMultiPar());
 747                 return true;
 748
 749         default:
 750                 return InsetText::getStatus(cur, cmd, flag);
 751         }
 752 }
 753
 754
 755 void InsetCollapsable::setLabel(docstring const & l)
 756 {
 757         labelstring_ = l;
 758 }
 759
 760
 761 void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
 762 {
 763         status_ = status;
 764         setButtonLabel();
 765         if (status_ == Collapsed)
 766                 cur.leaveInset(*this);
 767 }
 768
 769
 770 docstring InsetCollapsable::floatName(
 771                 string const & type, BufferParams const & bp) const
 772 {
 773         FloatList const & floats = bp.documentClass().floats();
 774         FloatList::const_iterator it = floats[type];
 775         // FIXME UNICODE
 776         return (it == floats.end()) ? from_ascii(type) : bp.B_(it->second.name());
 777 }
 778
 779
 780 InsetLayout::InsetDecoration InsetCollapsable::decoration() const
 781 {
 782         if (!layout_)
 783                 return InsetLayout::Classic;
 784         InsetLayout::InsetDecoration const dec = layout_->decoration();
 785         switch (dec) {
 786         case InsetLayout::Classic:
 787         case InsetLayout::Minimalistic:
 788         case InsetLayout::Conglomerate:
 789                 return dec;
 790         case InsetLayout::Default:
 791                 break;
 792         }
 793         if (lyxCode() == FLEX_CODE)
 794                 return InsetLayout::Conglomerate;
 795         return InsetLayout::Classic;
 796 }
 797
 798
 799 int InsetCollapsable::latex(odocstream & os,
 800                           OutputParams const & runparams) const
 801 {
 802         // FIXME: What should we do layout_ is 0?
 803         // 1) assert
 804         // 2) through an error
 805         if (!layout_)
 806                 return 0;
 807
 808         // This implements the standard way of handling the LaTeX output of
 809         // a collapsable inset, either a command or an environment. Standard
 810         // collapsable insets should not redefine this, non-standard ones may
 811         // call this.
 812         if (!layout_->latexname().empty()) {
 813                 if (layout_->latextype() == "command") {
 814                         // FIXME UNICODE
 815                         if (runparams.moving_arg)
 816                                 os << "\\protect";
 817                         os << '\\' << from_utf8(layout_->latexname());
 818                         if (!layout_->latexparam().empty())
 819                                 os << from_utf8(layout_->latexparam());
 820                         os << '{';
 821                 } else if (layout_->latextype() == "environment") {
 822                         os << "%\n\\begin{" << from_utf8(layout_->latexname()) << "}\n";
 823                         if (!layout_->latexparam().empty())
 824                                 os << from_utf8(layout_->latexparam());
 825                 }
 826         }
 827         OutputParams rp = runparams;
 828         if (layout_->isPassThru())
 829                 rp.verbatim = true;
 830         if (layout_->isNeedProtect())
 831                 rp.moving_arg = true;
 832         int i = InsetText::latex(os, rp);
 833         if (!layout_->latexname().empty()) {
 834                 if (layout_->latextype() == "command") {
 835                         os << "}";
 836                 } else if (layout_->latextype() == "environment") {
 837                         os << "\n\\end{" << from_utf8(layout_->latexname()) << "}\n";
 838                         i += 4;
 839                 }
 840         }
 841         return i;
 842 }
 843
 844
 845 void InsetCollapsable::validate(LaTeXFeatures & features) const
 846 {
 847         if (!layout_)
 848                 return;
 849
 850         // Force inclusion of preamble snippet in layout file
 851         features.require(to_utf8(layout_->name()));
 852         InsetText::validate(features);
 853 }
 854
 855
 856 bool InsetCollapsable::undefined() const
 857 {
 858         docstring const & n = getLayout().name();
 859         return n.empty() || n == DocumentClass::emptyInsetLayout().name();
 860 }
 861
 862
 863 docstring InsetCollapsable::contextMenu(BufferView const & bv, int x,
 864         int y) const
 865 {
 866         if (decoration() == InsetLayout::Conglomerate)
 867                 return from_ascii("context-conglomerate");
 868
 869         if (geometry() == NoButton)
 870                 return from_ascii("context-collapsable");
 871
 872         Dimension dim = dimensionCollapsed();
 873         if (x < xo(bv) + dim.wid && y < yo(bv) + dim.des)
 874                 return from_ascii("context-collapsable");
 875
 876         return InsetText::contextMenu(bv, x, y);
 877 }
 878
 879 } // namespace lyx