PluginSelector Class Reference
[Graphical User Interface's components for XINX]
The PluginSelector provides a list of configurable plugin elements. More...
#include <pluginselector.h>
Public Slots | |
| void | clear () |
| Clear the list of PluginElement. | |
Signals | |
| void | configurePlugin (PluginElement *plugin) |
| This signal is emited when the plugin requests to be configured. | |
| void | aboutPlugin (PluginElement *plugin) |
| The signal is emited when the plugin requests to show a description. | |
Public Member Functions | |
| PluginSelector (QWidget *parent=0) | |
| Creates the plugin selector widget. | |
| virtual | ~PluginSelector () |
| Destroys the plugin selector. | |
| void | addPlugin (PluginElement *plugin) |
| Add a plugin to the list. The plugin must be a XinxPluginElement. | |
| const QList< PluginElement * > & | plugins () const |
| List of plugins add in the PluginSelector. | |
| QStyleOptionViewItem | viewOptions () const |
Detailed Description
The PluginSelector provides a list of configurable plugin elements.
- Since:
- 0.7.0.0
- Binary Compatible:
- 0.10.0.0
This class shows to the user the list of plugins with for each plugins a configure button and a about button.
If the plugins suggests one, the list can also show an icon. The list is inspired from some KDE application screen where the user can activate or desactivate plugins.
Each item of the list is a PluginElement :
- The Checkbox is only shown if PluginElement::isModifiable() return true.
- PluginSelector shows in bold the name of the PluginElement, and above the description (truncated with ellipse).
- If PluginElement::pixmap().isValid() an icon is shown.
- PluginElement::isActivated() and PluginElement::setActivated() are both used to show and change the check in the checkbox.
Constructor & Destructor Documentation
| PluginSelector::PluginSelector | ( | QWidget * | parent = 0 |
) |
Creates the plugin selector widget.
- Parameters:
-
parent The parent widget.
| PluginSelector::~PluginSelector | ( | ) | [virtual] |
Destroys the plugin selector.
Member Function Documentation
| void PluginSelector::aboutPlugin | ( | PluginElement * | plugin | ) | [signal] |
The signal is emited when the plugin requests to show a description.
| void PluginSelector::addPlugin | ( | PluginElement * | plugin | ) |
Add a plugin to the list. The plugin must be a XinxPluginElement.
| void PluginSelector::clear | ( | ) | [slot] |
Clear the list of PluginElement.
| void PluginSelector::configurePlugin | ( | PluginElement * | plugin | ) | [signal] |
This signal is emited when the plugin requests to be configured.
| const QList< PluginElement * > & PluginSelector::plugins | ( | ) | const |
List of plugins add in the PluginSelector.
| QStyleOptionViewItem PluginSelector::viewOptions | ( | ) | const |
