VIEW::ModularWidget Class Reference
[Widget connectivity and message queuing]

ModularWidget is a base class for widely independent widget that realize one feature domain. More...

#include <modularWidget.h>

Inheritance diagram for VIEW::ModularWidget:


Registering
virtual void	initializeWidget (MainControl &main_control)
	Initialize the widget.
virtual void	finalizeWidget (MainControl &main_control)
	Remove the widget custom items, e.g all menu entries.
virtual bool	canHandle (const String &) const
	Test if this ModularWidget can handle a given file format.
virtual bool	openFile (const String &)
	Tell this ModularWidget to open a given file.
void	registerWidget (ModularWidget *mwidget) throw (Exception::NullPointer)
	Register the widget mwidget to the MainControl.
Public Member Functions
void	setWorkingDirFromFilename_ (String filename) throw ()
virtual void	showHelp (const String &url)
Constructors
	ModularWidget (const char *name="<ModularWidget>") throw ()
	Default Constructor.
	ModularWidget (const ModularWidget &widget) throw ()
	Copy constructor.
Destructors
virtual	~ModularWidget () throw ()
	Destructor.
virtual void	destroy () throw ()
	Explicit destructor.
virtual void	clear () throw ()
	Explicit default initialization.
Management of menu and toolbar entries
virtual void	checkMenu (MainControl &main_control) throw ()
	Menu checking method.
QAction *	insertMenuEntry (Position parent_id, const String &name, const QObject receiver=0, const char slot=0, QKeySequence accel=QKeySequence()) throw ()
void	setMenuHint (const String &hint)
	Set the hint for the last added menu entry.
void	setMenuHelp (const String &url)
	Set the help URL for the last added menu entry.
virtual void	registerForHelpSystem (const QObject *object, const String &url)
	Register an QObject for the help system.
virtual void	addToolBarEntries (QToolBar *main_tb)
	Add the widgets actions to the (main) toolbar.
void	setIcon (const String &filename, bool add_to_main_toolbar=true)
	Set the icon for the last added QAction.
Preferences handling
virtual void	initializePreferencesTab (Preferences &preferences) throw ()
	Initialize a preferences tab for the widget (if needed).
virtual void	finalizePreferencesTab (Preferences &preferences) throw ()
	Remove the preferences tab.
virtual void	applyPreferences () throw ()
	Apply the preferences of the specific tab.
virtual void	fetchPreferences (INIFile &inifile) throw ()
	Fetch the widgets preferences from the INIFile.
virtual void	writePreferences (INIFile &inifile) throw ()
	Writes the widgets preferences to the INIFile.
Preferences handling
bool	lockComposites () throw ()
	Try to get an exclusive lock on the Composites, so that they can not be altered by any other ModularWidget.
bool	unlockComposites () throw ()
	Unlock the Composites.
Convenience methods
MainControl *	getMainControl () const throw ()
	Return the MainControl of this ModularWidget Implemented for convenience.
virtual void	setStatusbarText (String text, bool important=false) throw ()
	Set the text of the statusbar of the main application.
String	getWorkingDir () throw ()
	Implemented for convenience.
void	setWorkingDir (const String &dir) throw ()
	Implemented for convenience.
FragmentDB &	getFragmentDB () const throw ()
	Return the FragmentDB.
Debugging and Diagnostics
virtual void	dump (std::ostream &s=std::cout, Size depth=0) const throw ()
	Internal state dump.
Protected Attributes
QAction *	window_menu_entry_
bool	show_window_enty_
bool	default_visible_
QAction *	last_action_
QList< QAction * >	main_toolbar_actions_

Detailed Description

ModularWidget is a base class for widely independent widget that realize one feature domain.

The VIEW framework provides a simple mechanism for Rapid Application Prototyping based on modular widgets. Using these modular widgets and the MainControl class (or more precisely, classes derived from MainControl) applications can be developed in a plug&play style. Inserting an instance of one of these widgets automatically creates the required menus and menu entries in the menubar of the main window, sets up the required connections, and registers the class instance for usage from the embedded Python interpreter (if desired).
When implementing classes derived from ModularWidget and access to the class from Python is desired, please remember to include the BALL_EMBEDDABLE macro in the public section of your class declaration. Also make sure that the QT class you derive from (e.g. QWidget) is the first base class and ModularWidget second.

Remember: A ModularWidget is not notified by the Messages it sends itself!

See also:

MainControl

Embeddable

PyWidget

Constructor & Destructor Documentation

VIEW::ModularWidget::ModularWidget ( const char * name = "<ModularWidget>" ) throw ()

Default Constructor.
Set the name of this ModularWidget to name.
Parameters:

name the name of this modularWidget

VIEW::ModularWidget::ModularWidget ( const ModularWidget & widget ) throw ()

Copy constructor.

virtual VIEW::ModularWidget::~ModularWidget ( ) throw () [virtual]

Destructor.
If the ModularWidget was registered, it will call MainControl::removeModularWidget.

Member Function Documentation

virtual void VIEW::ModularWidget::addToolBarEntries ( QToolBar * main_tb ) [virtual]

Add the widgets actions to the (main) toolbar.
This method is needed to enable ordering the entries. It is called in Mainframe.
Reimplemented in VIEW::EditableScene, and VIEW::Scene.

virtual void VIEW::ModularWidget::applyPreferences ( ) throw () [virtual]

Apply the preferences of the specific tab.
In this method the widget can extract any changed values from its preferences tab (if required). This method is called automatically by the applyPreferencesTab from the MainControl object if the apply button in the Preferences dialog is pressed.
Parameters:

preferences the Preferences dialog of the MainControl

See also:
initializePreferencesTab
finalizePreferencesTab
applyPreferencesTab

Reimplemented in VIEW::DisplayProperties, VIEW::Server, VIEW::EditableScene, VIEW::PyWidget, and VIEW::Scene.

virtual bool VIEW::ModularWidget::canHandle ( const String & ) const [virtual]

Test if this ModularWidget can handle a given file format.

Parameters:

fileform short string with the file extension (e.g. PDB)

See also:
openFile
MainControl::openFile

Reimplemented in VIEW::MolecularFileDialog, VIEW::DatasetControl, VIEW::PyWidget, and VIEW::TestFramework.

virtual void VIEW::ModularWidget::checkMenu ( MainControl & main_control ) throw () [virtual]

Menu checking method.
This method is called MainControl::checkMenus before a popup menu is shown. It should be used to update the state of menu entries (e.g. disable or enable entries).
Parameters:

main_control the MainControl object whose menus should be checked

Reimplemented in VIEW::DisplayProperties, VIEW::DownloadPDBFile, VIEW::LabelDialog, VIEW::MolecularFileDialog, VIEW::PubChemDialog, VIEW::DatasetControl, VIEW::DockingController, VIEW::EditableScene, VIEW::FileObserver, VIEW::GeometricControl, VIEW::MolecularStructure, VIEW::PyWidget, VIEW::Scene, and VIEW::TestFramework.

virtual void VIEW::ModularWidget::clear ( ) throw () [virtual]

Explicit default initialization.
Currently does nothing.
Reimplemented from VIEW::ConnectionObject.
Reimplemented in VIEW::Server, VIEW::GeometricControl, VIEW::PyWidget, and VIEW::Scene.

virtual void VIEW::ModularWidget::destroy ( ) throw () [virtual]

Explicit destructor.
Calls clear
See also:
clear

Reimplemented from VIEW::ConnectionObject.

virtual void VIEW::ModularWidget::dump ( std::ostream & s = std::cout,

Size depth = 0

) const throw () [virtual]

Internal state dump.
Dump the current internal state of this mainControl to the output ostream s with dumping depth depth. Calls ConnectionObject::dump.
Parameters:

s output stream where to output the internal state

depth the dumping depth

Reimplemented from Embeddable.
Reimplemented in VIEW::Server, VIEW::PyWidget, and VIEW::Scene.

virtual void VIEW::ModularWidget::fetchPreferences ( INIFile & inifile ) throw () [virtual]

Fetch the widgets preferences from the INIFile.
This method is called automatically by MainControl::show() at the start of the application.
Parameters:

inifile the INIFile that contains the needed values

See also:
writePreferences

Reimplemented in VIEW::DownloadPDBFile, VIEW::LabelDialog, VIEW::DockingController, VIEW::DockWidget, VIEW::MolecularControl, VIEW::MolecularStructure, VIEW::PyWidget, and VIEW::Scene.

virtual void VIEW::ModularWidget::finalizePreferencesTab ( Preferences & preferences ) throw () [virtual]

Remove the preferences tab.
This method can remove a preferences widget (if created in initializePreferencesTab) from the Preferences dialog of the MainControl. This method is called automatically by MainControl::aboutToExit() at the end of the application.
Parameters:

preferences the Preferences dialog of the MainControl

Reimplemented in VIEW::DisplayProperties, VIEW::Server, VIEW::EditableScene, VIEW::PyWidget, and VIEW::Scene.

virtual void VIEW::ModularWidget::finalizeWidget ( MainControl & main_control ) [virtual]

Remove the widget custom items, e.g all menu entries.
This method should reverse all actions performed in initializeWidget (remove menu entries and connections of this ModularWidget). Call this method also in derived classes finalizeWidget to remove the menu entries. This method will be called by MainControl::aboutToExit().
Parameters:

main_control the MainControl object to be finalized with this ModularWidget

See also:
initializeWidget

Reimplemented in VIEW::Server, VIEW::EditFunctions, VIEW::LogView, and VIEW::PyWidget.

FragmentDB& VIEW::ModularWidget::getFragmentDB ( ) const throw ()

Return the FragmentDB.
Note: The ModularWidget must be registered to a MainControl. Implemented for convenience.

MainControl* VIEW::ModularWidget::getMainControl ( ) const throw ()

Return the MainControl of this ModularWidget Implemented for convenience.

virtual void VIEW::ModularWidget::initializePreferencesTab ( Preferences & preferences ) throw () [virtual]

Initialize a preferences tab for the widget (if needed).
This method can be used to create preferences widgets that can be inserted into the Preferences dialog with the method insertTab. This method is called automatically by MainControl::show at the start of the application.
Parameters:

preferences the Preferences dialog of the MainControl

Reimplemented in VIEW::DisplayProperties, VIEW::Server, VIEW::EditableScene, VIEW::PyWidget, and VIEW::Scene.

virtual void VIEW::ModularWidget::initializeWidget ( MainControl & main_control ) [virtual]

Initialize the widget.
This method is called automatically immediately before the main application is started. It should add the widget's menu entries and connections (if required). This method will be called by MainControl::show.
Parameters:

main_control the MainControl object to be initialized with this ModularWidget

See also:
finalizeWidget()

Reimplemented in VIEW::DisplayProperties, VIEW::LabelDialog, VIEW::MolecularFileDialog, VIEW::OpenBruker1DFile, VIEW::OpenBruker2DFile, VIEW::PubChemDialog, VIEW::Server, VIEW::DatasetControl, VIEW::DockingController, VIEW::DockWidget, VIEW::EditableScene, VIEW::EditFunctions, VIEW::FileObserver, VIEW::GenericControl, VIEW::GeometricControl, VIEW::HelpViewer, VIEW::LogView, VIEW::MolecularControl, VIEW::MolecularStructure, VIEW::PyWidget, VIEW::Scene, and VIEW::TestFramework.

bool VIEW::ModularWidget::lockComposites ( ) throw ()

Try to get an exclusive lock on the Composites, so that they can not be altered by any other ModularWidget.

virtual bool VIEW::ModularWidget::openFile ( const String & ) [virtual]

Tell this ModularWidget to open a given file.

See also:
canHandle
MainControl::openFile

Reimplemented in VIEW::MolecularFileDialog, VIEW::DatasetControl, VIEW::PyWidget, and VIEW::TestFramework.

virtual void VIEW::ModularWidget::registerForHelpSystem ( const QObject * object,

const String & url

) [virtual]

Register an QObject for the help system.

See also:
HelpViewer

Reimplemented in VIEW::DockWidget, and VIEW::HelpViewer.

void VIEW::ModularWidget::registerWidget ( ModularWidget * mwidget ) throw (Exception::NullPointer) [static]

Register the widget mwidget to the MainControl.
ModularWidget objects must always be created with MainControl as parent and must have this method in their constructors. This method connects them to the MainControl object.
Parameters:

mwidget the ModularWidget to be registered to the MainControl

void VIEW::ModularWidget::setIcon ( const String & filename,

bool add_to_main_toolbar = true

)

Set the icon for the last added QAction.
The file is searched in BALL/data/graphics.

void VIEW::ModularWidget::setMenuHelp ( const String & url )

Set the help URL for the last added menu entry.

See also:
insertMenuEntry
HelpViewer

void VIEW::ModularWidget::setMenuHint ( const String & hint )

Set the hint for the last added menu entry.

See also:
insertMenuEntry

virtual void VIEW::ModularWidget::setStatusbarText ( String text,

bool important = false

) throw () [virtual]

Set the text of the statusbar of the main application.
Note: The ModularWidget must be registered to a MainControl. Implemented for convenience.

virtual void VIEW::ModularWidget::writePreferences ( INIFile & inifile ) throw () [virtual]

Writes the widgets preferences to the INIFile.
This method is called automatically by MainControl::aboutToExit at the end of the application.
Parameters:

inifile the INIFile to contain the values

See also:
fetchPreferences

Reimplemented in VIEW::DownloadPDBFile, VIEW::LabelDialog, VIEW::DockingController, VIEW::DockWidget, VIEW::MolecularControl, VIEW::MolecularStructure, VIEW::PyWidget, and VIEW::Scene.

VIEW::ModularWidget Class Reference [Widget connectivity and message queuing]

Registering

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

VIEW::ModularWidget Class Reference
[Widget connectivity and message queuing]