The MainWindow class provides a main window with menu bar, toolbars, dockable windows, a status bar and mainly a workspace for the MDI windows. More...

#include <MainWindow.h>

Public Types
enum	ConfirmSaveResult { Cancel = 0 , Save , SaveAll , Discard , DiscardAll }

Public Member Functions
MDIView *	activeWindow () const
	Returns the active MDI window or 0 if there is none. More...

void	addWindow (MDIView *view)
	Adds an MDI window view to the main window's workspace and adds a new tab to the tab bar. More...

void	appendRecentFile (const QString &filename)
	MRU: Appends file to the list of recent files. More...

void	appendRecentMacro (const QString &filename)
	MRU: Appends macro to the list of recent macros. More...

QMenu *	createPopupMenu ()
	Returns true that the context menu contains the 'Customize...' menu item. More...

bool	eventFilter (QObject o, QEvent e)
	Filters events if this object has been installed as an event filter for the watched object. More...

	MainWindow (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::Window)
	Constructs an empty main window. More...

void	removeWindow (MDIView *view, bool close=true)
	Removes an MDI window from the main window's workspace and its associated tab without deleting the widget. More...

void	setActiveWindow (MDIView *view)
	Sets the active window to view. More...

void	tabChanged (MDIView *view)
	Can be called after the caption of an MDIView has changed to update the tab's caption. More...

QList< QWidget * >	windows (QMdiArea::WindowOrder order=QMdiArea::CreationOrder) const
	Returns a list of all MDI windows in the worpspace. More...

	~MainWindow ()
	Destroys the object and frees any allocated resources. More...

Layout Methods
void	loadWindowSettings ()
	Loads the main window settings. More...

void	saveWindowSettings ()
	Saves the main window settings. More...

MIME data handling
enum	StatusType { }

QMimeData *	createMimeDataFromSelection () const
	Create mime data from selected objects. More...

bool	canInsertFromMimeData (const QMimeData *source) const
	Check if mime data contains object data. More...

void	insertFromMimeData (const QMimeData *source)
	Insert the objects into the active document. More...

void	loadUrls (App::Document *, const QList< QUrl > &)
	Load files from the given URLs into the given document. More...

void	setUrlHandler (const QString &scheme, UrlHandler *handler)
	Sets the handler for the given scheme. More...

void	unsetUrlHandler (const QString &scheme)
	Removes a previously set URL handler for the specified scheme. More...

void	updateActions (bool delay=false)

void	showStatus (int type, const QString &message)

void	updateEditorActions ()
	Updates the standard actions of a text editor such as Cut, Copy, Paste, Undo and Redo. More...

void	setPaneText (int i, QString text)
	Sets text to the pane in the status bar. More...

void	arrangeIcons ()
	Arranges all child windows in a horizontal tile pattern. More...

void	tile ()
	Arranges all child windows in a tile pattern. More...

void	cascade ()
	Arranges all the child windows in a cascade pattern. More...

void	closeActiveWindow ()
	Closes the child window that is currently active. More...

bool	closeAllDocuments (bool close=true)
	Closes all document window. More...

int	confirmSave (const char docName, QWidget parent=nullptr, bool addCheckBox=false)
	Pop up a message box asking for saving document. More...

void	activateNextWindow ()
	Activates the next window in the child window chain. More...

void	activatePreviousWindow ()
	Activates the previous window in the child window chain. More...

void	activateWorkbench (const QString &)
	Just emits the workbenchActivated() signal to notify all receivers. More...

void	whatsThis ()
	Starts the what's this mode. More...

void	switchToTopLevelMode ()

void	switchToDockedMode ()

void	statusMessageChanged ()

void	showMessage (const QString &message, int timeout=0)

void	closeEvent (QCloseEvent *e)
	This method checks if the main window can be closed by checking all open documents and views. More...

void	showEvent (QShowEvent *e)

void	hideEvent (QHideEvent *e)

void	timerEvent (QTimerEvent *)

void	customEvent (QEvent *e)

bool	event (QEvent *e)

void	dropEvent (QDropEvent *e)
	Try to interpret dropped elements. More...

void	dragEnterEvent (QDragEnterEvent *e)
	Checks if a mime source object can be interpreted. More...

void	changeEvent (QEvent *e)
	This method is called from the Qt framework automatically whenever a QTranslator object has been installed. More...

void	timeEvent ()

void	windowStateChanged (MDIView *)

void	workbenchActivated (const QString &)

void	mainWindowClosed ()

Splasher and access methods
void	startSplasher (void)
	Starts the splasher at startup. More...

void	stopSplasher (void)
	Stops the splasher after startup. More...

QPixmap	aboutImage () const

QPixmap	splashImage () const

void	showDocumentation (const QString &help)
	Shows the online documentation. More...

static MainWindow *	getInstance ()
	Gets the one and only instance. More...

Detailed Description

The MainWindow class provides a main window with menu bar, toolbars, dockable windows, a status bar and mainly a workspace for the MDI windows.

Author: Werner Mayer

Member Enumeration Documentation

◆ ConfirmSaveResult

enum Gui::MainWindow::ConfirmSaveResult

Enumerator
Cancel
Save
SaveAll
Discard
DiscardAll

◆ StatusType

enum Gui::MainWindow::StatusType

Enumerator
Err
Wrn
Pane
Msg
Log
Tmp

Constructor & Destructor Documentation

◆ MainWindow()

MainWindow::MainWindow	(	QWidget *	parent = `nullptr`,
		Qt::WindowFlags	f = `Qt::Window`
	)

Constructs an empty main window.

For default parent is 0, as there usually is no toplevel window there.

References Gui::MainWindowP::actionLabel, Gui::MainWindowP::actionTimer, Gui::MainWindowP::activeView, Gui::MainWindowP::activityTimer, Gui::MainWindowP::assistant, Gui::BitmapFactory(), App::Application::Config(), draftgeoutils.intersections::connect(), App::GetApplication(), ParameterGrp::GetBool(), ParameterGrp::GetGroup(), Gui::ToolBoxManager::getInstance(), Gui::SequencerBar::getProgressBar(), App::Application::GetUserParameter(), ParameterGrp::HasGroup(), Gui::DockWindowManager::instance(), Gui::SequencerBar::instance(), Gui::MainWindowP::mdiArea, draftutils.translate::QT_TRANSLATE_NOOP, Gui::DockWindowManager::registerDockWindow(), Gui::ToolBoxManager::setToolBox(), Gui::MainWindowP::sizeLabel, Gui::MainWindowP::splashscreen, Gui::MainWindowP::status, statusMessageChanged(), Gui::MainWindowP::statusTimer, tabChanged(), updateEditorActions(), Gui::MainWindowP::whatsthis, and Gui::MainWindowP::windowMapper.

◆ ~MainWindow()

MainWindow::~MainWindow ( )

Destroys the object and frees any allocated resources.

References Gui::MainWindowP::status.

Member Function Documentation

◆ aboutImage()

QPixmap MainWindow::aboutImage ( ) const

References Gui::BitmapFactory(), App::Application::Config(), App::Application::getHomePath(), and Gui::BitmapFactoryInst::pixmap().

Referenced by Gui::Dialog::AboutDialog::AboutDialog().

◆ activateNextWindow

void MainWindow::activateNextWindow ( )

slot

Activates the next window in the child window chain.

References Gui::MainWindowP::mdiArea.

Referenced by StdCmdActivateNextWindow::activated().

◆ activatePreviousWindow

void MainWindow::activatePreviousWindow ( )

slot

Activates the previous window in the child window chain.

References Gui::MainWindowP::mdiArea.

Referenced by StdCmdActivatePrevWindow::activated().

◆ activateWorkbench

void MainWindow::activateWorkbench ( const QString & name )

slot

Just emits the workbenchActivated() signal to notify all receivers.

= nullptr

References App::GetApplication(), ParameterGrp::GetBool(), App::Application::GetParameterGroupByPath(), Gui::MainWindowP::mdiArea, updateActions(), and workbenchActivated().

Referenced by Gui::Application::activateWorkbench().

◆ activeWindow()

MDIView * MainWindow::activeWindow ( void ) const

Returns the active MDI window or 0 if there is none.

References Gui::MainWindowP::activeView.

Referenced by SketcherGui::DrawSketchHandler::activate(), StdCmdPrint::activated(), StdCmdPrintPreview::activated(), StdCmdPrintPdf::activated(), StdCmdEdit::activated(), CmdTestMDI1::activated(), CmdTestMDI2::activated(), CmdTestMDI3::activated(), StdMainFullscreen::activated(), StdViewDockUndockFullscreen::activated(), StdCmdToggleNavigation::activated(), changeEvent(), Gui::SoFCColorGradient::customize(), SketcherGui::DrawSketchHandler::devicePixelRatio(), Gui::Dialog::DlgActivateWindowImp::DlgActivateWindowImp(), Gui::Document::getActiveView(), CmdTestMDI1::isActive(), CmdTestMDI2::isActive(), CmdTestMDI3::isActive(), StdViewDock::isActive(), StdViewUndock::isActive(), StdViewFullscreen::isActive(), StdViewDockUndockFullscreen::isActive(), StdCmdToggleNavigation::isActive(), StdCmdMeasureDistance::isActive(), StdCmdTextureMapping::isActive(), Gui::Dialog::UndoDialog::onFetchInfo(), Gui::Dialog::RedoDialog::onFetchInfo(), TechDrawGui::ViewProviderPage::removeMDIView(), Gui::Application::sendHasMsgToActiveView(), Gui::Application::sendHasMsgToFocusView(), Gui::Application::sendMsgToActiveView(), Gui::Application::sendMsgToFocusView(), Gui::Document::setActiveWindow(), SpreadsheetGui::WorkbenchHelper::setBackgroundColor(), SketcherGui::DrawSketchHandler::setCursor(), SpreadsheetGui::WorkbenchHelper::setForegroundColor(), Gui::Application::slotActiveDocument(), SketcherGui::DrawSketchHandler::suggestedConstraintsPixmaps(), and SketcherGui::DrawSketchHandler::unsetCursor().

◆ addWindow()

void MainWindow::addWindow ( MDIView * view )

Adds an MDI window view to the main window's workspace and adds a new tab to the tab bar.

References draftgeoutils.intersections::connect(), Gui::MainWindowP::mdiArea, showMessage(), and windowStateChanged().

Referenced by StdCmdDependencyGraph::activated(), StdViewDockUndockFullscreen::activated(), Gui::RecentMacrosAction::activateFile(), Gui::Document::createView(), Gui::ViewProviderTextDocument::doubleClicked(), Gui::Dialog::AboutDialog::linkActivated(), Gui::Dialog::DlgMacroExecuteImp::on_createButton_clicked(), Gui::Dialog::DlgMacroExecuteImp::on_editButton_clicked(), WebGui::BrowserView::onOpenLinkInNewWindow(), WebGui::BrowserView::onViewSource(), Gui::Application::sCreateViewer(), Gui::MDIView::setCurrentViewMode(), Gui::PythonDebugger::showDebugMarker(), DrawingGui::ViewProviderDrawingPage::showDrawingView(), TechDrawGui::ViewProviderPage::showMDIViewPage(), SpreadsheetGui::ViewProviderSheet::showSpreadsheetView(), Gui::Application::sInsert(), Gui::Application::sOpen(), and Gui::ManualAlignment::startAlignment().

◆ appendRecentFile()

void MainWindow::appendRecentFile ( const QString & filename )

MRU: Appends file to the list of recent files.

References Gui::RecentFilesAction::appendFile().

Referenced by Gui::Application::exportTo(), Gui::Application::importFrom(), Gui::Application::open(), and Gui::Document::saveAs().

◆ appendRecentMacro()

void MainWindow::appendRecentMacro ( const QString & filename )

MRU: Appends macro to the list of recent macros.

References Gui::RecentMacrosAction::appendFile().

Referenced by Gui::Dialog::DlgMacroExecuteImp::accept(), Gui::RecentMacrosAction::activateFile(), Gui::Dialog::DlgMacroExecuteImp::on_createButton_clicked(), and Gui::Dialog::DlgMacroExecuteImp::on_editButton_clicked().

◆ arrangeIcons

void MainWindow::arrangeIcons ( )

slot

Arranges all child windows in a horizontal tile pattern.

References Gui::MainWindowP::mdiArea.

Referenced by StdCmdArrangeIcons::activated().

◆ canInsertFromMimeData()

bool MainWindow::canInsertFromMimeData ( const QMimeData * source ) const

Check if mime data contains object data.

Referenced by StdCmdPaste::isActive().

◆ cascade

void MainWindow::cascade ( )

slot

Arranges all the child windows in a cascade pattern.

References Gui::MainWindowP::mdiArea.

Referenced by StdCmdCascadeWindows::activated().

◆ changeEvent()

void MainWindow::changeEvent ( QEvent * e )

protected

This method is called from the Qt framework automatically whenever a QTranslator object has been installed.

This allows to translate all relevant user visible text.

References Gui::WorkbenchManager::active(), Gui::MainWindowP::activeView, activeWindow(), Gui::Application::commandManager(), Gui::CommandManager::getAllCommands(), Gui::getMainWindow(), Gui::Application::Instance, Gui::WorkbenchManager::instance(), Gui::MainWindowP::mdiArea, Gui::Workbench::retranslate(), Gui::MainWindowP::sizeLabel, and Gui::Application::viewActivated().

◆ closeActiveWindow

void MainWindow::closeActiveWindow ( )

slot

Closes the child window that is currently active.

References Gui::MainWindowP::mdiArea.

Referenced by StdCmdCloseActiveWindow::activated().

◆ closeAllDocuments

bool MainWindow::closeAllDocuments ( bool close = true )

slot

Closes all document window.

References App::Application::closeAllDocuments(), confirmSave(), App::GetApplication(), App::Document::getDependentDocuments(), Gui::Application::getDocument(), App::Application::getDocuments(), Gui::getMainWindow(), Gui::Application::Instance, App::Document::PartialDoc, OfflineRenderingUtils::save(), and App::Document::TempDoc.

Referenced by StdCmdCloseAllWindows::activated().

◆ closeEvent()

void MainWindow::closeEvent ( QCloseEvent * e )

protected

This method checks if the main window can be closed by checking all open documents and views.

References Gui::MainWindowP::activityTimer, Gui::MainWindowP::assistant, Base::FileInfo::deleteFile(), Base::FileInfo::exists(), Gui::Application::Instance, Gui::WorkbenchManager::instance(), femsolver.elmer.sifio::isValid(), mainWindowClosed(), saveWindowSettings(), and Gui::Application::tryClose().

◆ confirmSave

int MainWindow::confirmSave	(	const char *	docName,
		QWidget *	parent = `nullptr`,
		bool	addCheckBox = `false`
	)

slot

Pop up a message box asking for saving document.

References App::GetApplication(), ParameterGrp::GetBool(), ParameterGrp::GetGroup(), App::Application::GetUserParameter(), and ParameterGrp::SetBool().

Referenced by Gui::Document::canClose(), and closeAllDocuments().

◆ createMimeDataFromSelection()

QMimeData * MainWindow::createMimeDataFromSelection ( ) const

Create mime data from selected objects.

References Base::FileInfo::filePath(), App::Document::getDependencyList(), Gui::getMainWindow(), Gui::DlgObjectSelection::getSelections(), App::Application::getTempFileName(), App::PropertyXLink::hasXLink(), and Gui::Selection().

Referenced by StdCmdCopy::activated().

◆ createPopupMenu()

QMenu * MainWindow::createPopupMenu ( )

Returns true that the context menu contains the 'Customize...' menu item.

References Gui::WorkbenchManager::active(), Gui::Command::addTo(), Gui::Application::commandManager(), Gui::Workbench::createMainWindowPopupMenu(), Gui::CommandManager::getCommandByName(), Gui::MenuItem::getItems(), Gui::MenuItem::hasItems(), Gui::Application::Instance, and Gui::WorkbenchManager::instance().

◆ customEvent()

void MainWindow::customEvent ( QEvent * e )

protected

References Gui::Application::activeDocument(), Gui::ActionStyleEvent::Clear, Gui::ActionStyleEvent::EventType, draftutils.utils::getType, Gui::Application::Instance, Log, Gui::CustomMessageEvent::message(), Gui::Document::setAnnotationViewProvider(), showMessage(), showStatus(), Gui::CustomMessageEvent::timeout(), Tmp, and Gui::CustomMessageEvent::type().

◆ dragEnterEvent()

void MainWindow::dragEnterEvent ( QDragEnterEvent * e )

protected

Checks if a mime source object can be interpreted.

◆ dropEvent()

void MainWindow::dropEvent ( QDropEvent * e )

protected

Try to interpret dropped elements.

Drops the event e and tries to open the files.

References App::GetApplication(), and loadUrls().

◆ event()

bool MainWindow::event ( QEvent * e )

protected

◆ eventFilter()

bool MainWindow::eventFilter	(	QObject *	o,
		QEvent *	e
	)

Filters events if this object has been installed as an event filter for the watched object.

References Gui::MainWindowP::whatstext, Gui::MainWindowP::whatsthis, and windowStateChanged().

◆ getInstance()

MainWindow * MainWindow::getInstance ( )

static

Gets the one and only instance.

Referenced by Gui::getMainWindow(), SketcherGui::TaskSketcherConstraints::on_listWidgetConstraints_itemChanged(), and SketcherGui::ConstraintView::swapNamedOfSelectedItems().

◆ hideEvent()

void MainWindow::hideEvent ( QHideEvent * e )

protected

◆ insertFromMimeData()

void MainWindow::insertFromMimeData ( const QMimeData * source )

Insert the objects into the active document.

If no document exists one gets created.

References App::Application::getActiveDocument(), App::GetApplication(), Gui::Application::getDocument(), Gui::getMainWindow(), Gui::SelectionSingleton::getObjectsOfType(), Draft::gui, Gui::MergeDocuments::importObjects(), Gui::Application::Instance, loadUrls(), App::Application::newDocument(), and Gui::Selection().

Referenced by StdCmdPaste::activated().

◆ loadUrls()

void MainWindow::loadUrls	(	App::Document *	doc,
		const QList< QUrl > &	urls
	)

Load files from the given URLs into the given document.

If the document is 0 one gets created automatically if needed.

If a url handler is registered that supports its scheme it will be delegated to this handler. This mechanism allows to change the default behaviour.

References Base::Console(), Gui::Dialog::DownloadManager::download(), App::GetApplication(), App::Application::getImportModules(), Gui::Dialog::DownloadManager::getInstance(), Gui::Application::importFrom(), Gui::SelectModule::importHandler(), Gui::Application::Instance, Base::ConsoleSingleton::Message(), Gui::Dialog::DownloadManager::redirectUrl(), and Gui::MainWindowP::urlHandler.

Referenced by dropEvent(), Gui::View3DInventor::dropEvent(), Gui::View3DInventorViewer::dropEvent(), insertFromMimeData(), and WebGui::BrowserView::onDownloadRequested().

◆ loadWindowSettings()

void MainWindow::loadWindowSettings ( )

Loads the main window settings.

References App::Application::Config(), Gui::ToolBarManager::getInstance(), draftfunctions.move::move(), Base::ConsoleSingleton::MsgType_Wrn, and Gui::ToolBarManager::restoreState().

◆ mainWindowClosed

void Gui::MainWindow::mainWindowClosed ( )

signal

Referenced by closeEvent().

◆ removeWindow()

void MainWindow::removeWindow	(	Gui::MDIView *	view,
		bool	close = `true`
	)

Removes an MDI window from the main window's workspace and its associated tab without deleting the widget.

Removes the instance of Gui::MDiView from the main window and sends am event to the parent widget, a QMdiSubWindow to delete itself.

If the main windows does not have such a window nothing happens.

If you want to avoid that the Gui::MDIView instance gets destructed too you must reparent it afterwards, e.g. set parent to NULL.

References Gui::MainWindowP::mdiArea, showMessage(), updateActions(), and windowStateChanged().

Referenced by CmdTestMDI1::activated(), CmdTestMDI3::activated(), SpreadsheetGui::ViewProviderSheet::beforeDelete(), TechDrawGui::ViewProviderPage::removeMDIView(), Gui::MDIView::setCurrentViewMode(), and SpreadsheetGui::ViewProviderSheet::~ViewProviderSheet().

◆ saveWindowSettings()

void MainWindow::saveWindowSettings ( )

Saves the main window settings.

References App::Application::Config(), Gui::ToolBarManager::getInstance(), Gui::DockWindowManager::instance(), Gui::DockWindowManager::saveState(), and Gui::ToolBarManager::saveState().

Referenced by closeEvent().

◆ setActiveWindow()

void MainWindow::setActiveWindow ( MDIView * view )

Sets the active window to view.

References Gui::MainWindowP::activeView, Gui::Application::Instance, and Gui::Application::viewActivated().

Referenced by Gui::Dialog::DlgActivateWindowImp::accept(), Gui::MDIView::changeEvent(), DrawingGui::ViewProviderDrawingPage::doubleClicked(), SpreadsheetGui::ViewProviderSheet::doubleClicked(), TechDrawGui::ViewProviderPage::doubleClicked(), StartGui::Workbench::loadStartPage(), Gui::DAG::Model::mouseDoubleClickEvent(), Gui::TreeView::mouseDoubleClickEvent(), Gui::Application::onLastWindowClosed(), WebGui::BrowserView::onOpenLinkInNewWindow(), Gui::TreeWidget::onStartEditing(), Gui::Document::setActiveView(), Gui::Document::setActiveWindow(), Gui::Document::setEdit(), SpreadsheetGui::ViewProviderSheet::setEdit(), Gui::PythonDebugger::showDebugMarker(), Gui::Application::slotActiveDocument(), and Gui::Application::sSetActiveDocument().

◆ setPaneText

void MainWindow::setPaneText	(	int	i,
		QString	text
	)

slot

Sets text to the pane in the status bar.

References Pane, showStatus(), and Gui::MainWindowP::sizeLabel.

Referenced by MeshGui::ViewProviderMeshCurvature::curvatureInfoCallback(), InspectionGui::ViewProviderInspection::inspectCallback(), Gui::View3DInventorViewer::printDimension(), Gui::SequencerBar::resetData(), and Gui::View3DInventorViewer::~View3DInventorViewer().

◆ setUrlHandler()

void MainWindow::setUrlHandler	(	const QString &	scheme,
		Gui::UrlHandler *	handler
	)

Sets the handler for the given scheme.

If setUrlHandler() is used to set a new handler for a scheme which already has a handler, the existing handler is simply replaced with the new one. Since MainWindow does not take ownership of handlers, no objects are deleted when a handler is replaced.

References Gui::MainWindowP::urlHandler.