 |
MHEG5
18.9.0
MHEG5 Documentation
|
Implement the MHEG5 SwitchButton Class. Defines the behaviour of pressable buttons. Base class: PushButton. Subclasses: None. Status: Concrete class. More...
#include "mh5pushbutton.h"Go to the source code of this file.
Classes | |
| struct | MHEG5Switchbutton |
Functions | |
| void | MHEG5switchbuttonInit (MHEG5Switchbutton *switchbutton) |
| <Function description>=""> 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 | 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... | |
| MHEG5ErrorCode | MHEG5getSelectionStatus (MHEG5Root *target, MHEG5GList *params) |
| Implementation of the GetSelectionStatus action. More... | |
Implement the MHEG5 SwitchButton Class. Defines the behaviour of pressable buttons. Base class: PushButton. Subclasses: None. Status: Concrete class.
Definition in file mh5switchbutton.h.
| MHEG5ErrorCode MHEG5getSelectionStatus | ( | MHEG5Root * | target, |
| MHEG5GList * | params | ||
| ) |
Implementation of the GetSelectionStatus action.
| target | target object for this action |
| params | Linked list of action parameters |
Definition at line 184 of file mh5switchbutton.c.
| 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 |
Definition at line 142 of file mh5switchbutton.c.
| 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 |
Definition at line 156 of file mh5switchbutton.c.
| void MHEG5switchbuttonDestruct | ( | MHEG5Switchbutton * | switchbutton | ) |
Destruct a switchbutton object.
| MHEG5Switchbutton | *switchbutton |
Definition at line 168 of file mh5switchbutton.c.
| 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. |
Definition at line 104 of file mh5switchbutton.c.
| void MHEG5switchbuttonInit | ( | MHEG5Switchbutton * | switchbutton | ) |
<Function description>="">
| switchbutton | Pointer to object to initialise. |
<Function description>="">
| switchbutton | Pointer to object to initialise. |
Definition at line 88 of file mh5switchbutton.c.
| 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 |
Definition at line 128 of file mh5switchbutton.c.
| 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 |
Definition at line 230 of file mh5switchbutton.c.
1.8.11