mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-24 18:43:37 +00:00
ec94b42f51
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@9010 a592a061-630c-0410-9148-cb99ea01b6c8
80 lines
2.2 KiB
C++
80 lines
2.2 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file WorkArea.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author unknown
|
|
* \author John Levon
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef WORKAREA_H
|
|
#define WORKAREA_H
|
|
|
|
#include "frontends/key_state.h"
|
|
|
|
#include <boost/shared_ptr.hpp>
|
|
#include <boost/signal.hpp>
|
|
|
|
|
|
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;
|
|
|
|
/**
|
|
* 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 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::signal<void()> selectionRequested;
|
|
/// emitted when another X client has stolen our selection
|
|
boost::signal<void()> selectionLost;
|
|
};
|
|
|
|
#endif // WORKAREA_H
|