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