kitchensync
QSync::Environment Class Reference
List of all members.Detailed Description
Definition at line 36 of file environment.h.
Public Member Functions | |
| Environment () | |
| ~Environment () | |
| GroupIterator | groupBegin () |
| GroupIterator | groupEnd () |
| PluginIterator | pluginBegin () |
| PluginIterator | pluginEnd () |
| Result | initialize () |
| Result | finalize () |
| int | groupCount () const |
| Group | groupAt (int pos) const |
| Group | groupByName (const QString &name) const |
| Group | addGroup () |
| Result | removeGroup (const Group &group) |
| int | pluginCount () const |
| Plugin | pluginAt (int pos) const |
| Plugin | pluginByName (const QString &name) const |
| Conversion | conversion () const |
Classes | |
| class | GroupIterator |
| class | PluginIterator |
Member Function Documentation
| Environment::GroupIterator Environment::groupBegin | ( | ) |
Returns an iterator pointing to the first item in the group list.
This iterator equals groupEnd() if the group list is empty.
Definition at line 38 of file environment.cpp.
| Environment::GroupIterator Environment::groupEnd | ( | ) |
Returns an iterator pointing past the last item in the group list.
This iterator equals groupBegin() if the group list is empty.
Definition at line 46 of file environment.cpp.
| Environment::PluginIterator Environment::pluginBegin | ( | ) |
Returns an iterator pointing to the first item in the plugin list.
This iterator equals pluginEnd() if the group list is empty.
Definition at line 54 of file environment.cpp.
| Environment::PluginIterator Environment::pluginEnd | ( | ) |
Returns an iterator pointing past the last item in the plugin list.
This iterator equals pluginBegin() if the plugin list is empty.
Definition at line 62 of file environment.cpp.
| Result Environment::initialize | ( | ) |
Initializes the environment ( e.g.
loads the groups and plugins ). Has to be called before the groups or plugins can be accessed.
Definition at line 70 of file environment.cpp.
| Result Environment::finalize | ( | ) |
Finalizes the environment ( e.g.
unloads the groups and plugins ). Should be the last call before the object is deleted.
Definition at line 79 of file environment.cpp.
| int Environment::groupCount | ( | ) | const |
| Group Environment::groupAt | ( | int | pos | ) | const |
| Group Environment::groupByName | ( | const QString & | name | ) | const |
Returns a group by name or an invalid group when the group with this name doesn't exists.
Definition at line 106 of file environment.cpp.
| Group Environment::addGroup | ( | ) |
Adds a new group to the environment.
- Returns:
- the new group.
Definition at line 117 of file environment.cpp.
| int Environment::pluginCount | ( | ) | const |
| Plugin Environment::pluginAt | ( | int | pos | ) | const |
| Plugin Environment::pluginByName | ( | const QString & | name | ) | const |
Returns a plugin by name or an invalid plugin when the plugin with this name doesn't exists.
Definition at line 155 of file environment.cpp.
| Conversion Environment::conversion | ( | ) | const |
The documentation for this class was generated from the following files:
