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