// -*- C++ -*-
/**
* \file WorkArea.h
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
* \author unknown
- * \author John Levon
+ * \author John Levon
+ * \author Abdelrazak Younes
*
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
*/
-#ifndef WORKAREA_H
-#define WORKAREA_H
+#ifndef BASE_WORKAREA_H
+#define BASE_WORKAREA_H
-#include "frontends/key_state.h"
-#include "frontends/LyXKeySym.h"
-#include "funcrequest.h"
+#include "frontends/KeyModifier.h"
+#include "frontends/Delegates.h"
-#include <boost/signals/signal0.hpp>
-#include <boost/signals/signal1.hpp>
-#include <boost/signals/signal2.hpp>
-#include <boost/signals/signal3.hpp>
+#include "support/Timeout.h"
+#include "support/docstring.h"
-#include <utility>
+#undef CursorShape
+namespace lyx {
+
+class Buffer;
+class BufferView;
+class FuncRequest;
+class KeySymbol;
+
+namespace frontend {
+
+class LyXView;
class Painter;
+/// types of cursor in work area
+enum CursorShape {
+ /// normal I-beam
+ BAR_SHAPE,
+ /// L-shape for locked insets of a different language
+ L_SHAPE,
+ /// reverse L-shape for RTL text
+ REVERSED_L_SHAPE
+};
+
/**
* The work area class represents the widget that provides the
* view onto a document. It is owned by the BufferView, and
* is responsible for handing events back to its owning BufferView.
- * It works in concert with the LyXScreen class to update the
+ * It works in concert with the BaseScreen class to update the
* widget view of a document.
*/
-class WorkArea {
+class WorkArea
+{
public:
+ ///
+ WorkArea(Buffer & buffer, LyXView & lv);
- WorkArea() {}
+ virtual ~WorkArea();
- virtual ~WorkArea() {}
+ ///
+ void setLyXView(LyXView & lv) { lyx_view_ = &lv; }
- /// return the painter object for this work area
- virtual Painter & getPainter() = 0;
+ ///
+ BufferView & bufferView();
+ ///
+ BufferView const & bufferView() const;
+
+ /// \return true if has the keyboard input focus.
+ virtual bool hasFocus() const = 0;
+
+ /// \return true if has this WorkArea is visible.
+ virtual bool isVisible() const = 0;
/// return the width of the work area in pixels
- virtual int workWidth() const = 0;
+ virtual int width() const = 0;
+
/// return the height of the work area in pixels
- virtual int workHeight() const = 0;
+ virtual int height() const = 0;
/**
* Update the scrollbar.
*/
virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
- // FIXME: this is an odd place to have it, but xforms needs it here ...
- /// a selection exists
- virtual void haveSelection(bool) const = 0;
- /// get the X clipboard contents
- virtual string const getClipboard() const = 0;
- /// fill the clipboard
- virtual void putClipboard(string const &) const = 0;
-
- /// work area dimensions have changed
- boost::signal0<void> workAreaResize;
- /// the scrollbar has changed
- boost::signal1<void, int> scrollDocView;
- /// a key combination has been pressed
- boost::signal2<void, LyXKeySymPtr, key_modifier::state> workAreaKeyPress;
- /// some mouse event
- boost::signal1<void, FuncRequest> dispatch;
- /// emitted when an X client has requested our selection
- boost::signal0<void> selectionRequested;
- /// emitted when another X client has stolen our selection
- boost::signal0<void> selectionLost;
+ ///
+ virtual void scheduleRedraw() = 0;
+
+ /// redraw the screen, without using existing pixmap
+ virtual void redraw();
+ ///
+ void stopBlinkingCursor();
+ void startBlinkingCursor();
+
+ /// Process Key pressed event.
+ /// This needs to be public because it is accessed externally by GuiView.
+ void processKeySym(KeySymbol const & key, KeyModifier mod);
+
+ /// close this work area.
+ /// Slot for Buffer::closing signal.
+ void close();
+
+protected:
+ /// cause the display of the given area of the work area
+ virtual void expose(int x, int y, int w, int h) = 0;
+ ///
+ void dispatch(FuncRequest const & cmd0, KeyModifier = NoModifier);
+
+ ///
+ void resizeBufferView();
+ /// hide the visible cursor, if it is visible
+ void hideCursor();
+ /// show the cursor if it is not visible
+ void showCursor();
+ /// toggle the cursor's visibility
+ void toggleCursor();
+ /// hide the cursor
+ virtual void removeCursor() = 0;
+ /// paint the cursor and store the background
+ virtual void showCursor(int x, int y, int h, CursorShape shape) = 0;
+ ///
+ void updateScrollbar();
+
+ ///
+ BufferView * buffer_view_;
+ ///
+ LyXView * lyx_view_;
+
+private:
+ /// is the cursor currently displayed
+ bool cursor_visible_;
+
+ ///
+ Timeout cursor_timeout_;
};
-#endif // WORKAREA_H
+} // namespace frontend
+} // namespace lyx
+
+#endif // BASE_WORKAREA_H
projects / lyx.git / blobdiff