This Class describes the "historical" imp application. More...

#include <ImpMainWindow.h>

Public Slots
file menu slot
open a data directory, "called" from the fileOpenDataDirectoryMenu
void	openDirectory (QAction *)

viewers' slot
this slot is connected to all the viewers selectionChanged() signal, this will call the refresh method of all viewers but whoIsAsking
virtual void	refresh ()

View menu slots
Note everything that is linked to the InteractiveViewer has to be managed by the view (in case there is more than one InteractiveViewer)
void	showToolbar (bool)
	show or hide the toolbar More...

void	showMenuBar (bool)
	show or hide the menu bar More...

void	resetWindows ()
	reset all windows in their initial state More...

void	showStatusBar (bool)
	show or hide the status bar More...

void	saveHistoryAsSCXML ()
	Save the history of action as a SCXML file. More...

Edit menu slots
void	editSettings ()

Public Slots inherited from camitk::MainWindow
virtual void	refresh ()

void	show ()
	inherited from QWidget, just to refresh all viewers More...

Public Member Functions
general
construtor
	ImpMainWindow ()

void	aboutToShow ()
	overriden from MainWindow to automatically load last opened document if needed More...

virtual	~ImpMainWindow ()
	destructor More...

open a top-level component
virtual void	addDockViewer (Qt::DockWidgetArea, camitk::Viewer *)
	add a Viewer to the application as a docking widget and specify where it has to be docked MainWindow takes the hand on the Viewer (it will be deleted when MainWindow is deleted). More...

virtual void	setCentralViewer (camitk::Viewer *)
	set the central Viewer of the application. More...

virtual void	redirectToConsole (bool)
	use or not the application console (overriden to add an action to show the console window) More...

Public Member Functions inherited from camitk::MainWindow
	MainWindow (QString title)
	Constructor, the window title can be changed here, it is inconsistent to use setWindowTitle(). More...

	~MainWindow () override
	destructor More...

QString	getName () const
	Get the main window title. More...

void	setWindowSubtitle (QString)
	The subtitle is situated at the end of the title, on the title bar, is helps for example showing which file is currently selected. More...

QProgressBar *	getProgressBar ()
	similar as statusBar() from QMainWindow but for the progress bar More...

void	showStatusBar (bool)
	show the status bar (by default it is hidden) More...

void	showConsole (bool)
	get the console window More...

bool	getConsoleVisibility ()
	get the visibility state of the console ( More...

virtual void	showViewer (Viewer *, bool)
	set the visibility for the given viewer (if it is in a dock) More...

void	refreshViewers ()
	Method uses to refresh all the viewer of the Main Window. More...

virtual const Viewer &	getCentralViewer () const
	the actual central viewer. More...

Protected Member Functions
void	initActions ()
	initializes all QActions of the application More...

void	updateViewMenu ()
	update the viewer's menu More...

Extension and ComponentPlugin attributes
void	updateOpenDirectoryMenu ()

void	updateRecentDocumentsMenu ()
	update the recent document menu More...

Protected Member Functions inherited from camitk::MainWindow
void	closeEvent (QCloseEvent *) override
	overriden from QMainWindow, just connect to slotFileQuit More...

void	dragEnterEvent (QDragEnterEvent *event) override
	called when a drag event started on the main window, accept drag only if file is MIME type text/uri-list More...

void	dragLeaveEvent (QDragLeaveEvent *event) override
	called when the mouse leaves the widgets area during a drag/drop operation More...

void	dragMoveEvent (QDragMoveEvent *event) override
	called when the mouse moves inside the widgets area during a drag/drop operation More...

void	dropEvent (QDropEvent *event) override
	just call open with the dragged uri More...

bool	removeViewer (Viewer *viewer)
	Remove the given viewer from the list of viewer. More...

virtual void	initSettings ()
	init MainWindow specific settings (e.g. size, position) More...

Protected Attributes
QToolBar *	mainToolbar
	the main toolbar More...

Protected Attributes inherited from camitk::MainWindow
Viewer *	centralViewer
	The actual central Viewer. More...

QList< Viewer * >	viewers

QMap< Viewer , QDockWidget >	dockWidgetMap
	the map that gives the corresponding QDockWidget for a given Viewer More...

Private Slots
void	openRecentDocuments ()
	open a given recent document More...

Private Attributes
File menu attributes
QMenu *	fileMenu
	file_menu contains all items of the menubar entry "File" More...

QMenu *	fileOpenDataDirectoryMenu

QAction *	fileOpen

QAction *	fileClose

QAction *	fileCloseAll

QAction *	fileSave

QAction *	fileSaveAs

QAction *	fileSaveAll

QAction *	fileQuit

View menu attributes and action
QMenu *	viewMenu
	view_menu contains all items of the menubar entry "View" More...

QAction *	viewMenuBar

QAction *	viewStatusBar

QAction *	viewResetWindows

Edit menu attributes
QAction *	editApplicationSettings

QAction *	editClearSelection

QAction *	saveHistory

Other menu attributes
QMenu *	actionMenu
	the actionMenu. More...

QAction *	helpAboutApp

QAction *	helpShowConsole
	action for the show console More...

Translation menu attributes
QAction *	changeLanguage

File management attributes
QList< QAction * >	recentDocumentActions
	list of all the possible recent documents actions More...

QAction *	recentDocumentSeparator
	the separator between the last file menu action and the recent document actions More...

initialization/update methods
void	updateActionStates ()

void	initMenuBar ()
	initMenuBar creates the menu_bar and inserts the menuitems More...

void	initToolBar ()
	this creates the toolbars. More...

Detailed Description

This Class describes the "historical" imp application.

It is a classical desktop application, with menubar, toolbar and statusbar.

Constructor & Destructor Documentation

◆ ImpMainWindow()

ImpMainWindow::ImpMainWindow ( )

References addDockViewer(), camitk::MainWindow::dockWidgetMap, initActions(), initMenuBar(), initToolBar(), setCentralViewer(), showStatusBar(), camitk::MainWindow::showViewer(), updateActionStates(), and updateOpenDirectoryMenu().

◆ ~ImpMainWindow()

ImpMainWindow::~ImpMainWindow ( )

virtual

destructor

Member Function Documentation

◆ aboutToShow()

void ImpMainWindow::aboutToShow ( )

virtual

overriden from MainWindow to automatically load last opened document if needed

Reimplemented from camitk::MainWindow.

References updateRecentDocumentsMenu().

◆ addDockViewer()

void ImpMainWindow::addDockViewer	(	Qt::DockWidgetArea	dockingArea,
		camitk::Viewer *	theViewer
	)

virtual

add a Viewer to the application as a docking widget and specify where it has to be docked MainWindow takes the hand on the Viewer (it will be deleted when MainWindow is deleted).

This method calls addViewer(...).

Reimplemented from camitk::MainWindow.

References updateViewMenu().

Referenced by ImpMainWindow().

◆ editSettings

void ImpMainWindow::editSettings ( )

slot

settings slot

References camitk::SettingsDialog::editSettings(), camitk::Viewer::getPropertyObject(), updateOpenDirectoryMenu(), updateRecentDocumentsMenu(), and camitk::MainWindow::viewers.

Referenced by initActions().

◆ initActions()

void ImpMainWindow::initActions ( )

protected

initializes all QActions of the application

References CAMITK_ERROR, changeLanguage, editApplicationSettings, editClearSelection, editSettings(), fileClose, fileCloseAll, fileOpen, fileQuit, fileSave, fileSaveAll, fileSaveAs, camitk::ActionExtension::getName(), helpAboutApp, helpShowConsole, openRecentDocuments(), recentDocumentActions, recentDocumentSeparator, resetWindows(), saveHistory, saveHistoryAsSCXML(), showMenuBar(), showStatusBar(), viewMenuBar, viewResetWindows, and viewStatusBar.

Referenced by ImpMainWindow().

◆ initMenuBar()

void ImpMainWindow::initMenuBar ( )

private

initMenuBar creates the menu_bar and inserts the menuitems

References actionMenu, changeLanguage, editApplicationSettings, editClearSelection, fileClose, fileCloseAll, fileMenu, fileOpen, fileOpenDataDirectoryMenu, fileQuit, fileSave, fileSaveAll, fileSaveAs, helpAboutApp, helpShowConsole, recentDocumentActions, recentDocumentSeparator, saveHistory, and viewMenu.

Referenced by ImpMainWindow().

◆ initToolBar()

void ImpMainWindow::initToolBar ( )

private

this creates the toolbars.

Change the toobar look and add new toolbars in this function.

References fileOpen, fileSave, and mainToolbar.

Referenced by ImpMainWindow().

◆ openDirectory

void ImpMainWindow::openDirectory ( QAction * emitter )

slot

References camitk::MainWindow::getProgressBar(), and refresh().

Referenced by updateOpenDirectoryMenu().

◆ openRecentDocuments

void ImpMainWindow::openRecentDocuments ( )

privateslot

open a given recent document

References camitk::Action::applyAndRegister(), and CAMITK_WARNING.

Referenced by initActions().

◆ redirectToConsole()

void ImpMainWindow::redirectToConsole ( bool visible )

virtual

use or not the application console (overriden to add an action to show the console window)

Reimplemented from camitk::MainWindow.

References helpShowConsole.

◆ refresh

void ImpMainWindow::refresh ( )

virtualslot

References updateActionStates(), updateOpenDirectoryMenu(), and updateRecentDocumentsMenu().

Referenced by openDirectory().

◆ resetWindows

void ImpMainWindow::resetWindows ( )

slot

reset all windows in their initial state

References camitk::MainWindow::dockWidgetMap, showMenuBar(), showStatusBar(), and showToolbar().

Referenced by initActions().

◆ saveHistoryAsSCXML

void ImpMainWindow::saveHistoryAsSCXML ( )

slot

Save the history of action as a SCXML file.

Referenced by initActions().

◆ setCentralViewer()

void ImpMainWindow::setCentralViewer ( camitk::Viewer * theViewer )

virtual

set the central Viewer of the application.

MainWindow takes the hand on the Viewer (it will be deleted when MainWindow is deleted) This method calls addViewer(...).

Reimplemented from camitk::MainWindow.

References updateViewMenu().

Referenced by ImpMainWindow().

◆ showMenuBar

void ImpMainWindow::showMenuBar ( bool b )

slot

show or hide the menu bar

References CAMITK_WARNING, showStatusBar(), and viewMenuBar.

Referenced by initActions(), and resetWindows().

◆ showStatusBar

void ImpMainWindow::showStatusBar ( bool b )

slot

show or hide the status bar

Referenced by ImpMainWindow(), initActions(), resetWindows(), and showMenuBar().

◆ showToolbar

void ImpMainWindow::showToolbar ( bool b )

slot

show or hide the toolbar

References mainToolbar.

Referenced by resetWindows().

◆ updateActionStates()

void ImpMainWindow::updateActionStates ( )

protected

set the current QAction enable state depending on the current selection

References actionMenu, editClearSelection, fileClose, fileCloseAll, fileSave, fileSaveAll, fileSaveAs, camitk::Component::getActionMenu(), camitk::Action::getQAction(), and camitk::MainWindow::setWindowSubtitle().

Referenced by ImpMainWindow(), and refresh().

◆ updateOpenDirectoryMenu()

void ImpMainWindow::updateOpenDirectoryMenu ( )

protected

update the data directory menu depending on registered plugins

References fileOpenDataDirectoryMenu, and openDirectory().

Referenced by editSettings(), ImpMainWindow(), and refresh().

◆ updateRecentDocumentsMenu()

void ImpMainWindow::updateRecentDocumentsMenu ( )

protected

update the recent document menu

References recentDocumentActions, and recentDocumentSeparator.

Referenced by aboutToShow(), editSettings(), and refresh().

◆ updateViewMenu()

void ImpMainWindow::updateViewMenu ( )

protected

update the viewer's menu

References camitk::MainWindow::dockWidgetMap, camitk::Viewer::getMenu(), mainToolbar, camitk::MainWindow::viewers, viewMenu, viewMenuBar, viewResetWindows, and viewStatusBar.

Referenced by addDockViewer(), and setCentralViewer().

Member Data Documentation

◆ actionMenu

QMenu* ImpMainWindow::actionMenu

private

the actionMenu.

it contains the list of specific actions possible on the currently selected Component (this menu is in fact the Popup Menu of the selected Component and is updated everytime a new Component is selected)

Referenced by initMenuBar(), and updateActionStates().

◆ changeLanguage

QAction* ImpMainWindow::changeLanguage

private

action to the change the language of the application

Referenced by initActions(), and initMenuBar().

◆ editApplicationSettings

QAction* ImpMainWindow::editApplicationSettings

private

edit actions

Referenced by initActions(), and initMenuBar().

◆ editClearSelection

QAction* ImpMainWindow::editClearSelection

private

Referenced by initActions(), initMenuBar(), and updateActionStates().

◆ fileClose

QAction* ImpMainWindow::fileClose

private

Referenced by initActions(), initMenuBar(), and updateActionStates().

◆ fileCloseAll

QAction* ImpMainWindow::fileCloseAll

private

Referenced by initActions(), initMenuBar(), and updateActionStates().

◆ fileMenu

QMenu* ImpMainWindow::fileMenu

private

file_menu contains all items of the menubar entry "File"

Referenced by initMenuBar().

◆ fileOpen

QAction* ImpMainWindow::fileOpen

private

Referenced by initActions(), initMenuBar(), and initToolBar().

◆ fileOpenDataDirectoryMenu

QMenu* ImpMainWindow::fileOpenDataDirectoryMenu

private

Referenced by initMenuBar(), and updateOpenDirectoryMenu().

◆ fileQuit

QAction* ImpMainWindow::fileQuit

private

Referenced by initActions(), and initMenuBar().

◆ fileSave

QAction* ImpMainWindow::fileSave

private

Referenced by initActions(), initMenuBar(), initToolBar(), and updateActionStates().

◆ fileSaveAll

QAction* ImpMainWindow::fileSaveAll

private

Referenced by initActions(), initMenuBar(), and updateActionStates().

◆ fileSaveAs

QAction* ImpMainWindow::fileSaveAs

private

Referenced by initActions(), initMenuBar(), and updateActionStates().

◆ helpAboutApp

QAction* ImpMainWindow::helpAboutApp

private

actions of the Help menu

Referenced by initActions(), and initMenuBar().

◆ helpShowConsole

QAction* ImpMainWindow::helpShowConsole

private

action for the show console

Referenced by initActions(), initMenuBar(), and redirectToConsole().

◆ mainToolbar

QToolBar* ImpMainWindow::mainToolbar

protected

the main toolbar

Referenced by initToolBar(), showToolbar(), and updateViewMenu().

◆ recentDocumentActions

QList<QAction*> ImpMainWindow::recentDocumentActions

private

list of all the possible recent documents actions

Referenced by initActions(), initMenuBar(), and updateRecentDocumentsMenu().

◆ recentDocumentSeparator

QAction* ImpMainWindow::recentDocumentSeparator

private

the separator between the last file menu action and the recent document actions

Referenced by initActions(), initMenuBar(), and updateRecentDocumentsMenu().

◆ saveHistory

QAction* ImpMainWindow::saveHistory

private

Referenced by initActions(), and initMenuBar().

◆ viewMenu

QMenu* ImpMainWindow::viewMenu

private

view_menu contains all items of the menubar entry "View"

Referenced by initMenuBar(), and updateViewMenu().

◆ viewMenuBar

QAction* ImpMainWindow::viewMenuBar

private

Referenced by initActions(), showMenuBar(), and updateViewMenu().

◆ viewResetWindows

QAction* ImpMainWindow::viewResetWindows

private

Referenced by initActions(), and updateViewMenu().

◆ viewStatusBar

QAction* ImpMainWindow::viewStatusBar

private

Referenced by initActions(), and updateViewMenu().

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

Public Slots

Public Member Functions

Protected Member Functions

Protected Attributes

Private Slots

Private Attributes

initialization/update methods

Detailed Description

Constructor & Destructor Documentation

◆ ImpMainWindow()

◆ ~ImpMainWindow()

Member Function Documentation

◆ aboutToShow()

◆ addDockViewer()

◆ editSettings

◆ initActions()

◆ initMenuBar()

◆ initToolBar()

◆ openDirectory

◆ openRecentDocuments

◆ redirectToConsole()

◆ refresh

◆ resetWindows

◆ saveHistoryAsSCXML

◆ setCentralViewer()

◆ showMenuBar

◆ showStatusBar

◆ showToolbar

◆ updateActionStates()

◆ updateOpenDirectoryMenu()

◆ updateRecentDocumentsMenu()

◆ updateViewMenu()

Member Data Documentation

◆ actionMenu

◆ changeLanguage

◆ editApplicationSettings

◆ editClearSelection

◆ fileClose

◆ fileCloseAll

◆ fileMenu

◆ fileOpen

◆ fileOpenDataDirectoryMenu

◆ fileQuit

◆ fileSave

◆ fileSaveAll

◆ fileSaveAs

◆ helpAboutApp

◆ helpShowConsole

◆ mainToolbar

◆ recentDocumentActions

◆ recentDocumentSeparator

◆ saveHistory

◆ viewMenu

◆ viewMenuBar

◆ viewResetWindows

◆ viewStatusBar