X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffrontends%2FWorkArea.h;h=b4d9f9ee199b249ae3f44841fdbebe79faf7b9fd;hb=bc20c9f382a0db9f91ac9cfc32bd70f445a45b0e;hp=091318b0d6a45a3b6a79c3e871e1a3b753df6060;hpb=f1c24d100985c6df2eb5ec390017b69c78fe49c7;p=lyx.git

diff --git a/src/frontends/WorkArea.h b/src/frontends/WorkArea.h
index 091318b0d6..b4d9f9ee19 100644
--- a/src/frontends/WorkArea.h
+++ b/src/frontends/WorkArea.h
@@ -1,98 +1,92 @@
 // -*- 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
+#ifndef BASE_WORKAREA_H
+#define BASE_WORKAREA_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "frontends/KeyModifier.h"
 
-#include "frontends/Painter.h"
-#include "frontends/mouse_state.h"
-#include "frontends/key_state.h"
-#include "frontends/LyXKeySym.h"
+namespace lyx {
 
-#include <boost/signals/signal0.hpp>
-#include <boost/signals/signal1.hpp>
-#include <boost/signals/signal2.hpp>
-#include <boost/signals/signal3.hpp>
+class BufferView;
+class KeySymbol;
 
-#include <utility>
+namespace frontend {
 
-///
-class WorkArea {
+/**
+ * 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 BaseScreen class to update the
+ * widget view of a document.
+ */
+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 ~WorkArea();
+
 	///
-	virtual void redraw() const = 0;
-  	///
-	virtual void setFocus() const = 0;
+	virtual BufferView & bufferView() = 0;
 	///
+	virtual BufferView const & bufferView() const = 0;
+
+	/// 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 width() const = 0;
+
+	/// return the height of the work area in pixels
+	virtual int height() const = 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;
+
 	///
-	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;
+	virtual void scheduleRedraw() = 0;
+
+	/// redraw the screen, without using existing pixmap
+	virtual void redraw() = 0;
 	///
-	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;
+	virtual void stopBlinkingCursor() = 0;
+	virtual void startBlinkingCursor() = 0;
+
+	/// Process Key pressed event.
+	/// This needs to be public because it is accessed externally by GuiView.
+	virtual void processKeySym(KeySymbol const & key, KeyModifier mod) = 0;
+
+	/// close this work area.
+	/// Slot for Buffer::closing signal.
+	virtual void close() = 0;
+	/// This function is called when the buffer readonly status change.
+	virtual void setReadOnly(bool) = 0;
+
+	/// Update window titles of all users.
+	virtual void updateWindowTitle() = 0;
 };
- 
-#endif // WORKAREA_H
+
+} // namespace frontend
+} // namespace lyx
+
+#endif // BASE_WORKAREA_H