source: trunk/examples/objects/api/cpp/boolean @ 1586

Last change on this file since 1586 was 1586, checked in by dkearney, 11 years ago

updating potential apis for c cpp and python. adding random() and diff()
functions to the rappture objects. objects should be able to generate a random
value for itself based on how it was configured. objects should be able to
compare itself with another object and tell us what the differences are.

File size: 10.7 KB
Line 
1Boolean
2
3constructors/destructors
4    Boolean()
5    Boolean(const char *name, bool val);
6    Boolean(const char *name, bool val, const char *label,
7                const char *desc);
8    Boolean(const Boolean& o);
9    ~Boolean ();
10
11methods
12    const char *name() const;
13    void name(const char *val);
14
15    const char *path() const;
16    void path(const char *val);
17
18    const char *label() const;
19    void label(const char *val);
20
21    const char *desc() const;
22    void desc(const char *val);
23
24    const char *hints() const;
25    void hints(const char *val);
26
27    const char *color() const;
28    void color(const char *val);
29
30    bool def() const;
31    void def(bool val);
32
33    bool cur() const;
34    void cur(bool val);
35
36    int defset() const;
37    int curset() const;
38
39    const void *property (const char *key) const;
40    void property (const char *key, const void *val, size_t nbytes);
41
42    const char *propstr (const char *key) const;
43    void propstr (const char *key, const char *val);
44
45    void propremove (const char *key);
46
47    void vvalue(void *storage, size_t numHints, va_list arg) const;
48    void random();
49    Rp_Chain *diff(const Object& o);
50
51    void configure(size_t as, ClientData c);
52    void dump(size_t as, ClientData c);
53
54    Outcome &outcome() const;
55
56    const int is() const;
57
58    void defFromStr(const char *val);
59    void curFromStr(const char *val);
60
61---------------------------------------
62
63const char *name()
64    Purpose: get the id name of the object
65    Input Arguments: None
66    Return Value: the id name stored in the object.
67    Notes: if no name is set, NULL will be returned
68            the id name is used to identify this object from
69            all other objects and should be unique
70    Code Example:
71
72void name(const char *val)
73    Purpose: set the id name of the object
74    Input Arguments: 1
75        1. const char *val - new id name
76    Return Value: None
77    Notes: a copy of the memory location val will be stored
78    Code Example:
79
80const char *path()
81    Purpose: get the path of the object
82    Input Arguments: None
83    Return Value: the path stored in the object.
84    Notes: if no path is set, NULL will be returned
85            the path tells where this object sits in the
86            hierarchy of objects.
87    Code Example:
88
89void path(const char *val)
90    Purpose: set the path of the object
91    Input Arguments: 1
92        1. const char *val - new path
93    Return Value: None
94    Notes: a copy of the memory location val will be stored
95    Code Example:
96
97const char *label()
98    Purpose: get the label of the object
99    Input Arguments: None
100    Return Value: the label stored in the object.
101    Notes: if no label is set, NULL will be returned
102            the label is used by the graphical user interface.
103    Code Example:
104
105void label(const char *val)
106    Purpose: set the label of the object
107    Input Arguments: 1
108        1. const char *val - new label
109    Return Value: None
110    Notes: a copy of the memory location val will be stored
111    Code Example:
112
113const char *desc()
114    Purpose: get the description of the object
115    Input Arguments: None
116    Return Value: the description stored in the object.
117    Notes: if no description is set, NULL will be returned
118            the description is used by the graphical user
119            interface to describe what type of data is being
120            requested and how the input is used.
121    Code Example:
122
123void desc(const char *val)
124    Purpose: set the description of the object
125    Input Arguments: 1
126        1. const char *val - new description
127    Return Value: None
128    Notes: a copy of the memory location val will be stored
129    Code Example:
130
131const char *hints()
132    Purpose: get the hints of the object
133    Input Arguments: None
134    Return Value: the hints stored in the object.
135    Notes: if no hints are set, NULL will be returned
136            the hints are used by the graphical user interface
137    Code Example:
138
139void hints(const char *val)
140    Purpose: set the hints of the object
141    Input Arguments: 1
142        1. const char *val - new hints
143    Return Value: None
144    Notes: a copy of the memory location val will be stored
145    Code Example:
146
147bool def()
148    Purpose: get the default value
149    Input Arguments: None
150    Return Value: the default value stored in the object.
151    Notes: None
152    Code Example:
153
154void def(bool val)
155    Purpose: set the default value
156    Input Arguments: 1
157        1. bool val - new default value
158    Return Value: None
159    Notes: None
160    Code Example:
161
162bool cur()
163    Purpose: get the current value
164    Input Arguments: None
165    Return Value: the current value stored in the object.
166    Notes: None
167    Code Example:
168
169void cur(bool val)
170    Purpose: set the current value
171    Input Arguments: 1
172        1. bool val - new current value
173    Return Value: None
174    Notes: None
175    Code Example:
176
177int defset() const
178    Purpose: return whether the default value was set by the user
179    Input Arguments: None
180    Return Value: 1 if default was set by user, otherwise 0
181    Notes: None
182    Code Example:
183
184int curset() const
185    Purpose: return whether the current value was set by the user
186    Input Arguments: None
187    Return Value: 1 if current was set by user, otherwise 0
188    Notes: None
189    Code Example:
190
191const void *property (const char *key) const;
192    Purpose: get a generic property from the property database
193    Input Arguments: 1
194        1. const char *key - property name
195    Return Value: value of the property
196    Notes: None
197    Code Example:
198
199void property (const char *key, const void *val, size_t nbytes);
200    Purpose: set a generic property in the property database
201    Input Arguments: 3
202        1. const char *key - property name
203        2. const void *val - property value
204        3. size_t nbytes - size (in bytes) of the value
205    Return Value: None
206    Notes: A copy of the memory pointed to by val is stored
207            in the property database
208    Code Example:
209
210const char *propstr (const char *key) const;
211    Purpose: get a string property from the property database
212    Input Arguments: 1
213        1. const char *key - property name
214    Return Value: value of the property
215    Notes: None
216    Code Example:
217
218void propstr (const char *key, const char *val);
219    Purpose: set a string property in the property database
220    Input Arguments: 2
221        1. const char *key - property name
222        2. const char *val - property value
223    Return Value: None
224    Notes: A copy of the memory pointed to by val is stored
225            in the property database
226    Code Example:
227
228void propremove (const char *key);
229    Purpose: remove a property from the property database
230    Input Arguments: 1
231        1. const char *key - property name
232    Return Value: value of the property
233    Notes: None
234    Code Example:
235
236void vvalue(void *storage, size_t numHints, va_list arg) const;
237    Purpose: return the value of the object after applying a
238                varying number of hints about how the value
239                should be configured
240    Input Arguments: 3
241        1. void *storage - the return value
242        2. size_t numHints - number of hints provided
243        3. va_list arg - list of hints specified as a va_list
244    Return Value: None
245    Notes: vvalue will parse out the recognisable hints from
246                va_list arg. Values stored in the object are
247                not changed.
248    Code Example:
249
250void random();
251    Purpose: populate the object with a random value
252    Input Arguments: 0
253    Return Value: None
254    Notes: the current value of this object will be populated
255           with a random value that fits within the min and
256           max if they were specified.
257    Code Example:
258
259Rp_Chain *diff(const Rp_Object &o);
260    Purpose: return a linked list showing the differences between
261             this object and Rp_Object &o
262    Input Arguments: 1
263        1. const Rp_Object &o - object to diff against
264    Return Value: list of differences between objects
265    Notes: None
266    Code Example:
267
268void configure(size_t as, ClientData c);
269    Purpose: configure the object based on the data in "c".
270                use "as" to determine the type of data in "c".
271    Input Arguments: 2
272        1. size_t as - type of data stored in "c".
273                        valid values include:
274                            RPCONFIG_XML
275                            RPCONFIG_TREE
276        2. ClientData c - data to configure the object from.
277                            if as is...     then c should be...
278                            RPCONFIG_XML    const char *xmltext
279                            RPCONFIG_TREE   RP_ParserXML *object
280    Return Value: None
281    Notes: object is configured based on values in "c"
282    Code Example:
283
284void dump(size_t as, ClientData c);
285    Purpose: dump the object values based to the object "c".
286                use "as" to determine how to dump the data.
287    Input Arguments: 2
288        1. size_t as - type of data stored in "c".
289                        valid values include:
290                            RPCONFIG_XML
291                            RPCONFIG_TREE
292        2. ClientData c - data to configure the object from.
293                            if as is...     then c should be...
294                            RPCONFIG_XML    ClientDataXml *object
295                            RPCONFIG_TREE   RP_ParserXML *object
296    Return Value: None
297    Notes: None
298    Code Example:
299
300Outcome &outcome() const;
301    Purpose: return the status of this object as an Outcome.
302    Input Arguments: 0
303    Return Value: status of the object as an Outcome
304    Notes: None
305    Code Example:
306
307const int is() const;
308    Purpose: return an integer tag describing the object.
309    Input Arguments: 0
310    Return Value: integer tag unique to all number objects
311    Notes: None
312    Code Example:
313
314void defFromStr(const char *val);
315    Purpose: populate the def() value from a string.
316    Input Arguments: 1
317        1. const char *val - the new default value
318    Return Value: None
319    Notes: This function tries to parse the string for a value
320            that can be evaluated as a boolean. It evaluates
321            case insensitive versions of the strings "true", "1"
322            "yes", and "on" as positives boolean expressions.
323            Case insensitive version of the strings "false",
324            "0", "no", and "off" are evaluated as negative
325            boolean expressions.
326    Code Example:
327
328void curFromStr(const char *val);
329    Purpose: populate the cur() value from a string.
330    Input Arguments: 1
331        1. const char *val - the new current value
332    Return Value: None
333    Notes: This function tries to parse the string for a value
334            that can be evaluated as a boolean. It evaluates
335            case insensitive versions of the strings "true", "1"
336            "yes", and "on" as positives boolean expressions.
337            Case insensitive version of the strings "false",
338            "0", "no", and "off" are evaluated as negative
339            boolean expressions.
340    Code Example:
Note: See TracBrowser for help on using the repository browser.