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  AppCtrlSingleton
 
class  ApplicationController
 The base API for TerraLib applications. More...
 
class  BaseApplication
 
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  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...
 

Enumerations

enum  ListenerType { SENDER, RECEIVER, BOTH }
 

Functions

TEQTAFEXPORT void AddActionToCustomToolbars (te::qt::af::ApplicationController *appController, 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 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 (te::qt::af::ApplicationController *appController)
 
TEQTAFEXPORT QString GetGenerationDate ()
 Writes the configuration file. It updates the application settings. More...
 
TEQTAFEXPORT QString GetLastDatasourceFromSettings ()
 
TEQTAFEXPORT std::vector< std::string > GetPluginsFiles ()
 
TEQTAFEXPORT std::vector< std::string > GetPluginsNames (const std::vector< std::string > &plgFiles)
 
TEQTAFEXPORT QString GetStyleSheetFromColors (QColor primaryColor, QColor secondaryColor)
 
TEQTAFEXPORT QString GetStyleSheetFromSettings ()
 
TEQTAFEXPORT std::vector< QToolBar * > ReadToolBarsFromSettings (te::qt::af::ApplicationController *appController, 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 SaveDataSourcesFile (te::qt::af::ApplicationController *appController)
 Saves data sources file. More...
 
TEQTAFEXPORT void SaveLastDatasourceOnSettings (const QString &dsType)
 
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 (te::qt::af::ApplicationController *appController)
 Update plugins file. More...
 
TEQTAFEXPORT void UpdateUserSettings ()
 Reads and return a te::qt::af::Project from the file. More...
 
TEQTAFEXPORT void UpdateUserSettingsFile (const QString &fileName, const bool &removeOlder=true)
 Changes the user settings file location. More...
 

Detailed Description

Namespace for the Qt Application Framework module of TerraLib.

Enumeration Type Documentation

Enumerator
SENDER 
RECEIVER 
BOTH 

Definition at line 69 of file ApplicationController.h.

Function Documentation

TEQTAFEXPORT void te::qt::af::AddActionToCustomToolbars ( te::qt::af::ApplicationController appController,
QAction *  act 
)

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

Parameters
actAction to be inserted.
TEQTAFEXPORT void te::qt::af::AddToolBarToSettings ( QToolBar *  bar)

Update settings with a new tool bar.

Parameters
barBar to be added.
TEQTAFEXPORT bool te::qt::af::GetAlternateRowColorsFromSettings ( )
Returns
TEQTAFEXPORT QString te::qt::af::GetDateTime ( )
TEQTAFEXPORT QString te::qt::af::GetDefaultConfigFileOutputDir ( )

Returns the default path for output of configuration file.

TEQTAFEXPORT QColor te::qt::af::GetDefaultDisplayColorFromSettings ( )
Returns
TEQTAFEXPORT std::vector<std::string> te::qt::af::GetDefaultPluginsNames ( te::qt::af::ApplicationController appController)
TEQTAFEXPORT QString te::qt::af::GetGenerationDate ( )

Writes the configuration file. It updates the application settings.

Parameters
fileNameComplete path to the configuration file.
appNameName of the application.
appTitleTitle to be presented on the main window.

Writes the user settings file.

Writes the application plugins file.

Writes the default project file.

Returns the date and time of generated binary.

TEQTAFEXPORT QString te::qt::af::GetLastDatasourceFromSettings ( )
Parameters
TEQTAFEXPORT std::vector<std::string> te::qt::af::GetPluginsFiles ( )
TEQTAFEXPORT std::vector<std::string> te::qt::af::GetPluginsNames ( const std::vector< std::string > &  plgFiles)
TEQTAFEXPORT QString te::qt::af::GetStyleSheetFromColors ( QColor  primaryColor,
QColor  secondaryColor 
)
Returns
TEQTAFEXPORT QString te::qt::af::GetStyleSheetFromSettings ( )
Returns
TEQTAFEXPORT std::vector<QToolBar*> te::qt::af::ReadToolBarsFromSettings ( te::qt::af::ApplicationController appController,
QWidget *  barsParent = 0 
)

Returns a vector of tool bars registered in the QSettings.

Parameters
barsParent
TEQTAFEXPORT void te::qt::af::RemoveToolBarFromSettings ( QToolBar *  bar)

Removes a tool bar from the settings.

Parameters
barBar to be removed.
TEQTAFEXPORT void te::qt::af::RestoreState ( QMainWindow *  mainWindow)
TEQTAFEXPORT void te::qt::af::SaveDataSourcesFile ( te::qt::af::ApplicationController appController)

Saves data sources file.

TEQTAFEXPORT void te::qt::af::SaveLastDatasourceOnSettings ( const QString &  dsType)
Parameters
TEQTAFEXPORT void te::qt::af::SaveState ( QMainWindow *  mainWindow)
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
fileNameComplete path to the application configuration file.
TEQTAFEXPORT void te::qt::af::SetDateTime ( const QString &  dateTime)
Parameters
TEQTAFEXPORT QString te::qt::af::UnsavedStar ( const QString  windowTitle,
bool  isUnsaved 
)

Unsaved star.

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

Changes the application plugins file location.

Parameters
fileNameThe new file to be generated.
removeOlderFlag information the remove older application plugins file. If true remove the older file, otherwise maintain it.
TEQTAFEXPORT void te::qt::af::UpdateToolBarsInTheSettings ( te::qt::af::ApplicationController appController)

Update plugins file.

Update the existing tool bars

Parameters
barsSet with the existing tool bars.
TEQTAFEXPORT void te::qt::af::UpdateUserSettings ( )

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

Parameters
uriLocation of the te::qt::af::Project file.
Returns
A pointer to the te::qt::af::Project defined in the uri file.

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

Parameters
readerThe XML reader to be used.
Returns
A pointer to the te::qt::af::Project.

Saves the informations of the project in the uri file.

Parameters
projectThe te::qt::af::Project to be saved.
uriFile location.

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

Parameters
projectThe te::qt::af::Project to be saved.
writerThe XML writer to be used.

Updates user settings file section about information of the projects.

Parameters
prjFilesList of the files containing projects.
prjTitlesList of the titles of the projects.
userConfigFileName of the user configuration file.
TEQTAFEXPORT void te::qt::af::UpdateUserSettingsFile ( const QString &  fileName,
const bool &  removeOlder = true 
)

Changes the user settings file location.

Parameters
fileNameThe new file to be generated.
removeOlderFlag information the remove older settings file. If true remove the older file, otherwise maintain it.