// -*- C++ -*-
/**
* \file WorkArea.h
- * Copyright 1995-2002 the LyX Team
- * 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 <moz@compsoc.man.ac.uk>
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS.
*/
#ifndef WORKAREA_H
#define WORKAREA_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "frontends/Painter.h"
-#include "frontends/mouse_state.h"
#include "frontends/key_state.h"
-#include "frontends/LyXKeySym.h"
-#include <boost/signals/signal0.hpp>
-#include <boost/signals/signal1.hpp>
-#include <boost/signals/signal2.hpp>
-#include <boost/signals/signal3.hpp>
+#include <boost/shared_ptr.hpp>
+#include <boost/signal.hpp>
-#include <utility>
-///
+class Painter;
+class FuncRequest;
+class LyXKeySym;
+
+/**
+ * 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
+ * widget view of a document.
+ */
class WorkArea {
public:
- ///
+ typedef boost::shared_ptr<LyXKeySym> LyXKeySymPtr;
+
WorkArea() {}
- ///
+
virtual ~WorkArea() {}
- ///
+
+ /// return the painter object for this work area
virtual Painter & getPainter() = 0;
- ///
+
+ /// return the width of the work area in pixels
virtual int workWidth() const = 0;
- ///
+ /// return the height of the work area in pixels
virtual int workHeight() const = 0;
-
- ///
- virtual int xpos() const = 0;
- ///
- virtual int ypos() const = 0;
- ///
- virtual void resize(int xpos, int ypos, int width, int height) = 0;
- ///
- virtual void redraw() const = 0;
- ///
- virtual void setFocus() const = 0;
- ///
- virtual bool hasFocus() const = 0;
- ///
- virtual bool visible() const = 0;
- ///
- virtual void greyOut() const = 0;
- ///
- virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
-
+
+ /**
+ * Update the scrollbar.
+ * @param height the total document height in pixels
+ * @param pos the current position in the document, in pixels
+ * @param line_height the line-scroll amount, in pixels
+ */
+ 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;
- ///
- virtual string const getClipboard() const = 0;
- ///
- virtual void putClipboard(string const &) const = 0;
- // Signals
- ///
- boost::signal0<void> workAreaExpose;
- ///
- boost::signal1<void, int> scrollDocView;
- ///
- boost::signal2<void, LyXKeySymPtr, key_modifier::state> workAreaKeyPress;
- ///
- boost::signal3<void, int, int, mouse_button::state> workAreaButtonPress;
- ///
- boost::signal3<void, int, int, mouse_button::state> workAreaButtonRelease;
- ///
- boost::signal3<void, int, int, mouse_button::state> workAreaMotionNotify;
- ///
- boost::signal0<void> workAreaFocus;
- ///
- boost::signal0<void> workAreaUnfocus;
- ///
- boost::signal3<void, int, int, mouse_button::state> workAreaDoubleClick;
- ///
- boost::signal3<void, int, int, mouse_button::state> workAreaTripleClick;
+ /// get the X clipboard contents
+ virtual std::string const getClipboard() const = 0;
+ /// fill the clipboard
+ virtual void putClipboard(std::string const &) const = 0;
+
+ /// work area dimensions have changed
+ boost::signal<void()> workAreaResize;
+ /// the scrollbar has changed
+ boost::signal<void(int)> scrollDocView;
+ /// a key combination has been pressed
+ boost::signal<void(LyXKeySymPtr, key_modifier::state)> workAreaKeyPress;
+ /// some mouse event
+ boost::signal<void(FuncRequest)> dispatch;
/// emitted when an X client has requested our selection
- boost::signal0<void> selectionRequested;
+ boost::signal<void()> selectionRequested;
/// emitted when another X client has stolen our selection
- boost::signal0<void> selectionLost;
+ boost::signal<void()> selectionLost;
};
-
+
#endif // WORKAREA_H