Base class for an MDI main application window. More...

#include <RMainWindow.h>

Inheritance diagram for RMainWindow:

Public Member Functions
void	addBlockListener (RBlockListener *l)
	Adds a listener for block change / add / remove events.
void	addCoordinateListener (RCoordinateListener *l)
	Adds a listener for coordinate events.
void	addFocusListener (RFocusListener *l)
	Adds a listener for focus changes.
void	addLayerListener (RLayerListener *l)
	Adds a listener for layer change / add / remove events.
void	addPenListener (RPenListener *l)
	Adds a listener for pen change events.
void	addPropertyListener (RPropertyListener *l)
	Adds a listener for property events.
void	addSelectionListener (RSelectionListener *l)
	Adds a listener for selection events.
void	addSnapListener (RSnapListener *l)
	Adds a listener for snap mode changes.
void	addTransactionListener (RTransactionListener *l)
	Adds a listener for transaction events.
void	addUcsListener (RUcsListener *l)
	Adds a listener for UCS change / add / remove events.
void	addViewListener (RViewListener *l)
	Adds a listener for view change / add / remove events.
virtual void	close ()=0
	Closes the application window.
virtual void	escapeEvent ()=0
virtual RDocument *	getDocument ()=0
virtual RDocumentInterface *	getDocumentInterface ()=0
virtual int	getHeight ()=0
virtual int	getPositionX ()=0
virtual int	getPositionY ()=0
virtual int	getWidth ()=0
virtual void	move (int x, int y)=0
	Moves the application window to the given `x` / `y` position.
void	notifyBlockListeners (RDocumentInterface *documentInterface)
	Notifies all block listeners that at least one block object has changed.
void	notifyCoordinateListeners (RDocumentInterface *documentInterface)
	Notifies all coordinate listeners that the coordinate has changed to `position`.
void	notifyFocusListeners (RDocumentInterface *documentInterface)
	Notifies all focus listeners.
void	notifyLayerListeners (RDocumentInterface *documentInterface)
	Notifies all layer listeners that at least one layer object has changed.
void	notifyListeners (bool withNull=false)
void	notifyPenListeners (RDocumentInterface *documentInterface)
	Notifies all pen listeners that the current pen has changed.
void	notifyPropertyListeners (RDocument *document, bool onlyChanges=false, RS::EntityType entityTypeFilter=RS::EntityAll)
	Notifies all property listeners that the current property has changed.
void	notifyPropertyListeners (RDocument &document, REntity &entity)
	Notifies all property listeners that the current property is the given entity.
void	notifyPropertyListeners ()
	Notifies all property listeners that no properties are currently relevant.
void	notifySelectionListeners (RDocumentInterface *documentInterface)
	Notifies all selection listeners that the current selection has changed.
void	notifySnapListeners (RDocumentInterface *documentInterface)
	Notifies all snap mode listeners.
void	notifyTransactionListeners (RDocument *document)
	Notifies all transaction listeners.
void	notifyUcsListeners (RDocumentInterface *documentInterface)
	Notifies all UCS listeners that at least one UCS object has changed.
void	notifyViewListeners (RDocumentInterface *documentInterface)
	Notifies all view listeners that at least one view object has changed.
virtual void	postCloseEvent ()=0
virtual void	postSelectionChangedEvent ()=0
virtual void	postTransactionEvent (bool onlyChanges=false, RS::EntityType entityTypeFilter=RS::EntityAll)=0
void	propertyChangeEvent (RPropertyEvent &event)
virtual void	resize (int width, int height)=0
	Resizes the application window to the given `width` and `height`.
	RMainWindow ()
virtual void	setCommandPrompt (const QString &text="")=0
virtual void	setGraphicsViewCursor (const QCursor &cursor)=0
	Sets the cursor of all graphics views in all MDI children.
virtual void	setLeftMouseTip (const QString &text="")=0
virtual void	setRightMouseTip (const QString &text="")=0
void	ucsSetEvent (const QString &ucsName)
	Called immediately after the user has activated a new UCS to be used as current UCS.
virtual	~RMainWindow ()
Public Member Functions inherited from RProgressHandler
	RProgressHandler ()
virtual void	setProgress (int value)=0
virtual void	setProgressEnabled (bool on)
virtual void	setProgressEnd ()=0
virtual void	setProgressText (const QString &text="")=0
Public Member Functions inherited from RMessageHandler
virtual void	handleUserCommand (const QString &message)=0
virtual void	handleUserInfo (const QString &message)=0
virtual void	handleUserMessage (const QString &message)=0
virtual void	handleUserWarning (const QString &message, bool messageBox=false)=0

Static Public Member Functions
static RDocumentInterface *	getDocumentInterfaceStatic ()
static RMainWindow *	getMainWindow ()
static bool	hasMainWindow ()
static void	installMessageHandler ()
static void	messageHandler (QtMsgType type, const char *msg)

Protected Member Functions
virtual bool	readSettings ()
	Restores the application window settings (size, position, ...).
virtual void	writeSettings ()
	Stores the application window settings (size, position, ...).

Protected Attributes
QList< RBlockListener * >	blockListeners
QList< RCoordinateListener * >	coordinateListeners
QList< RFocusListener * >	focusListeners
QList< RLayerListener * >	layerListeners
QMutex	mutex
QList< RPenListener * >	penListeners
QList< RPropertyListener * >	propertyListeners
QList< RSelectionListener * >	selectionListeners
QList< RSnapListener * >	snapListeners
QList< RTransactionListener * >	transactionListeners
QList< RUcsListener * >	ucsListeners
QList< RViewListener * >	viewListeners
Protected Attributes inherited from RProgressHandler
bool	progressEnabled

Static Protected Attributes
static RMainWindow *	mainWindow = NULL

Detailed Description

Base class for an MDI main application window.

Scriptable:: This class is wrapped for script environments.

Constructor & Destructor Documentation

RMainWindow::RMainWindow ( )

RMainWindow::~RMainWindow ( )

virtual

Member Function Documentation

void RMainWindow::addBlockListener ( RBlockListener * l )

Adds a listener for block change / add / remove events.

void RMainWindow::addCoordinateListener ( RCoordinateListener * l )

Adds a listener for coordinate events.

This can for example be a widget that displays the current coordinate.

void RMainWindow::addFocusListener ( RFocusListener * l )

Adds a listener for focus changes.

void RMainWindow::addLayerListener ( RLayerListener * l )

Adds a listener for layer change / add / remove events.

void RMainWindow::addPenListener ( RPenListener * l )

Adds a listener for pen change events.

void RMainWindow::addPropertyListener ( RPropertyListener * l )

Adds a listener for property events.

This can for example be a widget that displays the properties of selected entities or the current action.

void RMainWindow::addSelectionListener ( RSelectionListener * l )

Adds a listener for selection events.

This can for example be a widget that displays the number of selected entities.

void RMainWindow::addSnapListener ( RSnapListener * l )

Adds a listener for snap mode changes.

This can for example be a snap status widget.

void RMainWindow::addTransactionListener ( RTransactionListener * l )

Adds a listener for transaction events.

This can for example be an undo or redo button.

void RMainWindow::addUcsListener ( RUcsListener * l )

Adds a listener for UCS change / add / remove events.

This can for example be a widget that displays all UCS objects.

void RMainWindow::addViewListener ( RViewListener * l )

Adds a listener for view change / add / remove events.

virtual void RMainWindow::close ( )

pure virtual

Closes the application window.

Implemented in RMainWindowQt.

virtual void RMainWindow::escapeEvent ( )

pure virtual

Implemented in RMainWindowQt.

virtual RDocument* RMainWindow::getDocument ( )

pure virtual

Returns:: Pointer to the document that is currently open and has the focus or NULL if no document is open.

Implemented in RMainWindowQt.

virtual RDocumentInterface* RMainWindow::getDocumentInterface ( )

pure virtual

Returns:: Pointer to the document interface of the document that is currently open and has the focus or NULL if no document is open.

Implemented in RMainWindowQt.

RDocumentInterface * RMainWindow::getDocumentInterfaceStatic ( )

static

Returns:: Pointer to the document interface of the current document (e.g. the active MDI window) or NULL if no document is open.

virtual int RMainWindow::getHeight ( )

pure virtual

Returns:: Height of the main application window.

Implemented in RMainWindowQt.

RMainWindow * RMainWindow::getMainWindow ( )

static

Reimplemented in RMainWindowQt.

virtual int RMainWindow::getPositionX ( )

pure virtual

Returns:: X position of the main application window (distance from left of screen).

Implemented in RMainWindowQt.

virtual int RMainWindow::getPositionY ( )

pure virtual

Returns:: Y position of the main application window (distance from top of screen).

Implemented in RMainWindowQt.

virtual int RMainWindow::getWidth ( )

pure virtual

Returns:: Width of the main application window.

Implemented in RMainWindowQt.

bool RMainWindow::hasMainWindow ( )

static

void RMainWindow::installMessageHandler ( )

static

void RMainWindow::messageHandler	(	QtMsgType	type,
		const char *	msg
	)

static

   \par Non-Scriptable:

This function is not available in script environments.

virtual void RMainWindow::move	(	int	x,
		int	y
	)

pure virtual

Moves the application window to the given x / y position.

Implemented in RMainWindowQt.

void RMainWindow::notifyBlockListeners ( RDocumentInterface * documentInterface )

Notifies all block listeners that at least one block object has changed.

void RMainWindow::notifyCoordinateListeners ( RDocumentInterface * documentInterface )

Notifies all coordinate listeners that the coordinate has changed to position.

void RMainWindow::notifyFocusListeners ( RDocumentInterface * documentInterface )

Notifies all focus listeners.

void RMainWindow::notifyLayerListeners ( RDocumentInterface * documentInterface )

Notifies all layer listeners that at least one layer object has changed.

void RMainWindow::notifyListeners ( bool withNull = false )

void RMainWindow::notifyPenListeners ( RDocumentInterface * documentInterface )

Notifies all pen listeners that the current pen has changed.

void RMainWindow::notifyPropertyListeners	(	RDocument *	document,
		bool	onlyChanges = `false`,
		RS::EntityType	entityTypeFilter = `RS::EntityAll`
	)

Notifies all property listeners that the current property has changed.

void RMainWindow::notifyPropertyListeners	(	RDocument &	document,
		REntity &	entity
	)

Notifies all property listeners that the current property is the given entity.

void RMainWindow::notifyPropertyListeners ( )

Notifies all property listeners that no properties are currently relevant.

void RMainWindow::notifySelectionListeners ( RDocumentInterface * documentInterface )

Notifies all selection listeners that the current selection has changed.

void RMainWindow::notifySnapListeners ( RDocumentInterface * documentInterface )

Notifies all snap mode listeners.

void RMainWindow::notifyTransactionListeners ( RDocument * document )

Notifies all transaction listeners.

void RMainWindow::notifyUcsListeners ( RDocumentInterface * documentInterface )

Notifies all UCS listeners that at least one UCS object has changed.

void RMainWindow::notifyViewListeners ( RDocumentInterface * documentInterface )

Notifies all view listeners that at least one view object has changed.

virtual void RMainWindow::postCloseEvent ( )

pure virtual

Implemented in RMainWindowQt.

virtual void RMainWindow::postSelectionChangedEvent ( )

pure virtual

Implemented in RMainWindowQt.

virtual void RMainWindow::postTransactionEvent	(	bool	onlyChanges = `false`,
		RS::EntityType	entityTypeFilter = `RS::EntityAll`
	)

pure virtual

Implemented in RMainWindowQt.

void RMainWindow::propertyChangeEvent ( RPropertyEvent & event )

bool RMainWindow::readSettings ( )

protectedvirtual

Restores the application window settings (size, position, ...).

Reimplemented in RMainWindowQt.

virtual void RMainWindow::resize	(	int	width,
		int	height
	)

pure virtual

Resizes the application window to the given width and height.

Implemented in RMainWindowQt.

virtual void RMainWindow::setCommandPrompt ( const QString & text = "" )

pure virtual

Implemented in RMainWindowQt.

virtual void RMainWindow::setGraphicsViewCursor ( const QCursor & cursor )

pure virtual

Sets the cursor of all graphics views in all MDI children.

Necessary as workaround for Qt cursor bug (cursor inconsistent with multiple widgets on top of each otehr in MDI area).

Implemented in RMainWindowQt.

virtual void RMainWindow::setLeftMouseTip ( const QString & text = "" )

pure virtual

Implemented in RMainWindowQt.

virtual void RMainWindow::setRightMouseTip ( const QString & text = "" )

pure virtual

Implemented in RMainWindowQt.

void RMainWindow::ucsSetEvent ( const QString & ucsName )

Called immediately after the user has activated a new UCS to be used as current UCS.

void RMainWindow::writeSettings ( )

protectedvirtual

Stores the application window settings (size, position, ...).

Reimplemented in RMainWindowQt.

Member Data Documentation

QList<RBlockListener*> RMainWindow::blockListeners

protected

QList<RCoordinateListener*> RMainWindow::coordinateListeners

protected

QList<RFocusListener*> RMainWindow::focusListeners

protected

QList<RLayerListener*> RMainWindow::layerListeners

protected

RMainWindow * RMainWindow::mainWindow = NULL

staticprotected

QMutex RMainWindow::mutex

protected

QList<RPenListener*> RMainWindow::penListeners

protected

QList<RPropertyListener*> RMainWindow::propertyListeners

protected

QList<RSelectionListener*> RMainWindow::selectionListeners

protected

QList<RSnapListener*> RMainWindow::snapListeners

protected

QList<RTransactionListener*> RMainWindow::transactionListeners

protected

QList<RUcsListener*> RMainWindow::ucsListeners

protected

QList<RViewListener*> RMainWindow::viewListeners

protected

The documentation for this class was generated from the following files:

src/core/RMainWindow.h
src/core/RMainWindow.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation