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 class ViewMetricsInfo;
  45
  46 enum CursorStatus {
  47         CUR_INSIDE,
  48         CUR_ABOVE,
  49         CUR_BELOW
  50 };
  51
  52 /// Scrollbar Parameters.
  53 struct ScrollbarParameters
  54 {
  55         void reset(int h = 0, int p = 0, int l = 0)
  56         {
  57                 height = h;
  58                 position = p;
  59                 lineScrollHeight = l;
  60         }
  61
  62         /// Total document height in pixels.
  63         int height;
  64         /// Current position in the document in pixels.
  65         int position;
  66         /// Line-scroll amount in pixels.
  67         int lineScrollHeight;
  68 };
  69
  70 /// Screen view of a Buffer.
  71 /**
  72  * A BufferView encapsulates a view onto a particular
  73  * buffer, and allows access to operate upon it. A view
  74  * is a sliding window of the entire document rendering.
  75  * It is the official interface between the LyX core and
  76  * the frontend WorkArea.
  77  *
  78  * \sa WorkArea
  79  * \sa Buffer
  80  * \sa CoordCache
  81  */
  82 class BufferView {
  83 public:
  84         ///
  85         BufferView(Buffer & buffer);
  86         ///
  87         ~BufferView();
  88
  89         /// return the buffer being viewed.
  90         Buffer & buffer();
  91         Buffer const & buffer() const;
  92
  93         /// perform pending metrics updates.
  94         /** \c Update::FitCursor means first to do a FitCursor, and to
  95          * force an update if screen position changes.
  96          * \c Update::Force means to force an update in any case.
  97          * \retval true if a screen redraw is needed
  98          */
  99         void processUpdateFlags(Update::flags flags);
 100
 101         /// move the screen to fit the cursor.
 102         /// Only to be called with good y coordinates (after a bv::metrics)
 103         bool fitCursor();
 104         /// reset the scrollbar to reflect current view position.
 105         void updateScrollbar();
 106         /// return the Scrollbar Parameters.
 107         ScrollbarParameters const & scrollbarParameters() const;
 108
 109         /// Save the current position as bookmark.
 110         /// if idx == 0, save to temp_bookmark
 111         void saveBookmark(unsigned int idx);
 112         /// goto a specified position, try top_id first, and then bottom_pit.
 113         /// \return true if success
 114         bool moveToPosition(
 115                 pit_type bottom_pit, ///< Paragraph pit, used when par_id is zero or invalid.
 116                 pos_type bottom_pos, ///< Paragraph pit, used when par_id is zero or invalid.
 117                 int top_id, ///< Paragraph ID, \sa Paragraph
 118                 pos_type top_pos ///< Position in the \c Paragraph
 119                 );
 120         /// return the current change at the cursor.
 121         Change const getCurrentChange() const;
 122
 123         /// move cursor to the named label.
 124         void gotoLabel(docstring const & label);
 125
 126         /// set the cursor based on the given TeX source row.
 127         void setCursorFromRow(int row);
 128
 129         /// center the document view around the cursor.
 130         void center();
 131         /// scroll down document by the given number of pixels.
 132         void scrollDown(int pixels);
 133         /// scroll up document by the given number of pixels.
 134         void scrollUp(int pixels);
 135         /// scroll document by the given number of pixels.
 136         void scroll(int pixels);
 137         /// Scroll the view by a number of pixels.
 138         void scrollDocView(int pixels);
 139         /// Set the cursor position based on the scrollbar one.
 140         void setCursorFromScrollbar();
 141
 142         /// return the pixel width of the document view.
 143         int workWidth() const;
 144         /// return the pixel height of the document view.
 145         int workHeight() const;
 146
 147         /// translate and insert a character, using the correct keymap.
 148         void translateAndInsert(char_type c, Text * t, Cursor & cur);
 149
 150         /// return true for events that will handle.
 151         FuncStatus getStatus(FuncRequest const & cmd);
 152         /// execute the given function.
 153         /// \return the Update::flags for further metrics update.
 154         Update::flags dispatch(FuncRequest const & argument);
 155
 156         /// request an X11 selection.
 157         /// \return the selected string.
 158         docstring const requestSelection();
 159         /// clear the X11 selection.
 160         void clearSelection();
 161
 162         /// resize the BufferView.
 163         /// \sa WorkArea
 164         void resize(int width, int height);
 165
 166         /// dispatch method helper for \c WorkArea
 167         /// \sa WorkArea
 168         void mouseEventDispatch(FuncRequest const & ev);
 169
 170         /// access to anchor.
 171         pit_type anchor_ref() const;
 172
 173         ///
 174         CursorStatus cursorStatus(DocIterator const & dit) const;
 175         /// access to full cursor.
 176         Cursor & cursor();
 177         /// access to full cursor.
 178         Cursor const & cursor() const;
 179         /// sets cursor.
 180         /// This will also open all relevant collapsable insets.
 181         void setCursor(DocIterator const &);
 182         /// Check deleteEmptyParagraphMechanism and update metrics if needed.
 183         /// \retval true if an update was needed.
 184         bool checkDepm(Cursor & cur, Cursor & old);
 185         /// sets cursor.
 186         /// This is used when handling LFUN_MOUSE_PRESS.
 187         bool mouseSetCursor(Cursor & cur, bool select = false);
 188
 189         /// sets the selection.
 190         /* When \c backwards == false, set anchor
 191          * to \c cur and cursor to \c cur + \c length. When \c
 192          * backwards == true, set anchor to \c cur and cursor to \c
 193          * cur + \c length.
 194          */
 195         void putSelectionAt(DocIterator const & cur,
 196                 int length, bool backwards);
 197
 198         /// return the internal \c ViewMetricsInfo.
 199         /// This is used specifically by the \c Workrea.
 200         /// \sa WorkArea
 201         /// \sa ViewMetricsInfo
 202         ViewMetricsInfo const & viewMetricsInfo();
 203         /// update the internal \c ViewMetricsInfo.
 204         void updateMetrics();
 205
 206         ///
 207         TextMetrics const & textMetrics(Text const * t) const;
 208         TextMetrics & textMetrics(Text const * t);
 209         ///
 210         ParagraphMetrics const & parMetrics(Text const *, pit_type) const;
 211
 212         ///
 213         CoordCache & coordCache();
 214         ///
 215         CoordCache const & coordCache() const;
 216
 217         ///
 218         Point getPos(DocIterator const & dit, bool boundary) const;
 219
 220
 221         ///
 222         void draw(frontend::Painter & pain);
 223
 224         /// get this view's keyboard map handler.
 225         Intl & getIntl();
 226         ///
 227         Intl const & getIntl() const;
 228
 229         //
 230         // Messages to the GUI
 231         //
 232         /// This signal is emitted when some message shows up.
 233         void message(docstring const & msg);
 234
 235         /// This signal is emitted when some dialog needs to be shown.
 236         void showDialog(std::string const & name);
 237
 238         /// This signal is emitted when some dialog needs to be shown with
 239         /// some data.
 240         void showDialogWithData(std::string const & name, std::string const & data);
 241
 242         /// This signal is emitted when some inset dialogs needs to be shown.
 243         void showInsetDialog(std::string const & name, std::string const & data,
 244                 Inset * inset);
 245
 246         /// This signal is emitted when some dialogs needs to be updated.
 247         void updateDialog(std::string const & name, std::string const & data);
 248
 249         ///
 250         void setGuiDelegate(frontend::GuiBufferViewDelegate *);
 251
 252         ///
 253         docstring contentsOfPlaintextFile(std::string const & f, bool asParagraph);
 254         // Insert plain text file (if filename is empty, prompt for one)
 255         void insertPlaintextFile(std::string const & fileName, bool asParagraph);
 256
 257 private:
 258         /// noncopyable
 259         BufferView(BufferView const &);
 260         void operator=(BufferView const &);
 261
 262         // the position relative to (0, baseline) of outermost paragraph
 263         Point coordOffset(DocIterator const & dit, bool boundary) const;
 264         /// Update current paragraph metrics.
 265         /// \return true if no further update is needed.
 266         bool singleParUpdate();
 267         ///
 268         bool multiParSel();
 269
 270         /// Search recursively for the the innermost inset that covers (x, y) position.
 271         /// \retval 0 if no inset is found.
 272         Inset const * getCoveringInset(
 273                 Text const & text, //< The Text where we start searching.
 274                 int x, //< x-coordinate on screen
 275                 int y  //< y-coordinate on screen
 276                 );
 277
 278         ///
 279         int width_;
 280         ///
 281         int height_;
 282         ///
 283         Buffer & buffer_;
 284
 285         ///
 286         void menuInsertLyXFile(std::string const & filen);
 287
 288         void updateOffsetRef();
 289
 290         struct Private;
 291         Private * const d;
 292 };
 293
 294 /// some space for drawing the 'nested' markers (in pixel)
 295 inline int nestMargin() { return 15; }
 296
 297 /// margin for changebar
 298 inline int changebarMargin() { return 12; }
 299
 300 /// right margin
 301 inline int rightMargin() { return 10; }
 302
 303 } // namespace lyx
 304
 305 #endif // BUFFERVIEW_H