src/BufferView_pimpl.h

   1 // -*- C++ -*-
   2 /**
   3  * \file BufferView_pimpl.h
   4  * Copyright 2002 the LyX Team
   5  * Read the file COPYING
   6  *
   7  * \author various
   8  */
   9
  10 #ifndef BUFFERVIEW_PIMPL_H
  11 #define BUFFERVIEW_PIMPL_H
  12
  13 #include "BufferView.h"
  14 #include "frontends/Timeout.h"
  15 #include "frontends/key_state.h"
  16 #include "frontends/mouse_state.h"
  17 #include "frontends/LyXKeySym.h"
  18 #include "box.h"
  19 #include "insets/insetspecialchar.h"
  20 #include "support/types.h"
  21
  22 #include <boost/scoped_ptr.hpp>
  23 #include <boost/signals/trackable.hpp>
  24
  25 #ifdef __GNUG__
  26 #pragma interface
  27 #endif
  28
  29 class LyXView;
  30 class WorkArea;
  31 class LyXScreen;
  32
  33 ///
  34 struct BufferView::Pimpl : public boost::signals::trackable {
  35         ///
  36         Pimpl(BufferView * i, LyXView * o,
  37               int xpos, int ypos, int width, int height);
  38         ///
  39         Painter & painter() const;
  40         /// return the work area for this bview
  41         WorkArea & workarea() const;
  42         /// return the screen for this bview
  43         LyXScreen & screen() const;
  44         ///
  45         void buffer(Buffer *);
  46         /// Return true if the cursor was fitted.
  47         bool fitCursor();
  48         ///
  49         void redoCurrentBuffer();
  50         ///
  51         int resizeCurrentBuffer();
  52         ///
  53         void update();
  54         //
  55         void update(LyXText *, BufferView::UpdateCodes);
  56         /**
  57          * Repaint pixmap. Used for when we've made a visible
  58          * change but don't need the full update() logic
  59          */
  60         void repaint();
  61         ///
  62         void workAreaResize();
  63         ///
  64         void updateScrollbar();
  65         ///
  66         void scrollDocView(int value);
  67         /**
  68          * Returns an inset if inset was hit, or 0 if not.
  69          *
  70          * If hit, the coordinates are changed relative to the inset.
  71          */
  72         Inset * checkInsetHit(LyXText *, int & x, int & y);
  73         /// wheel mouse scroll
  74         int scroll(long time);
  75         ///
  76         void workAreaKeyPress(LyXKeySymPtr key,
  77                               key_modifier::state state);
  78         ///
  79         void workAreaMotionNotify(int x, int y, mouse_button::state state);
  80         ///
  81         void workAreaButtonPress(int x, int y, mouse_button::state button);
  82         ///
  83         void workAreaButtonRelease(int x, int y, mouse_button::state button);
  84         ///
  85         void doubleClick(int x, int y, mouse_button::state button);
  86         ///
  87         void tripleClick(int x, int y, mouse_button::state button);
  88         ///
  89         void selectionRequested();
  90         ///
  91         void selectionLost();
  92         ///
  93         void cursorToggle();
  94         ///
  95         void cursorPrevious(LyXText *);
  96         ///
  97         void cursorNext(LyXText *);
  98         ///
  99         bool available() const;
 100         ///
 101         void beforeChange(LyXText *);
 102         ///
 103         void savePosition(unsigned int i);
 104         ///
 105         void restorePosition(unsigned int i);
 106         ///
 107         bool isSavedPosition(unsigned int i);
 108         ///
 109         void switchKeyMap();
 110         ///
 111         void insetUnlock();
 112         ///
 113         void showCursor();
 114         ///
 115         void hideCursor();
 116         ///
 117         void toggleSelection(bool = true);
 118         ///
 119         void toggleToggle();
 120         ///
 121         void center();
 122         ///
 123         bool insertInset(Inset * inset, string const & lout = string());
 124         ///
 125         void updateInset(Inset * inset, bool mark_dirty);
 126         ///
 127         bool dispatch(FuncRequest const & ev);
 128 private:
 129         /**
 130          * Return the on-screen dimensions of the inset at the cursor.
 131          * Pre-condition: the cursor must be at an inset.
 132          */
 133         Box insetDimensions(LyXText const & text, LyXCursor const & cursor) const;
 134         /**
 135          * check if the given co-ordinates are inside an inset at the
 136          * given cursor, if one exists. If so, the inset is returned,
 137          * and the co-ordinates are made relative. Otherwise, 0 is returned.
 138          */
 139         Inset * checkInset(LyXText const & text, LyXCursor const & cursor,
 140                            int & x, int & y) const;
 141         ///
 142         friend class BufferView;
 143         /// open and lock an updatable inset
 144         bool open_new_inset(UpdatableInset * new_inset, bool behind = false);
 145         ///
 146         void specialChar(InsetSpecialChar::Kind);
 147         ///
 148         void hfill();
 149         ///
 150         void smartQuote();
 151         ///
 152         void insertAndEditInset(Inset *);
 153         ///
 154         void gotoInset(std::vector<Inset::Code> const & codes,
 155                        bool same_content);
 156         ///
 157         void gotoInset(Inset::Code codes, bool same_content);
 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 pasteClipboard(bool asPara);
 172         ///
 173         void stuffClipboard(string const &) const;
 174         ///
 175         bool using_xterm_cursor;
 176         ///
 177         struct Position {
 178                 /// Filename
 179                 string filename;
 180                 /// Cursor paragraph Id
 181                 int par_id;
 182                 /// Cursor position
 183                 lyx::pos_type par_pos;
 184                 ///
 185                 Position() : par_id(0), par_pos(0) {}
 186                 ///
 187                 Position(string const & f, int id, lyx::pos_type pos)
 188                         : filename(f), par_id(id), par_pos(pos) {}
 189         };
 190         ///
 191         std::vector<Position> saved_positions;
 192         ///
 193         void moveCursorUpdate(bool selecting, bool fitcur = true);
 194         /// Get next inset of this class from current cursor position
 195         Inset * getInsetByCode(Inset::Code code);
 196         ///
 197         void MenuInsertLyXFile(string const & filen);
 198 };
 199 #endif // BUFFERVIEW_PIMPL_H