te::qt::af Namespace Reference

Namespace for the Qt Application Framework module of TerraLib. More...

Namespaces
	evt

Classes
class	AbstractSettingWidget
	A frame for setting Table options. More...
class	ApplicationController
	The base API for TerraLib applications. More...
class	BaseApplication
	A QMainWindow to be used as the basis for TerraLib applications. More...
class	ChartDisplayDockWidget
	A dock widget for ChartDisplayWidget objects. More...
class	DataSetTableDockWidget
	A dock widget for DataSetTableView objects. More...
class	DisplayWidget
	A frame for setting display options. More...
class	DisplayWidgetFactory
	A factory to build the display frame object. More...
class	GeneralConfigWidget
class	GeneralConfigWidgetFactory
	A factory to build the general config frame object. More...
class	InterfaceController
	A connector to controll all non modal interfaces. More...
class	LayerExplorer
	A connector for the te::qt::widgets::LayerExplorer class to the Application Framework. More...
class	MapDisplay
	A connector of the te::qt::widgets::MapDisplay class to the Application Framework. More...
class	MenuBarModel
	Defines a model, based on a QMenuBar, to present all system buttons as a table. More...
class	Project
	This class models the concept of a project for the TerraLib Application Framework. More...
class	ProjectInfoDialog
class	ProjectInfoWidget
	A widget for present te::qt::af::Project informations. More...
class	ProjectWidget
	A frame for setting grid options. More...
class	ProjectWidgetFactory
	A factory to build the project frame object. More...
class	SettingsDialog
class	SettingsWidgetsFactory
class	SplashScreenManager
	A singleton for holding he application splash screen. More...
class	StyleExplorer
	A connector for the te::qt::widgets::StyleDockWidget class to the Application Framework. More...
class	TableWidget
	A frame for setting Table options. More...
class	TableWidgetFactory
	A factory to build the Table widget object. More...
class	ToolbarsWidget
class	ToolbarsWidgetFactory
	A factory to build the Table widget object. More...
class	XMLFormatter
	A class that formats strings. More...

Functions
TEQTAFEXPORT void	AddActionToCustomToolbars (QAction *act)
	Check QSettings for existance of act and adds it if necessary. More...
TEQTAFEXPORT void	AddToolBarToSettings (QToolBar *bar)
	Update settings with a new tool bar. More...
TEQTAFEXPORT void	CreateDefaultSettings ()
	Creates a default QSettings. More...
TEQTAFEXPORT bool	GetAlternateRowColorsFromSettings ()
TEQTAFEXPORT QString	GetDateTime ()
TEQTAFEXPORT QString	GetDefaultConfigFileOutputDir ()
	Returns the default path for output of configuration file. More...
TEQTAFEXPORT QColor	GetDefaultDisplayColorFromSettings ()
TEQTAFEXPORT std::vector < std::string >	GetDefaultPluginsNames ()
TEQTAFEXPORT QString	GetExtensionFilter ()
	Return extension filter string. More...
TEQTAFEXPORT QString	GetGenerationDate ()
	Returns the date and time of generated binary. More...
TEQTAFEXPORT QString	GetLastDatasourceFromSettings ()
TEQTAFEXPORT bool	GetOpenLastProjectFromSettings ()
TEQTAFEXPORT std::vector < std::string >	GetPluginsFiles ()
TEQTAFEXPORT std::vector < std::string >	GetPluginsNames (const std::vector< std::string > &plgFiles)
TEQTAFEXPORT void	GetProjectInformationsFromSettings (QString &defaultAuthor, int &maxSaved)
TEQTAFEXPORT QString	GetStyleSheetFromColors (QColor primaryColor, QColor secondaryColor)
TEQTAFEXPORT QString	GetStyleSheetFromSettings ()
TEQTAFEXPORT QString	GetWindowTitle (const Project &project)
	Return a QString with the new window title based on the project informations. More...
TEQTAFEXPORT Project *	ReadProject (const std::string &uri)
	Reads and return a te::qt::af::Project from the file. More...
TEQTAFEXPORT Project *	ReadProject (te::xml::Reader &reader)
	Reads and return a te::qt::af::Project using reader XML reader. More...
TEQTAFEXPORT std::vector < QToolBar * >	ReadToolBarsFromSettings (QWidget *barsParent=0)
	Returns a vector of tool bars registered in the QSettings. More...
TEQTAFEXPORT void	RemoveToolBarFromSettings (QToolBar *bar)
	Removes a tool bar from the settings. More...
TEQTAFEXPORT void	RestoreState (QMainWindow *mainWindow)
TEQTAFEXPORT void	Save (const Project &project, const std::string &uri)
	Saves the informations of the project in the uri file. More...
TEQTAFEXPORT void	Save (const Project &project, te::xml::AbstractWriter &writer)
	Saves the informations of the te::qt::af::Project using writer XML writer. More...
TEQTAFEXPORT void	SaveDataSourcesFile ()
	Saves data sources file. More...
TEQTAFEXPORT void	SaveLastDatasourceOnSettings (const QString &dsType)
TEQTAFEXPORT void	SaveOpenLastProjectOnSettings (bool openLast)
TEQTAFEXPORT void	SaveProjectInformationsOnSettings (const QString &defaultAuthor, const int &maxSaved)
TEQTAFEXPORT void	SaveState (QMainWindow *mainWindow)
TEQTAFEXPORT void	SetConfigFileName (const QString &fileName)
	Returns the complete path of the configuration file or an empty value if it not exists. More...
TEQTAFEXPORT void	SetDateTime (const QString &dateTime)
TEQTAFEXPORT QString	UnsavedStar (const QString windowTitle, bool isUnsaved)
	Unsaved star. More...
TEQTAFEXPORT void	UpdateAppPluginsFile (const QString &fileName, const bool &removeOlder=true)
	Changes the application plugins file location. More...
TEQTAFEXPORT void	UpdateToolBarsInTheSettings ()
	Update plugins file. More...
TEQTAFEXPORT void	UpdateUserSettings (const QStringList &prjFiles, const QStringList &prjTitles, const std::string &userConfigFile)
	Updates user settings file section about information of the projects. More...
TEQTAFEXPORT void	UpdateUserSettingsFile (const QString &fileName, const bool &removeOlder=true)
	Changes the user settings file location. More...
TEQTAFEXPORT void	WriteDefaultProjectFile (const QString &fileName)
	Writes the configuration file. It updates the application settings. More...

Detailed Description

Namespace for the Qt Application Framework module of TerraLib.

Function Documentation

void te::qt::af::AddActionToCustomToolbars

(

QAction *

act

)

Check QSettings for existance of act and adds it if necessary.

Parameters

act	Action to be inserted.

Definition at line 763 of file Utils.cpp.

Referenced by te::qt::plugins::vp::Plugin::registerActions(), te::qt::plugins::sa::Plugin::registerActions(), te::qt::plugins::rp::Plugin::registerActions(), te::qt::plugins::attributefill::Plugin::startup(), te::qt::plugins::terralib4::Plugin::startup(), te::qt::plugins::ogr::Plugin::startup(), te::qt::plugins::gdal::Plugin::startup(), and te::qt::plugins::addressgeocoding::Plugin::startup().

void te::qt::af::AddToolBarToSettings

(

QToolBar *

bar

)

Update settings with a new tool bar.

Parameters

bar	Bar to be added.

Definition at line 473 of file Utils.cpp.

References AddToolbarAndActions().

Referenced by te::qt::af::ToolbarsWidget::saveChanges().

void te::qt::af::CreateDefaultSettings

(

)

Creates a default QSettings.

Definition at line 621 of file Utils.cpp.

Referenced by te::qt::af::ApplicationController::initialize().

bool te::qt::af::GetAlternateRowColorsFromSettings

(

)

Returns

Definition at line 755 of file Utils.cpp.

Referenced by te::qt::af::DataSetTableDockWidget::DataSetTableDockWidget().

QString te::qt::af::GetDateTime

(

)

Definition at line 852 of file Utils.cpp.

QString te::qt::af::GetDefaultConfigFileOutputDir

(

)

Returns the default path for output of configuration file.

Definition at line 866 of file Utils.cpp.

QColor te::qt::af::GetDefaultDisplayColorFromSettings

(

)

Returns

Definition at line 715 of file Utils.cpp.

Referenced by te::qt::af::MapDisplay::MapDisplay().

std::vector< std::string > te::qt::af::GetDefaultPluginsNames

(

)

Definition at line 814 of file Utils.cpp.

References te::common::Singleton< ApplicationController >::getInstance().

Referenced by te::qt::af::ApplicationController::initializePlugins().

QString te::qt::af::GetExtensionFilter

(

)

Return extension filter string.

Definition at line 971 of file Utils.cpp.

References te::common::Singleton< ApplicationController >::getInstance().

Referenced by te::qt::af::BaseApplication::onOpenProjectTriggered(), te::qt::af::BaseApplication::onSaveProjectAsTriggered(), and te::qt::af::BaseApplication::onSaveProjectTriggered().

QString te::qt::af::GetGenerationDate

(

)

Returns the date and time of generated binary.

Definition at line 938 of file Utils.cpp.

QString te::qt::af::GetLastDatasourceFromSettings

(

)

Returns

Definition at line 601 of file Utils.cpp.

Referenced by te::qt::af::BaseApplication::onAddDataSetLayerTriggered(), te::qt::af::BaseApplication::onChangeLayerDataSourceTriggered(), te::qt::af::BaseApplication::onDataSourceExplorerTriggered(), and te::qt::af::BaseApplication::onToolsDataExchangerDirectTriggered().

bool te::qt::af::GetOpenLastProjectFromSettings

(

)

Returns

Definition at line 608 of file Utils.cpp.

Referenced by te::qt::af::BaseApplication::init().

std::vector< std::string > te::qt::af::GetPluginsFiles

(

)

Definition at line 794 of file Utils.cpp.

References te::common::FindInTerraLibPath().

Referenced by te::qt::af::ApplicationController::initializePlugins().

std::vector< std::string > te::qt::af::GetPluginsNames

(

const std::vector< std::string > &

plgFiles

)

Definition at line 836 of file Utils.cpp.

void te::qt::af::GetProjectInformationsFromSettings	(	QString &	defaultAuthor,
		int &	maxSaved
	)

Definition at line 567 of file Utils.cpp.

Referenced by te::qt::af::BaseApplication::newProject(), te::qt::af::ProjectWidget::resetState(), and te::qt::af::ApplicationController::updateRecentProjects().

QString te::qt::af::GetStyleSheetFromColors	(	QColor	primaryColor,
		QColor	secondaryColor
	)

Returns

Definition at line 727 of file Utils.cpp.

References GetRGBString().

Referenced by GetStyleSheetFromSettings(), te::qt::af::TableWidget::onAlternateRowColorsGroupBoxClicked(), te::qt::af::DataSetTableDockWidget::onApplicationTriggered(), te::qt::af::TableWidget::onPrimaryPushButtonClicked(), te::qt::af::TableWidget::onSecondaryPushButtonClicked(), and te::qt::af::TableWidget::TableWidget().

QString te::qt::af::GetStyleSheetFromSettings

(

)

Returns

Definition at line 738 of file Utils.cpp.

References GetStyleSheetFromColors().

Referenced by te::qt::af::DataSetTableDockWidget::DataSetTableDockWidget().

QString te::qt::af::GetWindowTitle

(

const Project &

project

)

Return a QString with the new window title based on the project informations.

Definition at line 954 of file Utils.cpp.

References te::qt::af::Project::getFileName(), te::common::Singleton< ApplicationController >::getInstance(), te::qt::af::Project::getTitle(), and TE_TR.

Referenced by te::qt::af::BaseApplication::newProject(), te::qt::af::BaseApplication::onProjectPropertiesTriggered(), te::qt::af::BaseApplication::onSaveProjectAsTriggered(), te::qt::af::BaseApplication::onSaveProjectTriggered(), and te::qt::af::BaseApplication::openProject().

te::qt::af::Project * te::qt::af::ReadProject

(

const std::string &

uri

)

Reads and return a te::qt::af::Project from the file.

Parameters

uri	Location of the te::qt::af::Project file.

Returns

A pointer to the te::qt::af::Project defined in the uri file.

Definition at line 77 of file Utils.cpp.

References te::xml::ReaderFactory::make(), te::qt::af::Project::setFileName(), te::qt::af::Project::setProjectAsChanged(), te::xml::START_ELEMENT, and TE_TR.

Referenced by te::qt::af::BaseApplication::openProject().

te::qt::af::Project * te::qt::af::ReadProject

(

te::xml::Reader &

reader

)

Reads and return a te::qt::af::Project using reader XML reader.

Parameters

reader

The XML reader to be used.

Returns

A pointer to the te::qt::af::Project.

Definition at line 110 of file Utils.cpp.

References te::xml::END_DOCUMENT, te::xml::END_ELEMENT, te::xml::Reader::getElementLocalName(), te::xml::Reader::getElementValue(), te::common::Singleton< DataSourceInfoManager >::getInstance(), te::common::Singleton< Layer >::getInstance(), te::xml::Reader::getNodeType(), te::xml::Reader::next(), te::map::serialize::Layer::read(), te::serialize::xml::ReadDataSourceInfo(), te::xml::START_ELEMENT, and te::xml::VALUE.

std::vector< QToolBar * > te::qt::af::ReadToolBarsFromSettings

(

QWidget *

barsParent = 0

)

Returns a vector of tool bars registered in the QSettings.

Parameters

barsParent

Definition at line 493 of file Utils.cpp.

Referenced by te::qt::af::BaseApplication::initToolbars().

void te::qt::af::RemoveToolBarFromSettings

(

QToolBar *

bar

)

Removes a tool bar from the settings.

Parameters

bar	Bar to be removed.

Definition at line 484 of file Utils.cpp.

Referenced by RemoveBars().

void te::qt::af::RestoreState

(

QMainWindow *

mainWindow

)

Definition at line 557 of file Utils.cpp.

Referenced by te::qt::af::BaseApplication::resetState().

void te::qt::af::Save	(	const Project &	project,
		const std::string &	uri
	)

Saves the informations of the project in the uri file.

Parameters

project	The te::qt::af::Project to be saved.
uri	File location.

Definition at line 194 of file Utils.cpp.

References te::xml::AbstractWriterFactory::make(), and te::serialize::xml::Save().

Referenced by te::qt::af::BaseApplication::onSaveProjectAsTriggered(), and te::qt::af::BaseApplication::onSaveProjectTriggered().

void te::qt::af::Save	(	const Project &	project,
		te::xml::AbstractWriter &	writer
	)

Saves the informations of the te::qt::af::Project using writer XML writer.

Parameters

project	The te::qt::af::Project to be saved.
writer	The XML writer to be used.

Definition at line 221 of file Utils.cpp.

References te::common::ConvertLatin1UTFString(), te::common::FindInTerraLibPath(), te::qt::af::Project::getAuthor(), te::common::Singleton< DataSourceInfoManager >::getInstance(), te::common::Singleton< Layer >::getInstance(), te::qt::af::Project::getTitle(), te::qt::af::Project::getTopLayers(), te::map::serialize::Layer::write(), te::xml::AbstractWriter::writeAttribute(), te::xml::AbstractWriter::writeElement(), te::xml::AbstractWriter::writeEndElement(), te::xml::AbstractWriter::writeStartDocument(), te::xml::AbstractWriter::writeStartElement(), te::xml::AbstractWriter::writeToFile(), and te::xml::AbstractWriter::writeValue().

void te::qt::af::SaveDataSourcesFile

(

)

Saves data sources file.

Definition at line 413 of file Utils.cpp.

References te::serialize::xml::Save(), and TERRALIB_APPLICATION_DATASOURCE_FILE_NAME.

Referenced by te::qt::af::ApplicationController::finalize(), te::qt::af::BaseApplication::onSaveProjectAsTriggered(), and te::qt::af::BaseApplication::onSaveProjectTriggered().

void te::qt::af::SaveLastDatasourceOnSettings

(

const QString &

dsType

)

Parameters

Definition at line 587 of file Utils.cpp.

Referenced by te::qt::af::BaseApplication::onAddDataSetLayerTriggered(), and te::qt::af::BaseApplication::onDataSourceExplorerTriggered().

void te::qt::af::SaveOpenLastProjectOnSettings

(

bool

openLast

)

Parameters

Definition at line 594 of file Utils.cpp.

Referenced by te::qt::af::ProjectWidget::saveChanges().

void te::qt::af::SaveProjectInformationsOnSettings	(	const QString &	defaultAuthor,
		const int &	maxSaved
	)

Definition at line 577 of file Utils.cpp.

Referenced by te::qt::af::ProjectWidget::saveChanges().

void te::qt::af::SaveState

(

QMainWindow *

mainWindow

)

Definition at line 547 of file Utils.cpp.

Referenced by te::qt::af::BaseApplication::~BaseApplication().

TEQTAFEXPORT void te::qt::af::SetConfigFileName

(

const QString &

fileName

)

Returns the complete path of the configuration file or an empty value if it not exists.

Setts the name of the application configuration file.

Parameters

fileName

Complete path to the application configuration file.

void te::qt::af::SetDateTime

(

const QString &

dateTime

)

Parameters

Definition at line 859 of file Utils.cpp.

QString te::qt::af::UnsavedStar	(	const QString	windowTitle,
		bool	isUnsaved
	)

Unsaved star.

Definition at line 697 of file Utils.cpp.

Referenced by te::qt::af::BaseApplication::onApplicationTriggered().

TEQTAFEXPORT void te::qt::af::UpdateAppPluginsFile	(	const QString &	fileName,
		const bool &	removeOlder = true
	)

Changes the application plugins file location.

Parameters

fileName	The new file to be generated.
removeOlder	Flag information the remove older application plugins file. If true remove the older file, otherwise maintain it.

void te::qt::af::UpdateToolBarsInTheSettings

(

)

Update plugins file.

Update the existing tool bars

Parameters

bars	Set with the existing tool bars.

Definition at line 453 of file Utils.cpp.

References AddToolbarAndActions(), and te::common::Singleton< ApplicationController >::getInstance().

Referenced by te::qt::af::ToolbarsWidget::saveChanges().

void te::qt::af::UpdateUserSettings	(	const QStringList &	prjFiles,
		const QStringList &	prjTitles,
		const std::string &	userConfigFile
	)

Updates user settings file section about information of the projects.

Parameters

prjFiles	List of the files containing projects.
prjTitles	List of the titles of the projects.
userConfigFile	Name of the user configuration file.

Definition at line 320 of file Utils.cpp.

References te::common::Singleton< PluginManager >::getInstance().

Referenced by te::qt::af::ApplicationController::finalize().

void te::qt::af::UpdateUserSettingsFile	(	const QString &	fileName,
		const bool &	removeOlder = true
	)

Changes the user settings file location.

Parameters

fileName	The new file to be generated.
removeOlder	Flag information the remove older settings file. If true remove the older file, otherwise maintain it.

Definition at line 875 of file Utils.cpp.

References te::common::ApplicationSettings::getAllSettings(), te::common::Singleton< UserApplicationSettings >::getInstance(), te::common::Singleton< T >::getInstance(), te::common::ApplicationSettings::getValue(), te::common::UserApplicationSettings::load(), and te::common::ApplicationSettings::setValue().

void te::qt::af::WriteDefaultProjectFile

(

const QString &

fileName

)

Writes the configuration file. It updates the application settings.

Parameters

fileName	Complete path to the configuration file.
appName	Name of the application.
appTitle	Title to be presented on the main window.

Writes the user settings file.

Writes the application plugins file.

Writes the default project file.

Definition at line 909 of file Utils.cpp.

References te::common::FindInTerraLibPath().