src/frontends/WorkArea.h

   1 // -*- C++ -*-
   2 /**
   3  * \file WorkArea.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author unknown
   8  * \author John Levon
   9  * \author Abdelrazak Younes
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef BASE_WORKAREA_H
  15 #define BASE_WORKAREA_H
  16
  17 #include "frontends/key_state.h"
  18 #include "frontends/LyXKeySym.h"
  19 #include "frontends/Timeout.h"
  20
  21 #include "support/docstring.h"
  22
  23 #include <boost/signals/trackable.hpp>
  24
  25 // FIXME: defined in X.h, spuriously pulled in by Qt 3 headers
  26 #undef CursorShape
  27
  28 namespace lyx {
  29
  30 class BufferView;
  31 class FuncRequest;
  32 class LyXView;
  33
  34 namespace frontend {
  35
  36 class Painter;
  37
  38 /// types of cursor in work area
  39 enum CursorShape {
  40         /// normal I-beam
  41         BAR_SHAPE,
  42         /// L-shape for locked insets of a different language
  43         L_SHAPE,
  44         /// reverse L-shape for RTL text
  45         REVERSED_L_SHAPE
  46 };
  47
  48 /**
  49  * The work area class represents the widget that provides the
  50  * view onto a document. It is owned by the BufferView, and
  51  * is responsible for handing events back to its owning BufferView.
  52  * It works in concert with the BaseScreen class to update the
  53  * widget view of a document.
  54  */
  55 class WorkArea : public boost::signals::trackable {
  56 public:
  57         WorkArea(LyXView & lyx_view);
  58
  59         virtual ~WorkArea() {}
  60
  61         void setBufferView(BufferView * buffer_view);
  62
  63         ///
  64         BufferView & bufferView();
  65         ///
  66         BufferView const & bufferView() const;
  67
  68
  69         /// return the painter object for this work area
  70         virtual Painter & getPainter() = 0;
  71
  72         /// return the width of the work area in pixels
  73         virtual int width() const = 0;
  74
  75         /// return the height of the work area in pixels
  76         virtual int height() const = 0;
  77
  78         /**
  79          * Update the scrollbar.
  80          * @param height the total document height in pixels
  81          * @param pos the current position in the document, in pixels
  82          * @param line_height the line-scroll amount, in pixels
  83          */
  84         virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
  85
  86         /// redraw the screen, without using existing pixmap
  87         virtual void redraw();
  88
  89         /// grey out (no buffer)
  90         void greyOut();
  91
  92 protected:
  93         ///
  94         void processKeySym(LyXKeySymPtr key, key_modifier::state state);
  95         /// cause the display of the given area of the work area
  96         virtual void expose(int x, int y, int w, int h) = 0;
  97
  98         ///
  99         void dispatch(FuncRequest const & cmd0);
 100
 101         ///
 102         void resizeBufferView();
 103
 104         ///
 105         void scrollBufferView(int position);
 106
 107         /// hide the visible cursor, if it is visible
 108         void hideCursor();
 109
 110         /// show the cursor if it is not visible
 111         void showCursor();
 112
 113         /// toggle the cursor's visibility
 114         void toggleCursor();
 115
 116         /// hide the cursor
 117         virtual void removeCursor() = 0;
 118
 119         /// paint the cursor and store the background
 120         virtual void showCursor(int x, int y, int h, CursorShape shape) = 0;
 121
 122         ///
 123         BufferView * buffer_view_;
 124
 125         ///
 126         LyXView & lyx_view_;
 127
 128 private:
 129         ///
 130         void updateScrollbar();
 131         ///
 132         void checkAndGreyOut();
 133         ///
 134         void displayMessage(docstring const &);
 135         /// buffer messages signal connection
 136         boost::signals::connection message_connection_;
 137
 138         ///
 139         bool greyed_out_;
 140
 141         /// is the cursor currently displayed
 142         bool cursor_visible_;
 143
 144         ///
 145         Timeout cursor_timeout_;
 146 };
 147
 148 } // namespace frontend
 149 } // namespace lyx
 150
 151 #endif // BASE_WORKAREA_H