src/BufferView.h

   1 // -*- C++ -*-
   2 /**
   3  * \file BufferView.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Alfredo Braustein
   8  * \author Lars Gullik Bjønnes
   9  * \author John Levon
  10  * \author Jürgen Vigna
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef BUFFER_VIEW_H
  16 #define BUFFER_VIEW_H
  17
  18 #include "update_flags.h"
  19
  20 #include "support/strfwd.h"
  21 #include "support/types.h"
  22
  23 namespace lyx {
  24
  25 namespace support { class FileName; }
  26
  27 namespace frontend { class Painter; }
  28 namespace frontend { class GuiBufferViewDelegate; }
  29
  30 class Buffer;
  31 class Change;
  32 class CoordCache;
  33 class Cursor;
  34 class DocIterator;
  35 class FuncRequest;
  36 class FuncStatus;
  37 class Intl;
  38 class Inset;
  39 class ParIterator;
  40 class ParagraphMetrics;
  41 class Point;
  42 class Text;
  43 class TextMetrics;
  44
  45 enum CursorStatus {
  46         CUR_INSIDE,
  47         CUR_ABOVE,
  48         CUR_BELOW
  49 };
  50
  51 /// Scrollbar Parameters.
  52 struct ScrollbarParameters
  53 {
  54         ScrollbarParameters()
  55                 : min(0), max(0), position(0), single_step(1), page_step(1)
  56         {}
  57         /// Minimum scrollbar position in pixels.
  58         int min;
  59         /// Maximum scrollbar position in pixels.
  60         int max;
  61         /// Current position in the document in pixels.
  62         int position;
  63         /// Line-scroll amount in pixels.
  64         int single_step;
  65         /// Page-scroll amount in pixels.
  66         int page_step;
  67 };
  68
  69 /// Screen view of a Buffer.
  70 /**
  71  * A BufferView encapsulates a view onto a particular
  72  * buffer, and allows access to operate upon it. A view
  73  * is a sliding window of the entire document rendering.
  74  * It is the official interface between the LyX core and
  75  * the frontend WorkArea.
  76  *
  77  * \sa WorkArea
  78  * \sa Buffer
  79  * \sa CoordCache
  80  */
  81 class BufferView {
  82 public:
  83         ///
  84         explicit BufferView(Buffer & buffer);
  85         ///
  86         ~BufferView();
  87
  88         /// return the buffer being viewed.
  89         Buffer & buffer();
  90         Buffer const & buffer() const;
  91
  92         ///
  93         void setFullScreen(bool full_screen) { full_screen_ = full_screen; }
  94
  95         /// right margin
  96         int rightMargin() const;
  97
  98         /// left margin
  99         int leftMargin() const;
 100
 101         /// \return true if the BufferView is at the top of the document.
 102         bool isTopScreen() const;
 103
 104         /// \return true if the BufferView is at the bottom of the document.
 105         bool isBottomScreen() const;
 106
 107         /// perform pending metrics updates.
 108         /** \c Update::FitCursor means first to do a FitCursor, and to
 109          * force an update if screen position changes.
 110          * \c Update::Force means to force an update in any case.
 111          * \retval true if a screen redraw is needed
 112          */
 113         void processUpdateFlags(Update::flags flags);
 114
 115         /// move the screen to fit the cursor.
 116         /// Only to be called with good y coordinates (after a bv::metrics)
 117         bool fitCursor();
 118         /// reset the scrollbar to reflect current view position.
 119         void updateScrollbar();
 120         /// return the Scrollbar Parameters.
 121         ScrollbarParameters const & scrollbarParameters() const;
 122         /// \return Tool tip for the given position.
 123         docstring toolTip(int x, int y) const;
 124         /// \return the context menu for the given position.
 125         docstring contextMenu(int x, int y) const;
 126
 127         /// Save the current position as bookmark.
 128         /// if idx == 0, save to temp_bookmark
 129         void saveBookmark(unsigned int idx);
 130         /// goto a specified position, try top_id first, and then bottom_pit.
 131         /// \return true if success
 132         bool moveToPosition(
 133                 pit_type bottom_pit, ///< Paragraph pit, used when par_id is zero or invalid.
 134                 pos_type bottom_pos, ///< Paragraph pit, used when par_id is zero or invalid.
 135                 int top_id, ///< Paragraph ID, \sa Paragraph
 136                 pos_type top_pos ///< Position in the \c Paragraph
 137                 );
 138         /// return the current change at the cursor.
 139         Change const getCurrentChange() const;
 140
 141         /// move cursor to the named label.
 142         void gotoLabel(docstring const & label);
 143
 144         /// set the cursor based on the given TeX source row.
 145         void setCursorFromRow(int row);
 146
 147         /// set cursor to the given inset. Return true if found.
 148         bool setCursorFromInset(Inset const *);
 149         /// Recenters the BufferView such that the passed cursor
 150         /// is in the center.
 151         void recenter();
 152         /// Ensure that the BufferView cursor is visible.
 153         /// This method will automatically scroll and update the BufferView
 154         /// if needed.
 155         void showCursor();
 156         /// Ensure the passed cursor \p dit is visible.
 157         /// This method will automatically scroll and update the BufferView
 158         /// if needed.
 159         /// \param recenter Whether the cursor should be centered on screen
 160         void showCursor(DocIterator const & dit, bool recenter = false);
 161         /// Scroll to the cursor.
 162         void scrollToCursor();
 163         /// Scroll to the cursor.
 164         /// \param recenter Whether the cursor should be centered on screen
 165         bool scrollToCursor(DocIterator const & dit, bool recenter);
 166         /// LFUN_SCROLL Helper.
 167         void lfunScroll(FuncRequest const & cmd);
 168         /// scroll down document by the given number of pixels.
 169         int scrollDown(int pixels);
 170         /// scroll up document by the given number of pixels.
 171         int scrollUp(int pixels);
 172         /// scroll document by the given number of pixels.
 173         int scroll(int pixels);
 174         /// Scroll the view by a number of pixels.
 175         void scrollDocView(int pixels);
 176         /// Set the cursor position based on the scrollbar one.
 177         void setCursorFromScrollbar();
 178
 179         /// return the pixel width of the document view.
 180         int workWidth() const;
 181         /// return the pixel height of the document view.
 182         int workHeight() const;
 183
 184         /// return the inline completion postfix.
 185         docstring const & inlineCompletion() const;
 186         /// return the number of unique characters in the inline completion.
 187         size_t const & inlineCompletionUniqueChars() const;
 188         /// return the position in the buffer of the inline completion postfix.
 189         DocIterator const & inlineCompletionPos() const;
 190         /// set the inline completion postfix and its position in the buffer.
 191         /// Updates the updateFlags in \c cur.
 192         void setInlineCompletion(Cursor & cur, DocIterator const & pos,
 193                 docstring const & completion, size_t uniqueChars = 0);
 194
 195         /// translate and insert a character, using the correct keymap.
 196         void translateAndInsert(char_type c, Text * t, Cursor & cur);
 197
 198         /// return true for events that will handle.
 199         FuncStatus getStatus(FuncRequest const & cmd);
 200         /// execute the given function.
 201         /// \return true if the function has been processed.
 202         bool dispatch(FuncRequest const & argument);
 203
 204         /// request an X11 selection.
 205         /// \return the selected string.
 206         docstring const requestSelection();
 207         /// clear the X11 selection.
 208         void clearSelection();
 209
 210         /// resize the BufferView.
 211         /// \sa WorkArea
 212         void resize(int width, int height);
 213
 214         /// dispatch method helper for \c WorkArea
 215         /// \sa WorkArea
 216         void mouseEventDispatch(FuncRequest const & ev);
 217
 218         /// access to anchor.
 219         pit_type anchor_ref() const;
 220
 221         ///
 222         CursorStatus cursorStatus(DocIterator const & dit) const;
 223         /// access to full cursor.
 224         Cursor & cursor();
 225         /// access to full cursor.
 226         Cursor const & cursor() const;
 227         /// sets cursor.
 228         /// This will also open all relevant collapsable insets.
 229         void setCursor(DocIterator const &);
 230         /// Check deleteEmptyParagraphMechanism and update metrics if needed.
 231         /// \retval true if an update was needed.
 232         bool checkDepm(Cursor & cur, Cursor & old);
 233         /// sets cursor.
 234         /// This is used when handling LFUN_MOUSE_PRESS.
 235         bool mouseSetCursor(Cursor & cur, bool select = false);
 236
 237         /// sets the selection.
 238         /* When \c backwards == false, set anchor
 239          * to \c cur and cursor to \c cur + \c length. When \c
 240          * backwards == true, set anchor to \c cur and cursor to \c
 241          * cur + \c length.
 242          */
 243         void putSelectionAt(DocIterator const & cur,
 244                 int length, bool backwards);
 245
 246         /// update the internal \c ViewMetricsInfo.
 247         void updateMetrics();
 248
 249         ///
 250         TextMetrics const & textMetrics(Text const * t) const;
 251         TextMetrics & textMetrics(Text const * t);
 252         ///
 253         ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
 254
 255         ///
 256         CoordCache & coordCache();
 257         ///
 258         CoordCache const & coordCache() const;
 259
 260         ///
 261         Point getPos(DocIterator const & dit, bool boundary) const;
 262         /// is the paragraph of the cursor visible ?
 263         bool paragraphVisible(DocIterator const & dit) const;
 264
 265
 266         ///
 267         void draw(frontend::Painter & pain);
 268
 269         /// get this view's keyboard map handler.
 270         Intl & getIntl();
 271         ///
 272         Intl const & getIntl() const;
 273
 274         //
 275         // Messages to the GUI
 276         //
 277         /// This signal is emitted when some message shows up.
 278         void message(docstring const & msg);
 279
 280         /// This signal is emitted when some dialog needs to be shown.
 281         void showDialog(std::string const & name);
 282
 283         /// This signal is emitted when some dialog needs to be shown with
 284         /// some data.
 285         void showDialog(std::string const & name, std::string const & data,
 286                 Inset * inset = 0);
 287
 288         /// This signal is emitted when some dialogs needs to be updated.
 289         void updateDialog(std::string const & name, std::string const & data);
 290
 291         ///
 292         void setGuiDelegate(frontend::GuiBufferViewDelegate *);
 293
 294         ///
 295         docstring contentsOfPlaintextFile(support::FileName const & f);
 296         // Insert plain text file (if filename is empty, prompt for one)
 297         void insertPlaintextFile(support::FileName const & f, bool asParagraph);
 298         ///
 299         void insertLyXFile(support::FileName const & f);
 300         /// save temporary bookmark for jump back navigation
 301         void bookmarkEditPosition();
 302
 303 private:
 304         /// noncopyable
 305         BufferView(BufferView const &);
 306         void operator=(BufferView const &);
 307
 308         // the position relative to (0, baseline) of outermost paragraph
 309         Point coordOffset(DocIterator const & dit, bool boundary) const;
 310         /// Update current paragraph metrics.
 311         /// \return true if no further update is needed.
 312         bool singleParUpdate();
 313
 314         /// The minimal size of the document that is visible. Used
 315         /// when it is allowed to scroll below the document.
 316         int minVisiblePart();
 317
 318         /// Search recursively for the the innermost inset that covers (x, y) position.
 319         /// \retval 0 if no inset is found.
 320         Inset const * getCoveringInset(
 321                 Text const & text, //< The Text where we start searching.
 322                 int x, //< x-coordinate on screen
 323                 int y  //< y-coordinate on screen
 324                 ) const;
 325
 326         ///
 327         int width_;
 328         ///
 329         int height_;
 330         ///
 331         bool full_screen_;
 332         ///
 333         Buffer & buffer_;
 334
 335         struct Private;
 336         Private * const d;
 337 };
 338
 339 /// some space for drawing the 'nested' markers (in pixel)
 340 inline int nestMargin() { return 15; }
 341
 342 /// margin for changebar
 343 inline int changebarMargin() { return 12; }
 344
 345 } // namespace lyx
 346
 347 #endif // BUFFERVIEW_H