 |
MHEG5
22.3.0
|
Implement the MHEG5 SwitchButton Class SwitchButton Class Defines the behaviour of pressable buttons. Base class: PushButton Subclasses: None Status: Concrete class. More...
#include <stdlib.h>#include <string.h>#include "mh5profile.h"#include "mh5switchbutton.h"#include "mh5object.h"#include "mh5variable.h"Functions | |
| void | MHEG5switchbuttonInit (MHEG5Switchbutton *switchbutton) |
| Initialise a switchbutton object with default values. More... | |
| void | MHEG5switchbuttonFree (MHEG5Switchbutton *switchbutton) |
| Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed. More... | |
| void | MHEG5switchbuttonPrepare (MHEG5Switchbutton *switchbutton) |
| Apply the preparation behaviour of the switchbutton class Apply the preparation behaviour of the switchbutton class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class. More... | |
| void | MHEG5switchbuttonActivate (MHEG5Switchbutton *switchbutton) |
| Apply the activation behaviour of the switchbutton class. As this class has no own activation behaviour this function just invokes the activation behaviour from the base class. More... | |
| void | MHEG5switchbuttonDeactivate (MHEG5Switchbutton *switchbutton) |
| Apply the deactivation behaviour of the switchbutton class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class. More... | |
| void | MHEG5switchbuttonDestruct (MHEG5Switchbutton *switchbutton) |
| Destruct a switchbutton object. More... | |
| MHEG5ErrorCode | MHEG5getSelectionStatus (MHEG5Root *target, MHEG5GList *params) |
| Implementation of the GetSelectionStatus action. More... | |
| MHEG5ErrorCode | MHEG5toggle (MHEG5Root *target, MHEG5GList *params) |
| The effect of this action is to toggle the selection state of the switchbutton. Implementation of the Toggle (target) action of the switchbutton class. If the switchbutton is selected, it is deselected and vice versa. More... | |
Implement the MHEG5 SwitchButton Class SwitchButton Class Defines the behaviour of pressable buttons. Base class: PushButton Subclasses: None Status: Concrete class.
| MHEG5ErrorCode MHEG5getSelectionStatus | ( | MHEG5Root * | target, |
| MHEG5GList * | params | ||
| ) |
Implementation of the GetSelectionStatus action.
| target | target object for this action |
| params | Linked list of action parameters |
| void MHEG5switchbuttonActivate | ( | MHEG5Switchbutton * | switchbutton | ) |
Apply the activation behaviour of the switchbutton class. As this class has no own activation behaviour this function just invokes the activation behaviour from the base class.
| MHEG5Switchbutton | *switchbutton |
| void MHEG5switchbuttonDeactivate | ( | MHEG5Switchbutton * | switchbutton | ) |
Apply the deactivation behaviour of the switchbutton class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class.
| MHEG5Switchbutton | *switchbutton |
| void MHEG5switchbuttonDestruct | ( | MHEG5Switchbutton * | switchbutton | ) |
| void MHEG5switchbuttonFree | ( | MHEG5Switchbutton * | switchbutton | ) |
Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
| switchbutton | Pointer to object to free. |
| void MHEG5switchbuttonInit | ( | MHEG5Switchbutton * | switchbutton | ) |
Initialise a switchbutton object with default values.
<Function description>="">
| switchbutton | Pointer to object to initialise. |
| void MHEG5switchbuttonPrepare | ( | MHEG5Switchbutton * | switchbutton | ) |
Apply the preparation behaviour of the switchbutton class Apply the preparation behaviour of the switchbutton class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class.
| MHEG5Switchbutton | *switchbutton |
| MHEG5ErrorCode MHEG5toggle | ( | MHEG5Root * | target, |
| MHEG5GList * | params | ||
| ) |
The effect of this action is to toggle the selection state of the switchbutton. Implementation of the Toggle (target) action of the switchbutton class. If the switchbutton is selected, it is deselected and vice versa.
| MHEG5Root | *target |
| MHEG5GList | *params |
1.8.11