src/BufferView.h

   1 // -*- C++ -*-
   2 /**
   3  * \file BufferView.h
   4  * Copyright 2002 the LyX Team
   5  * Read the file COPYING
   6  *
   7  *  \author Lars Gullik Bjønnes
   8 */
   9
  10 #ifndef BUFFER_VIEW_H
  11 #define BUFFER_VIEW_H
  12
  13 #ifdef __GNUG__
  14 #pragma interface
  15 #endif
  16
  17 #include "LString.h"
  18 #include "undo.h"
  19
  20 #include "insets/inset.h"
  21
  22 #include <boost/utility.hpp>
  23
  24 class LyXView;
  25 class LyXText;
  26 class TeXErrors;
  27 class Buffer;
  28 class LyXScreen;
  29 class Language;
  30 class Painter;
  31 class UpdatableInset;
  32 class WordLangTuple;
  33 class WorkArea;
  34
  35 ///
  36 class BufferView : boost::noncopyable {
  37 public:
  38         ///
  39         enum UpdateCodes {
  40                 ///
  41                 UPDATE = 0,
  42                 ///
  43                 SELECT = 1,
  44                 ///
  45                 FITCUR = 2,
  46                 ///
  47                 CHANGE = 4
  48         };
  49
  50         ///
  51         BufferView(LyXView * owner, int , int , int, int);
  52         ///
  53         ~BufferView();
  54         ///
  55         Buffer * buffer() const;
  56         ///
  57         Painter & painter() const;
  58         ///
  59         LyXScreen & screen() const;
  60         /// return the work area for this bview
  61         WorkArea & workarea() const;
  62         ///
  63         void buffer(Buffer * b);
  64         ///
  65         void resize();
  66         /**
  67          * Repaint the pixmap. Used for when we don't want
  68          * to go through the full update() logic, just a simple
  69          * repaint of the whole screen.
  70          */
  71         void repaint();
  72         ///
  73         bool fitCursor();
  74         ///
  75         void update();
  76         //
  77         void update(LyXText *, UpdateCodes uc);
  78         ///
  79         void updateScrollbar();
  80         ///
  81         Inset * checkInsetHit(LyXText *, int & x, int & y);
  82         ///
  83         void redoCurrentBuffer();
  84         ///
  85         void cursorPrevious(LyXText *);
  86         ///
  87         void cursorNext(LyXText *);
  88         ///
  89         bool available() const;
  90         ///
  91         LyXView * owner() const;
  92         ///
  93         void beforeChange(LyXText *);
  94         ///
  95         void finishChange(bool fitcur = false);
  96         ///
  97         void savePosition(unsigned int i);
  98         ///
  99         void restorePosition(unsigned int i);
 100         ///
 101         bool isSavedPosition(unsigned int i);
 102         /** This holds the mapping between buffer paragraphs and screen rows.
 103             This should be private...but not yet. (Lgb)
 104         */
 105         LyXText * text;
 106         ///
 107         LyXText * getLyXText() const;
 108         ///
 109         LyXText * getParentText(Inset * inset) const;
 110         ///
 111         Language const * getParentLanguage(Inset * inset) const;
 112         ///
 113         int workWidth() const;
 114         ///
 115         UpdatableInset * theLockingInset() const;
 116         ///
 117         void theLockingInset(UpdatableInset * inset);
 118         ///
 119         void updateInset(Inset * inset, bool mark_dirty);
 120         ///
 121         int slx;
 122         ///
 123         int sly;
 124         ///
 125         void insetUnlock();
 126         ///
 127         void replaceWord(string const & replacestring);
 128         ///
 129         void endOfSpellCheck();
 130         ///
 131         void selectLastWord();
 132         /// return the next word
 133         WordLangTuple const nextWord(float & value);
 134         ///
 135         bool gotoLabel(string const & label);
 136         ///
 137         void paste();
 138         ///
 139         void cut(bool realcut = true);
 140         ///
 141         void copy();
 142         ///
 143         void pasteEnvironment();
 144         ///
 145         void copyEnvironment();
 146         ///
 147         void menuUndo();
 148         ///
 149         void menuRedo();
 150         /// removes all autodeletable insets
 151         bool removeAutoInsets();
 152         ///
 153         void insertErrors(TeXErrors & terr);
 154         ///
 155         void setCursorFromRow(int row);
 156         /** Insert an inset into the buffer.
 157             Place it in a layout of lout,
 158             if no_table make sure that it doesn't end up in a table.
 159         */
 160         bool insertInset(Inset * inset, string const & lout = string());
 161         /// Inserts a lyx file at cursor position. return #false# if it fails
 162         bool insertLyXFile(string const & file);
 163         ///
 164         bool lockInset(UpdatableInset * inset);
 165         ///
 166         void showLockedInsetCursor(int x, int y, int asc, int desc);
 167         ///
 168         void hideLockedInsetCursor();
 169         ///
 170         bool fitLockedInsetCursor(int x, int y, int asc, int desc);
 171         ///
 172         int unlockInset(UpdatableInset * inset);
 173         ///
 174         void lockedInsetStoreUndo(Undo::undo_kind kind);
 175         ///
 176         void showCursor();
 177         ///
 178         void hideCursor();
 179         ///
 180         void toggleSelection(bool = true);
 181         ///
 182         void toggleToggle();
 183         ///
 184         void center();
 185
 186         /// Scroll the view by a number of pixels
 187         void scrollDocView(int);
 188
 189         ///
 190         void switchKeyMap();
 191
 192         ///
 193         bool ChangeInsets(Inset::Code code, string const & from,
 194                           string const & to);
 195         ///
 196         bool ChangeRefsIfUnique(string const & from, string const & to);
 197         ///
 198         bool ChangeCitationsIfUnique(string const & from, string const & to);
 199         ///
 200         string const getClipboard() const;
 201         ///
 202         void stuffClipboard(string const &) const;
 203         ///
 204         bool dispatch(FuncRequest const & argument);
 205         ///
 206         void moveCursorUpdate(bool selecting, bool fitcur = true);
 207 private:
 208         ///
 209         struct Pimpl;
 210         ///
 211         friend struct BufferView::Pimpl;
 212         ///
 213         Pimpl * pimpl_;
 214 };
 215
 216
 217 ///
 218 BufferView::UpdateCodes operator|(BufferView::UpdateCodes uc1,
 219                                   BufferView::UpdateCodes uc2);
 220
 221 #endif