src/BufferView_pimpl.h

   1 // -*- C++ -*-
   2 /**
   3  * \file BufferView_pimpl.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup
   8  * \author Alfredo Braustein
   9  * \author Lars Gullik Bjønnes
  10  * \author John Levon
  11  * \author André Pönitz
  12  * \author Dekel Tsur
  13  * \author Jürgen Vigna
  14  *
  15  * Full author contact details are available in file CREDITS.
  16  */
  17
  18 #ifndef BUFFERVIEW_PIMPL_H
  19 #define BUFFERVIEW_PIMPL_H
  20
  21 #include "BufferView.h"
  22 #include "cursor.h"
  23 #include "errorlist.h"
  24
  25 #include "insets/inset.h"
  26
  27 #include "frontends/key_state.h"
  28 #include "frontends/Timeout.h"
  29
  30 #include "support/types.h"
  31
  32 #include <boost/scoped_ptr.hpp>
  33 #include <boost/shared_ptr.hpp>
  34 #include <boost/signals/trackable.hpp>
  35
  36
  37 class Change;
  38 class LyXKeySym;
  39 class LyXView;
  40 class WorkArea;
  41 class LyXScreen;
  42 class FuncRequest;
  43
  44 ///
  45 struct BufferView::Pimpl : public boost::signals::trackable {
  46         ///
  47         Pimpl(BufferView * bv, LyXView * owner,
  48               int xpos, int ypos, int width, int height);
  49         ///
  50         Painter & painter() const;
  51         /// return the screen for this bview
  52         LyXScreen & screen() const;
  53         ///
  54         void buffer(Buffer *);
  55         /// Return true if the cursor was fitted.
  56         bool fitCursor();
  57         ///
  58         void redoCurrentBuffer();
  59         ///
  60         void resizeCurrentBuffer();
  61         ///
  62         void update();
  63         /**
  64          * Repaint pixmap. Used for when we've made a visible
  65          * change but don't need the full update() logic
  66          */
  67         ///
  68         bool newFile(std::string const &, std::string const &, bool);
  69         ///
  70         bool loadLyXFile(std::string const &, bool);
  71         ///
  72         void workAreaResize();
  73         ///
  74         void updateScrollbar();
  75         ///
  76         void scrollDocView(int value);
  77         /**
  78          * Wheel mouse scroll, move by multiples of text->defaultRowHeight().
  79          */
  80         void scroll(int lines);
  81         ///
  82         typedef boost::shared_ptr<LyXKeySym> LyXKeySymPtr;
  83         ///
  84         void workAreaKeyPress(LyXKeySymPtr key, key_modifier::state state);
  85         ///
  86         void selectionRequested();
  87         ///
  88         void selectionLost();
  89         ///
  90         void cursorToggle();
  91         ///
  92         bool available() const;
  93         /// get the change at the cursor position
  94         Change const getCurrentChange();
  95         ///
  96         void savePosition(unsigned int i);
  97         ///
  98         void restorePosition(unsigned int i);
  99         ///
 100         bool isSavedPosition(unsigned int i);
 101         ///
 102         void switchKeyMap();
 103         ///
 104         void center();
 105         ///
 106         bool insertInset(InsetOld * inset, std::string const & lout = std::string());
 107         /// a function should be executed from the workarea
 108         bool workAreaDispatch(FuncRequest const & ev);
 109         /// a function should be executed
 110         bool dispatch(FuncRequest const & ev);
 111         ///
 112         int top_y() const;
 113         ///
 114         void top_y(int y);
 115         /// update paragraph dialogs
 116         void updateParagraphDialog();
 117 private:
 118         /// the y coordinate of the top of the screen
 119         int top_y_;
 120         /// An error list (replaces the error insets)
 121         ErrorList errorlist_;
 122         /// add an error to the list
 123         void addError(ErrorItem const &);
 124         /// buffer errors signal connection
 125         boost::signals::connection errorConnection_;
 126         /// buffer messages signal connection
 127         boost::signals::connection messageConnection_;
 128         /// buffer busy status signal connection
 129         boost::signals::connection busyConnection_;
 130         /// buffer title changed signal connection
 131         boost::signals::connection titleConnection_;
 132         /// buffer reset timers signal connection
 133         boost::signals::connection timerConnection_;
 134         /// buffer readonly status changed signal connection
 135         boost::signals::connection readonlyConnection_;
 136         /// buffer closing signal connection
 137         boost::signals::connection closingConnection_;
 138         /// connect to signals in the given buffer
 139         void connectBuffer(Buffer & buf);
 140         /// disconnect from signals in the given buffer
 141         void disconnectBuffer();
 142         /// track changes for the document
 143         void trackChanges();
 144         /// notify readonly status
 145         void showReadonly(bool);
 146
 147         /**
 148          * Change all insets with the given code's contents to a new
 149          * string. May only be used with InsetCommand-derived insets
 150          * Returns true if a screen update is needed.
 151          */
 152         bool ChangeInsets(InsetOld::Code code, std::string const & from,
 153                           std::string const & to);
 154
 155         ///
 156         friend class BufferView;
 157
 158         ///
 159         BufferView * bv_;
 160         ///
 161         LyXView * owner_;
 162         ///
 163         Buffer * buffer_;
 164         ///
 165         boost::scoped_ptr<LyXScreen> screen_;
 166         ///
 167         boost::scoped_ptr<WorkArea> workarea_;
 168         ///
 169         Timeout cursor_timeout;
 170         ///
 171         void stuffClipboard(std::string const &) const;
 172         ///
 173         bool using_xterm_cursor;
 174         ///
 175         struct Position {
 176                 /// Filename
 177                 std::string filename;
 178                 /// Cursor paragraph Id
 179                 int par_id;
 180                 /// Cursor position
 181                 lyx::pos_type par_pos;
 182                 ///
 183                 Position() : par_id(0), par_pos(0) {}
 184                 ///
 185                 Position(std::string const & f, int id, lyx::pos_type pos)
 186                         : filename(f), par_id(id), par_pos(pos) {}
 187         };
 188         ///
 189         std::vector<Position> saved_positions;
 190         /// Get next inset of this class from current cursor position
 191         InsetOld * getInsetByCode(InsetOld::Code code);
 192         ///
 193         void MenuInsertLyXFile(std::string const & filen);
 194         /// our workarea
 195         WorkArea & workarea() const;
 196         /// this is used to handle XSelection events in the right manner
 197         struct {
 198                 LyXCursor cursor;
 199                 LyXCursor anchor;
 200                 bool set;
 201         } xsel_cache_;
 202         ///
 203         LCursor cursor_;
 204 };
 205 #endif // BUFFERVIEW_PIMPL_H