// -*- C++ -*-
-/* This file is part of
- * ======================================================
+/**
+ * \file WorkArea.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * LyX, The Document Processor
+ * \author unknown
+ * \author John Levon
+ * \author Abdelrazak Younes
*
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
- *
- * ======================================================*/
+ * 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 <utility>
+namespace lyx {
-#include <sigc++/signal_system.h>
+class BufferView;
+class KeySymbol;
-#include FORMS_H_LOCATION
-#include "frontends/Painter.h"
-#include "frontends/mouse_state.h"
-#include "frontends/key_state.h"
+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(int xpos, int ypos, int width, int height);
- ///
- ~WorkArea();
- ///
- Painter & getPainter() { return painter_; }
- ///
- int workWidth() const { return work_area->w; }
- ///
- unsigned int width() const { return work_area->w + scrollbar->w; }
- //unsigned int width() const { return backgroundbox->w + 15; }
- ///
- unsigned int height() const { return work_area->h; }
- //unsigned int height() const { return backgroundbox->h; }
- ///
- int xpos() const { return work_area->x; }
- //int xpos() const { return backgroundbox->x; }
- ///
- int ypos() const { return work_area->y; }
- //int ypos() const { return backgroundbox->y; }
- ///
- void resize(int xpos, int ypos, int width, int height);
- ///
- void redraw() const {
- fl_redraw_object(work_area);
- fl_redraw_object(scrollbar);
- }
- ///
- void setFocus() const;
- ///
- Window getWin() const { return work_area->form->window; }
- ///
- bool hasFocus() const { return work_area->focus; }
- ///
- bool active() const { return work_area->active; }
- ///
- bool belowMouse() const;
- ///
- bool visible() const { return work_area->form->visible; }
- ///
- void greyOut() const;
- ///
- void setScrollbar(double pos, double length_fraction) const;
- ///
- void setScrollbarValue(double y) const {
- fl_set_scrollbar_value(scrollbar, y);
- }
- ///
- void setScrollbarBounds(double, double) const;
- ///
- void setScrollbarIncrements(double inc) const;
- ///
- double getScrollbarValue() const {
- return fl_get_scrollbar_value(scrollbar);
- }
- ///
- std::pair<float, float> const getScrollbarBounds() const {
- std::pair<float, float> p;
- fl_get_scrollbar_bounds(scrollbar, &p.first, &p.second);
- return p;
- }
- ///
- Pixmap getPixmap() const { return workareapixmap; }
- /// xforms callback
- static int work_area_handler(FL_OBJECT *, int event,
- FL_Coord, FL_Coord,
- int /*key*/, void * xev);
- /// xforms callback
- static void scroll_cb(FL_OBJECT *, long);
- /// a selection exists
- void haveSelection(bool) const;
- ///
- string const getClipboard() const;
- ///
- void putClipboard(string const &) const;
- // Signals
- ///
- SigC::Signal0<void> workAreaExpose;
- ///
- SigC::Signal1<void, double> scrollCB;
- ///
- SigC::Signal2<void, KeySym, key_modifier::state> workAreaKeyPress;
- ///
- SigC::Signal3<void, int, int, mouse_button::state> workAreaButtonPress;
- ///
- SigC::Signal3<void, int, int, mouse_button::state> workAreaButtonRelease;
- ///
- SigC::Signal3<void, int, int, mouse_button::state> workAreaMotionNotify;
- ///
- SigC::Signal0<void> workAreaFocus;
- ///
- SigC::Signal0<void> workAreaUnfocus;
- ///
- SigC::Signal0<void> workAreaEnter;
- ///
- SigC::Signal0<void> workAreaLeave;
- ///
- SigC::Signal3<void, int, int, mouse_button::state> workAreaDoubleClick;
- ///
- SigC::Signal3<void, int, int, mouse_button::state> workAreaTripleClick;
- /// emitted when an X client has requested our selection
- SigC::Signal0<void> selectionRequested;
- /// emitted when another X client has stolen our selection
- SigC::Signal0<void> selectionLost;
+ virtual ~WorkArea() {}
- /// handles SelectionRequest X Event, to fill the clipboard
- int event_cb(XEvent * xev);
-private:
- ///
- void createPixmap(int, int);
+ /// redraw the screen, without using existing pixmap
+ virtual void redraw(bool update_metrics) = 0;
- ///
- FL_OBJECT * backgroundbox;
- ///
- FL_OBJECT * work_area;
- ///
- FL_OBJECT * scrollbar;
- ///
- mutable FL_OBJECT * splash_;
- ///
- mutable FL_OBJECT * splash_text_;
- /// The pixmap overlay on the workarea
- Pixmap workareapixmap;
- ///
- Painter painter_;
- /// if we call redraw with true needed for locking-insets
- bool screen_cleared;
+ /// close this work area.
+ /// Slot for Buffer::closing signal.
+ virtual void close() = 0;
+
+ /// Update window titles of all users.
+ virtual void updateWindowTitle() = 0;
};
-#endif
+
+} // namespace frontend
+} // namespace lyx
+
+#endif // BASE_WORKAREA_H
projects / lyx.git / blobdiff