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/KeySymbol.h"
  19
  20 #include "support/Timeout.h"
  21 #include "support/docstring.h"
  22
  23 #include <boost/signals/trackable.hpp>
  24
  25 #undef CursorShape
  26
  27 namespace lyx {
  28 class Buffer;
  29 class BufferView;
  30 class FuncRequest;
  31
  32 namespace frontend {
  33
  34 class LyXView;
  35 class Painter;
  36
  37 /// types of cursor in work area
  38 enum CursorShape {
  39         /// normal I-beam
  40         BAR_SHAPE,
  41         /// L-shape for locked insets of a different language
  42         L_SHAPE,
  43         /// reverse L-shape for RTL text
  44         REVERSED_L_SHAPE
  45 };
  46
  47 /**
  48  * The work area class represents the widget that provides the
  49  * view onto a document. It is owned by the BufferView, and
  50  * is responsible for handing events back to its owning BufferView.
  51  * It works in concert with the BaseScreen class to update the
  52  * widget view of a document.
  53  */
  54 class WorkArea : public boost::signals::trackable {
  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(KeySymbolPtr key, key_modifier::state state);
 101
 102 protected:
 103         /// cause the display of the given area of the work area
 104         virtual void expose(int x, int y, int w, int h) = 0;
 105         ///
 106         void dispatch(FuncRequest const & cmd0,
 107                 key_modifier::state = key_modifier::none);
 108
 109         /// close this work area.
 110         /// Slot for Buffer::closing boost signal.
 111         void close();
 112         ///
 113         void resizeBufferView();
 114         /// hide the visible cursor, if it is visible
 115         void hideCursor();
 116         /// show the cursor if it is not visible
 117         void showCursor();
 118         /// toggle the cursor's visibility
 119         void toggleCursor();
 120         /// hide the cursor
 121         virtual void removeCursor() = 0;
 122         /// paint the cursor and store the background
 123         virtual void showCursor(int x, int y, int h, CursorShape shape) = 0;
 124         ///
 125         void updateScrollbar();
 126
 127         ///
 128         BufferView * buffer_view_;
 129         ///
 130         LyXView * lyx_view_;
 131
 132 private:
 133         /// is the cursor currently displayed
 134         bool cursor_visible_;
 135
 136         ///
 137         Timeout cursor_timeout_;
 138
 139         /// buffer changed signal connection
 140         boost::signals::connection bufferChangedConnection_;
 141         /// buffer closing signal connection
 142         boost::signals::connection bufferClosingConnection_;
 143 };
 144
 145 } // namespace frontend
 146 } // namespace lyx
 147
 148 #endif // BASE_WORKAREA_H