Create a grfx::Loader class and so move large chunks of code out of

[lyx.git] / src / frontends / WorkArea.h

diff --git a/src/frontends/WorkArea.h b/src/frontends/WorkArea.h
index 21b8e8425284b9fd8385e50bde54262e4c9232a0..7ecf1aad608c17657a158c26aae4bcd7e87aeebd 100644 (file)
--- a/src/frontends/WorkArea.h
+++ b/src/frontends/WorkArea.h
@@ -11,11 +11,6 @@
 #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"
@@ -27,60 +22,66 @@
 
 #include <utility>
 
-///
+class Painter;
+
+/**
+ * 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:
-       ///
+
        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 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 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;
-       ///
+       /// get the X clipboard contents
        virtual string const getClipboard() const = 0;
-       ///
+       /// fill the clipboard
        virtual void putClipboard(string const &) const = 0;
-       // Signals
-       ///
-       boost::signal0<void> workAreaExpose;
-       ///
+
+       /// 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;
-       ///
+       /// a mouse button has been pressed
        boost::signal3<void, int, int, mouse_button::state> workAreaButtonPress;
-       ///
+       /// a mouse button has been released
        boost::signal3<void, int, int, mouse_button::state> workAreaButtonRelease;
-       ///
+       /// the mouse has moved
        boost::signal3<void, int, int, mouse_button::state> workAreaMotionNotify;
-       ///
+       /// a mouse button has been double-clicked
        boost::signal3<void, int, int, mouse_button::state> workAreaDoubleClick;
-       ///
+       /// a mouse button has been triple-clicked
        boost::signal3<void, int, int, mouse_button::state> workAreaTripleClick;
        /// 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;
 };
- 
+
 #endif // WORKAREA_H