Documents > BPS V2 C++ API
BpsConfigWidget Class Reference

Abstract configuration widget. More...

#include <bpsconfigwidget.h>

+ Inheritance diagram for BpsConfigWidget:

List of all members.

Signals

void configChanged ()
 Signal emitted whenever the configuration changes.
void configEdited ()
 Signal emitted when a user changes the configuration.
void configValid (bool aValid)
 Signal emitted when valid/invalid status changes;.

Public Member Functions

 BpsConfigWidget (QWidget *aParent=0)
 The constructor.
virtual QMap< QString, QString > config () const
virtual void focusToFirstInput ()
 Set the focus to the first input.
virtual void focusToFirstInvalidInput ()
 Set the focus to the first input responsible for the invalid state.
virtual bool isConfigValid () const
virtual void setConfig (const QMap< QString, QString > &aConfig)
 Set the configuration settings to edit.
virtual ~BpsConfigWidget ()
 Virtual default destructor.

Detailed Description

Abstract configuration widget.


Constructor & Destructor Documentation

BpsConfigWidget::BpsConfigWidget ( QWidget *  aParent = 0)

The constructor.

Parameters:
[in]aParentThe parent widget.

Member Function Documentation

virtual QMap<QString,QString> BpsConfigWidget::config ( ) const [virtual]
Returns:
The configuration settings as currently edited.
void BpsConfigWidget::configChanged ( ) [signal]

Signal emitted whenever the configuration changes.

The signal is also emitted when the configuration is changed by calling setConfig().

void BpsConfigWidget::configEdited ( ) [signal]

Signal emitted when a user changes the configuration.

The signal is not emitted when the configuration is changed by calling setConfig().

void BpsConfigWidget::configValid ( bool  aValid) [signal]

Signal emitted when valid/invalid status changes;.

Parameters:
[in]aValidTrue on valid configuration.
virtual void BpsConfigWidget::focusToFirstInvalidInput ( ) [virtual]

Set the focus to the first input responsible for the invalid state.

If state is valid, sets focus to the first input.

virtual bool BpsConfigWidget::isConfigValid ( ) const [virtual]
Returns:
True if the widget has a valid configuration.
virtual void BpsConfigWidget::setConfig ( const QMap< QString, QString > &  aConfig) [virtual]

Set the configuration settings to edit.

Parameters:
[in]aConfigThe configuration settings to use.

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