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 "metricsinfo.h"
  19
  20 #include "frontends/LyXKeySym.h"
  21
  22 #include "support/types.h"
  23
  24 #include <boost/utility.hpp>
  25
  26 #include <string>
  27
  28 class Buffer;
  29 class Change;
  30 class DocIterator;
  31 class ErrorList;
  32 class FuncRequest;
  33 class FuncStatus;
  34 class Language;
  35 class LCursor;
  36 class LyXText;
  37 class LyXView;
  38 class ParIterator;
  39 class ViewMetricsInfo;
  40
  41 namespace Update {
  42         enum flags {
  43                 FitCursor = 1,
  44                 Force = 2,
  45                 SinglePar = 4,
  46                 MultiParSel = 8
  47         };
  48
  49 inline flags operator|(flags const f, flags const g)
  50 {
  51         return static_cast<flags>(int(f) | int(g));
  52 }
  53
  54 inline flags operator&(flags const f, flags const g)
  55 {
  56         return static_cast<flags>(int(f) & int(g));
  57 }
  58
  59 } // namespace
  60
  61 /// Scrollbar Parameters
  62 struct ScrollbarParameters
  63 {
  64         void reset(int h = 0, int p = 0, int l = 0)
  65         {
  66                 height = h;
  67                 position = p;
  68                 lineScrollHeight = l;
  69         }
  70
  71         /// The total document height in pixels
  72         int height;
  73         /// The current position in the document, in pixels
  74         int position;
  75         /// the line-scroll amount, in pixels
  76         int lineScrollHeight;
  77 };
  78
  79 /**
  80  * A buffer view encapsulates a view onto a particular
  81  * buffer, and allows access to operate upon it. A view
  82  * is a sliding window of the entire document rendering.
  83  *
  84  * Eventually we will allow several views onto a single
  85  * buffer, but not yet.
  86  */
  87 class BufferView : boost::noncopyable {
  88 public:
  89         /**
  90          * Create a view with the given owner main window,
  91          * of the given dimensions.
  92          */
  93         BufferView(LyXView * owner);
  94
  95         ~BufferView();
  96
  97         /// set the buffer we are viewing
  98         void setBuffer(Buffer * b);
  99         /// return the buffer being viewed
 100         Buffer * buffer() const;
 101         /// return the first layout of the Buffer.
 102         std::string firstLayout();
 103
 104         /// return the owning main view
 105         LyXView * owner() const;
 106
 107         /// resize event has happened
 108         void resize();
 109
 110         /// reload the contained buffer
 111         void reload();
 112         /// load a buffer into the view
 113         bool loadLyXFile(std::string const & name, bool tolastfiles = true);
 114
 115         /** perform pending painting updates. \c fitcursor means first
 116          *  to do a fitcursor, and to force an update if screen
 117          *  position changes. \c forceupdate means to force an update
 118          *  in any case.
 119          * \return true if a full updateMetrics() is needed.
 120          */
 121         bool update(Update::flags flags = Update::FitCursor | Update::Force);
 122
 123         /// move the screen to fit the cursor. Only to be called with
 124         /// good y coordinates (after a bv::metrics)
 125         bool fitCursor();
 126         /// reset the scrollbar to reflect current view position
 127         void updateScrollbar();
 128         /// return the Scrollbar Parameters
 129         ScrollbarParameters const & scrollbarParameters() const;
 130
 131         /// FIXME
 132         bool available() const;
 133
 134         /// Save the current position as bookmark i
 135         void savePosition(unsigned int i);
 136         /// Restore the position from bookmark i
 137         void restorePosition(unsigned int i);
 138         /// does the given bookmark have a saved position ?
 139         bool isSavedPosition(unsigned int i);
 140         /// save bookmarks to .lyx/session
 141         void saveSavedPositions();
 142
 143         /// return the current change at the cursor
 144         Change const getCurrentChange();
 145
 146         /// return the lyxtext we are using
 147         LyXText * getLyXText();
 148
 149         /// return the lyxtext we are using
 150         LyXText const * getLyXText() const;
 151
 152         /// simple replacing. Use the font of the first selected character
 153         void replaceSelectionWithString(std::string const & str);
 154
 155         /// move cursor to the named label
 156         void gotoLabel(std::string const & label);
 157
 158         /// get the stored error list
 159         ErrorList const & getErrorList() const;
 160         /// show the error list to the user
 161         void showErrorList(std::string const &) const;
 162         /// set the cursor based on the given TeX source row
 163         void setCursorFromRow(int row);
 164
 165         /// center the document view around the cursor
 166         void center();
 167         /// scroll document by the given number of lines of default height
 168         void scroll(int lines);
 169         /// Scroll the view by a number of pixels
 170         void scrollDocView(int pixels);
 171
 172         /// return the pixel width of the document view
 173         int workWidth() const;
 174         /// return the pixel height of the document view
 175         int workHeight() const;
 176
 177         /// switch between primary and secondary keymaps for RTL entry
 178         void switchKeyMap();
 179
 180         /// return true for events that will handle
 181         FuncStatus getStatus(FuncRequest const & cmd);
 182         /// execute the given function
 183         bool dispatch(FuncRequest const & argument);
 184
 185         ///
 186         void selectionRequested();
 187         ///
 188         void selectionLost();
 189
 190         ///
 191         void workAreaResize(int width, int height);
 192
 193         /// Receive a keypress
 194         void workAreaKeyPress(LyXKeySymPtr key, key_modifier::state state);
 195
 196         /// a function should be executed from the workarea
 197         bool workAreaDispatch(FuncRequest const & ev);
 198
 199         /// clear the X selection
 200         void unsetXSel();
 201
 202         /// access to offset
 203         int offset_ref() const;
 204         /// access to anchor
 205         lyx::pit_type anchor_ref() const;
 206
 207         /// access to full cursor
 208         LCursor & cursor();
 209         /// access to full cursor
 210         LCursor const & cursor() const;
 211         ///
 212         LyXText * text() const;
 213         /// sets cursor and open all relevant collapsable insets.
 214         void setCursor(DocIterator const &);
 215         /// sets cursor; this is used when handling LFUN_MOUSE_PRESS.
 216         void mouseSetCursor(LCursor & cur);
 217
 218         /* Sets the selection. When \c backwards == false, set anchor
 219          * to \c cur and cursor to \c cur + \c length. When \c
 220          * backwards == true, set anchor to \c cur and cursor to \c
 221          * cur + \c length.
 222          */
 223         void putSelectionAt(DocIterator const & cur,
 224                 int length, bool backwards);
 225         ///
 226         ViewMetricsInfo const & viewMetricsInfo();
 227         ///
 228         void updateMetrics(bool singlepar = false);
 229
 230 private:
 231         ///
 232         class Pimpl;
 233         ///
 234         friend class BufferView::Pimpl;
 235         ///
 236         Pimpl * pimpl_;
 237 };
 238
 239 #endif // BUFFERVIEW_H