Changes between Version 1 and Version 2 of TutorialAddingNewParameter

Timestamp:

11/20/13 11:56:44 (11 years ago)

Author:

Marek Kurdej

Comment:

Added XML modification

TutorialAddingNewParameter

@@ -3 +3 @@
 Let us suppose that we want to add two new parameters to our component.
 First parameter, named "integer-value" of type ```int``` will be obligatory (required).
-Second one, named "floating-point-value" of type ```double``` will be defaulted (we will provide a default value and the user will not be obliged to set it.
+Second one, named "floating-point-value" of type ```double``` will be optional/defaulted (we will provide a default value and the user will not be obliged to set it.
 
 1. Add member fields to your component which will contain parameter values.
@@ -11 +11 @@
 {{{
 class MyComponent
+    : public QObject
+    , public ComponentBase
 {
 public:
@@ -27 +29 @@
 For a ''required'' parameter: add a line like ```("parameter-name", value<!ParameterType>(&variableToSetWithParameterValue)->required(), "parameter description"```.
 
-For a ''defaulted'' parameter: add a line like ```("parameter-name", value<!ParameterType>(&variableToSetWithParameterValue)->default_value(kDefaultParameterValue), "parameter description"```.
+For a ''optional/defaulted'' parameter: add a line like ```("parameter-name", value<!ParameterType>(&variableToSetWithParameterValue)->default_value(kDefaultParameterValue), "parameter description"```.
 
 {{{
@@ -35 +37 @@
 ;
 }}}
+
+3. Modify your XML file
+
+In the ```<components``` section, modify your component by adding the required and, optionally, the defaulted arguments.
+
+'''Before the modification:'''
+{{{
+<component name="mycomp" type="MyComponent" />
+}}}
+
+'''After the modification:'''
+{{{
+<component name="mycomp" type="MyComponent" integer-value="12345" />
+}}}
+or
+{{{
+<component name="mycomp" type="MyComponent" integer-value="12345" floating-point-value="543.21" />
+}}}
+