3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
10 * \author Jürgen Vigna
12 * Full author contact details are available in file CREDITS.
17 #include "BufferView.h"
19 #include "BranchList.h"
21 #include "buffer_funcs.h"
22 #include "BufferList.h"
23 #include "BufferParams.h"
24 #include "CoordCache.h"
26 #include "CutAndPaste.h"
27 #include "DispatchResult.h"
28 #include "ErrorList.h"
30 #include "FloatList.h"
31 #include "FuncRequest.h"
32 #include "FuncStatus.h"
34 #include "InsetIterator.h"
36 #include "LaTeXFeatures.h"
37 #include "LayoutFile.h"
41 #include "LyXAction.h"
45 #include "MetricsInfo.h"
46 #include "Paragraph.h"
47 #include "ParagraphParameters.h"
48 #include "ParIterator.h"
49 #include "RowPainter.h"
52 #include "TextClass.h"
53 #include "TextMetrics.h"
55 #include "TocBackend.h"
56 #include "WordLangTuple.h"
58 #include "insets/InsetBibtex.h"
59 #include "insets/InsetCitation.h"
60 #include "insets/InsetCommand.h" // ChangeRefs
61 #include "insets/InsetExternal.h"
62 #include "insets/InsetGraphics.h"
63 #include "insets/InsetNote.h"
64 #include "insets/InsetRef.h"
65 #include "insets/InsetText.h"
67 #include "mathed/MathData.h"
69 #include "frontends/alert.h"
70 #include "frontends/Application.h"
71 #include "frontends/Delegates.h"
72 #include "frontends/FontMetrics.h"
73 #include "frontends/NullPainter.h"
74 #include "frontends/Painter.h"
75 #include "frontends/Selection.h"
77 #include "support/convert.h"
78 #include "support/debug.h"
79 #include "support/ExceptionMessage.h"
80 #include "support/filetools.h"
81 #include "support/gettext.h"
82 #include "support/lassert.h"
83 #include "support/lstrings.h"
84 #include "support/lyxlib.h"
85 #include "support/Package.h"
86 #include "support/types.h"
96 using namespace lyx::support;
100 namespace Alert = frontend::Alert;
104 /// Return an inset of this class if it exists at the current cursor position
106 T * getInsetByCode(Cursor const & cur, InsetCode code)
108 DocIterator it = cur;
109 Inset * inset = it.nextInset();
110 if (inset && inset->lyxCode() == code)
111 return static_cast<T*>(inset);
116 /// Note that comparing contents can only be used for InsetCommand
117 bool findNextInset(DocIterator & dit, vector<InsetCode> const & codes,
118 docstring const & contents)
120 DocIterator tmpdit = dit;
123 Inset const * inset = tmpdit.nextInset();
125 bool const valid_code = std::find(codes.begin(), codes.end(),
126 inset->lyxCode()) != codes.end();
127 InsetCommand const * ic = inset->asInsetCommand();
128 bool const same_or_no_contents = contents.empty()
129 || (ic && (ic->getFirstNonOptParam() == contents));
131 if (valid_code && same_or_no_contents) {
136 tmpdit.forwardInset();
143 /// Looks for next inset with one of the given codes.
144 /// Note that same_content can only be used for InsetCommand
145 bool findInset(DocIterator & dit, vector<InsetCode> const & codes,
149 DocIterator tmpdit = dit;
150 tmpdit.forwardInset();
154 Inset const * inset = tmpdit.nextInset();
155 if (same_content && inset) {
156 InsetCommand const * ic = inset->asInsetCommand();
158 bool const valid_code = std::find(codes.begin(), codes.end(),
159 ic->lyxCode()) != codes.end();
161 contents = ic->getFirstNonOptParam();
165 if (!findNextInset(tmpdit, codes, contents)) {
166 if (dit.depth() != 1 || dit.pit() != 0 || dit.pos() != 0) {
167 Inset * inset = &tmpdit.bottom().inset();
168 tmpdit = doc_iterator_begin(&inset->buffer(), inset);
169 if (!findNextInset(tmpdit, codes, contents))
181 /// Looks for next inset with the given code
182 void findInset(DocIterator & dit, InsetCode code, bool same_content)
184 findInset(dit, vector<InsetCode>(1, code), same_content);
188 /// Moves cursor to the next inset with one of the given codes.
189 void gotoInset(BufferView * bv, vector<InsetCode> const & codes,
192 Cursor tmpcur = bv->cursor();
193 if (!findInset(tmpcur, codes, same_content)) {
194 bv->cursor().message(_("No more insets"));
198 tmpcur.clearSelection();
199 bv->setCursor(tmpcur);
204 /// Moves cursor to the next inset with given code.
205 void gotoInset(BufferView * bv, InsetCode code, bool same_content)
207 gotoInset(bv, vector<InsetCode>(1, code), same_content);
211 /// A map from a Text to the associated text metrics
212 typedef map<Text const *, TextMetrics> TextMetricsCache;
214 enum ScreenUpdateStrategy {
224 /////////////////////////////////////////////////////////////////////
228 /////////////////////////////////////////////////////////////////////
230 struct BufferView::Private
232 Private(BufferView & bv) : update_strategy_(FullScreenUpdate),
233 update_flags_(Update::Force),
235 anchor_pit_(0), anchor_ypos_(0),
236 inlineCompletionUniqueChars_(0),
237 last_inset_(0), clickable_inset_(false),
238 mouse_position_cache_(),
239 bookmark_edit_position_(-1), gui_(0),
240 horiz_scroll_offset_(0), repaint_caret_row_(false)
242 xsel_cache_.set = false;
246 ScrollbarParameters scrollbarParameters_;
248 ScreenUpdateStrategy update_strategy_;
250 Update::flags update_flags_;
252 CoordCache coord_cache_;
254 /// Estimated average par height for scrollbar.
256 /// this is used to handle XSelection events in the right manner.
265 pit_type anchor_pit_;
269 vector<int> par_height_;
272 DocIterator inlineCompletionPos_;
274 docstring inlineCompletion_;
276 size_t inlineCompletionUniqueChars_;
278 /// keyboard mapping object.
281 /// last visited inset.
282 /** kept to send setMouseHover(false).
283 * Not owned, so don't delete.
285 Inset const * last_inset_;
286 /// are we hovering something that we can click
287 bool clickable_inset_;
289 /// position of the mouse at the time of the last mouse move
290 /// This is used to update the hovering status of inset in
291 /// cases where the buffer is scrolled, but the mouse didn't move.
292 Point mouse_position_cache_;
294 // cache for id of the paragraph which was edited the last time
295 int bookmark_edit_position_;
297 mutable TextMetricsCache text_metrics_;
300 /** Not owned, so don't delete.
302 frontend::GuiBufferViewDelegate * gui_;
304 /// Cache for Find Next
305 FuncRequest search_request_cache_;
308 map<string, Inset *> edited_insets_;
310 /// When the row where the cursor lies is scrolled, this
311 /// contains the scroll offset
312 int horiz_scroll_offset_;
313 /// a slice pointing to the start of the row where the cursor
314 /// is (at last draw time)
315 CursorSlice current_row_slice_;
316 /// a slice pointing to the start of the row where cursor was
317 /// at previous draw event
318 CursorSlice last_row_slice_;
320 /// a slice pointing to where the cursor has been drawn after the current
322 CursorSlice caret_slice_;
323 /// indicates whether the caret slice needs to be repainted in this draw() run.
324 bool repaint_caret_row_;
328 BufferView::BufferView(Buffer & buf)
329 : width_(0), height_(0), full_screen_(false), buffer_(buf),
330 d(new Private(*this))
332 d->xsel_cache_.set = false;
333 d->intl_.initKeyMapper(lyxrc.use_kbmap);
335 d->cursor_.setBuffer(&buf);
336 d->cursor_.push(buffer_.inset());
337 d->cursor_.resetAnchor();
338 d->cursor_.setCurrentFont();
340 buffer_.updatePreviews();
344 BufferView::~BufferView()
346 // current buffer is going to be switched-off, save cursor pos
347 // Ideally, the whole cursor stack should be saved, but session
348 // currently can only handle bottom (whole document) level pit and pos.
349 // That is to say, if a cursor is in a nested inset, it will be
350 // restore to the left of the top level inset.
351 LastFilePosSection::FilePos fp;
352 fp.pit = d->cursor_.bottom().pit();
353 fp.pos = d->cursor_.bottom().pos();
354 theSession().lastFilePos().save(buffer_.fileName(), fp);
357 d->last_inset_->setMouseHover(this, false);
363 int BufferView::rightMargin() const
365 // The value used to be hardcoded to 10
366 int const default_margin = zoomedPixels(10);
367 // The additional test for the case the outliner is opened.
368 if (!full_screen_ || !lyxrc.full_screen_limit
369 || width_ < lyxrc.full_screen_width + 2 * default_margin)
370 return default_margin;
372 return (width_ - lyxrc.full_screen_width) / 2;
376 int BufferView::leftMargin() const
378 return rightMargin();
382 int BufferView::inPixels(Length const & len) const
384 Font const font = buffer().params().getFont();
385 return len.inPixels(workWidth(), theFontMetrics(font).em());
389 int BufferView::zoomedPixels(int pix) const
391 // FIXME: the dpi setting should really depend on the BufferView
392 // (think different monitors).
394 // Zoom factor specified by user in percent
395 double const zoom = lyxrc.currentZoom / 100.0; // [percent]
397 // DPI setting for monitor relative to 100dpi
398 double const dpizoom = lyxrc.dpi / 100.0; // [per 100dpi]
400 return support::iround(pix * zoom * dpizoom);
404 bool BufferView::isTopScreen() const
406 return 0 == d->scrollbarParameters_.min;
410 bool BufferView::isBottomScreen() const
412 return 0 == d->scrollbarParameters_.max;
416 Intl & BufferView::getIntl()
422 Intl const & BufferView::getIntl() const
428 CoordCache & BufferView::coordCache()
430 return d->coord_cache_;
434 CoordCache const & BufferView::coordCache() const
436 return d->coord_cache_;
440 Buffer & BufferView::buffer()
446 Buffer const & BufferView::buffer() const
452 bool BufferView::needsFitCursor() const
454 if (cursorStatus(d->cursor_) == CUR_INSIDE) {
455 frontend::FontMetrics const & fm =
456 theFontMetrics(d->cursor_.getFont().fontInfo());
457 int const asc = fm.maxAscent();
458 int const des = fm.maxDescent();
459 Point const p = getPos(d->cursor_);
460 if (p.y_ - asc >= 0 && p.y_ + des < height_)
469 // this is for debugging only.
470 string flagsAsString(Update::flags flags)
472 if (flags == Update::None)
474 return string((flags & Update::FitCursor) ? "FitCursor " : "")
475 + ((flags & Update::Force) ? "Force " : "")
476 + ((flags & Update::ForceDraw) ? "ForceDraw " : "")
477 + ((flags & Update::SinglePar) ? "SinglePar " : "");
482 void BufferView::processUpdateFlags(Update::flags flags)
484 LYXERR(Debug::PAINTING, "BufferView::processUpdateFlags( "
485 << flagsAsString(flags) << ") buffer: " << &buffer_);
487 // Case when no explicit update is requested.
488 if (flags == Update::None)
491 // SinglePar is ignored for now (this should probably change). We
492 // set it ourselves below, at the price of always rebreaking the
493 // paragraph at cursor. This can be expensive for large tables.
494 flags = flags & ~Update::SinglePar;
496 // First check whether the metrics and inset positions should be updated
497 if (flags & Update::Force) {
498 // This will update the CoordCache items and replace Force
499 // with ForceDraw in flags.
500 updateMetrics(flags);
503 // Then make sure that the screen contains the cursor if needed
504 if (flags & Update::FitCursor) {
505 if (needsFitCursor()) {
506 scrollToCursor(d->cursor_, false);
507 // Metrics have to be recomputed (maybe again)
508 updateMetrics(flags);
510 flags = flags & ~Update::FitCursor;
513 // Finally detect whether we can only repaint a single paragraph
514 if (!(flags & Update::ForceDraw)) {
515 if (singleParUpdate())
516 flags = flags | Update::SinglePar;
518 updateMetrics(flags);
521 // Add flags to the the update flags. These will be reset to None
522 // after the redraw is actually done
523 d->update_flags_ = d->update_flags_ | flags;
524 LYXERR(Debug::PAINTING, "Cumulative flags: " << flagsAsString(flags));
526 // Now compute the update strategy
527 // Possibly values in flag are None, Decoration, ForceDraw
528 LATTEST((d->update_flags_ & ~(Update::None | Update::SinglePar
529 | Update::Decoration | Update::ForceDraw)) == 0);
531 if (d->update_flags_ & Update::ForceDraw)
532 d->update_strategy_ = FullScreenUpdate;
533 else if (d->update_flags_ & Update::Decoration)
534 d->update_strategy_ = DecorationUpdate;
535 else if (d->update_flags_ & Update::SinglePar)
536 d->update_strategy_ = SingleParUpdate;
538 // no need to redraw anything.
539 d->update_strategy_ = NoScreenUpdate;
542 updateHoveredInset();
545 buffer_.changed(false);
549 void BufferView::updateScrollbar()
551 if (height_ == 0 && width_ == 0)
554 // We prefer fixed size line scrolling.
555 d->scrollbarParameters_.single_step = defaultRowHeight();
556 // We prefer full screen page scrolling.
557 d->scrollbarParameters_.page_step = height_;
559 Text & t = buffer_.text();
560 TextMetrics & tm = d->text_metrics_[&t];
562 LYXERR(Debug::GUI, " Updating scrollbar: height: "
563 << t.paragraphs().size()
564 << " curr par: " << d->cursor_.bottom().pit()
565 << " default height " << defaultRowHeight());
567 size_t const parsize = t.paragraphs().size();
568 if (d->par_height_.size() != parsize) {
569 d->par_height_.clear();
570 // FIXME: We assume a default paragraph height of 2 rows. This
571 // should probably be pondered with the screen width.
572 d->par_height_.resize(parsize, defaultRowHeight() * 2);
575 // Look at paragraph heights on-screen
576 pair<pit_type, ParagraphMetrics const *> first = tm.first();
577 pair<pit_type, ParagraphMetrics const *> last = tm.last();
578 for (pit_type pit = first.first; pit <= last.first; ++pit) {
579 d->par_height_[pit] = tm.parMetrics(pit).height();
580 LYXERR(Debug::SCROLLING, "storing height for pit " << pit << " : "
581 << d->par_height_[pit]);
584 int top_pos = first.second->position() - first.second->ascent();
585 int bottom_pos = last.second->position() + last.second->descent();
586 bool first_visible = first.first == 0 && top_pos >= 0;
587 bool last_visible = last.first + 1 == int(parsize) && bottom_pos <= height_;
588 if (first_visible && last_visible) {
589 d->scrollbarParameters_.min = 0;
590 d->scrollbarParameters_.max = 0;
594 d->scrollbarParameters_.min = top_pos;
595 for (size_t i = 0; i != size_t(first.first); ++i)
596 d->scrollbarParameters_.min -= d->par_height_[i];
597 d->scrollbarParameters_.max = bottom_pos;
598 for (size_t i = last.first + 1; i != parsize; ++i)
599 d->scrollbarParameters_.max += d->par_height_[i];
601 // The reference is the top position so we remove one page.
602 if (lyxrc.scroll_below_document)
603 d->scrollbarParameters_.max -= minVisiblePart();
605 d->scrollbarParameters_.max -= d->scrollbarParameters_.page_step;
607 // 0 must be inside the range as it denotes the current position
608 if (d->scrollbarParameters_.max < 0)
609 d->scrollbarParameters_.max = 0;
610 if (d->scrollbarParameters_.min > 0)
611 d->scrollbarParameters_.min = 0;
615 ScrollbarParameters const & BufferView::scrollbarParameters() const
617 return d->scrollbarParameters_;
621 docstring BufferView::toolTip(int x, int y) const
623 // Get inset under mouse, if there is one.
624 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
626 // No inset, no tooltip...
628 return covering_inset->toolTip(*this, x, y);
632 string BufferView::contextMenu(int x, int y) const
634 //If there is a selection, return the containing inset menu
635 if (d->cursor_.selection())
636 return d->cursor_.inset().contextMenu(*this, x, y);
638 // Get inset under mouse, if there is one.
639 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
641 return covering_inset->contextMenu(*this, x, y);
643 return buffer_.inset().contextMenu(*this, x, y);
648 void BufferView::scrollDocView(int const value, bool update)
650 // The scrollbar values are relative to the top of the screen, therefore the
651 // offset is equal to the target value.
653 // No scrolling at all? No need to redraw anything
657 // If the offset is less than 2 screen height, prefer to scroll instead.
658 if (abs(value) <= 2 * height_) {
659 d->anchor_ypos_ -= value;
660 processUpdateFlags(Update::Force);
664 // cut off at the top
665 if (value <= d->scrollbarParameters_.min) {
666 DocIterator dit = doc_iterator_begin(&buffer_);
667 showCursor(dit, false, update);
668 LYXERR(Debug::SCROLLING, "scroll to top");
672 // cut off at the bottom
673 if (value >= d->scrollbarParameters_.max) {
674 DocIterator dit = doc_iterator_end(&buffer_);
676 showCursor(dit, false, update);
677 LYXERR(Debug::SCROLLING, "scroll to bottom");
681 // find paragraph at target position
682 int par_pos = d->scrollbarParameters_.min;
684 for (; i != int(d->par_height_.size()); ++i) {
685 par_pos += d->par_height_[i];
686 if (par_pos >= value)
690 if (par_pos < value) {
691 // It seems we didn't find the correct pit so stay on the safe side and
693 LYXERR0("scrolling position not found!");
694 scrollDocView(d->scrollbarParameters_.max, update);
698 DocIterator dit = doc_iterator_begin(&buffer_);
700 LYXERR(Debug::SCROLLING, "value = " << value << " -> scroll to pit " << i);
701 showCursor(dit, false, update);
705 // FIXME: this method is not working well.
706 void BufferView::setCursorFromScrollbar()
708 TextMetrics & tm = d->text_metrics_[&buffer_.text()];
710 int const height = 2 * defaultRowHeight();
711 int const first = height;
712 int const last = height_ - height;
714 Cursor const & oldcur = d->cursor_;
716 switch (cursorStatus(oldcur)) {
724 int const y = getPos(oldcur).y_;
725 newy = min(last, max(y, first));
729 // We reset the cursor because cursorStatus() does not
730 // work when the cursor is within mathed.
733 tm.setCursorFromCoordinates(cur, 0, newy);
735 // update the bufferview cursor and notify insets
736 // FIXME: Care about the d->cursor_ flags to redraw if needed
737 Cursor old = d->cursor_;
739 // the DEPM call in mouseSetCursor() might have destroyed the
740 // paragraph the cursor is in.
741 bool badcursor = old.fixIfBroken();
742 badcursor |= notifyCursorLeavesOrEnters(old, d->cursor_);
744 d->cursor_.fixIfBroken();
748 Change const BufferView::getCurrentChange() const
750 if (!d->cursor_.selection())
751 return Change(Change::UNCHANGED);
753 DocIterator dit = d->cursor_.selectionBegin();
754 // The selected content might have been changed (see #7685)
755 dit = dit.getInnerText();
756 return dit.paragraph().lookupChange(dit.pos());
760 // this could be used elsewhere as well?
761 // FIXME: This does not work within mathed!
762 CursorStatus BufferView::cursorStatus(DocIterator const & dit) const
764 Point const p = getPos(dit);
767 if (p.y_ > workHeight())
773 void BufferView::bookmarkEditPosition()
775 // Don't eat cpu time for each keystroke
776 if (d->cursor_.paragraph().id() == d->bookmark_edit_position_)
779 d->bookmark_edit_position_ = d->cursor_.paragraph().id();
783 void BufferView::saveBookmark(unsigned int idx)
785 // tentatively save bookmark, id and pos will be used to
786 // acturately locate a bookmark in a 'live' lyx session.
787 // pit and pos will be updated with bottom level pit/pos
789 if (!buffer_.isInternal()) {
790 theSession().bookmarks().save(
792 d->cursor_.bottom().pit(),
793 d->cursor_.bottom().pos(),
794 d->cursor_.paragraph().id(),
799 // emit message signal.
800 message(_("Save bookmark"));
805 bool BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
806 int top_id, pos_type top_pos)
808 bool success = false;
811 d->cursor_.clearSelection();
813 // if a valid par_id is given, try it first
814 // This is the case for a 'live' bookmark when unique paragraph ID
815 // is used to track bookmarks.
817 dit = buffer_.getParFromID(top_id);
819 dit.pos() = min(dit.paragraph().size(), top_pos);
820 // Some slices of the iterator may not be
821 // reachable (e.g. closed collapsible inset)
822 // so the dociterator may need to be
823 // shortened. Otherwise, setCursor may crash
824 // lyx when the cursor can not be set to these
826 size_t const n = dit.depth();
827 for (size_t i = 0; i < n; ++i)
828 if (!dit[i].inset().editable()) {
836 // if top_id == 0, or searching through top_id failed
837 // This is the case for a 'restored' bookmark when only bottom
838 // (document level) pit was saved. Because of this, bookmark
839 // restoration is inaccurate. If a bookmark was within an inset,
840 // it will be restored to the left of the outmost inset that contains
842 if (bottom_pit < int(buffer_.paragraphs().size())) {
843 dit = doc_iterator_begin(&buffer_);
845 dit.pit() = bottom_pit;
846 dit.pos() = min(bottom_pos, dit.paragraph().size());
851 // Note: only bottom (document) level pit is set.
853 // set the current font.
854 d->cursor_.setCurrentFont();
855 // Do not forget to reset the anchor (see #9912)
856 d->cursor_.resetAnchor();
857 processUpdateFlags(Update::FitCursor);
864 void BufferView::translateAndInsert(char_type c, Text * t, Cursor & cur)
866 if (d->cursor_.real_current_font.isRightToLeft()) {
867 if (d->intl_.keymap == Intl::PRIMARY)
868 d->intl_.keyMapSec();
870 if (d->intl_.keymap == Intl::SECONDARY)
871 d->intl_.keyMapPrim();
874 d->intl_.getTransManager().translateAndInsert(c, t, cur);
878 int BufferView::workWidth() const
884 void BufferView::recenter()
886 showCursor(d->cursor_, true, true);
890 void BufferView::showCursor()
892 showCursor(d->cursor_, false, true);
896 void BufferView::showCursor(DocIterator const & dit,
897 bool recenter, bool update)
899 if (scrollToCursor(dit, recenter) && update)
900 processUpdateFlags(Update::Force);
904 void BufferView::scrollToCursor()
906 if (scrollToCursor(d->cursor_, false))
907 processUpdateFlags(Update::Force);
911 bool BufferView::scrollToCursor(DocIterator const & dit, bool const recenter)
913 // We are not properly started yet, delay until resizing is
918 LYXERR(Debug::SCROLLING, "recentering!");
920 CursorSlice const & bot = dit.bottom();
921 TextMetrics & tm = d->text_metrics_[bot.text()];
923 pos_type const max_pit = pos_type(bot.text()->paragraphs().size() - 1);
924 int bot_pit = bot.pit();
925 if (bot_pit > max_pit) {
926 // FIXME: Why does this happen?
927 LYXERR0("bottom pit is greater that max pit: "
928 << bot_pit << " > " << max_pit);
932 if (bot_pit == tm.first().first - 1)
933 tm.newParMetricsUp();
934 else if (bot_pit == tm.last().first + 1)
935 tm.newParMetricsDown();
937 if (tm.contains(bot_pit)) {
938 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
939 LBUFERR(!pm.rows().empty());
940 // FIXME: smooth scrolling doesn't work in mathed.
941 CursorSlice const & cs = dit.innerTextSlice();
942 int offset = coordOffset(dit).y_;
943 int ypos = pm.position() + offset;
944 Dimension const & row_dim =
945 pm.getRow(cs.pos(), dit.boundary()).dimension();
948 scrolled = scroll(ypos - height_/2);
950 // We try to visualize the whole row, if the row height is larger than
951 // the screen height, we scroll to a heuristic value of height_ / 4.
952 // FIXME: This heuristic value should be replaced by a recursive search
953 // for a row in the inset that can be visualized completely.
954 else if (row_dim.height() > height_) {
955 if (ypos < defaultRowHeight())
956 scrolled = scroll(ypos - height_ / 4);
957 else if (ypos > height_ - defaultRowHeight())
958 scrolled = scroll(ypos - 3 * height_ / 4);
961 // If the top part of the row falls of the screen, we scroll
962 // up to align the top of the row with the top of the screen.
963 else if (ypos - row_dim.ascent() < 0 && ypos < height_) {
964 int ynew = row_dim.ascent();
965 scrolled = scrollUp(ynew - ypos);
968 // If the bottom of the row falls of the screen, we scroll down.
969 else if (ypos + row_dim.descent() > height_ && ypos > 0) {
970 int ynew = height_ - row_dim.descent();
971 scrolled = scrollDown(ypos - ynew);
974 // else, nothing to do, the cursor is already visible so we just return.
975 return scrolled != 0;
978 // fix inline completion position
979 if (d->inlineCompletionPos_.fixIfBroken())
980 d->inlineCompletionPos_ = DocIterator();
982 tm.redoParagraph(bot_pit);
983 ParagraphMetrics const & pm = tm.parMetrics(bot_pit);
984 int offset = coordOffset(dit).y_;
986 d->anchor_pit_ = bot_pit;
987 CursorSlice const & cs = dit.innerTextSlice();
988 Dimension const & row_dim =
989 pm.getRow(cs.pos(), dit.boundary()).dimension();
992 d->anchor_ypos_ = height_/2;
993 else if (d->anchor_pit_ == 0)
994 d->anchor_ypos_ = offset + pm.ascent();
995 else if (d->anchor_pit_ == max_pit)
996 d->anchor_ypos_ = height_ - offset - row_dim.descent();
997 else if (offset > height_)
998 d->anchor_ypos_ = height_ - offset - defaultRowHeight();
1000 d->anchor_ypos_ = defaultRowHeight() * 2;
1006 void BufferView::makeDocumentClass()
1008 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1009 buffer_.params().makeDocumentClass();
1010 updateDocumentClass(olddc);
1014 void BufferView::updateDocumentClass(DocumentClassConstPtr olddc)
1016 message(_("Converting document to new document class..."));
1018 StableDocIterator backcur(d->cursor_);
1019 ErrorList & el = buffer_.errorList("Class Switch");
1020 cap::switchBetweenClasses(
1021 olddc, buffer_.params().documentClassPtr(),
1022 static_cast<InsetText &>(buffer_.inset()), el);
1024 setCursor(backcur.asDocIterator(&buffer_));
1026 buffer_.errors("Class Switch");
1030 /** Return the change status at cursor position, taking into account the
1031 * status at each level of the document iterator (a table in a deleted
1032 * footnote is deleted).
1033 * When \param outer is true, the top slice is not looked at.
1035 static Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
1037 size_t const depth = dit.depth() - (outer ? 1 : 0);
1039 for (size_t i = 0 ; i < depth ; ++i) {
1040 CursorSlice const & slice = dit[i];
1041 if (!slice.inset().inMathed()
1042 && slice.pos() < slice.paragraph().size()) {
1043 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
1044 if (ch != Change::UNCHANGED)
1048 return Change::UNCHANGED;
1052 bool BufferView::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1054 FuncCode const act = cmd.action();
1056 // Can we use a readonly buffer?
1057 if (buffer_.isReadonly()
1058 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1059 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1060 if (buffer_.hasReadonlyFlag())
1061 flag.message(from_utf8(N_("Document is read-only")));
1063 flag.message(from_utf8(N_("Document has been modified externally")));
1064 flag.setEnabled(false);
1068 // Are we in a DELETED change-tracking region?
1069 if (lookupChangeType(d->cursor_, true) == Change::DELETED
1070 && !lyxaction.funcHasFlag(act, LyXAction::ReadOnly)
1071 && !lyxaction.funcHasFlag(act, LyXAction::NoBuffer)) {
1072 flag.message(from_utf8(N_("This portion of the document is deleted.")));
1073 flag.setEnabled(false);
1077 Cursor & cur = d->cursor_;
1079 if (cur.getStatus(cmd, flag))
1084 // FIXME: This is a bit problematic because we don't check if this is
1085 // a document BufferView or not for these LFUNs. We probably have to
1086 // dispatch both to currentBufferView() and, if that fails,
1087 // to documentBufferView(); same as we do now for current Buffer and
1088 // document Buffer. Ideally those LFUN should go to Buffer as they
1089 // operate on the full Buffer and the cursor is only needed either for
1090 // an Undo record or to restore a cursor position. But we don't know
1091 // how to do that inside Buffer of course.
1092 case LFUN_BUFFER_PARAMS_APPLY:
1093 case LFUN_LAYOUT_MODULES_CLEAR:
1094 case LFUN_LAYOUT_MODULE_ADD:
1095 case LFUN_LAYOUT_RELOAD:
1096 case LFUN_TEXTCLASS_APPLY:
1097 case LFUN_TEXTCLASS_LOAD:
1098 flag.setEnabled(!buffer_.isReadonly());
1102 // We do not use the LyXAction flag for readonly because Undo sets the
1103 // buffer clean/dirty status by itself.
1104 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasUndoStack());
1107 // We do not use the LyXAction flag for readonly because Redo sets the
1108 // buffer clean/dirty status by itself.
1109 flag.setEnabled(!buffer_.isReadonly() && buffer_.undo().hasRedoStack());
1111 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
1112 case LFUN_FILE_INSERT_PLAINTEXT: {
1113 docstring const fname = cmd.argument();
1114 if (!FileName::isAbsolute(to_utf8(fname))) {
1115 flag.message(_("Absolute filename expected."));
1118 flag.setEnabled(cur.inTexted());
1121 case LFUN_FILE_INSERT:
1122 case LFUN_BOOKMARK_SAVE:
1123 // FIXME: Actually, these LFUNS should be moved to Text
1124 flag.setEnabled(cur.inTexted());
1127 case LFUN_FONT_STATE:
1128 case LFUN_LABEL_INSERT:
1129 case LFUN_INFO_INSERT:
1130 case LFUN_PARAGRAPH_GOTO:
1131 case LFUN_NOTE_NEXT:
1132 case LFUN_REFERENCE_NEXT:
1133 case LFUN_WORD_FIND:
1134 case LFUN_WORD_FIND_FORWARD:
1135 case LFUN_WORD_FIND_BACKWARD:
1136 case LFUN_WORD_REPLACE:
1139 case LFUN_MARK_TOGGLE:
1140 case LFUN_SCREEN_RECENTER:
1141 case LFUN_SCREEN_SHOW_CURSOR:
1142 case LFUN_BIBTEX_DATABASE_ADD:
1143 case LFUN_BIBTEX_DATABASE_DEL:
1144 case LFUN_STATISTICS:
1145 case LFUN_KEYMAP_OFF:
1146 case LFUN_KEYMAP_PRIMARY:
1147 case LFUN_KEYMAP_SECONDARY:
1148 case LFUN_KEYMAP_TOGGLE:
1149 case LFUN_INSET_SELECT_ALL:
1150 flag.setEnabled(true);
1153 case LFUN_GRAPHICS_UNIFY:
1154 flag.setEnabled(cur.selection());
1157 case LFUN_WORD_FINDADV: {
1158 FindAndReplaceOptions opt;
1159 istringstream iss(to_utf8(cmd.argument()));
1161 flag.setEnabled(opt.repl_buf_name.empty()
1162 || !buffer_.isReadonly());
1166 case LFUN_LABEL_GOTO:
1167 flag.setEnabled(!cmd.argument().empty()
1168 || getInsetByCode<InsetRef>(cur, REF_CODE));
1171 case LFUN_CHANGES_MERGE:
1172 case LFUN_CHANGE_NEXT:
1173 case LFUN_CHANGE_PREVIOUS:
1174 case LFUN_ALL_CHANGES_ACCEPT:
1175 case LFUN_ALL_CHANGES_REJECT:
1176 flag.setEnabled(buffer_.areChangesPresent());
1179 case LFUN_SCREEN_UP:
1180 case LFUN_SCREEN_DOWN:
1182 case LFUN_SCREEN_UP_SELECT:
1183 case LFUN_SCREEN_DOWN_SELECT:
1184 case LFUN_INSET_FORALL:
1185 flag.setEnabled(true);
1188 case LFUN_LAYOUT_TABULAR:
1189 flag.setEnabled(cur.innerInsetOfType(TABULAR_CODE));
1193 flag.setEnabled(!cur.inset().forcePlainLayout(cur.idx()));
1196 case LFUN_LAYOUT_PARAGRAPH:
1197 flag.setEnabled(cur.inset().allowParagraphCustomization(cur.idx()));
1200 case LFUN_BRANCH_ADD_INSERT:
1201 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1204 case LFUN_DIALOG_SHOW_NEW_INSET:
1205 // FIXME: this is wrong, but I do not understand the
1207 if (cur.inset().lyxCode() == CAPTION_CODE)
1208 return cur.inset().getStatus(cur, cmd, flag);
1209 // FIXME we should consider passthru paragraphs too.
1210 flag.setEnabled(!(cur.inTexted() && cur.paragraph().isPassThru()));
1213 case LFUN_CITATION_INSERT: {
1214 FuncRequest fr(LFUN_INSET_INSERT, "citation");
1215 // FIXME: This could turn in a recursive hell.
1216 // Shouldn't we use Buffer::getStatus() instead?
1217 flag.setEnabled(lyx::getStatus(fr).enabled());
1220 case LFUN_INSET_APPLY: {
1221 string const name = cmd.getArg(0);
1222 Inset * inset = editedInset(name);
1224 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
1225 if (!inset->getStatus(cur, fr, flag)) {
1226 // Every inset is supposed to handle this
1227 LASSERT(false, break);
1230 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
1231 flag = lyx::getStatus(fr);
1244 Inset * BufferView::editedInset(string const & name) const
1246 map<string, Inset *>::const_iterator it = d->edited_insets_.find(name);
1247 return it == d->edited_insets_.end() ? 0 : it->second;
1251 void BufferView::editInset(string const & name, Inset * inset)
1253 d->edited_insets_[name] = inset;
1257 void BufferView::dispatch(FuncRequest const & cmd, DispatchResult & dr)
1259 LYXERR(Debug::ACTION, "BufferView::dispatch: cmd: " << cmd);
1261 string const argument = to_utf8(cmd.argument());
1262 Cursor & cur = d->cursor_;
1265 // Don't dispatch function that does not apply to internal buffers.
1266 if (buffer_.isInternal()
1267 && lyxaction.funcHasFlag(cmd.action(), LyXAction::NoInternal))
1270 // We'll set this back to false if need be.
1271 bool dispatched = true;
1272 buffer_.undo().beginUndoGroup();
1274 FuncCode const act = cmd.action();
1277 case LFUN_BUFFER_PARAMS_APPLY: {
1278 DocumentClassConstPtr olddc = buffer_.params().documentClassPtr();
1279 cur.recordUndoBufferParams();
1280 istringstream ss(to_utf8(cmd.argument()));
1283 int const unknown_tokens = buffer_.readHeader(lex);
1284 if (unknown_tokens != 0) {
1285 LYXERR0("Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1286 << unknown_tokens << " unknown token"
1287 << (unknown_tokens == 1 ? "" : "s"));
1289 updateDocumentClass(olddc);
1291 // We are most certainly here because of a change in the document
1292 // It is then better to make sure that all dialogs are in sync with
1293 // current document settings.
1294 dr.screenUpdate(Update::Force | Update::FitCursor);
1295 dr.forceBufferUpdate();
1299 case LFUN_LAYOUT_MODULES_CLEAR: {
1300 // FIXME: this modifies the document in cap::switchBetweenClasses
1301 // without calling recordUndo. Fix this before using
1302 // recordUndoBufferParams().
1303 cur.recordUndoFullBuffer();
1304 buffer_.params().clearLayoutModules();
1305 makeDocumentClass();
1306 dr.screenUpdate(Update::Force);
1307 dr.forceBufferUpdate();
1311 case LFUN_LAYOUT_MODULE_ADD: {
1312 BufferParams const & params = buffer_.params();
1313 if (!params.layoutModuleCanBeAdded(argument)) {
1314 LYXERR0("Module `" << argument <<
1315 "' cannot be added due to failed requirements or "
1316 "conflicts with installed modules.");
1319 // FIXME: this modifies the document in cap::switchBetweenClasses
1320 // without calling recordUndo. Fix this before using
1321 // recordUndoBufferParams().
1322 cur.recordUndoFullBuffer();
1323 buffer_.params().addLayoutModule(argument);
1324 makeDocumentClass();
1325 dr.screenUpdate(Update::Force);
1326 dr.forceBufferUpdate();
1330 case LFUN_TEXTCLASS_APPLY: {
1331 // since this shortcircuits, the second call is made only if
1333 bool const success =
1334 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1335 LayoutFileList::get().load(argument, buffer_.filePath());
1337 docstring s = bformat(_("The document class `%1$s' "
1338 "could not be loaded."), from_utf8(argument));
1339 frontend::Alert::error(_("Could not load class"), s);
1343 LayoutFile const * old_layout = buffer_.params().baseClass();
1344 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1346 if (old_layout == new_layout)
1350 // Save the old, possibly modular, layout for use in conversion.
1351 // FIXME: this modifies the document in cap::switchBetweenClasses
1352 // without calling recordUndo. Fix this before using
1353 // recordUndoBufferParams().
1354 cur.recordUndoFullBuffer();
1355 buffer_.params().setBaseClass(argument);
1356 makeDocumentClass();
1357 dr.screenUpdate(Update::Force);
1358 dr.forceBufferUpdate();
1362 case LFUN_TEXTCLASS_LOAD: {
1363 // since this shortcircuits, the second call is made only if
1365 bool const success =
1366 LayoutFileList::get().load(argument, buffer_.temppath()) ||
1367 LayoutFileList::get().load(argument, buffer_.filePath());
1369 docstring s = bformat(_("The document class `%1$s' "
1370 "could not be loaded."), from_utf8(argument));
1371 frontend::Alert::error(_("Could not load class"), s);
1376 case LFUN_LAYOUT_RELOAD: {
1377 LayoutFileIndex bc = buffer_.params().baseClassID();
1378 LayoutFileList::get().reset(bc);
1379 buffer_.params().setBaseClass(bc);
1380 makeDocumentClass();
1381 dr.screenUpdate(Update::Force);
1382 dr.forceBufferUpdate();
1387 dr.setMessage(_("Undo"));
1388 cur.clearSelection();
1389 // We need to find out if the bibliography information
1390 // has changed. See bug #11055.
1391 // So these should not be references...
1392 LayoutModuleList const engines = buffer().params().citeEngine();
1393 CiteEngineType const enginetype = buffer().params().citeEngineType();
1394 if (!cur.textUndo())
1395 dr.setMessage(_("No further undo information"));
1397 dr.screenUpdate(Update::Force | Update::FitCursor);
1398 dr.forceBufferUpdate();
1399 if (buffer().params().citeEngine() != engines ||
1400 buffer().params().citeEngineType() != enginetype)
1401 buffer().invalidateCiteLabels();
1407 dr.setMessage(_("Redo"));
1408 cur.clearSelection();
1409 // We need to find out if the bibliography information
1410 // has changed. See bug #11055.
1411 // So these should not be references...
1412 LayoutModuleList const engines = buffer().params().citeEngine();
1413 CiteEngineType const enginetype = buffer().params().citeEngineType();
1414 if (!cur.textRedo())
1415 dr.setMessage(_("No further redo information"));
1417 dr.screenUpdate(Update::Force | Update::FitCursor);
1418 dr.forceBufferUpdate();
1419 if (buffer().params().citeEngine() != engines ||
1420 buffer().params().citeEngineType() != enginetype)
1421 buffer().invalidateCiteLabels();
1426 case LFUN_FONT_STATE:
1427 dr.setMessage(cur.currentState(false));
1430 case LFUN_BOOKMARK_SAVE:
1431 saveBookmark(convert<unsigned int>(to_utf8(cmd.argument())));
1434 case LFUN_LABEL_GOTO: {
1435 docstring label = cmd.argument();
1436 if (label.empty()) {
1438 getInsetByCode<InsetRef>(cur, REF_CODE);
1440 label = inset->getParam("reference");
1441 // persistent=false: use temp_bookmark
1445 if (!label.empty()) {
1447 // at the moment, this is redundant, since gotoLabel will
1448 // eventually call LFUN_PARAGRAPH_GOTO, but it seems best
1450 dr.screenUpdate(Update::Force | Update::FitCursor);
1455 case LFUN_PARAGRAPH_GOTO: {
1456 int const id = convert<int>(cmd.getArg(0));
1457 pos_type const pos = convert<int>(cmd.getArg(1));
1460 string const str_id_end = cmd.getArg(2);
1461 string const str_pos_end = cmd.getArg(3);
1463 for (Buffer * b = &buffer_; i == 0 || b != &buffer_;
1464 b = theBufferList().next(b)) {
1467 cur.setCursor(b->getParFromID(id));
1469 LYXERR(Debug::INFO, "No matching paragraph found! [" << id << "].");
1473 LYXERR(Debug::INFO, "Paragraph " << cur.paragraph().id()
1474 << " found in buffer `"
1475 << b->absFileName() << "'.");
1477 if (b == &buffer_) {
1479 if (str_id_end.empty() || str_pos_end.empty()) {
1482 mouseSetCursor(cur);
1485 int const id_end = convert<int>(str_id_end);
1486 pos_type const pos_end = convert<int>(str_pos_end);
1487 success = setCursorFromEntries({id, pos},
1491 dr.screenUpdate(Update::Force | Update::FitCursor);
1493 // Switch to other buffer view and resend cmd
1494 lyx::dispatch(FuncRequest(
1495 LFUN_BUFFER_SWITCH, b->absFileName()));
1503 case LFUN_NOTE_NEXT:
1504 gotoInset(this, NOTE_CODE, false);
1507 case LFUN_REFERENCE_NEXT: {
1508 vector<InsetCode> tmp;
1509 tmp.push_back(LABEL_CODE);
1510 tmp.push_back(REF_CODE);
1511 gotoInset(this, tmp, true);
1515 case LFUN_CHANGE_NEXT:
1516 findNextChange(this);
1517 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1518 dr.screenUpdate(Update::Force | Update::FitCursor);
1521 case LFUN_CHANGE_PREVIOUS:
1522 findPreviousChange(this);
1523 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1524 dr.screenUpdate(Update::Force | Update::FitCursor);
1527 case LFUN_CHANGES_MERGE:
1528 if (findNextChange(this) || findPreviousChange(this)) {
1529 dr.screenUpdate(Update::Force | Update::FitCursor);
1530 dr.forceBufferUpdate();
1531 showDialog("changes");
1535 case LFUN_ALL_CHANGES_ACCEPT:
1536 // select complete document
1538 cur.selHandle(true);
1539 buffer_.text().cursorBottom(cur);
1540 // accept everything in a single step to support atomic undo
1541 buffer_.text().acceptOrRejectChanges(cur, Text::ACCEPT);
1543 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1544 dr.screenUpdate(Update::Force | Update::FitCursor);
1545 dr.forceBufferUpdate();
1548 case LFUN_ALL_CHANGES_REJECT:
1549 // select complete document
1551 cur.selHandle(true);
1552 buffer_.text().cursorBottom(cur);
1553 // reject everything in a single step to support atomic undo
1554 // Note: reject does not work recursively; the user may have to repeat the operation
1555 buffer_.text().acceptOrRejectChanges(cur, Text::REJECT);
1557 // FIXME: Move this LFUN to Buffer so that we don't have to do this:
1558 dr.screenUpdate(Update::Force | Update::FitCursor);
1559 dr.forceBufferUpdate();
1562 case LFUN_WORD_FIND_FORWARD:
1563 case LFUN_WORD_FIND_BACKWARD: {
1565 // Would it maybe be better if this variable were view specific anyway?
1566 static docstring last_search;
1567 docstring searched_string;
1569 if (!cmd.argument().empty()) {
1570 last_search = cmd.argument();
1571 searched_string = cmd.argument();
1573 searched_string = last_search;
1576 if (searched_string.empty())
1579 bool const fw = act == LFUN_WORD_FIND_FORWARD;
1580 docstring const data =
1581 find2string(searched_string, true, false, fw);
1582 bool found = lyxfind(this, FuncRequest(LFUN_WORD_FIND, data));
1584 dr.screenUpdate(Update::Force | Update::FitCursor);
1588 case LFUN_WORD_FIND: {
1589 FuncRequest req = cmd;
1590 if (cmd.argument().empty() && !d->search_request_cache_.argument().empty())
1591 req = d->search_request_cache_;
1592 if (req.argument().empty()) {
1593 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "findreplace"));
1596 if (lyxfind(this, req))
1597 dr.screenUpdate(Update::Force | Update::FitCursor);
1599 d->search_request_cache_ = req;
1603 case LFUN_WORD_REPLACE: {
1604 bool has_deleted = false;
1605 if (cur.selection()) {
1606 DocIterator beg = cur.selectionBegin();
1607 DocIterator end = cur.selectionEnd();
1608 if (beg.pit() == end.pit()) {
1609 for (pos_type p = beg.pos() ; p < end.pos() ; ++p) {
1610 if (!cur.inMathed() && cur.paragraph().isDeleted(p)) {
1617 if (lyxreplace(this, cmd, has_deleted)) {
1618 dr.forceBufferUpdate();
1619 dr.screenUpdate(Update::Force | Update::FitCursor);
1624 case LFUN_WORD_FINDADV: {
1625 FindAndReplaceOptions opt;
1626 istringstream iss(to_utf8(cmd.argument()));
1628 if (findAdv(this, opt)) {
1629 dr.screenUpdate(Update::Force | Update::FitCursor);
1640 cur.clearSelection();
1641 dr.setMessage(from_utf8(N_("Mark off")));
1645 cur.clearSelection();
1647 dr.setMessage(from_utf8(N_("Mark on")));
1650 case LFUN_MARK_TOGGLE:
1651 cur.selection(false);
1654 dr.setMessage(from_utf8(N_("Mark removed")));
1657 dr.setMessage(from_utf8(N_("Mark set")));
1662 case LFUN_SCREEN_SHOW_CURSOR:
1666 case LFUN_SCREEN_RECENTER:
1670 case LFUN_BIBTEX_DATABASE_ADD: {
1671 Cursor tmpcur = cur;
1672 findInset(tmpcur, BIBTEX_CODE, false);
1673 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1676 if (inset->addDatabase(cmd.argument()))
1677 dr.forceBufferUpdate();
1682 case LFUN_BIBTEX_DATABASE_DEL: {
1683 Cursor tmpcur = cur;
1684 findInset(tmpcur, BIBTEX_CODE, false);
1685 InsetBibtex * inset = getInsetByCode<InsetBibtex>(tmpcur,
1688 if (inset->delDatabase(cmd.argument()))
1689 dr.forceBufferUpdate();
1694 case LFUN_GRAPHICS_UNIFY: {
1696 cur.recordUndoFullBuffer();
1698 DocIterator from, to;
1699 from = cur.selectionBegin();
1700 to = cur.selectionEnd();
1702 string const newId = cmd.getArg(0);
1703 bool fetchId = newId.empty(); //if we wait for groupId from first graphics inset
1705 InsetGraphicsParams grp_par;
1707 InsetGraphics::string2params(graphics::getGroupParams(buffer_, newId), buffer_, grp_par);
1709 if (!from.nextInset()) //move to closest inset
1710 from.forwardInset();
1712 while (!from.empty() && from < to) {
1713 Inset * inset = from.nextInset();
1716 InsetGraphics * ig = inset->asInsetGraphics();
1718 InsetGraphicsParams inspar = ig->getParams();
1723 grp_par.filename = inspar.filename;
1724 ig->setParams(grp_par);
1727 from.forwardInset();
1729 dr.screenUpdate(Update::Force); //needed if triggered from context menu
1733 case LFUN_STATISTICS: {
1734 DocIterator from, to;
1735 if (cur.selection()) {
1736 from = cur.selectionBegin();
1737 to = cur.selectionEnd();
1739 from = doc_iterator_begin(&buffer_);
1740 to = doc_iterator_end(&buffer_);
1742 buffer_.updateStatistics(from, to);
1743 int const words = buffer_.wordCount();
1744 int const chars = buffer_.charCount(false);
1745 int const chars_blanks = buffer_.charCount(true);
1747 if (cur.selection())
1748 message = _("Statistics for the selection:");
1750 message = _("Statistics for the document:");
1753 message += bformat(_("%1$d words"), words);
1755 message += _("One word");
1757 if (chars_blanks != 1)
1758 message += bformat(_("%1$d characters (including blanks)"),
1761 message += _("One character (including blanks)");
1764 message += bformat(_("%1$d characters (excluding blanks)"),
1767 message += _("One character (excluding blanks)");
1769 Alert::information(_("Statistics"), message);
1773 case LFUN_SCREEN_UP:
1774 case LFUN_SCREEN_DOWN: {
1775 Point p = getPos(cur);
1776 // This code has been commented out to enable to scroll down a
1777 // document, even if there are large insets in it (see bug #5465).
1778 /*if (p.y_ < 0 || p.y_ > height_) {
1779 // The cursor is off-screen so recenter before proceeding.
1783 int const scrolled = scroll(act == LFUN_SCREEN_UP
1784 ? -height_ : height_);
1785 if (act == LFUN_SCREEN_UP && scrolled > -height_)
1787 if (act == LFUN_SCREEN_DOWN && scrolled < height_)
1788 p = Point(width_, height_);
1789 bool const in_texted = cur.inTexted();
1790 cur.setCursor(doc_iterator_begin(cur.buffer()));
1791 cur.selHandle(false);
1792 // Force an immediate computation of metrics because we need it below
1793 processUpdateFlags(Update::Force);
1795 d->text_metrics_[&buffer_.text()].editXY(cur, p.x_, p.y_,
1796 true, act == LFUN_SCREEN_UP);
1797 //FIXME: what to do with cur.x_target()?
1798 bool update = in_texted && cur.bv().checkDepm(cur, old);
1801 if (update || cur.mark())
1802 dr.screenUpdate(Update::Force | Update::FitCursor);
1804 dr.forceBufferUpdate();
1809 string const scroll_type = cmd.getArg(0);
1810 int scroll_step = 0;
1811 if (scroll_type == "line")
1812 scroll_step = d->scrollbarParameters_.single_step;
1813 else if (scroll_type == "page")
1814 scroll_step = d->scrollbarParameters_.page_step;
1817 string const scroll_quantity = cmd.getArg(1);
1818 if (scroll_quantity == "up")
1819 scrollUp(scroll_step);
1820 else if (scroll_quantity == "down")
1821 scrollDown(scroll_step);
1823 int const scroll_value = convert<int>(scroll_quantity);
1825 scroll(scroll_step * scroll_value);
1827 dr.screenUpdate(Update::ForceDraw);
1828 dr.forceBufferUpdate();
1832 case LFUN_SCREEN_UP_SELECT: {
1833 // FIXME: why is the algorithm different from LFUN_SCREEN_UP?
1834 cur.selHandle(true);
1835 if (isTopScreen()) {
1836 lyx::dispatch(FuncRequest(LFUN_BUFFER_BEGIN_SELECT));
1840 int y = getPos(cur).y_;
1841 int const ymin = y - height_ + defaultRowHeight();
1842 while (y > ymin && cur.up())
1846 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1850 case LFUN_SCREEN_DOWN_SELECT: {
1851 // FIXME: why is the algorithm different from LFUN_SCREEN_DOWN?
1852 cur.selHandle(true);
1853 if (isBottomScreen()) {
1854 lyx::dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
1858 int y = getPos(cur).y_;
1859 int const ymax = y + height_ - defaultRowHeight();
1860 while (y < ymax && cur.down())
1864 dr.screenUpdate(Update::SinglePar | Update::FitCursor);
1869 case LFUN_INSET_SELECT_ALL: {
1870 // true if all cells are selected
1871 bool const all_selected = cur.depth() > 1
1872 && cur.selBegin().at_begin()
1873 && cur.selEnd().at_end();
1874 // true if some cells are selected
1875 bool const cells_selected = cur.depth() > 1
1876 && cur.selBegin().at_cell_begin()
1877 && cur.selEnd().at_cell_end();
1878 if (all_selected || (cells_selected && !cur.inset().isTable())) {
1879 // All the contents of the inset if selected, or only at
1880 // least one cell but inset is not a table.
1881 // Select the inset from outside.
1884 cur.selection(true);
1886 } else if (cells_selected) {
1887 // At least one complete cell is selected and inset is a table.
1892 cur.selection(true);
1893 cur.idx() = cur.lastidx();
1894 cur.pos() = cur.lastpos();
1896 // select current cell
1900 cur.selection(true);
1901 cur.pit() = cur.lastpit();
1902 cur.pos() = cur.lastpos();
1904 cur.setCurrentFont();
1905 dr.screenUpdate(Update::Force);
1910 // This would be in Buffer class if only Cursor did not
1911 // require a bufferview
1912 case LFUN_INSET_FORALL: {
1913 docstring const name = from_utf8(cmd.getArg(0));
1914 string const commandstr = cmd.getLongArg(1);
1915 FuncRequest const fr = lyxaction.lookupFunc(commandstr);
1917 // an arbitrary number to limit number of iterations
1918 const int max_iter = 100000;
1920 Cursor & cur = d->cursor_;
1921 Cursor const savecur = cur;
1923 if (!cur.nextInset())
1925 cur.beginUndoGroup();
1926 while(cur && iterations < max_iter) {
1927 Inset * const ins = cur.nextInset();
1930 docstring insname = ins->layoutName();
1931 while (!insname.empty()) {
1932 if (insname == name || name == from_utf8("*")) {
1934 lyx::dispatch(fr, dr);
1938 size_t const i = insname.rfind(':');
1939 if (i == string::npos)
1941 insname = insname.substr(0, i);
1943 // if we did not delete the inset, skip it
1944 if (!cur.nextInset() || cur.nextInset() == ins)
1949 /** This is a dummy undo record only to remember the cursor
1950 * that has just been set; this will be used on a redo action
1951 * (see ticket #10097)
1953 * FIXME: a better fix would be to have a way to set the
1954 * cursor value directly, but I am not sure it is worth it.
1958 dr.screenUpdate(Update::Force);
1959 dr.forceBufferUpdate();
1961 if (iterations >= max_iter) {
1963 dr.setMessage(bformat(_("`inset-forall' interrupted because number of actions is larger than %1$d"), max_iter));
1965 dr.setMessage(bformat(_("Applied \"%1$s\" to %2$d insets"), from_utf8(commandstr), iterations));
1970 case LFUN_BRANCH_ADD_INSERT: {
1971 docstring branch_name = from_utf8(cmd.getArg(0));
1972 if (branch_name.empty())
1973 if (!Alert::askForText(branch_name, _("Branch name")) ||
1974 branch_name.empty())
1977 DispatchResult drtmp;
1978 buffer_.dispatch(FuncRequest(LFUN_BRANCH_ADD, branch_name), drtmp);
1979 if (drtmp.error()) {
1980 Alert::warning(_("Branch already exists"), drtmp.message());
1983 docstring const sep = buffer_.params().branchlist().separator();
1984 for (docstring const & branch : getVectorFromString(branch_name, sep))
1985 lyx::dispatch(FuncRequest(LFUN_BRANCH_INSERT, branch));
1989 case LFUN_KEYMAP_OFF:
1990 getIntl().keyMapOn(false);
1993 case LFUN_KEYMAP_PRIMARY:
1994 getIntl().keyMapPrim();
1997 case LFUN_KEYMAP_SECONDARY:
1998 getIntl().keyMapSec();
2001 case LFUN_KEYMAP_TOGGLE:
2002 getIntl().toggleKeyMap();
2005 case LFUN_DIALOG_SHOW_NEW_INSET: {
2006 string const name = cmd.getArg(0);
2007 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
2008 if (decodeInsetParam(name, data, buffer_))
2009 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
2011 lyxerr << "Inset type '" << name <<
2012 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
2016 case LFUN_CITATION_INSERT: {
2017 if (argument.empty()) {
2018 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
2021 // we can have one optional argument, delimited by '|'
2022 // citation-insert <key>|<text_before>
2023 // this should be enhanced to also support text_after
2024 // and citation style
2025 string arg = argument;
2027 if (contains(argument, "|")) {
2028 arg = token(argument, '|', 0);
2029 opt1 = token(argument, '|', 1);
2032 // if our cursor is directly in front of or behind a citation inset,
2033 // we will instead add the new key to it.
2034 Inset * inset = cur.nextInset();
2035 if (!inset || inset->lyxCode() != CITE_CODE)
2036 inset = cur.prevInset();
2037 if (inset && inset->lyxCode() == CITE_CODE) {
2038 InsetCitation * icite = static_cast<InsetCitation *>(inset);
2039 if (icite->addKey(arg)) {
2040 dr.forceBufferUpdate();
2041 dr.screenUpdate(Update::FitCursor | Update::SinglePar);
2043 LYXERR0("Discarding optional argument to citation-insert.");
2048 InsetCommandParams icp(CITE_CODE);
2049 icp["key"] = from_utf8(arg);
2051 icp["before"] = from_utf8(opt1);
2052 string icstr = InsetCommand::params2string(icp);
2053 FuncRequest fr(LFUN_INSET_INSERT, icstr);
2058 case LFUN_INSET_APPLY: {
2059 string const name = cmd.getArg(0);
2060 Inset * inset = editedInset(name);
2062 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
2066 // put cursor in front of inset.
2067 if (!setCursorFromInset(inset)) {
2068 LASSERT(false, break);
2071 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
2072 inset->dispatch(cur, fr);
2073 dr.screenUpdate(cur.result().screenUpdate());
2074 if (cur.result().needBufferUpdate())
2075 dr.forceBufferUpdate();
2080 // The change of language of buffer belongs to the Buffer class.
2081 // We have to do it here because we need a cursor for Undo.
2082 // When Undo::recordUndoBufferParams() is implemented someday
2083 // LFUN_BUFFER_LANGUAGE should be handled by the Buffer class.
2084 case LFUN_BUFFER_LANGUAGE: {
2085 Language const * oldL = buffer_.params().language;
2086 Language const * newL = languages.getLanguage(argument);
2087 if (!newL || oldL == newL)
2089 if (oldL->rightToLeft() == newL->rightToLeft()) {
2090 cur.recordUndoFullBuffer();
2091 buffer_.changeLanguage(oldL, newL);
2092 cur.setCurrentFont();
2093 dr.forceBufferUpdate();
2098 case LFUN_FILE_INSERT_PLAINTEXT_PARA:
2099 case LFUN_FILE_INSERT_PLAINTEXT: {
2100 bool const as_paragraph = (act == LFUN_FILE_INSERT_PLAINTEXT_PARA);
2101 string const fname = to_utf8(cmd.argument());
2102 if (!FileName::isAbsolute(fname))
2103 dr.setMessage(_("Absolute filename expected."));
2105 insertPlaintextFile(FileName(fname), as_paragraph);
2110 // OK, so try the Buffer itself...
2111 buffer_.dispatch(cmd, dr);
2112 dispatched = dr.dispatched();
2116 buffer_.undo().endUndoGroup();
2117 dr.dispatched(dispatched);
2119 // NOTE: The code below is copied from Cursor::dispatch. If you
2120 // need to modify this, please update the other one too.
2122 // notify insets we just entered/left
2123 if (cursor() != old) {
2124 old.beginUndoGroup();
2126 bool badcursor = notifyCursorLeavesOrEnters(old, cursor());
2128 cursor().fixIfBroken();
2129 resetInlineCompletionPos();
2136 docstring const BufferView::requestSelection()
2138 Cursor & cur = d->cursor_;
2140 LYXERR(Debug::SELECTION, "requestSelection: cur.selection: " << cur.selection());
2141 if (!cur.selection()) {
2142 d->xsel_cache_.set = false;
2146 LYXERR(Debug::SELECTION, "requestSelection: xsel_cache.set: " << d->xsel_cache_.set);
2147 if (!d->xsel_cache_.set ||
2148 cur.top() != d->xsel_cache_.cursor ||
2149 cur.realAnchor().top() != d->xsel_cache_.anchor)
2151 d->xsel_cache_.cursor = cur.top();
2152 d->xsel_cache_.anchor = cur.realAnchor().top();
2153 d->xsel_cache_.set = cur.selection();
2154 return cur.selectionAsString(false);
2160 void BufferView::clearSelection()
2162 d->cursor_.clearSelection();
2163 // Clear the selection buffer. Otherwise a subsequent
2164 // middle-mouse-button paste would use the selection buffer,
2165 // not the more current external selection.
2166 cap::clearSelection();
2167 d->xsel_cache_.set = false;
2168 // The buffer did not really change, but this causes the
2169 // redraw we need because we cleared the selection above.
2170 buffer_.changed(false);
2174 void BufferView::resize(int width, int height)
2176 // Update from work area
2180 // Clear the paragraph height cache.
2181 d->par_height_.clear();
2182 // Redo the metrics.
2187 Inset const * BufferView::getCoveringInset(Text const & text,
2190 TextMetrics & tm = d->text_metrics_[&text];
2191 Inset * inset = tm.checkInsetHit(x, y);
2195 if (!inset->descendable(*this))
2196 // No need to go further down if the inset is not
2200 size_t cell_number = inset->nargs();
2201 // Check all the inner cell.
2202 for (size_t i = 0; i != cell_number; ++i) {
2203 Text const * inner_text = inset->getText(i);
2206 Inset const * inset_deeper =
2207 getCoveringInset(*inner_text, x, y);
2209 return inset_deeper;
2217 void BufferView::updateHoveredInset() const
2219 // Get inset under mouse, if there is one.
2220 int const x = d->mouse_position_cache_.x_;
2221 int const y = d->mouse_position_cache_.y_;
2222 Inset const * covering_inset = getCoveringInset(buffer_.text(), x, y);
2224 d->clickable_inset_ = covering_inset && covering_inset->clickable(*this, x, y);
2226 if (covering_inset == d->last_inset_)
2227 // Same inset, no need to do anything...
2230 bool need_redraw = false;
2231 if (d->last_inset_) {
2232 // Remove the hint on the last hovered inset (if any).
2233 need_redraw |= d->last_inset_->setMouseHover(this, false);
2237 if (covering_inset && covering_inset->setMouseHover(this, true)) {
2239 // Only the insets that accept the hover state, do
2240 // clear the last_inset_, so only set the last_inset_
2241 // member if the hovered setting is accepted.
2242 d->last_inset_ = covering_inset;
2246 LYXERR(Debug::PAINTING, "Mouse hover detected at: ("
2247 << d->mouse_position_cache_.x_ << ", "
2248 << d->mouse_position_cache_.y_ << ")");
2250 d->update_strategy_ = DecorationUpdate;
2252 // This event (moving without mouse click) is not passed further.
2253 // This should be changed if it is further utilized.
2254 buffer_.changed(false);
2259 void BufferView::clearLastInset(Inset * inset) const
2261 if (d->last_inset_ != inset) {
2262 LYXERR0("Wrong last_inset!");
2269 void BufferView::mouseEventDispatch(FuncRequest const & cmd0)
2271 //lyxerr << "[ cmd0 " << cmd0 << "]" << endl;
2273 // This is only called for mouse related events including
2274 // LFUN_FILE_OPEN generated by drag-and-drop.
2275 FuncRequest cmd = cmd0;
2277 Cursor old = cursor();
2279 cur.push(buffer_.inset());
2280 cur.selection(d->cursor_.selection());
2282 // Either the inset under the cursor or the
2283 // surrounding Text will handle this event.
2285 // make sure we stay within the screen...
2286 cmd.set_y(min(max(cmd.y(), -1), height_));
2288 d->mouse_position_cache_.x_ = cmd.x();
2289 d->mouse_position_cache_.y_ = cmd.y();
2291 if (cmd.action() == LFUN_MOUSE_MOTION && cmd.button() == mouse_button::none) {
2292 updateHoveredInset();
2296 // Build temporary cursor.
2297 Inset * inset = d->text_metrics_[&buffer_.text()].editXY(cur, cmd.x(), cmd.y());
2299 // If inset is not editable, cur.pos() might point behind the
2300 // inset (depending on cmd.x(), cmd.y()). This is needed for
2301 // editing to fix bug 9628, but e.g. the context menu needs a
2302 // cursor in front of the inset.
2303 if ((inset->hasSettings() || !inset->contextMenuName().empty()
2304 || inset->lyxCode() == SEPARATOR_CODE) &&
2305 cur.nextInset() != inset && cur.prevInset() == inset)
2307 } else if (cur.inTexted() && cur.pos()
2308 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
2309 // Always place cursor in front of a separator inset.
2313 // Put anchor at the same position.
2316 cur.beginUndoGroup();
2318 // Try to dispatch to an non-editable inset near this position
2319 // via the temp cursor. If the inset wishes to change the real
2320 // cursor it has to do so explicitly by using
2321 // cur.bv().cursor() = cur; (or similar)
2323 inset->dispatch(cur, cmd);
2325 // Now dispatch to the temporary cursor. If the real cursor should
2326 // be modified, the inset's dispatch has to do so explicitly.
2327 if (!inset || !cur.result().dispatched())
2330 // Notify left insets
2332 bool badcursor = old.fixIfBroken() | cur.fixIfBroken();
2333 badcursor |= notifyCursorLeavesOrEnters(old, cur);
2335 cursor().fixIfBroken();
2340 // Do we have a selection?
2341 theSelection().haveSelection(cursor().selection());
2343 if (cur.needBufferUpdate()) {
2344 cur.clearBufferUpdate();
2345 buffer().updateBuffer();
2348 // If the command has been dispatched,
2349 if (cur.result().dispatched() || cur.result().screenUpdate())
2350 processUpdateFlags(cur.result().screenUpdate());
2354 int BufferView::minVisiblePart()
2356 return 2 * defaultRowHeight();
2360 int BufferView::scroll(int y)
2363 return scrollDown(y);
2365 return scrollUp(-y);
2370 int BufferView::scrollDown(int offset)
2372 Text * text = &buffer_.text();
2373 TextMetrics & tm = d->text_metrics_[text];
2374 int const ymax = height_ + offset;
2376 pair<pit_type, ParagraphMetrics const *> last = tm.last();
2377 int bottom_pos = last.second->position() + last.second->descent();
2378 if (lyxrc.scroll_below_document)
2379 bottom_pos += height_ - minVisiblePart();
2380 if (last.first + 1 == int(text->paragraphs().size())) {
2381 if (bottom_pos <= height_)
2383 offset = min(offset, bottom_pos - height_);
2386 if (bottom_pos > ymax)
2388 tm.newParMetricsDown();
2390 d->anchor_ypos_ -= offset;
2395 int BufferView::scrollUp(int offset)
2397 Text * text = &buffer_.text();
2398 TextMetrics & tm = d->text_metrics_[text];
2399 int ymin = - offset;
2401 pair<pit_type, ParagraphMetrics const *> first = tm.first();
2402 int top_pos = first.second->position() - first.second->ascent();
2403 if (first.first == 0) {
2406 offset = min(offset, - top_pos);
2411 tm.newParMetricsUp();
2413 d->anchor_ypos_ += offset;
2418 bool BufferView::setCursorFromRow(int row)
2420 TexRow::TextEntry start, end;
2421 tie(start,end) = buffer_.texrow().getEntriesFromRow(row);
2422 LYXERR(Debug::LATEX,
2423 "setCursorFromRow: for row " << row << ", TexRow has found "
2424 "start (id=" << start.id << ",pos=" << start.pos << "), "
2425 "end (id=" << end.id << ",pos=" << end.pos << ")");
2426 return setCursorFromEntries(start, end);
2430 bool BufferView::setCursorFromEntries(TexRow::TextEntry start,
2431 TexRow::TextEntry end)
2433 DocIterator dit_start, dit_end;
2434 tie(dit_start,dit_end) =
2435 TexRow::getDocIteratorsFromEntries(start, end, buffer_);
2438 // Setting selection start
2439 d->cursor_.clearSelection();
2440 setCursor(dit_start);
2441 // Setting selection end
2443 d->cursor_.resetAnchor();
2444 setCursorSelectionTo(dit_end);
2450 bool BufferView::setCursorFromInset(Inset const * inset)
2452 // are we already there?
2453 if (cursor().nextInset() == inset)
2456 // Inset is not at cursor position. Find it in the document.
2459 while (cur && cur.nextInset() != inset)
2470 void BufferView::gotoLabel(docstring const & label)
2472 for (Buffer const * buf : buffer().allRelatives()) {
2474 for (TocItem const & item : *buf->tocBackend().toc("label")) {
2475 if (label == item.str()) {
2476 lyx::dispatch(item.action());
2484 TextMetrics const & BufferView::textMetrics(Text const * t) const
2486 return const_cast<BufferView *>(this)->textMetrics(t);
2490 TextMetrics & BufferView::textMetrics(Text const * t)
2493 TextMetricsCache::iterator tmc_it = d->text_metrics_.find(t);
2494 if (tmc_it == d->text_metrics_.end()) {
2495 tmc_it = d->text_metrics_.insert(
2496 make_pair(t, TextMetrics(this, const_cast<Text *>(t)))).first;
2498 return tmc_it->second;
2502 ParagraphMetrics const & BufferView::parMetrics(Text const * t,
2505 return textMetrics(t).parMetrics(pit);
2509 int BufferView::workHeight() const
2515 void BufferView::setCursor(DocIterator const & dit)
2518 size_t const n = dit.depth();
2519 for (size_t i = 0; i < n; ++i)
2520 dit[i].inset().edit(d->cursor_, true);
2522 d->cursor_.setCursor(dit);
2523 d->cursor_.selection(false);
2524 d->cursor_.setCurrentFont();
2526 // It seems on general grounds as if this is probably needed, but
2527 // it is not yet clear.
2528 // See bug #7394 and r38388.
2529 // d->cursor.resetAnchor();
2533 void BufferView::setCursorSelectionTo(DocIterator const & dit)
2535 size_t const n = dit.depth();
2536 for (size_t i = 0; i < n; ++i)
2537 dit[i].inset().edit(d->cursor_, true);
2539 d->cursor_.selection(true);
2540 d->cursor_.setCursorSelectionTo(dit);
2541 d->cursor_.setCurrentFont();
2545 bool BufferView::checkDepm(Cursor & cur, Cursor & old)
2547 // Would be wrong to delete anything if we have a selection.
2548 if (cur.selection())
2551 bool need_anchor_change = false;
2552 bool changed = d->cursor_.text()->deleteEmptyParagraphMechanism(cur, old,
2553 need_anchor_change);
2555 if (need_anchor_change)
2563 // we would rather not do this here, but it needs to be done before
2564 // the changed() signal is sent.
2565 buffer_.updateBuffer();
2567 buffer_.changed(true);
2572 bool BufferView::mouseSetCursor(Cursor & cur, bool const select)
2574 LASSERT(&cur.bv() == this, return false);
2577 // this event will clear selection so we save selection for
2578 // persistent selection
2579 cap::saveSelection(cursor());
2581 d->cursor_.macroModeClose();
2582 // If a macro has been finalized, the cursor might have been broken
2585 // Has the cursor just left the inset?
2586 bool const leftinset = (&d->cursor_.inset() != &cur.inset());
2588 d->cursor_.fixIfBroken();
2590 // do the dEPM magic if needed
2591 // FIXME: (1) move this to InsetText::notifyCursorLeaves?
2592 // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
2593 // the leftinset bool would not be necessary (badcursor instead).
2594 bool update = leftinset;
2597 d->cursor_.setSelection();
2598 d->cursor_.setCursorSelectionTo(cur);
2600 if (d->cursor_.inTexted())
2601 update |= checkDepm(cur, d->cursor_);
2602 d->cursor_.resetAnchor();
2603 d->cursor_.setCursor(cur);
2604 d->cursor_.clearSelection();
2606 d->cursor_.boundary(cur.boundary());
2607 d->cursor_.finishUndo();
2608 d->cursor_.setCurrentFont();
2610 cur.forceBufferUpdate();
2615 void BufferView::putSelectionAt(DocIterator const & cur,
2616 int length, bool backwards)
2618 d->cursor_.clearSelection();
2624 d->cursor_.pos() += length;
2625 d->cursor_.setSelection(d->cursor_, -length);
2627 d->cursor_.setSelection(d->cursor_, length);
2632 bool BufferView::selectIfEmpty(DocIterator & cur)
2634 if ((cur.inTexted() && !cur.paragraph().empty())
2635 || (cur.inMathed() && !cur.cell().empty()))
2638 pit_type const beg_pit = cur.pit();
2640 // The paragraph associated to this item isn't
2641 // the first one, so it can be selected
2644 // We have to resort to select the space between the
2645 // end of this item and the begin of the next one
2649 // If it is the only item in the document,
2650 // nothing can be selected
2653 pit_type const end_pit = cur.pit();
2654 pos_type const end_pos = cur.pos();
2655 d->cursor_.clearSelection();
2657 d->cursor_.setCursor(cur);
2658 d->cursor_.pit() = beg_pit;
2659 d->cursor_.pos() = 0;
2660 d->cursor_.selection(false);
2661 d->cursor_.resetAnchor();
2662 d->cursor_.pit() = end_pit;
2663 d->cursor_.pos() = end_pos;
2664 d->cursor_.setSelection();
2669 Cursor & BufferView::cursor()
2675 Cursor const & BufferView::cursor() const
2681 bool BufferView::singleParUpdate()
2683 Text & buftext = buffer_.text();
2684 pit_type const bottom_pit = d->cursor_.bottom().pit();
2685 TextMetrics & tm = textMetrics(&buftext);
2686 int old_height = tm.parMetrics(bottom_pit).height();
2688 // make sure inline completion pointer is ok
2689 if (d->inlineCompletionPos_.fixIfBroken())
2690 d->inlineCompletionPos_ = DocIterator();
2692 // In Single Paragraph mode, rebreak only
2693 // the (main text, not inset!) paragraph containing the cursor.
2694 // (if this paragraph contains insets etc., rebreaking will
2695 // recursively descend)
2696 tm.redoParagraph(bottom_pit);
2697 ParagraphMetrics const & pm = tm.parMetrics(bottom_pit);
2698 if (pm.height() != old_height)
2699 // Paragraph height has changed so we cannot proceed to
2700 // the singlePar optimisation.
2703 tm.updatePosCache(bottom_pit);
2705 LYXERR(Debug::PAINTING, "\ny1: " << pm.position() - pm.ascent()
2706 << " y2: " << pm.position() + pm.descent()
2707 << " pit: " << bottom_pit
2708 << " singlepar: 1");
2713 void BufferView::updateMetrics()
2715 updateMetrics(d->update_flags_);
2716 d->update_strategy_ = FullScreenUpdate;
2720 void BufferView::updateMetrics(Update::flags & update_flags)
2722 if (height_ == 0 || width_ == 0)
2725 Text & buftext = buffer_.text();
2726 pit_type const npit = int(buftext.paragraphs().size());
2728 // Clear out the position cache in case of full screen redraw,
2729 d->coord_cache_.clear();
2731 // Clear out paragraph metrics to avoid having invalid metrics
2732 // in the cache from paragraphs not relayouted below
2733 // The complete text metrics will be redone.
2734 d->text_metrics_.clear();
2736 TextMetrics & tm = textMetrics(&buftext);
2738 // make sure inline completion pointer is ok
2739 if (d->inlineCompletionPos_.fixIfBroken())
2740 d->inlineCompletionPos_ = DocIterator();
2742 if (d->anchor_pit_ >= npit)
2743 // The anchor pit must have been deleted...
2744 d->anchor_pit_ = npit - 1;
2746 // Rebreak anchor paragraph.
2747 tm.redoParagraph(d->anchor_pit_);
2748 ParagraphMetrics & anchor_pm = tm.par_metrics_[d->anchor_pit_];
2751 if (d->anchor_pit_ == 0) {
2752 int scrollRange = d->scrollbarParameters_.max - d->scrollbarParameters_.min;
2754 // Complete buffer visible? Then it's easy.
2755 if (scrollRange == 0)
2756 d->anchor_ypos_ = anchor_pm.ascent();
2758 // avoid empty space above the first row
2759 d->anchor_ypos_ = min(d->anchor_ypos_, anchor_pm.ascent());
2762 anchor_pm.setPosition(d->anchor_ypos_);
2763 tm.updatePosCache(d->anchor_pit_);
2765 LYXERR(Debug::PAINTING, "metrics: "
2766 << " anchor pit = " << d->anchor_pit_
2767 << " anchor ypos = " << d->anchor_ypos_);
2769 // Redo paragraphs above anchor if necessary.
2770 int y1 = d->anchor_ypos_ - anchor_pm.ascent();
2771 // We are now just above the anchor paragraph.
2772 pit_type pit1 = d->anchor_pit_ - 1;
2773 for (; pit1 >= 0 && y1 >= 0; --pit1) {
2774 tm.redoParagraph(pit1);
2775 ParagraphMetrics & pm = tm.par_metrics_[pit1];
2777 // Save the paragraph position in the cache.
2779 tm.updatePosCache(pit1);
2783 // Redo paragraphs below the anchor if necessary.
2784 int y2 = d->anchor_ypos_ + anchor_pm.descent();
2785 // We are now just below the anchor paragraph.
2786 pit_type pit2 = d->anchor_pit_ + 1;
2787 for (; pit2 < npit && y2 <= height_; ++pit2) {
2788 tm.redoParagraph(pit2);
2789 ParagraphMetrics & pm = tm.par_metrics_[pit2];
2791 // Save the paragraph position in the cache.
2793 tm.updatePosCache(pit2);
2797 LYXERR(Debug::PAINTING, "Metrics: "
2798 << " anchor pit = " << d->anchor_pit_
2799 << " anchor ypos = " << d->anchor_ypos_
2802 << " pit1 = " << pit1
2803 << " pit2 = " << pit2);
2805 // metrics is done, full drawing is necessary now
2806 update_flags = (update_flags & ~Update::Force) | Update::ForceDraw;
2808 // Now update the positions of insets in the cache.
2811 if (lyxerr.debugging(Debug::WORKAREA)) {
2812 LYXERR(Debug::WORKAREA, "BufferView::updateMetrics");
2813 d->coord_cache_.dump();
2818 void BufferView::updatePosCache()
2820 // this is the "nodraw" drawing stage: only set the positions of the
2821 // insets in metrics cache.
2822 frontend::NullPainter np;
2827 void BufferView::insertLyXFile(FileName const & fname)
2829 LASSERT(d->cursor_.inTexted(), return);
2831 // Get absolute path of file and add ".lyx"
2832 // to the filename if necessary
2833 FileName filename = fileSearch(string(), fname.absFileName(), "lyx");
2835 docstring const disp_fn = makeDisplayPath(filename.absFileName());
2836 // emit message signal.
2837 message(bformat(_("Inserting document %1$s..."), disp_fn));
2840 Buffer buf(filename.absFileName(), false);
2841 if (buf.loadLyXFile() == Buffer::ReadSuccess) {
2842 ErrorList & el = buffer_.errorList("Parse");
2843 // Copy the inserted document error list into the current buffer one.
2844 el = buf.errorList("Parse");
2845 buffer_.undo().recordUndo(d->cursor_);
2846 cap::pasteParagraphList(d->cursor_, buf.paragraphs(),
2847 buf.params().documentClassPtr(), el);
2848 res = _("Document %1$s inserted.");
2850 res = _("Could not insert document %1$s");
2853 buffer_.changed(true);
2854 // emit message signal.
2855 message(bformat(res, disp_fn));
2859 Point BufferView::coordOffset(DocIterator const & dit) const
2865 // Addup contribution of nested insets, from inside to outside,
2866 // keeping the outer paragraph for a special handling below
2867 for (size_t i = dit.depth() - 1; i >= 1; --i) {
2868 CursorSlice const & sl = dit[i];
2872 // get relative position inside sl.inset()
2873 sl.inset().cursorPos(*this, sl, dit.boundary() && (i + 1 == dit.depth()), xx, yy);
2875 // Make relative position inside of the edited inset relative to sl.inset()
2879 // In case of an RTL inset, the edited inset will be positioned to the left
2882 bool boundary_i = dit.boundary() && i + 1 == dit.depth();
2883 bool rtl = textMetrics(sl.text()).isRTL(sl, boundary_i);
2888 // remember width for the case that sl.inset() is positioned in an RTL inset
2889 lastw = sl.inset().dimension(*this).wid;
2891 //lyxerr << "Cursor::getPos, i: "
2892 // << i << " x: " << xx << " y: " << y << endl;
2895 // Add contribution of initial rows of outermost paragraph
2896 CursorSlice const & sl = dit[0];
2897 TextMetrics const & tm = textMetrics(sl.text());
2898 ParagraphMetrics const & pm = tm.parMetrics(sl.pit());
2900 LBUFERR(!pm.rows().empty());
2901 y -= pm.rows()[0].ascent();
2903 // FIXME: document this mess
2905 if (sl.pos() > 0 && dit.depth() == 1) {
2907 if (pos && dit.boundary())
2909 // lyxerr << "coordOffset: boundary:" << dit.boundary() << " depth:" << dit.depth() << " pos:" << pos << " sl.pos:" << sl.pos() << endl;
2910 rend = pm.pos2row(pos);
2912 rend = pm.pos2row(sl.pos());
2914 size_t rend = pm.pos2row(sl.pos());
2916 for (size_t rit = 0; rit != rend; ++rit)
2917 y += pm.rows()[rit].height();
2918 y += pm.rows()[rend].ascent();
2920 TextMetrics const & bottom_tm = textMetrics(dit.bottom().text());
2922 // Make relative position from the nested inset now bufferview absolute.
2923 int xx = bottom_tm.cursorX(dit.bottom(), dit.boundary() && dit.depth() == 1);
2926 // In the RTL case place the nested inset at the left of the cursor in
2927 // the outer paragraph
2928 bool boundary_1 = dit.boundary() && 1 == dit.depth();
2929 bool rtl = bottom_tm.isRTL(dit.bottom(), boundary_1);
2937 Point BufferView::getPos(DocIterator const & dit) const
2939 if (!paragraphVisible(dit))
2940 return Point(-1, -1);
2942 CursorSlice const & bot = dit.bottom();
2943 TextMetrics const & tm = textMetrics(bot.text());
2945 // offset from outer paragraph
2946 Point p = coordOffset(dit);
2947 p.y_ += tm.parMetrics(bot.pit()).position();
2952 bool BufferView::paragraphVisible(DocIterator const & dit) const
2954 CursorSlice const & bot = dit.bottom();
2955 TextMetrics const & tm = textMetrics(bot.text());
2957 return tm.contains(bot.pit());
2961 void BufferView::caretPosAndHeight(Point & p, int & h) const
2963 Cursor const & cur = cursor();
2964 Font const font = cur.real_current_font;
2965 frontend::FontMetrics const & fm = theFontMetrics(font);
2966 int const asc = fm.maxAscent();
2967 int const des = fm.maxDescent();
2974 bool BufferView::cursorInView(Point const & p, int h) const
2976 Cursor const & cur = cursor();
2977 // does the cursor touch the screen ?
2978 if (p.y_ + h < 0 || p.y_ >= workHeight() || !paragraphVisible(cur))
2984 int BufferView::horizScrollOffset() const
2986 return d->horiz_scroll_offset_;
2990 int BufferView::horizScrollOffset(Text const * text,
2991 pit_type pit, pos_type pos) const
2993 // Is this a row that is currently scrolled?
2994 if (!d->current_row_slice_.empty()
2995 && &text->inset() == d->current_row_slice_.inset().asInsetText()
2996 && pit == d->current_row_slice_.pit()
2997 && pos == d->current_row_slice_.pos())
2998 return d->horiz_scroll_offset_;
3003 bool BufferView::hadHorizScrollOffset(Text const * text,
3004 pit_type pit, pos_type pos) const
3006 return !d->last_row_slice_.empty()
3007 && &text->inset() == d->last_row_slice_.inset().asInsetText()
3008 && pit == d->last_row_slice_.pit()
3009 && pos == d->last_row_slice_.pos();
3013 void BufferView::setCurrentRowSlice(CursorSlice const & rowSlice)
3015 // nothing to do if the cursor was already on this row
3016 if (d->current_row_slice_ == rowSlice) {
3017 d->last_row_slice_ = CursorSlice();
3021 // if the (previous) current row was scrolled, we have to
3022 // remember it in order to repaint it next time.
3023 if (d->horiz_scroll_offset_ != 0)
3024 d->last_row_slice_ = d->current_row_slice_;
3026 d->last_row_slice_ = CursorSlice();
3028 // Since we changed row, the scroll offset is not valid anymore
3029 d->horiz_scroll_offset_ = 0;
3030 d->current_row_slice_ = rowSlice;
3036 bool sliceInRow(CursorSlice const & cs, Text const * text, Row const & row)
3038 /* The normal case is the last line. The previous line takes care
3039 * of empty rows (e.g. empty paragraphs). Cursor boundary issues
3040 * are taken care of when setting caret_slice_ in
3043 return !cs.empty() && cs.text() == text && cs.pit() == row.pit()
3044 && ((row.pos() == row.endpos() && row.pos() == cs.pos())
3045 || (row.pos() <= cs.pos() && cs.pos() < row.endpos()));
3051 bool BufferView::needRepaint(Text const * text, Row const & row) const
3053 return d->repaint_caret_row_ && sliceInRow(d->caret_slice_, text, row);
3057 void BufferView::checkCursorScrollOffset()
3059 CursorSlice rowSlice = d->cursor_.bottom();
3060 TextMetrics const & tm = textMetrics(rowSlice.text());
3062 // Stop if metrics have not been computed yet, since it means
3063 // that there is nothing to do.
3064 if (!tm.contains(rowSlice.pit()))
3066 ParagraphMetrics const & pm = tm.parMetrics(rowSlice.pit());
3067 Row const & row = pm.getRow(rowSlice.pos(),
3068 d->cursor_.boundary() && rowSlice == d->cursor_.top());
3069 rowSlice.pos() = row.pos();
3071 // Set the row on which the cursor lives.
3072 setCurrentRowSlice(rowSlice);
3074 // Current x position of the cursor in pixels
3075 int cur_x = getPos(d->cursor_).x_;
3077 // Horizontal scroll offset of the cursor row in pixels
3078 int offset = d->horiz_scroll_offset_;
3079 int const MARGIN = 2 * theFontMetrics(d->cursor_.real_current_font).em()
3081 if (row.right_x() <= workWidth() - row.right_margin) {
3082 // Row is narrower than the work area, no offset needed.
3085 if (cur_x - offset < MARGIN) {
3086 // cursor would be too far right
3087 offset = cur_x - MARGIN;
3088 } else if (cur_x - offset > workWidth() - MARGIN) {
3089 // cursor would be too far left
3090 offset = cur_x - workWidth() + MARGIN;
3092 // Correct the offset to make sure that we do not scroll too much
3095 if (row.right_x() - offset < workWidth() - row.right_margin)
3096 offset = row.right_x() - workWidth() + row.right_margin;
3099 //lyxerr << "cur_x=" << cur_x << ", offset=" << offset << ", row.wid=" << row.width() << ", margin=" << MARGIN << endl;
3101 if (offset != d->horiz_scroll_offset_)
3102 LYXERR(Debug::PAINTING, "Horiz. scroll offset changed from "
3103 << d->horiz_scroll_offset_ << " to " << offset);
3105 if (d->update_strategy_ == NoScreenUpdate
3106 && (offset != d->horiz_scroll_offset_
3107 || !d->last_row_slice_.empty())) {
3108 // FIXME: if one uses SingleParUpdate, then home/end
3109 // will not work on long rows. Why?
3110 d->update_strategy_ = FullScreenUpdate;
3113 d->horiz_scroll_offset_ = offset;
3117 void BufferView::draw(frontend::Painter & pain, bool paint_caret)
3119 if (height_ == 0 || width_ == 0)
3121 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t--- START NODRAW ---"
3122 : "\t\t*** START DRAWING ***"));
3123 Text & text = buffer_.text();
3124 TextMetrics const & tm = d->text_metrics_[&text];
3125 int const y = tm.first().second->position();
3126 PainterInfo pi(this, pain);
3128 /** A repaint of the previous caret row is needed if there is
3129 * caret painted on screen and either
3130 * 1/ a new caret has to be painted at a place different from
3132 * 2/ there is no need for a caret anymore.
3134 d->repaint_caret_row_ = !d->caret_slice_.empty() &&
3135 ((paint_caret && d->cursor_.top() != d->caret_slice_)
3138 // Check whether the row where the cursor lives needs to be scrolled.
3139 // Update the drawing strategy if needed.
3140 checkCursorScrollOffset();
3142 switch (d->update_strategy_) {
3144 case NoScreenUpdate:
3145 // no screen painting is actually needed. In nodraw stage
3146 // however, the different coordinates of insets and paragraphs
3147 // needs to be updated.
3148 LYXERR(Debug::PAINTING, "Strategy: NoScreenUpdate");
3149 pi.full_repaint = false;
3150 if (pain.isNull()) {
3151 pi.full_repaint = true;
3153 } else if (d->repaint_caret_row_) {
3154 pi.full_repaint = false;
3159 case SingleParUpdate:
3160 pi.full_repaint = false;
3161 LYXERR(Debug::PAINTING, "Strategy: SingleParUpdate");
3162 // In general, only the current row of the outermost paragraph
3163 // will be redrawn. Particular cases where selection spans
3164 // multiple paragraph are correctly detected in TextMetrics.
3168 case DecorationUpdate:
3169 // FIXME: We should also distinguish DecorationUpdate to avoid text
3170 // drawing if possible. This is not possible to do easily right now
3171 // because of the single backing pixmap.
3173 case FullScreenUpdate:
3175 LYXERR(Debug::PAINTING,
3176 ((d->update_strategy_ == FullScreenUpdate)
3177 ? "Strategy: FullScreenUpdate"
3178 : "Strategy: DecorationUpdate"));
3180 // The whole screen, including insets, will be refreshed.
3181 pi.full_repaint = true;
3183 // Clear background.
3184 pain.fillRectangle(0, 0, width_, height_,
3185 pi.backgroundColor(&buffer_.inset()));
3190 // and possibly grey out below
3191 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3192 int const y2 = lastpm.second->position() + lastpm.second->descent();
3195 Color color = buffer().isInternal()
3196 ? Color_background : Color_bottomarea;
3197 pain.fillRectangle(0, y2, width_, height_ - y2, color);
3201 LYXERR(Debug::PAINTING, (pain.isNull() ? "\t\t --- END NODRAW ---"
3202 : "\t\t *** END DRAWING ***"));
3204 // The scrollbar needs an update.
3207 // Normalize anchor for next time
3208 pair<pit_type, ParagraphMetrics const *> firstpm = tm.first();
3209 pair<pit_type, ParagraphMetrics const *> lastpm = tm.last();
3210 for (pit_type pit = firstpm.first; pit <= lastpm.first; ++pit) {
3211 ParagraphMetrics const & pm = tm.parMetrics(pit);
3212 if (pm.position() + pm.descent() > 0) {
3213 if (d->anchor_pit_ != pit
3214 || d->anchor_ypos_ != pm.position())
3215 LYXERR(Debug::PAINTING, "Found new anchor pit = " << d->anchor_pit_
3216 << " anchor ypos = " << d->anchor_ypos_);
3217 d->anchor_pit_ = pit;
3218 d->anchor_ypos_ = pm.position();
3222 if (!pain.isNull()) {
3223 // reset the update flags, everything has been done
3224 d->update_flags_ = Update::None;
3227 // Remember what has just been done for the next draw() step
3229 d->caret_slice_ = d->cursor_.top();
3230 if (d->caret_slice_.pos() > 0
3231 && (d->cursor_.boundary()
3232 || d->caret_slice_.pos() == d->caret_slice_.lastpos()))
3233 --d->caret_slice_.pos();
3235 d->caret_slice_ = CursorSlice();
3239 void BufferView::message(docstring const & msg)
3242 d->gui_->message(msg);
3246 void BufferView::showDialog(string const & name)
3249 d->gui_->showDialog(name, string());
3253 void BufferView::showDialog(string const & name,
3254 string const & data, Inset * inset)
3257 d->gui_->showDialog(name, data, inset);
3261 void BufferView::updateDialog(string const & name, string const & data)
3264 d->gui_->updateDialog(name, data);
3268 void BufferView::setGuiDelegate(frontend::GuiBufferViewDelegate * gui)
3274 // FIXME: Move this out of BufferView again
3275 docstring BufferView::contentsOfPlaintextFile(FileName const & fname)
3277 if (!fname.isReadableFile()) {
3278 docstring const error = from_ascii(strerror(errno));
3279 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3280 docstring const text =
3281 bformat(_("Could not read the specified document\n"
3282 "%1$s\ndue to the error: %2$s"), file, error);
3283 Alert::error(_("Could not read file"), text);
3287 if (!fname.isReadableFile()) {
3288 docstring const file = makeDisplayPath(fname.absFileName(), 50);
3289 docstring const text =
3290 bformat(_("%1$s\n is not readable."), file);
3291 Alert::error(_("Could not open file"), text);
3295 // FIXME UNICODE: We don't know the encoding of the file
3296 docstring file_content = fname.fileContents("UTF-8");
3297 if (file_content.empty()) {
3298 Alert::error(_("Reading not UTF-8 encoded file"),
3299 _("The file is not UTF-8 encoded.\n"
3300 "It will be read as local 8Bit-encoded.\n"
3301 "If this does not give the correct result\n"
3302 "then please change the encoding of the file\n"
3303 "to UTF-8 with a program other than LyX.\n"));
3304 file_content = fname.fileContents("local8bit");
3307 return normalize_c(file_content);
3311 void BufferView::insertPlaintextFile(FileName const & f, bool asParagraph)
3313 docstring const tmpstr = contentsOfPlaintextFile(f);
3318 Cursor & cur = cursor();
3319 cap::replaceSelection(cur);
3320 buffer_.undo().recordUndo(cur);
3322 cur.innerText()->insertStringAsParagraphs(cur, tmpstr, cur.current_font);
3324 cur.innerText()->insertStringAsLines(cur, tmpstr, cur.current_font);
3326 buffer_.changed(true);
3330 docstring const & BufferView::inlineCompletion() const
3332 return d->inlineCompletion_;
3336 size_t const & BufferView::inlineCompletionUniqueChars() const
3338 return d->inlineCompletionUniqueChars_;
3342 DocIterator const & BufferView::inlineCompletionPos() const
3344 return d->inlineCompletionPos_;
3348 void BufferView::resetInlineCompletionPos()
3350 d->inlineCompletionPos_ = DocIterator();
3354 bool samePar(DocIterator const & a, DocIterator const & b)
3356 if (a.empty() && b.empty())
3358 if (a.empty() || b.empty())
3360 if (a.depth() != b.depth())
3362 return &a.innerParagraph() == &b.innerParagraph();
3366 void BufferView::setInlineCompletion(Cursor const & cur, DocIterator const & pos,
3367 docstring const & completion, size_t uniqueChars)
3369 uniqueChars = min(completion.size(), uniqueChars);
3370 bool changed = d->inlineCompletion_ != completion
3371 || d->inlineCompletionUniqueChars_ != uniqueChars;
3372 bool singlePar = true;
3373 d->inlineCompletion_ = completion;
3374 d->inlineCompletionUniqueChars_ = min(completion.size(), uniqueChars);
3376 //lyxerr << "setInlineCompletion pos=" << pos << " completion=" << completion << " uniqueChars=" << uniqueChars << std::endl;
3379 DocIterator const & old = d->inlineCompletionPos_;
3381 //lyxerr << "inlineCompletionPos changed" << std::endl;
3382 // old or pos are in another paragraph?
3383 if ((!samePar(cur, pos) && !pos.empty())
3384 || (!samePar(cur, old) && !old.empty())) {
3386 //lyxerr << "different paragraph" << std::endl;
3388 d->inlineCompletionPos_ = pos;
3393 if (singlePar && !(cur.result().screenUpdate() & Update::Force))
3394 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::SinglePar);
3396 cur.screenUpdateFlags(cur.result().screenUpdate() | Update::Force);
3401 bool BufferView::clickableInset() const
3403 return d->clickable_inset_;