Commit fea00bf0 authored by Sebastian Eichelbaum's avatar Sebastian Eichelbaum
Browse files

[DOC]

parent e8c825da
......@@ -45,11 +45,10 @@ public:
/**
* Creates a new progress instance as child of the specified progress. The instance is instantly marked "running".
*
* \param parent parent progress or NULL if there is no parent.
* \param name name of the progress, can be empty.
* \param count value denoting the final value. A value of zero will cause this progress to be indetermined.
*
* \note Reaching the count does not automatically stop the progress. You still need to call stop().
* \note Reaching the count does not automatically stop the progress. You still need to call finish().
* \note An indetermined progress is just indicating a pending progress without progress information.
*/
WProgress( std::string name, unsigned int count = 0 );
......
......@@ -60,6 +60,8 @@ public:
/**
* Run thread. This does not start threadMain(() but runs a specified function instead.
*
* \param f the function to run instead of the threadMain method.
*/
void run( THREADFUNCTION f );
......
......@@ -44,6 +44,9 @@ public:
TS_ASSERT_EQUALS( prop.getValue<bool>(), true );
}
/**
* Test whether a value can be set to a property.
*/
void testBoolSetFalse( void )
{
WProperty prop( "testProp", true );
......@@ -51,6 +54,9 @@ public:
TS_ASSERT_EQUALS( prop.getValue<bool>(), false );
}
/**
* Test whether the boolean is properly stored as string internally.
*/
void testBoolGetString( void )
{
WProperty prop( "testProp", true );
......
......@@ -41,45 +41,66 @@ class WPropertyManager : public QObject
public:
/**
* standard constructor
* Standard constructor. Creates an empty property manager.
*/
WPropertyManager();
/**
* destructor
* Destructor.
*/
virtual ~WPropertyManager();
/**
* adds a property pointer to the list
* Add a property to the list of managed properties.
*
* \param properties the property to add.
*/
void connectProperties( boost::shared_ptr< WProperties > properties );
public slots:
/**
* slot function that writes a boolean value to all properties objects that contain an entry
* with that name
* Slot function that writes a boolean value to all properties objects that contain an entry
* with that name.
*
* \param name the name of the property to set the bool for.
* \param value the bool value to set.
*/
void slotBoolChanged( QString name, bool value );
/**
* slot function that writes a integer value to all properties objects that contain an entry
* Slot function that writes a integer value to all properties objects that contain an entry
* with that name
*
* \param name the name of the property to set the value for.
* \param value the value to set.
*/
void slotIntChanged( QString name, int value );
/**
* slot function that writes a float value to all properties objects that contain an entry
* with that name
*
* \param name the name of the property to set the value for.
* \param value the value to set.
*/
void slotFloatChanged( QString name, float value );
/**
* slot function that writes a string value to all properties objects that contain an entry
* with that name
*
* \param name the name of the property to set the value for.
* \param value the value to set.
*/
void slotStringChanged( QString name, QString value );
protected:
private:
/**
* List of all properties actually connected with this manager instance.
*/
std::vector< boost::shared_ptr< WProperties > > m_connectedProperties;
};
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment