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 "support/types.h"
  19
  20 #include <boost/utility.hpp>
  21
  22 #include <string>
  23
  24 class Buffer;
  25 class Change;
  26 class DocumentIterator;
  27 class Encoding;
  28 class ErrorList;
  29 class FuncRequest;
  30 class InsetBase;
  31 class InsetOld;
  32 class Language;
  33 class LCursor;
  34 class LyXText;
  35 class LyXScreen;
  36 class LyXView;
  37 class Painter;
  38 class ParIterator;
  39 class TeXErrors;
  40 class UpdatableInset;
  41
  42 /**
  43  * A buffer view encapsulates a view onto a particular
  44  * buffer, and allows access to operate upon it. A view
  45  * is a sliding window of the entire document rendering.
  46  *
  47  * Eventually we will allow several views onto a single
  48  * buffer, but not yet.
  49  */
  50 class BufferView : boost::noncopyable {
  51 public:
  52         /**
  53          * Create a view with the given owner main window,
  54          * of the given dimensions.
  55          */
  56         BufferView(LyXView * owner, int x, int y, int w, int h);
  57
  58         ~BufferView();
  59
  60         /// set the buffer we are viewing
  61         void setBuffer(Buffer * b);
  62         /// return the buffer being viewed
  63         Buffer * buffer() const;
  64
  65         /// return the painter object for drawing onto the view
  66         Painter & painter() const;
  67         /// return the screen object for handling re-drawing
  68         LyXScreen & screen() const;
  69         /// return the owning main view
  70         LyXView * owner() const;
  71
  72         /// return the visible top y
  73         int top_y() const;
  74
  75         /// set the visible top y
  76         void top_y(int);
  77
  78         /// resize event has happened
  79         void resize();
  80
  81         /// reload the contained buffer
  82         void reload();
  83         /// create a new buffer based on template
  84         void newFile(std::string const & fname, std::string const & tname,
  85                      bool named = true);
  86         /// load a buffer into the view
  87         bool loadLyXFile(std::string const & name, bool tolastfiles = true);
  88
  89         /// fit the user cursor within the visible view
  90         bool fitCursor();
  91         /// perform pending painting updates
  92         void update();
  93         /// reset the scrollbar to reflect current view position
  94         void updateScrollbar();
  95         /// FIXME
  96         void redoCurrentBuffer();
  97
  98         /// FIXME
  99         bool available() const;
 100
 101         /// Save the current position as bookmark i
 102         void savePosition(unsigned int i);
 103         /// Restore the position from bookmark i
 104         void restorePosition(unsigned int i);
 105         /// does the given bookmark have a saved position ?
 106         bool isSavedPosition(unsigned int i);
 107
 108         /// return the current change at the cursor
 109         Change const getCurrentChange();
 110
 111         /// return the lyxtext we are using
 112         LyXText * getLyXText() const;
 113
 114         /// return the parent language of the given inset
 115         Language const * getParentLanguage(InsetOld * inset) const;
 116
 117         /// simple replacing. Use the font of the first selected character
 118         void replaceSelectionWithString(std::string const & str);
 119
 120         /// move cursor to the named label
 121         void gotoLabel(std::string const & label);
 122
 123         /// get the stored error list
 124         ErrorList const & getErrorList() const;
 125         /// show the error list to the user
 126         void showErrorList(std::string const &) const;
 127         /// set the cursor based on the given TeX source row
 128         void setCursorFromRow(int row);
 129
 130         /// Inserts a lyx file at cursor position. return false if it fails
 131         bool insertLyXFile(std::string const & file);
 132
 133         /// FIXME
 134         bool fitLockedInsetCursor(int x, int y, int asc, int desc);
 135
 136         /// hide the cursor if it is visible
 137         void hideCursor();
 138
 139         /// center the document view around the cursor
 140         void center();
 141         /// scroll document by the given number of lines of default height
 142         void scroll(int lines);
 143         /// Scroll the view by a number of pixels
 144         void scrollDocView(int);
 145
 146         /// return the pixel width of the document view
 147         int workWidth() const;
 148         /// return the pixel height of the document view
 149         int workHeight() const;
 150
 151         /// switch between primary and secondary keymaps for RTL entry
 152         void switchKeyMap();
 153
 154         /// get the contents of the window system clipboard
 155         std::string const getClipboard() const;
 156         /// fill the window system clipboard
 157         void stuffClipboard(std::string const &) const;
 158         /// tell the window system we have a selection
 159         void haveSelection(bool sel);
 160
 161         /// execute the given function
 162         bool dispatch(FuncRequest const & argument);
 163
 164         /// clear the X selection
 165         void unsetXSel();
 166
 167         /// access to full cursor
 168         LCursor & cursor();
 169         /// access to full cursor
 170         LCursor const & cursor() const;
 171         ///
 172         LyXText * text() const;
 173         ///
 174         void setCursor(ParIterator const & par, lyx::pos_type pos);
 175         ///
 176         void putSelectionAt(DocumentIterator const & cur,
 177                 int length, bool backwards);
 178
 179 private:
 180         ///
 181         struct Pimpl;
 182         ///
 183         friend struct BufferView::Pimpl;
 184         ///
 185         Pimpl * pimpl_;
 186 };
 187
 188 #endif // BUFFERVIEW_H