Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Protected Member Functions | Private Attributes | List of all members
camitk::MainWindow Class Reference

This Class is the base class for your application. More...

#include <MainWindow.h>

+ Inheritance diagram for camitk::MainWindow:

Public Slots

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

Public Member Functions

general
 MainWindow (QString title)
 Constructor, the window title can be changed here, it is inconsistent to use setWindowTitle(). More...
 
virtual ~MainWindow ()
 destructor More...
 
virtual void aboutToShow ()
 this method is automatically called by Application before the first time show() is called. More...
 
subtitle, status bar message, progress bar state and console
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...
 
virtual void redirectToConsole (bool)
 use or not the application console (redirect or not standard out/err streams) More...
 
void showConsole (bool)
 get the console window More...
 
Viewers
virtual bool addViewer (Viewer *)
 add a viewer (called by addDockViewer and setCentralViewer), returns true if not already added. More...
 
virtual void showViewer (Viewer *, bool)
 set the visibility for the given viewer (if it is in a dock) More...
 
virtual void addDockViewer (Qt::DockWidgetArea, Viewer *)
 add a Viewer to the application as a docking widget and specify where it has to be docked Note that MainWindow takes ownership of the Viewer pointer and deletes it at the appropriate time. More...
 
void refreshViewers ()
 Method uses to refresh all the viewer of the Main Window. More...
 
virtual void setCentralViewer (Viewer *)
 set the central Viewer of the application. More...
 

Protected Member Functions

virtual void closeEvent (QCloseEvent *)
 overriden from QMainWindow, just connect to slotFileQuit More...
 
void dragEnterEvent (QDragEnterEvent *event)
 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)
 called when the mouse leaves the widgets area during a drag/drop operation More...
 
void dragMoveEvent (QDragMoveEvent *event)
 called when the mouse moves inside the widgets area during a drag/drop operation More...
 
void dropEvent (QDropEvent *event)
 just call open with the dragged uri More...
 

Private Attributes

ConsoleStream cerr
 the error stream for the application console More...
 
QDialog * consoleWindow
 console to display all messages More...
 
QTextEdit * consoleWindowTextEdit
 the QTextEdit part of the console dialog More...
 
ConsoleStream cout
 the output stream for the application console More...
 
QString mainTitle
 the main part of the title More...
 
QProgressBar * myProgressBar
 the progress bar (access through setProgress() method) More...
 

Viewer and other things

QList< Viewer * > viewers
 
QMap< Viewer *, QDockWidget * > dockWidgetMap
 the map that gives the corresponding QDockWidget for a given Viewer More...
 
virtual void initSettings ()
 init MainWindow specific settings (e.g. size, position) More...
 

Detailed Description

This Class is the base class for your application.

It sets up the main window and providing a menubar, toolbar and statusbar (all hidden). It is the default main window for a application.

Create a class that inherits from MainWindow to get all the goodies of Core and add your own customization/UI. See applications for examples.

Constructor & Destructor Documentation

camitk::MainWindow::MainWindow ( QString  title)

Constructor, the window title can be changed here, it is inconsistent to use setWindowTitle().

If you like to dynamically add some information to the window title, please use setWindowSubtitle() instead.

See Also
setWindowSubtitle
Parameters
titlemain window title
virtual camitk::MainWindow::~MainWindow ( )
virtual

destructor

Member Function Documentation

virtual void camitk::MainWindow::aboutToShow ( )
virtual

this method is automatically called by Application before the first time show() is called.

This method calls initSettings().

Reimplemented in ImpMainWindow.

virtual void camitk::MainWindow::addDockViewer ( Qt::DockWidgetArea  ,
Viewer  
)
virtual

add a Viewer to the application as a docking widget and specify where it has to be docked Note that MainWindow takes ownership of the Viewer pointer and deletes it at the appropriate time.

This method calls addViewer(...).

Reimplemented in ImpMainWindow.

virtual bool camitk::MainWindow::addViewer ( Viewer )
virtual

add a viewer (called by addDockViewer and setCentralViewer), returns true if not already added.

Note that MainWindow takes ownership of the Viewer pointer and deletes it at the appropriate time. This method connects the selectionChanged signal of the viewer to the refresh method.

virtual void camitk::MainWindow::closeEvent ( QCloseEvent *  )
protectedvirtual

overriden from QMainWindow, just connect to slotFileQuit

void camitk::MainWindow::dragEnterEvent ( QDragEnterEvent *  event)
protected

called when a drag event started on the main window, accept drag only if file is MIME type text/uri-list

void camitk::MainWindow::dragLeaveEvent ( QDragLeaveEvent *  event)
protected

called when the mouse leaves the widgets area during a drag/drop operation

void camitk::MainWindow::dragMoveEvent ( QDragMoveEvent *  event)
protected

called when the mouse moves inside the widgets area during a drag/drop operation

void camitk::MainWindow::dropEvent ( QDropEvent *  event)
protected

just call open with the dragged uri

QProgressBar* camitk::MainWindow::getProgressBar ( )

similar as statusBar() from QMainWindow but for the progress bar

virtual void camitk::MainWindow::initSettings ( )
protectedvirtual

init MainWindow specific settings (e.g. size, position)

Reimplemented in ImpMainWindow.

virtual void camitk::MainWindow::redirectToConsole ( bool  )
virtual

use or not the application console (redirect or not standard out/err streams)

Reimplemented in ImpMainWindow.

virtual void camitk::MainWindow::refresh ( )
virtualslot

this slot is connected to all the viewers selectionChanged() signal, this will call the refresh method of all viewers

void camitk::MainWindow::refreshViewers ( )

Method uses to refresh all the viewer of the Main Window.

virtual void camitk::MainWindow::setCentralViewer ( Viewer )
virtual

set the central Viewer of the application.

Note that MainWindow takes ownership of the Viewer pointer and deletes it at the appropriate time. This method calls addViewer(...).

Reimplemented in ImpMainWindow.

void camitk::MainWindow::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.

It appears between brackets "[ ... ]"

Note
the main title is set to Core::version, you can change the title part (i.e. the part of the title bar before the subtitle), by calling setWindowTitle(...)
void camitk::MainWindow::show ( )
slot

inherited from QWidget, just to refresh all viewers

void camitk::MainWindow::showConsole ( bool  )

get the console window

void camitk::MainWindow::showStatusBar ( bool  )

show the status bar (by default it is hidden)

virtual void camitk::MainWindow::showViewer ( Viewer ,
bool   
)
virtual

set the visibility for the given viewer (if it is in a dock)

Member Data Documentation

ConsoleStream camitk::MainWindow::cerr
private

the error stream for the application console

QDialog* camitk::MainWindow::consoleWindow
private

console to display all messages

QTextEdit* camitk::MainWindow::consoleWindowTextEdit
private

the QTextEdit part of the console dialog

ConsoleStream camitk::MainWindow::cout
private

the output stream for the application console

QMap<Viewer*, QDockWidget*> camitk::MainWindow::dockWidgetMap
protected

the map that gives the corresponding QDockWidget for a given Viewer

QString camitk::MainWindow::mainTitle
private

the main part of the title

QProgressBar* camitk::MainWindow::myProgressBar
private

the progress bar (access through setProgress() method)

QList<Viewer *> camitk::MainWindow::viewers
protected

the set of viewers


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