The base API for TerraLib applications. More...

#include <ApplicationController.h>

Inheritance diagram for te::qt::af::ApplicationController:

Signals
void	triggered (te::qt::af::evt::Event *)
	Send events in broadcast for all registered components. More...

Public Member Functions
void	addListener (QObject *obj, const ListenerType &type=BOTH)
	Insert an application item that will listen to framework events. More...

	ApplicationController ()
	Constructor. More...

virtual void	finalize ()
	Finalize the application framework. More...

virtual void	finalizePlugins ()

const QString &	getAboutLogo () const
	Returns the application project extension. More...

const QString &	getAppIconName () const
	Returns the application icon. More...

const QString &	getAppName () const
	Returns the application name. More...

const QString &	getAppPluginsPath () const
	Returns the plugins file path of application. More...

const QString &	getAppTitle () const
	Returns the application title. More...

int	getDefaultSRID () const
	Returns the most recent project. More...

QWidget *	getMainWindow () const
	Returns main window. More...

QColor	getSelectionColor () const
	Returns the application selection color. More...

QSettings &	getSettings ()
	Return the QSettings of the application. This can be used to add settings from external sources. More...

const QString &	getTlibLogo () const

const QString &	getUserDataDir () const

virtual void	initialize ()
	Initializes the application framework. More...

virtual void	initializePlugins ()
	Load the plugin list and initialize the plugins enabled by the user. More...

void	removeListener (QObject *obj)
	Remove the obj from the list of event listeners. More...

virtual void	setConfigFile (const std::string &configFileName)
	Tells wich configuration file to be used by the controller during its initialization. More...

virtual void	setMsgBoxParentWidget (QWidget *w)
	Tells the widget to be used as the parent of messages showned in a QMessageBox. More...

void	setResetTerraLibFlag (const bool &status)

void	setSelectionColor (const QColor &c)
	Sets the application selection color. More...

void	trigger (te::qt::af::evt::Event *)

virtual	~ApplicationController ()
	Destructor. More...

Menus and Menubars Management.
Register and recover menus and menu bars. The methods find will returns a valid object only if it exists in some menu, otherwise the return will be a NULL pointer. The methods get ALWAYS returns a valid pointer. If the requested menu or menubar does not exists these funtions will create, register and return the object. Note The identifiers of the menus are the texts presented by menus. The search for menus will occurs in ALL OF THE REGISTERED menus and menu bars, including submenus. The correct sintaxe for searchies submenus may be found in the documentation of the findMenu(QString mnuText, QMenu* mnu) method.
void	addToolBar (const QString &id, QToolBar *bar)
	Register the toolbar in the list of the known toolbars and dispatch an event. More...

void	registerToolBar (const QString &id, QToolBar *bar)
	Register the toolbar in the list of the known toolbars. More...

QToolBar *	getToolBar (const QString &id) const
	Return the toolbar identified by id or NULL if none is found. More...

std::vector< QToolBar * >	getToolBars () const
	Return the list of registered toolbars. More...

void	removeToolBar (const QString &id)
	Removes the toolbar identified by id. More...

void	registerMenu (QMenu *mnu)
	Register the mnu. More...

QMenu *	findMenu (const QString &id) const
	Returns the menu registered with key id. More...

QMenu *	getMenu (const QString &id)
	Returns a menu registered with key id. More...

void	registerMenuBar (QMenuBar *bar)
	Register the bar. More...

QMenuBar *	findMenuBar (const QString &id) const
	Returns the menu bar registered with key id. More...

QMenuBar *	getMenuBar (const QString &id) const
	Returns a menu bar registered with key id. More...

QAction *	findAction (const QString &id) const
	Returns the action identified by id or NULL if there's not an action identified by id. More...

QActionGroup *	findActionGroup (const QString &id) const
	Returns the action group identified by id or NULL if there's not an action group identified by id. More...

Protected Attributes
QString	m_aboutLogo

std::string	m_appConfigFile
	The application framework configuration file. More...

std::string	m_appDatasourcesFile
	Name of the file containing datasources used. More...

QString	m_appDefaultIconTheme
	Name of the icon theme to be used. More...

QString	m_appHelpFile
	Name of the help file. More...

QString	m_appIconName
	Icon used in the application. More...

QString	m_appIconThemeDir
	Directory of the application icon theme. More...

std::set< QObject * >	m_applicationItems
	The list of registered application items. More...

QString	m_appName
	Application name. More...

QString	m_appOrganization
	Organization name. More...

QString	m_appPluginsPath
	Name of the plugins path. More...

QSettings	m_appSettings

QString	m_appTitle
	Application title. More...

QString	m_appToolBarDefaultIconSize
	Size of the tool buttons. More...

std::string	m_appUserSettingsFile
	Name of the user settings file. More...

int	m_defaultSRID
	Default SRID value. More...

bool	m_initialized
	A flag indicating if the controller is initialized. More...

std::vector< QMenuBar * >	m_menuBars
	Menu bars registered. More...

std::vector< QMenu * >	m_menus
	Menus registered. More...

QWidget *	m_msgBoxParentWidget
	Parent used to show message boxes. More...

bool	m_resetTerralib

QColor	m_selectionColor
	Default selection color. More...

QString	m_tLibLogo

std::map< QString, QToolBar * >	m_toolbars
	Toolbars registered. More...

QString	m_userDataDir
	The data dir used to store data files. More...

Related Functions
(Note that these are not member functions.)
QMenu *	findMenu

Detailed Description

The base API for TerraLib applications.

Note: Temporally this class is a singleton!

Definition at line 85 of file ApplicationController.h.

Constructor & Destructor Documentation

te::qt::af::ApplicationController::ApplicationController ( )

Constructor.

Parameters

parent The parent object.

virtual te::qt::af::ApplicationController::~ApplicationController ( )

virtual

Destructor.

Member Function Documentation

void te::qt::af::ApplicationController::addListener	(	QObject *	obj,
		const ListenerType &	type = `BOTH`
	)

Insert an application item that will listen to framework events.

Parameters

obj	The application item that will listen to framework events.

Note: The obj MUST HAVE AN IMPLEMENTATION of the slot onApplicationTriggered(Event*). If it hasn't, a warning will be sent at run-time.; If the obj was previously registered, nothing will be done.

void te::qt::af::ApplicationController::addToolBar	(	const QString &	id,
		QToolBar *	bar
	)

Register the toolbar in the list of the known toolbars and dispatch an event.

Parameters

id	The toolbar identification string.
bar	The toolbar to be registered. The controller will not take the bar ownership.

An event will be broadcasted to indicate that the toolbar was appended.

Exceptions

Exception It throws an exception if a toolbar with the given id already exists.

virtual void te::qt::af::ApplicationController::finalize ( )

virtual

Finalize the application framework.

This method will unload all TerraLib modules, plugins, and dynamic libraries that are loaded.

Note: Make sure that the application calls this method BEFORE it finishes.

virtual void te::qt::af::ApplicationController::finalizePlugins ( )

virtual

QAction* te::qt::af::ApplicationController::findAction ( const QString & id ) const

Returns the action identified by id or NULL if there's not an action identified by id.

Parameters

id	Identifier if the action.

Returns: QAction identified or NULL if could not find one.

Note: There's a rule to determine id. The text of menus and submenus separated by '.' character.

QActionGroup* te::qt::af::ApplicationController::findActionGroup ( const QString & id ) const

Returns the action group identified by id or NULL if there's not an action group identified by id.

Parameters

id	Identifier of the action group.

Returns: QActionGroup identified or NULL if could not find one.

QMenu* te::qt::af::ApplicationController::findMenu ( const QString & id ) const

Returns the menu registered with key id.

Parameters

id	Indentifier of the menu.

Returns: Menu registered or NULL with there is not one registered with the key id.

QMenuBar* te::qt::af::ApplicationController::findMenuBar ( const QString & id ) const

Returns the menu bar registered with key id.

Parameters

id	Indentifier of the menu bar.

Returns: Menu bar registered or NULL with there is not one registered with the key id.

const QString& te::qt::af::ApplicationController::getAboutLogo ( ) const

Returns the application project extension.

Returns: Application project extension.

const QString& te::qt::af::ApplicationController::getAppIconName ( ) const

Returns the application icon.

Returns: Application icon.

const QString& te::qt::af::ApplicationController::getAppName ( ) const

Returns the application name.

Returns: Application name.

const QString& te::qt::af::ApplicationController::getAppPluginsPath ( ) const

Returns the plugins file path of application.

Returns: A path of plugins file.

const QString& te::qt::af::ApplicationController::getAppTitle ( ) const

Returns the application title.

Returns: Application title.

int te::qt::af::ApplicationController::getDefaultSRID ( ) const

Returns the most recent project.

Returns: Application most recent opened project.

Returns the application default SRID value.

Returns: Application default SRID value.

QWidget* te::qt::af::ApplicationController::getMainWindow ( ) const

Returns main window.

Returns: The main window pointer.

QMenu* te::qt::af::ApplicationController::getMenu ( const QString & id )

Returns a menu registered with key id.

Parameters

id	Identifier of menu to be searched.

Returns: The menu registered with the id identifier.

Note: If the menu does not exists, then this function will create it.

QMenuBar* te::qt::af::ApplicationController::getMenuBar ( const QString & id ) const

Returns a menu bar registered with key id.

Parameters

id	Identifier of menu bar to be searched.

Returns: The menu bar registered with the id identifier.

Note: If the menu bar does not exists, then this function will create it.

QColor te::qt::af::ApplicationController::getSelectionColor ( ) const

Returns the application selection color.

Returns: Application selection color.

QSettings& te::qt::af::ApplicationController::getSettings ( )

Return the QSettings of the application. This can be used to add settings from external sources.

Returns: QSettings being used.

const QString& te::qt::af::ApplicationController::getTlibLogo ( ) const

QToolBar* te::qt::af::ApplicationController::getToolBar ( const QString & id ) const

Return the toolbar identified by id or NULL if none is found.

Parameters

id	The toolbar identification string.

Returns: A toolbar identified by id or NULL if none is found.

std::vector<QToolBar*> te::qt::af::ApplicationController::getToolBars ( ) const

Return the list of registered toolbars.

Returns: List of registered ToolBars.

const QString& te::qt::af::ApplicationController::getUserDataDir ( ) const

virtual void te::qt::af::ApplicationController::initialize ( )

virtual

Initializes the application framework.

The initialization will read the following configurations files (in order):

A main config file, generally called config.xml
A user settings file, generally called user_settings.xml<li>

It will start by initializing the available TerraLib modules. This means that applications that uses the application framework, does not need to call TerraLib initialization (TerraLib::getInstance().initialize()) and finalization methods (TerraLib::getInstance().finalize()).

Exceptions

Exception It throws an exception if the initialization fails.

Note: Make sure that the application calls this method BEFORE it uses any TerraLib modules or functions.

virtual void te::qt::af::ApplicationController::initializePlugins ( )

virtual

Load the plugin list and initialize the plugins enabled by the user.

The plugin initialization will read a file containing a list of plugins with their addresses. This file is generally called application_plugins.xml.

Precondition: The application must assure that any resource needed by their plugins are ready for use. This means that initialize should be called before initializing the plugins.

void te::qt::af::ApplicationController::registerMenu ( QMenu * mnu )

Register the mnu.

Parameters

mnu	Pointer to the menu to be registered.

void te::qt::af::ApplicationController::registerMenuBar ( QMenuBar * bar )

Register the bar.

Parameters

bar	Pointer to the menu bar to be registered.

void te::qt::af::ApplicationController::registerToolBar	(	const QString &	id,
		QToolBar *	bar
	)

Register the toolbar in the list of the known toolbars.

Parameters

id	The toolbar identification string.
bar	The toolbar to be registered. The controller will not take the bar ownership.

Exceptions

Exception It throws an exception if a toolbar with the given id already exists.

void te::qt::af::ApplicationController::removeListener ( QObject * obj )

Remove the obj from the list of event listeners.

Parameters

obj	The application item to be removed.

Note: If the obj was not previously registered, nothing will be done.

void te::qt::af::ApplicationController::removeToolBar ( const QString & id )

Removes the toolbar identified by id.

Parameters

id	Identifier of the tool bar.

virtual void te::qt::af::ApplicationController::setConfigFile ( const std::string & configFileName )

virtual

Tells wich configuration file to be used by the controller during its initialization.

Parameters

configFileName The configuration file name with full path.

virtual void te::qt::af::ApplicationController::setMsgBoxParentWidget ( QWidget * w )

virtual

Tells the widget to be used as the parent of messages showned in a QMessageBox.

Parameters

w	The widget to be used as the parent of messages showned in a QMessageBox.

void te::qt::af::ApplicationController::setResetTerraLibFlag ( const bool & status )

void te::qt::af::ApplicationController::setSelectionColor ( const QColor & c )

Sets the application selection color.

void te::qt::af::ApplicationController::trigger ( te::qt::af::evt::Event * )

void te::qt::af::ApplicationController::triggered ( te::qt::af::evt::Event * )

signal

Send events in broadcast for all registered components.

Parameters

evt	Event to be sent.

Signal emmited to the aplication framework listeners.

Friends And Related Function Documentation

QMenu * te::qt::widgets::findMenu	(	const QString &	mnuText,
		QMenuBar *	bar
	)

The difference for the above function is that this will search in all QMenu objects contained in the bar.

Member Data Documentation

QString te::qt::af::ApplicationController::m_aboutLogo

protected

Definition at line 432 of file ApplicationController.h.

std::string te::qt::af::ApplicationController::m_appConfigFile

protected

The application framework configuration file.

Definition at line 426 of file ApplicationController.h.

std::string te::qt::af::ApplicationController::m_appDatasourcesFile

protected

Name of the file containing datasources used.

Definition at line 440 of file ApplicationController.h.

QString te::qt::af::ApplicationController::m_appDefaultIconTheme

protected

Name of the icon theme to be used.

Definition at line 438 of file ApplicationController.h.

QString te::qt::af::ApplicationController::m_appHelpFile

protected

Name of the help file.

Definition at line 436 of file ApplicationController.h.

QString te::qt::af::ApplicationController::m_appIconName

protected

Icon used in the application.

Definition at line 431 of file ApplicationController.h.

QString te::qt::af::ApplicationController::m_appIconThemeDir

protected

Directory of the application icon theme.

Definition at line 437 of file ApplicationController.h.

std::set<QObject*> te::qt::af::ApplicationController::m_applicationItems

protected

The list of registered application items.

Definition at line 424 of file ApplicationController.h.

QString te::qt::af::ApplicationController::m_appName

protected

Application name.

Definition at line 429 of file ApplicationController.h.

QString te::qt::af::ApplicationController::m_appOrganization

protected

Organization name.

Definition at line 428 of file ApplicationController.h.

QString te::qt::af::ApplicationController::m_appPluginsPath

protected

Name of the plugins path.

Definition at line 435 of file ApplicationController.h.

QSettings te::qt::af::ApplicationController::m_appSettings

protected

Definition at line 446 of file ApplicationController.h.

QString te::qt::af::ApplicationController::m_appTitle

protected

Application title.

Definition at line 430 of file ApplicationController.h.

QString te::qt::af::ApplicationController::m_appToolBarDefaultIconSize

protected

Size of the tool buttons.

Definition at line 439 of file ApplicationController.h.

std::string te::qt::af::ApplicationController::m_appUserSettingsFile

protected

Name of the user settings file.

Definition at line 434 of file ApplicationController.h.

int te::qt::af::ApplicationController::m_defaultSRID

protected

Default SRID value.

Definition at line 441 of file ApplicationController.h.

bool te::qt::af::ApplicationController::m_initialized

protected

A flag indicating if the controller is initialized.

Definition at line 444 of file ApplicationController.h.

std::vector<QMenuBar*> te::qt::af::ApplicationController::m_menuBars

protected

Menu bars registered.

Definition at line 423 of file ApplicationController.h.

std::vector<QMenu*> te::qt::af::ApplicationController::m_menus

protected

Menus registered.

Definition at line 422 of file ApplicationController.h.

QWidget* te::qt::af::ApplicationController::m_msgBoxParentWidget

protected

Parent used to show message boxes.

Definition at line 425 of file ApplicationController.h.

bool te::qt::af::ApplicationController::m_resetTerralib

protected

Definition at line 448 of file ApplicationController.h.

QColor te::qt::af::ApplicationController::m_selectionColor

protected

Default selection color.

Definition at line 442 of file ApplicationController.h.

QString te::qt::af::ApplicationController::m_tLibLogo

protected

Definition at line 433 of file ApplicationController.h.

std::map<QString, QToolBar*> te::qt::af::ApplicationController::m_toolbars

protected

Toolbars registered.

Definition at line 421 of file ApplicationController.h.

QString te::qt::af::ApplicationController::m_userDataDir

protected

The data dir used to store data files.

Definition at line 427 of file ApplicationController.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/qt/af/ApplicationController.h
/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/qt/widgets/Utils.h

Signals

Public Member Functions

Protected Attributes

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation