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         bool available() const;
  86         ///
  87         LyXView * owner() const;
  88         ///
  89         void beforeChange(LyXText *);
  90         ///
  91         void finishChange(bool fitcur = false);
  92         ///
  93         void savePosition(unsigned int i);
  94         ///
  95         void restorePosition(unsigned int i);
  96         ///
  97         bool isSavedPosition(unsigned int i);
  98         /** This holds the mapping between buffer paragraphs and screen rows.
  99             This should be private...but not yet. (Lgb)
 100         */
 101         LyXText * text;
 102         ///
 103         LyXText * getLyXText() const;
 104         ///
 105         LyXText * getParentText(Inset * inset) const;
 106         ///
 107         Language const * getParentLanguage(Inset * inset) const;
 108         ///
 109         int workWidth() const;
 110         ///
 111         UpdatableInset * theLockingInset() const;
 112         ///
 113         void theLockingInset(UpdatableInset * inset);
 114         ///
 115         void updateInset(Inset * inset, bool mark_dirty);
 116         ///
 117         int slx;
 118         ///
 119         int sly;
 120         ///
 121         void insetUnlock();
 122         ///
 123         void replaceWord(string const & replacestring);
 124         ///
 125         void endOfSpellCheck();
 126         ///
 127         void selectLastWord();
 128         /// return the next word
 129         WordLangTuple const nextWord(float & value);
 130         ///
 131         bool gotoLabel(string const & label);
 132         ///
 133         void pasteEnvironment();
 134         ///
 135         void copyEnvironment();
 136         ///
 137         void menuUndo();
 138         ///
 139         void menuRedo();
 140         /// removes all autodeletable insets
 141         bool removeAutoInsets();
 142         ///
 143         void insertErrors(TeXErrors & terr);
 144         ///
 145         void setCursorFromRow(int row);
 146         /** Insert an inset into the buffer.
 147             Place it in a layout of lout,
 148             if no_table make sure that it doesn't end up in a table.
 149         */
 150         bool insertInset(Inset * inset, string const & lout = string());
 151         /// Inserts a lyx file at cursor position. return #false# if it fails
 152         bool insertLyXFile(string const & file);
 153         ///
 154         bool lockInset(UpdatableInset * inset);
 155         ///
 156         void showLockedInsetCursor(int x, int y, int asc, int desc);
 157         ///
 158         void hideLockedInsetCursor();
 159         ///
 160         bool fitLockedInsetCursor(int x, int y, int asc, int desc);
 161         ///
 162         int unlockInset(UpdatableInset * inset);
 163         ///
 164         void lockedInsetStoreUndo(Undo::undo_kind kind);
 165         ///
 166         void showCursor();
 167         ///
 168         void hideCursor();
 169         ///
 170         void toggleSelection(bool = true);
 171         ///
 172         void toggleToggle();
 173         ///
 174         void center();
 175
 176         /// Scroll the view by a number of pixels
 177         void scrollDocView(int);
 178
 179         ///
 180         void switchKeyMap();
 181
 182         ///
 183         bool ChangeInsets(Inset::Code code, string const & from,
 184                           string const & to);
 185         ///
 186         bool ChangeRefsIfUnique(string const & from, string const & to);
 187         ///
 188         bool ChangeCitationsIfUnique(string const & from, string const & to);
 189         ///
 190         string const getClipboard() const;
 191         ///
 192         void stuffClipboard(string const &) const;
 193         ///
 194         bool dispatch(FuncRequest const & argument);
 195         ///
 196         void moveCursorUpdate(bool selecting, bool fitcur = true);
 197 private:
 198         ///
 199         struct Pimpl;
 200         ///
 201         friend struct BufferView::Pimpl;
 202         ///
 203         Pimpl * pimpl_;
 204 };
 205
 206
 207 ///
 208 BufferView::UpdateCodes operator|(BufferView::UpdateCodes uc1,
 209                                   BufferView::UpdateCodes uc2);
 210
 211 #endif