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
  19 #include "support/Timeout.h"
  20 #include "support/docstring.h"
  21
  22 #undef CursorShape
  23
  24 namespace lyx {
  25
  26 class Buffer;
  27 class BufferView;
  28 class FuncRequest;
  29 class KeySymbol;
  30
  31 namespace frontend {
  32
  33 class LyXView;
  34 class Painter;
  35
  36 /// types of cursor in work area
  37 enum CursorShape {
  38         /// normal I-beam
  39         BAR_SHAPE,
  40         /// L-shape for locked insets of a different language
  41         L_SHAPE,
  42         /// reverse L-shape for RTL text
  43         REVERSED_L_SHAPE
  44 };
  45
  46 /**
  47  * The work area class represents the widget that provides the
  48  * view onto a document. It is owned by the BufferView, and
  49  * is responsible for handing events back to its owning BufferView.
  50  * It works in concert with the BaseScreen class to update the
  51  * widget view of a document.
  52  */
  53 class WorkArea
  54 {
  55 public:
  56         ///
  57         WorkArea(Buffer & buffer, LyXView & lv);
  58
  59         virtual ~WorkArea();
  60
  61         ///
  62         void setLyXView(LyXView & lv) { lyx_view_ = &lv; }
  63
  64         ///
  65         BufferView & bufferView();
  66         ///
  67         BufferView const & bufferView() const;
  68
  69         /// \return true if has the keyboard input focus.
  70         virtual bool hasFocus() const = 0;
  71
  72         /// \return true if has this WorkArea is visible.
  73         virtual bool isVisible() const = 0;
  74
  75         /// return the width of the work area in pixels
  76         virtual int width() const = 0;
  77
  78         /// return the height of the work area in pixels
  79         virtual int height() const = 0;
  80
  81         /**
  82          * Update the scrollbar.
  83          * @param height the total document height in pixels
  84          * @param pos the current position in the document, in pixels
  85          * @param line_height the line-scroll amount, in pixels
  86          */
  87         virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
  88
  89         ///
  90         virtual void scheduleRedraw() = 0;
  91
  92         /// redraw the screen, without using existing pixmap
  93         virtual void redraw();
  94         ///
  95         void stopBlinkingCursor();
  96         void startBlinkingCursor();
  97
  98         /// Process Key pressed event.
  99         /// This needs to be public because it is accessed externally by GuiView.
 100         void processKeySym(KeySymbol const & key, key_modifier::state state);
 101
 102         /// close this work area.
 103         /// Slot for Buffer::closing signal.
 104         void close();
 105
 106 protected:
 107         /// cause the display of the given area of the work area
 108         virtual void expose(int x, int y, int w, int h) = 0;
 109         ///
 110         void dispatch(FuncRequest const & cmd0,
 111                 key_modifier::state = key_modifier::none);
 112
 113         ///
 114         void resizeBufferView();
 115         /// hide the visible cursor, if it is visible
 116         void hideCursor();
 117         /// show the cursor if it is not visible
 118         void showCursor();
 119         /// toggle the cursor's visibility
 120         void toggleCursor();
 121         /// hide the cursor
 122         virtual void removeCursor() = 0;
 123         /// paint the cursor and store the background
 124         virtual void showCursor(int x, int y, int h, CursorShape shape) = 0;
 125         ///
 126         void updateScrollbar();
 127
 128         ///
 129         BufferView * buffer_view_;
 130         ///
 131         LyXView * lyx_view_;
 132
 133 private:
 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