RMainWindowQt

Class in GUI Module
Header: #include <src/gui/RMainWindowQt.h>
Inherits: QMainWindow, RMainWindow

Description

Base class for a Qt based MDI main application window.

Scriptable: This class is available in script environments.

Public Functions

	RMainWindowQt(QWidget *parent=0, bool hasMdiArea=true)
virtual	~RMainWindowQt()
virtual void	cancelProgress()
void	clearKeyLog()
virtual QMenu *	createPopupMenu()
virtual void	disable()
virtual void	enable()
virtual void	escapeEvent()
bool	focusNextPrevWidget(bool next, QWidget *from=NULL) Moves the keyboard focus to the next (or previous) widget in the focus chain of the main window (standard Tab / Shift+Tab behavior).
virtual QWidget *	getChildWidget(const QString &name)
QList< QDockWidget * >	getDockWidgets()
virtual RDocument *	getDocument()
virtual RDocumentInterface *	getDocumentInterface()
virtual int	getHeight()
QString	getKeyLog() const
RMdiArea *	getMdiArea()
RMdiChildQt *	getMdiChild()
virtual int	getPositionX()
virtual int	getPositionY()
QTabBar *	getTabBar()
QList< QToolBar * >	getToolBars()
virtual int	getWidth()
void	handleEnterKey(QObject *obj)
bool	handleTabKey(QObject *obj, bool backTab=false)
virtual void	handleUserCommand(const QString &message, bool escape=true)
virtual void	handleUserInfo(const QString &message, bool escape=true)
virtual void	handleUserMessage(const QString &message, bool escape=true)
virtual void	handleUserWarning(const QString &message, bool messageBox=false, bool escape=true)
bool	isFocusReachable(QWidget *w) const
virtual void	move(int x, int y) Moves the application window to the given x / y position.
void	notifyDockWidgetClosed(QWidget *dockWidget) Part 2 of workaround for Qt bug: dock widget closes before close dialog is shown dock widget state not persistent between sessions dock widget closes if user cancels close dialog.
virtual void	postCloseEvent()
virtual void	postPropertyEvent(RPropertyTypeId propertyTypeId, const QVariant &value, RS::EntityType entityTypeFilter=RS::EntityAll)
virtual void	postSelectionChangedEvent()
virtual void	postTransactionEvent(RTransaction &t, bool onlyChanges=false, RS::EntityType entityTypeFilter=RS::EntityAll)
virtual bool	readSettings() Restores the application window settings (size, position, …).
virtual void	reloadXRefs(RDocumentInterface *di, const QSet< QString > &dirtyXRefPaths)
virtual void	requestResourceBlockEditing(RObject::Id entityId, const RVector &pos)
virtual void	resize(int width, int height) Resizes the application window to the given width and height.
virtual void	setCommandPrompt(const QString &text=“”)
virtual void	setGraphicsViewCursor(const QCursor &cursor) Sets the cursor of all graphics views in all MDI children.
virtual void	setLeftMouseTip(const QString &text=“”)
virtual void	setProgress(int value)
virtual void	setProgressEnd()
virtual void	setProgressText(const QString &text=“”)
virtual void	setRightMouseTip(const QString &text=“”)
virtual void	showContextMenu(RObject::Id entityId, const RVector &pos)
virtual void	writeSettings() Stores the application window settings (size, position, …).

Static Public Functions

static RMainWindowQt *	getMainWindow()

Public Slots

void	currentTabChanged(int index) Part of the workaround for QMdiArea bug with events filtering through all stacked windows:
void	initGuiActions()
void	notifyListenersSlot(QMdiSubWindow *mdiChild)
void	quit()
void	subWindowActivated(QMdiSubWindow *sw)
void	suspendAndResume(QMdiSubWindow *mdiChild)
void	updateGuiActions(QMdiSubWindow *mdiChild=NULL)
void	updateScenes(QMdiSubWindow *mdiChild)

Protected Functions

virtual void	closeEvent(QCloseEvent *e)
virtual void	dragEnterEvent(QDragEnterEvent *event)
virtual void	dropEvent(QDropEvent *event)
virtual bool	event(QEvent *e)
virtual bool	focusNextPrevChild(bool next) Standard Tab / Shift+Tab handling of the main window, using focusNextPrevWidget to skip widgets which are not reachable (e.g.
void	restoreClosedDockWidgets() Shows all dock widgets again which were closed by Qt as part of the current (canceled) close operation.

Static Protected Functions

static bool	isCursorKeyReservedForScreenReader(QKeyEvent *ke)
static bool	isStaleAutoRepeatKeyEvent(QKeyEvent *ke)

Protected Attributes

QList< int >	closedDockWidgetPositionsX
QList< QPointer< QWidget > >	closedDockWidgets
bool	closingDown
int	disableCounter
QByteArray	dockWidgetState
bool	dockWidgetStateValid
QString	keyLog
QElapsedTimer	keyTimeOut
RMdiArea *	mdiArea

Protected Slots

void	forgetDockWidgetState() Discards the dock widget state remembered by notifyDockWidgetClosed().

Signals

void	closeRequested()
void	commandPrompt(const QString &text) Emitted when the command prompt is requested to change.
void	contextMenu(int entityId, const RVector &pos) Emitted when a context menu is requested on top of the given entity.
void	dragEnter(QDragEnterEvent *event)
void	drop(QDropEvent *event)
void	editResourceBlock(int entityId, const RVector &pos) Emitted when resource block editing is requested (double-click, context menu, …):
void	enterPressed()
void	escape()
void	leftMouseTip(const QString &message) Emitted when the left mouse button tip is requested to change.
void	progress(int value)
void	progressCanceled()
void	progressEnd()
void	progressText(const QString &label)
void	reloadXRefsSignal(RDocumentInterface *di, const QStringList &dirtyXRefPaths)
void	resumedTab(RMdiChildQt *mdiChild)
void	rightMouseTip(const QString &message) Emitted when the right mouse button tip is requested to change.
void	toolBarContextMenu(QMenu *menu)
void	userCommand(const QString &message, bool escape)
void	userInfo(const QString &message, bool escape)
void	userMessage(const QString &message, bool escape)
void	userWarning(const QString &message, bool messageBox, bool escape)

Member Documentation

RMainWindowQt

RMainWindowQt::RMainWindowQt(QWidget *parent=0, bool hasMdiArea=true)

All rights reserved.

This file is part of the QCAD project.

QCAD is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

QCAD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with QCAD.

~RMainWindowQt

virtual RMainWindowQt::~RMainWindowQt()

virtual

cancelProgress

virtual void RMainWindowQt::cancelProgress()

virtual

clearKeyLog

void RMainWindowQt::clearKeyLog()

createPopupMenu

virtual QMenu * RMainWindowQt::createPopupMenu()

virtual

disable

virtual void RMainWindowQt::disable()

virtual

Reimplemented from disable.

enable

virtual void RMainWindowQt::enable()

virtual

Reimplemented from enable.

escapeEvent

virtual void RMainWindowQt::escapeEvent()

virtual

Reimplemented from escapeEvent.

focusNextPrevWidget

bool RMainWindowQt::focusNextPrevWidget(bool next, QWidget *from=NULL)

Moves the keyboard focus to the next (or previous) widget in the focus chain of the main window (standard Tab / Shift+Tab behavior).

Moves the keyboard focus to the next (or previous) widget in the focus chain of this main window, starting at widget from (default: current focus widget).

Used by widgets that handle Tab themselves (graphics view, options tool bar) to continue the focus chain when they cannot handle it.

This is the standard Tab / Shift+Tab behavior, used by widgets which handle Tab themselves (graphics view, options tool bar) to continue the focus chain when they cannot handle it.

Unlike QWidget::focusNextPrevChild, this skips ancestors of from: QMdiSubWindow is focusable but immediately passes the focus back to its child widget (the graphics view), which would trap the focus.

getChildWidget

virtual QWidget * RMainWindowQt::getChildWidget(const QString &name)

virtual

Reimplemented from getChildWidget.

getDockWidgets

QList< QDockWidget * > RMainWindowQt::getDockWidgets()

inline

getDocument

virtual RDocument * RMainWindowQt::getDocument()

virtual

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

Reimplemented from getDocument.

getDocumentInterface

virtual RDocumentInterface * RMainWindowQt::getDocumentInterface()

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.

Reimplemented from getDocumentInterface.

getHeight

virtual int RMainWindowQt::getHeight()

virtual

Returns: Height of the main application window.

Reimplemented from getHeight.

getKeyLog

QString RMainWindowQt::getKeyLog() const

inline const

getMdiArea

RMdiArea * RMainWindowQt::getMdiArea()

getMdiChild

RMdiChildQt * RMainWindowQt::getMdiChild()

getPositionX

virtual int RMainWindowQt::getPositionX()

virtual

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

Reimplemented from getPositionX.

getPositionY

virtual int RMainWindowQt::getPositionY()

virtual

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

Reimplemented from getPositionY.

getTabBar

QTabBar * RMainWindowQt::getTabBar()

getToolBars

QList< QToolBar * > RMainWindowQt::getToolBars()

inline

getWidth

virtual int RMainWindowQt::getWidth()

virtual

Returns: Width of the main application window.

Reimplemented from getWidth.

handleEnterKey

void RMainWindowQt::handleEnterKey(QObject *obj)

inline

handleTabKey

bool RMainWindowQt::handleTabKey(QObject *obj, bool backTab=false)

inline

handleUserCommand

virtual void RMainWindowQt::handleUserCommand(const QString &message, bool escape=true)

virtual

Reimplemented from handleUserCommand.

handleUserInfo

virtual void RMainWindowQt::handleUserInfo(const QString &message, bool escape=true)

virtual

Reimplemented from handleUserInfo.

handleUserMessage

virtual void RMainWindowQt::handleUserMessage(const QString &message, bool escape=true)

virtual

Reimplemented from handleUserMessage.

handleUserWarning

virtual void RMainWindowQt::handleUserWarning(const QString &message, bool messageBox=false, bool escape=true)

virtual

Reimplemented from handleUserWarning.

isFocusReachable

bool RMainWindowQt::isFocusReachable(QWidget *w) const

const

Returns: True if the given widget can be reached with the keyboard (Tab): enabled, visible and not covered, e.g. by another dock widget in the same tab stack (such dock widgets report isVisible() true but have an empty visible region). Widgets in scroll areas are checked at the level of the scroll area, since they might be scrolled out of view temporarily.

move

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

virtual

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

Reimplemented from move.

notifyDockWidgetClosed

void RMainWindowQt::notifyDockWidgetClosed(QWidget *dockWidget)

Part 2 of workaround for Qt bug: dock widget closes before close dialog is shown dock widget state not persistent between sessions dock widget closes if user cancels close dialog.

Called by RDockWidget whenever a dock widget receives a close event, i.e. before the dock widget is hidden by Qt.

When the application is terminated, Qt closes all top level widgets (QApplicationPrivate::tryCloseAllWidgetWindows). Floating dock widgets are top level widgets, so they are closed (and hidden) as well. The order in which this happens is the order of QApplication::topLevelWidgets(), which is based on an unordered set and therefore arbitrary: if a floating dock widget happens to come before the main window, it is already hidden when closeEvent() / writeSettings() is called and saveState() would store it as hidden for the next session. Docked (non-floating) dock widgets are not top level widgets and are never affected, which is why only floating dock widgets lose their visibility (and only sometimes).

We therefore remember the dock widget state of the main window before the first dock widget of a close operation is hidden. The remembered state is discarded again as soon as control returns to the event loop: if the dock widget was closed by the user (and not as part of closing the main window), closeEvent() is never called and the state must not be reused.

postCloseEvent

virtual void RMainWindowQt::postCloseEvent()

virtual

Reimplemented from postCloseEvent.

postPropertyEvent

virtual void RMainWindowQt::postPropertyEvent(RPropertyTypeId propertyTypeId, const QVariant &value, RS::EntityType entityTypeFilter=RS::EntityAll)

virtual

Reimplemented from postPropertyEvent.

postSelectionChangedEvent

virtual void RMainWindowQt::postSelectionChangedEvent()

virtual

Reimplemented from postSelectionChangedEvent.

postTransactionEvent

virtual void RMainWindowQt::postTransactionEvent(RTransaction &t, bool onlyChanges=false, RS::EntityType entityTypeFilter=RS::EntityAll)

virtual

Reimplemented from postTransactionEvent.

readSettings

virtual bool RMainWindowQt::readSettings()

virtual

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

Reimplemented from readSettings.

reloadXRefs

virtual void RMainWindowQt::reloadXRefs(RDocumentInterface *di, const QSet< QString > &dirtyXRefPaths)

virtual

Reimplemented from reloadXRefs.

requestResourceBlockEditing

virtual void RMainWindowQt::requestResourceBlockEditing(RObject::Id entityId, const RVector &pos)

virtual

resize

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

virtual

Resizes the application window to the given width and height.

Reimplemented from resize.

setCommandPrompt

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

virtual

Reimplemented from setCommandPrompt.

setGraphicsViewCursor

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

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 other in MDI area).

Reimplemented from setGraphicsViewCursor.

setLeftMouseTip

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

virtual

Reimplemented from setLeftMouseTip.

setProgress

virtual void RMainWindowQt::setProgress(int value)

virtual

Reimplemented from setProgress.

setProgressEnd

virtual void RMainWindowQt::setProgressEnd()

virtual

Reimplemented from setProgressEnd.

setProgressText

virtual void RMainWindowQt::setProgressText(const QString &text="")

virtual

Reimplemented from setProgressText.

setRightMouseTip

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

virtual

Reimplemented from setRightMouseTip.

showContextMenu

virtual void RMainWindowQt::showContextMenu(RObject::Id entityId, const RVector &pos)

virtual

writeSettings

virtual void RMainWindowQt::writeSettings()

virtual

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

Reimplemented from writeSettings.

getMainWindow

static RMainWindowQt * RMainWindowQt::getMainWindow()

static

currentTabChanged

void RMainWindowQt::currentTabChanged(int index)

Part of the workaround for QMdiArea bug with events filtering through all stacked windows:

initGuiActions

void RMainWindowQt::initGuiActions()

notifyListenersSlot

void RMainWindowQt::notifyListenersSlot(QMdiSubWindow *mdiChild)

quit

void RMainWindowQt::quit()

subWindowActivated

void RMainWindowQt::subWindowActivated(QMdiSubWindow *sw)

suspendAndResume

void RMainWindowQt::suspendAndResume(QMdiSubWindow *mdiChild)

updateGuiActions

void RMainWindowQt::updateGuiActions(QMdiSubWindow *mdiChild=NULL)

updateScenes

void RMainWindowQt::updateScenes(QMdiSubWindow *mdiChild)

closeEvent

virtual void RMainWindowQt::closeEvent(QCloseEvent *e)

virtual protected

dragEnterEvent

virtual void RMainWindowQt::dragEnterEvent(QDragEnterEvent *event)

virtual protected

dropEvent

virtual void RMainWindowQt::dropEvent(QDropEvent *event)

virtual protected

event

virtual bool RMainWindowQt::event(QEvent *e)

virtual protected

focusNextPrevChild

virtual bool RMainWindowQt::focusNextPrevChild(bool next)

virtual protected

Standard Tab / Shift+Tab handling of the main window, using focusNextPrevWidget to skip widgets which are not reachable (e.g.

in dock widgets not on top of their tab stack).

restoreClosedDockWidgets

void RMainWindowQt::restoreClosedDockWidgets()

protected

Shows all dock widgets again which were closed by Qt as part of the current (canceled) close operation.

isCursorKeyReservedForScreenReader

static bool RMainWindowQt::isCursorKeyReservedForScreenReader(QKeyEvent *ke)

static protected

Non-Scriptable: This function is not available in script environments.

Returns: True if the given key event is an auto repeated cursor key event that has been waiting in the event queue for longer than the configured threshold (Keyboard/StaleAutoRepeatThreshold, ms).

Auto repeated key events are queued by the system at the key repeat rate. If handling one event takes longer than the repeat interval (e.g. moving a large selection with the cursor keys), the queue fills up and the queued events are still processed after the key has been released. Dropping stale auto repeat events keeps the reaction to the cursor keys smooth and stops moving the selection when the key is released.

The event time stamp and the wall clock use different bases, the base offset is calibrated with the smallest observed delay (an event that was processed immediately) and re-calibrated on every deliberate key press.

Returns: True if the given key event is a cursor key event which has to be left to a screen reader (see RSettings::isScreenReaderActive).

isStaleAutoRepeatKeyEvent

static bool RMainWindowQt::isStaleAutoRepeatKeyEvent(QKeyEvent *ke)

static protected

Non-Scriptable: This function is not available in script environments.

closedDockWidgetPositionsX

QList<int> RMainWindowQt::closedDockWidgetPositionsX

protected

closedDockWidgets

QList<QPointer<QWidget> > RMainWindowQt::closedDockWidgets

protected

closingDown

bool RMainWindowQt::closingDown

protected

disableCounter

int RMainWindowQt::disableCounter

protected

dockWidgetState

QByteArray RMainWindowQt::dockWidgetState

protected

dockWidgetStateValid

bool RMainWindowQt::dockWidgetStateValid

protected

keyLog

QString RMainWindowQt::keyLog

protected

keyTimeOut

QElapsedTimer RMainWindowQt::keyTimeOut

protected

mdiArea

RMdiArea* RMainWindowQt::mdiArea

protected

forgetDockWidgetState

void RMainWindowQt::forgetDockWidgetState()

protected

Discards the dock widget state remembered by notifyDockWidgetClosed().

closeRequested

void RMainWindowQt::closeRequested()

commandPrompt

void RMainWindowQt::commandPrompt(const QString &text)

Emitted when the command prompt is requested to change.

contextMenu

void RMainWindowQt::contextMenu(int entityId, const RVector &pos)

Emitted when a context menu is requested on top of the given entity.

dragEnter

void RMainWindowQt::dragEnter(QDragEnterEvent *event)

drop

void RMainWindowQt::drop(QDropEvent *event)

editResourceBlock

void RMainWindowQt::editResourceBlock(int entityId, const RVector &pos)

Emitted when resource block editing is requested (double-click, context menu, …):

enterPressed

void RMainWindowQt::enterPressed()

escape

void RMainWindowQt::escape()

leftMouseTip

void RMainWindowQt::leftMouseTip(const QString &message)

Emitted when the left mouse button tip is requested to change.

progress

void RMainWindowQt::progress(int value)

progressCanceled

void RMainWindowQt::progressCanceled()

progressEnd

void RMainWindowQt::progressEnd()

progressText

void RMainWindowQt::progressText(const QString &label)

reloadXRefsSignal

void RMainWindowQt::reloadXRefsSignal(RDocumentInterface *di, const QStringList &dirtyXRefPaths)

resumedTab

void RMainWindowQt::resumedTab(RMdiChildQt *mdiChild)

rightMouseTip

void RMainWindowQt::rightMouseTip(const QString &message)

Emitted when the right mouse button tip is requested to change.

toolBarContextMenu

void RMainWindowQt::toolBarContextMenu(QMenu *menu)

userCommand

void RMainWindowQt::userCommand(const QString &message, bool escape)

userInfo

void RMainWindowQt::userInfo(const QString &message, bool escape)

userMessage

void RMainWindowQt::userMessage(const QString &message, bool escape)

userWarning

void RMainWindowQt::userWarning(const QString &message, bool messageBox, bool escape)