Skip to content

Commit 9de2795

Browse files
committed
latest tweks .. for markdown understanding
1 parent 812797a commit 9de2795

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/properties.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The following are key attributes of properties within the framework
1515
* Property objects can act like a variable
1616
* Property objects allow introspection - they can be discovered and manipulated at runtime via software
1717

18-
### Property Types
18+
## Property Types
1919

2020
The following types are available for properties
2121

@@ -30,7 +30,7 @@ The following types are available for properties
3030
* double
3131
* string
3232

33-
#### Property Use
33+
### Property Use
3434

3535
Setting an value:
3636

@@ -48,26 +48,26 @@ Getting a value:
4848
value = anObject.property.get();
4949
```
5050

51-
### Defining a Property
51+
## Defining a Property
5252

5353
For the framework, two types of property classes exist.
5454

5555
* Standard Property - Defines a property that acts like a variable
5656
* Read/Write Property - Defines a property that calls a ```get()``` method on a value request and calls a ```set()``` method when it's value is set.
5757

58-
#### Different Property "Kinds"
58+
### Different Property "Kinds"
5959

6060
For each of the above types, besides _normal_ property types that are visible and stored as is, there are three different attributes available:
6161

6262
* Hidden - ```flxPropertyHidden<type>```, ```flxPropertyRWHidden<type>``` - The property isn't presented in menu systems, but can be used by an object to store/persist it's value.
6363
* Secure - ```flxPropertySecure<type>```, ```flxPropertyRWSecure<type>``` -The value of the property is encrypted before saving the value. This value is only written internally (not to a public JSON file)
6464
* Secret - ```flxPropertySecret<type>```, ```flxPropertyRWSecret<type>``` - The value is _hidden_ and _secure_.
6565

66-
### Standard Property Objects
66+
## Standard Property Objects
6767

6868
These property objects define a typed property and provided storage for this property. As such, they act like a instance variable for their containment class.
6969

70-
#### Declaring the Property
70+
### Declaring the Property
7171

7272
Within the definition of the class the property is for, the property is defined using the following pattern:
7373

@@ -93,7 +93,7 @@ Available Property Types:
9393
* flxPropertyDouble
9494
* flxPropertyString
9595
96-
##### Example
96+
#### Example
9797
9898
```C++
9999
class MyClass : public flxObject
@@ -105,7 +105,7 @@ public:
105105
}
106106
```
107107

108-
#### Setting an Initial Value
108+
### Setting an Initial Value
109109

110110
The initial value for a property can be set in it's declaration statement by assigning the desired value to the declared variable. The value is set using a standard C++ initialization list syntax - aka `{}` braces.
111111

@@ -121,7 +121,7 @@ public:
121121
}
122122
```
123123
124-
#### Runtime Registration
124+
### Runtime Registration
125125
126126
When an instance of the object that contains the property is created, the property is registered with that object using the ```flxRegister()``` function. This step connects the object instance with the property.
127127
@@ -150,13 +150,13 @@ MyClass()
150150

151151
> Internally, the flxRegister() call makes the containing object aware of the property object - adding it to an internal _property list_. This allows the system to enumerate properties at runtime as part of an introspection process.
152152

153-
### Read/Write (RW) Property Objects
153+
## Read/Write (RW) Property Objects
154154

155155
These property objects define a typed property and required a get and set method be provided to enable reading/writing of the property value.
156156

157157
By calling methods on read and write of the property, the Read/Write property objects allow for the immediate, dynamic response to a property operation.
158158

159-
#### Declaring Read/Write the Property
159+
### Declaring Read/Write the Property
160160

161161
Within the definition of a class the property is for, the property is defined using the following pattern:
162162

@@ -171,7 +171,7 @@ Where:
171171
* Getter - the name of the _get_ method the property should call when it's value is requested. **NOTE**: A reference, `& operator`, to the getter is provided
172172
* Setter - the name of the _set_ method the property should call when it's value is set. **NOTE**: A reference, `& operator`, to the getter is provided
173173

174-
##### Available Property Types
174+
#### Available Property Types
175175

176176
* flxPropertyRWBool - bool property
177177
* flxPropertyRWInt8 - integer 8 property
@@ -184,7 +184,7 @@ Where:
184184
* flxPropertyRWDouble - double
185185
* flxPropertyRWString - string -> std::string
186186

187-
##### Getter Methods
187+
#### Getter Methods
188188

189189
These methods are implemented on the containing class and are called when the value of a property is requested. These methods have the following signature:
190190

@@ -200,7 +200,7 @@ Where
200200
Note
201201
>By convention, getters method names are prefixed by ```get_```
202202
203-
##### Setter Methods
203+
#### Setter Methods
204204
205205
These methods are implemented on the containing class and are called when the value of a property is set. These methods have the following signature:
206206
@@ -216,7 +216,7 @@ Where
216216
Note
217217
> By convention, getters method names are prefixed by ```set_```
218218
219-
##### Example
219+
#### Example {#rw-props-example}
220220

221221
```C++
222222
class MyClass2 : public flxObject
@@ -239,7 +239,7 @@ Note
239239
> * The use of `set_` and `get_` prefixes on the setter and getter methods help identify the methods as supporting a property.
240240
> * If an initial value is set for a RW property it it's declaration statement, the _setter_ method called with the initial value when the property is registered via _flxRegister()_.
241241
242-
#### RW Property Runtime Registration
242+
### RW Property Runtime Registration
243243
244244
When an instance of the object that contains the property is created, the property is registered with that object using the ```flxRegister()``` function. This step connects the object instance with the property.
245245
@@ -268,9 +268,9 @@ MyClass2()
268268

269269
Note: If an initial value was set for the property, the value is passed to the _setter_ method as part of the registration process.
270270

271-
### Property Data Limits
271+
## Property Data Limits
272272

273-
#### Data Limit Values
273+
### Data Limit Values
274274

275275
Data limits define restrictions on the values the input parameter accepts. There are two types of data limits: range and valid value sets.
276276

0 commit comments

Comments
 (0)