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,
 163                 bool update);
 164         /// Scroll to the cursor.
 165         void scrollToCursor();
 166         /// Scroll to the cursor.
 167         /// \param recenter Whether the cursor should be centered on screen
 168         bool scrollToCursor(DocIterator const & dit, bool recenter);
 169         /// LFUN_SCROLL Helper.
 170         void lfunScroll(FuncRequest const & cmd);
 171         /// scroll down document by the given number of pixels.
 172         int scrollDown(int pixels);
 173         /// scroll up document by the given number of pixels.
 174         int scrollUp(int pixels);
 175         /// scroll document by the given number of pixels.
 176         int scroll(int pixels);
 177         /// Scroll the view by a number of pixels.
 178         void scrollDocView(int pixels, bool update);
 179         /// Set the cursor position based on the scrollbar one.
 180         void setCursorFromScrollbar();
 181
 182         /// return the pixel width of the document view.
 183         int workWidth() const;
 184         /// return the pixel height of the document view.
 185         int workHeight() const;
 186
 187         /// return the inline completion postfix.
 188         docstring const & inlineCompletion() const;
 189         /// return the number of unique characters in the inline completion.
 190         size_t const & inlineCompletionUniqueChars() const;
 191         /// return the position in the buffer of the inline completion postfix.
 192         DocIterator const & inlineCompletionPos() const;
 193         /// set the inline completion postfix and its position in the buffer.
 194         /// Updates the updateFlags in \c cur.
 195         void setInlineCompletion(Cursor & cur, DocIterator const & pos,
 196                 docstring const & completion, size_t uniqueChars = 0);
 197
 198         /// translate and insert a character, using the correct keymap.
 199         void translateAndInsert(char_type c, Text * t, Cursor & cur);
 200
 201         /// \return true if we've made a decision
 202         bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
 203         /// execute the given function.
 204         void dispatch(FuncRequest const & cmd, DispatchResult & dr);
 205
 206         /// request an X11 selection.
 207         /// \return the selected string.
 208         docstring const requestSelection();
 209         /// clear the X11 selection.
 210         void clearSelection();
 211
 212         /// resize the BufferView.
 213         /// \sa WorkArea
 214         void resize(int width, int height);
 215
 216         /// dispatch method helper for \c WorkArea
 217         /// \sa WorkArea
 218         void mouseEventDispatch(FuncRequest const & ev);
 219
 220         /// access to anchor.
 221         pit_type anchor_ref() const;
 222
 223         ///
 224         CursorStatus cursorStatus(DocIterator const & dit) const;
 225         /// access to full cursor.
 226         Cursor & cursor();
 227         /// access to full cursor.
 228         Cursor const & cursor() const;
 229         /// sets cursor.
 230         /// This will also open all relevant collapsable insets.
 231         void setCursor(DocIterator const &);
 232         /// Check deleteEmptyParagraphMechanism and update metrics if needed.
 233         /// \retval true if an update was needed.
 234         bool checkDepm(Cursor & cur, Cursor & old);
 235         /// sets cursor.
 236         /// This is used when handling LFUN_MOUSE_PRESS.
 237         bool mouseSetCursor(Cursor & cur, bool select = false);
 238
 239         /// sets the selection.
 240         /* When \c backwards == false, set anchor
 241          * to \c cur and cursor to \c cur + \c length. When \c
 242          * backwards == true, set anchor to \c cur and cursor to \c
 243          * cur + \c length.
 244          */
 245         void putSelectionAt(DocIterator const & cur,
 246                 int length, bool backwards);
 247
 248         /// update the internal \c ViewMetricsInfo.
 249         void updateMetrics();
 250
 251         ///
 252         TextMetrics const & textMetrics(Text const * t) const;
 253         TextMetrics & textMetrics(Text const * t);
 254         ///
 255         ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
 256
 257         ///
 258         CoordCache & coordCache();
 259         ///
 260         CoordCache const & coordCache() const;
 261
 262         ///
 263         Point getPos(DocIterator const & dit) const;
 264         /// is the paragraph of the cursor visible ?
 265         bool paragraphVisible(DocIterator const & dit) const;
 266         /// is the cursor currently visible in the view
 267         bool cursorInView(Point const & p, int h) const;
 268         /// get the position and height of the cursor
 269         void cursorPosAndHeight(Point & p, int & h) const;
 270
 271
 272         ///
 273         void draw(frontend::Painter & pain);
 274
 275         /// get this view's keyboard map handler.
 276         Intl & getIntl();
 277         ///
 278         Intl const & getIntl() const;
 279
 280         //
 281         // Messages to the GUI
 282         //
 283         /// This signal is emitted when some message shows up.
 284         void message(docstring const & msg);
 285
 286         /// This signal is emitted when some dialog needs to be shown.
 287         void showDialog(std::string const & name);
 288
 289         /// This signal is emitted when some dialog needs to be shown with
 290         /// some data.
 291         void showDialog(std::string const & name, std::string const & data,
 292                 Inset * inset = 0);
 293
 294         /// This signal is emitted when some dialogs needs to be updated.
 295         void updateDialog(std::string const & name, std::string const & data);
 296
 297         ///
 298         void setGuiDelegate(frontend::GuiBufferViewDelegate *);
 299
 300         ///
 301         docstring contentsOfPlaintextFile(support::FileName const & f);
 302         // Insert plain text file (if filename is empty, prompt for one)
 303         void insertPlaintextFile(support::FileName const & f, bool asParagraph);
 304         ///
 305         void insertLyXFile(support::FileName const & f);
 306         /// save temporary bookmark for jump back navigation
 307         void bookmarkEditPosition();
 308         /// Find and return the inset associated with given dialog name.
 309         Inset * editedInset(std::string const & name) const;
 310         /// Associate an inset associated with given dialog name.
 311         void editInset(std::string const & name, Inset * inset);
 312         ///
 313         void clearLastInset(Inset * inset) const;
 314         /// Is the mouse hovering a clickable inset or element?
 315         bool clickableInset() const;
 316
 317 private:
 318         /// noncopyable
 319         BufferView(BufferView const &);
 320         void operator=(BufferView const &);
 321
 322         /// the position relative to (0, baseline) of outermost paragraph
 323         Point coordOffset(DocIterator const & dit) const;
 324         /// Update current paragraph metrics.
 325         /// \return true if no further update is needed.
 326         bool singleParUpdate();
 327
 328         /// The minimal size of the document that is visible. Used
 329         /// when it is allowed to scroll below the document.
 330         int minVisiblePart();
 331
 332         /// Search recursively for the the innermost inset that covers (x, y) position.
 333         /// \retval 0 if no inset is found.
 334         Inset const * getCoveringInset(
 335                 Text const & text, //< The Text where we start searching.
 336                 int x, //< x-coordinate on screen
 337                 int y  //< y-coordinate on screen
 338                 ) const;
 339
 340         /// Update the hovering status of the insets. This is called when
 341         /// either the screen is updated or when the buffer has scolled.
 342         void updateHoveredInset() const;
 343
 344         ///
 345         void updateDocumentClass(DocumentClass const * const olddc);
 346         ///
 347         int width_;
 348         ///
 349         int height_;
 350         ///
 351         bool full_screen_;
 352         ///
 353         Buffer & buffer_;
 354
 355         struct Private;
 356         Private * const d;
 357 };
 358
 359 /// some space for drawing the 'nested' markers (in pixel)
 360 inline int nestMargin() { return 15; }
 361
 362 /// margin for changebar
 363 inline int changebarMargin() { return 12; }
 364
 365 } // namespace lyx
 366
 367 #endif // BUFFERVIEW_H