1 /***************************************************************************
2  * Copyright (c) 2024 Microsoft Corporation
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the MIT License which is available at
6  * https://opensource.org/licenses/MIT.
7  *
8  * SPDX-License-Identifier: MIT
9  **************************************************************************/
10 
11 
12 /**************************************************************************/
13 /**************************************************************************/
14 /**                                                                       */
15 /** GUIX Component                                                        */
16 /**                                                                       */
17 /**   Button Management (Checkbox)                                        */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 
24 /* Include necessary system files.  */
25 
26 #include "gx_api.h"
27 #include "gx_widget.h"
28 #include "gx_button.h"
29 #include "gx_system.h"
30 
31 GX_CALLER_CHECKING_EXTERNS
32 
33 /**************************************************************************/
34 /*                                                                        */
35 /*  FUNCTION                                               RELEASE        */
36 /*                                                                        */
37 /*    _gxe_checkbox_select                                PORTABLE C      */
38 /*                                                           6.1          */
39 /*  AUTHOR                                                                */
40 /*                                                                        */
41 /*    Kenneth Maxwell, Microsoft Corporation                              */
42 /*                                                                        */
43 /*  DESCRIPTION                                                           */
44 /*                                                                        */
45 /*    This function checks for errors in the checkbox select function     */
46 /*    call.                                                               */
47 /*                                                                        */
48 /*  INPUT                                                                 */
49 /*                                                                        */
50 /*    checkbox                              Checkbox control block        */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    status                                Completion status             */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    _gx_checkbox_select                   Actual checkbox select call   */
59 /*                                                                        */
60 /*  CALLED BY                                                             */
61 /*                                                                        */
62 /*    Application Code                                                    */
63 /*                                                                        */
64 /*  RELEASE HISTORY                                                       */
65 /*                                                                        */
66 /*    DATE              NAME                      DESCRIPTION             */
67 /*                                                                        */
68 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
69 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
70 /*                                            resulting in version 6.1    */
71 /*                                                                        */
72 /**************************************************************************/
_gxe_checkbox_select(GX_CHECKBOX * checkbox)73 UINT  _gxe_checkbox_select(GX_CHECKBOX *checkbox)
74 {
75 UINT       status;
76 GX_WIDGET *parent;
77 
78     /* Check for appropriate caller.  */
79     GX_INIT_AND_THREADS_CALLER_CHECKING
80 
81     /* Check for the invalid input pointers.  */
82     if ((checkbox == GX_NULL) || (checkbox -> gx_widget_parent == GX_NULL))
83     {
84         return(GX_PTR_ERROR);
85     }
86 
87     parent = checkbox -> gx_widget_parent;
88 
89     /* Check for the invalid widget.  */
90     if ((parent -> gx_widget_type == 0) ||
91         (checkbox -> gx_widget_type == 0))
92     {
93         return(GX_INVALID_WIDGET);
94     }
95 
96     /* Call the actual checkbox select function.  */
97     status = _gx_checkbox_select(checkbox);
98 
99     /* Return completion status.  */
100     return status;
101 }
102 
103