MHEG  17.9.0
 All Data Structures Files Functions Variables Typedefs Enumerations Macros Pages
mh5switchbutton.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2004 Ocean Blue Software Ltd
4  * Copyright © 2000 Koninklijke Philips Electronics N.V
5  *
6  * This file is part of a DTVKit Software Component
7  * You are permitted to copy, modify or distribute this file subject to the terms
8  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
9  *
10  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
11  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
12  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
13  *
14  * If you or your organisation is not a member of DTVKit then you have access
15  * to this source code outside of the terms of the licence agreement
16  * and you are expected to delete this and any associated files immediately.
17  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
18  *******************************************************************************/
30 #ifndef _MH5SWITCHBUTTON_H_
31 #define _MH5SWITCHBUTTON_H_
32 
33 /*---includes for this file--------------------------------------------------*/
34 #include "mh5pushbutton.h"
35 
36 /*---Constant and macro definitions for public use---------------------------*/
37 
38 /*---Enumerations for public use---------------------------------------------*/
39 
40 /*---Global type defs for public use-----------------------------------------*/
41 typedef struct
42 {
43  /* Base class */
44  MHEG5Pushbutton pushbutton;
45 
46  /* Exchanged attributes */
47  MHEG5PushbuttonStyle style;
48 
49  /* No internal attributes for this class */
51 
52 /*---Global variable declarations for public use-----------------------------*/
53 
54 /*---Global Function prototypes for public use-------------------------------*/
55 
66 void MHEG5switchbuttonInit(MHEG5Switchbutton *switchbutton);
67 
68 
76 void MHEG5switchbuttonFree(MHEG5Switchbutton *switchbutton);
77 
78 
79 /*
80  Internal behaviours
81  */
86 
87 
88 MHEG5ErrorCode MHEG5toggle(MHEG5Root *target, MHEG5GList *params);
89 
96 MHEG5ErrorCode MHEG5getSelectionStatus(MHEG5Root *target, MHEG5GList *params);
97 
98 /*
99  Debug
100  */
101 #ifdef MH5PRINTOUT
102 
108 void MHEG5switchbuttonPrint(MHEG5Switchbutton *switchbutton, char *out);
109 #endif
110 
111 #endif /*_MH5SWITCHBUTTON_H_*/
void MHEG5switchbuttonActivate(MHEG5Switchbutton *switchbutton)
Apply the activation behaviour of the switchbutton class. As this class has no own activation behavio...
Definition: mh5switchbutton.c:142
void MHEG5switchbuttonInit(MHEG5Switchbutton *switchbutton)
<Function description>="">
Definition: mh5switchbutton.c:88
MHEG5ErrorCode MHEG5toggle(MHEG5Root *target, MHEG5GList *params)
The effect of this action is to toggle the selection state of the switchbutton. Implementation of the...
Definition: mh5switchbutton.c:230
Definition: mh5base.h:169
Definition: mh5pushbutton.h:36
MHEG5ErrorCode MHEG5getSelectionStatus(MHEG5Root *target, MHEG5GList *params)
Implementation of the GetSelectionStatus action.
Definition: mh5switchbutton.c:184
void MHEG5switchbuttonDestruct(MHEG5Switchbutton *switchbutton)
Destruct a switchbutton object.
Definition: mh5switchbutton.c:168
Implement the MHEG5 PushButton Class. Defines labelled, largely rectangular areas on the screen...
void MHEG5switchbuttonDeactivate(MHEG5Switchbutton *switchbutton)
Apply the deactivation behaviour of the switchbutton class. As this class has no own deactivation beh...
Definition: mh5switchbutton.c:156
void MHEG5switchbuttonPrepare(MHEG5Switchbutton *switchbutton)
Apply the preparation behaviour of the switchbutton class Apply the preparation behaviour of the swit...
Definition: mh5switchbutton.c:128
Definition: mh5root.h:43
void MHEG5switchbuttonFree(MHEG5Switchbutton *switchbutton)
Free off all memory associated with the specified object, including any exchanged attributes and inte...
Definition: mh5switchbutton.c:104
Definition: mh5switchbutton.h:41