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