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(int id, LyXView & lyx_view);
  58
  59         virtual ~WorkArea() {}
  60
  61         int const id() const { return id_; }
  62
  63         void setBufferView(BufferView * buffer_view);
  64
  65         ///
  66         BufferView & bufferView();
  67         ///
  68         BufferView const & bufferView() const;
  69
  70         /// return the width of the work area in pixels
  71         virtual int width() const = 0;
  72
  73         /// return the height of the work area in pixels
  74         virtual int height() const = 0;
  75
  76         /**
  77          * Update the scrollbar.
  78          * @param height the total document height in pixels
  79          * @param pos the current position in the document, in pixels
  80          * @param line_height the line-scroll amount, in pixels
  81          */
  82         virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
  83
  84         /// redraw the screen, without using existing pixmap
  85         virtual void redraw();
  86         ///
  87         void checkAndGreyOut();
  88         ///
  89         void stopBlinkingCursor();
  90         void startBlinkingCursor();
  91
  92 protected:
  93         /// grey out (no buffer)
  94         virtual void greyOut();
  95         ///
  96         void processKeySym(LyXKeySymPtr key, key_modifier::state state);
  97         /// cause the display of the given area of the work area
  98         virtual void expose(int x, int y, int w, int h) = 0;
  99         ///
 100         void dispatch(FuncRequest const & cmd0);
 101         ///
 102         void resizeBufferView();
 103         ///
 104         void scrollBufferView(int position);
 105         /// hide the visible cursor, if it is visible
 106         void hideCursor();
 107         /// show the cursor if it is not visible
 108         void showCursor();
 109         /// toggle the cursor's visibility
 110         void toggleCursor();
 111         /// hide the cursor
 112         virtual void removeCursor() = 0;
 113         /// paint the cursor and store the background
 114         virtual void showCursor(int x, int y, int h, CursorShape shape) = 0;
 115         ///
 116         void updateScrollbar();
 117
 118         ///
 119         BufferView * buffer_view_;
 120
 121         ///
 122         LyXView & lyx_view_;
 123         ///
 124         bool greyed_out_;
 125
 126 private:
 127         ///
 128         int id_;
 129         ///
 130         void displayMessage(docstring const &);
 131         /// buffer messages signal connection
 132         boost::signals::connection message_connection_;
 133
 134         /// is the cursor currently displayed
 135         bool cursor_visible_;
 136
 137         ///
 138         Timeout cursor_timeout_;
 139 };
 140
 141 } // namespace frontend
 142 } // namespace lyx
 143
 144 #endif // BASE_WORKAREA_H