// -*- 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
+ * \author Abdelrazak Younes
+ *
+ * Full author contact details are available in file CREDITS.
*/
-#ifndef WORKAREA_H
-#define WORKAREA_H
-
-#ifdef __GNUG__
-#pragma interface
-#endif
+#ifndef BASE_WORKAREA_H
+#define BASE_WORKAREA_H
-#include "frontends/Painter.h"
-#include "frontends/mouse_state.h"
-#include "frontends/key_state.h"
-#include "frontends/LyXKeySym.h"
+#include "frontends/KeyModifier.h"
-#include <boost/signals/signal0.hpp>
-#include <boost/signals/signal1.hpp>
-#include <boost/signals/signal2.hpp>
-#include <boost/signals/signal3.hpp>
+namespace lyx {
-#include <utility>
+namespace frontend {
-///
-class WorkArea {
+/**
+ * The work area class represents the widget that provides the view
+ * onto a document. It owns the BufferView, and is responsible for
+ * handing events back to its BufferView.
+ */
+class WorkArea
+{
public:
- ///
- WorkArea() {}
///
virtual ~WorkArea() {}
- ///
- virtual Painter & getPainter() = 0;
- ///
- virtual int workWidth() const = 0;
- ///
- virtual int workHeight() const = 0;
- ///
- virtual unsigned int width() 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;
-
- /// 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;
- /// 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;
+
+ /// Update metrics if needed and schedule a paint event
+ virtual void scheduleRedraw(bool update_metrics) = 0;
+
+ /// close this work area.
+ /// Slot for Buffer::closing signal.
+ virtual void close() = 0;
+
+ /// Update window titles of all users.
+ virtual void updateWindowTitle() = 0;
};
-
-#endif // WORKAREA_H
+
+} // namespace frontend
+} // namespace lyx
+
+#endif // BASE_WORKAREA_H