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 (Button)                                          */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 
24 /* Include necessary system files.  */
25 
26 #include "gx_api.h"
27 #include "gx_button.h"
28 
29 /* Bring in externs for caller checking code.  */
30 GX_CALLER_CHECKING_EXTERNS
31 
32 /**************************************************************************/
33 /*                                                                        */
34 /*  FUNCTION                                               RELEASE        */
35 /*                                                                        */
36 /*    _gxe_button_deselect                                PORTABLE C      */
37 /*                                                           6.1          */
38 /*  AUTHOR                                                                */
39 /*                                                                        */
40 /*    Kenneth Maxwell, Microsoft Corporation                              */
41 /*                                                                        */
42 /*  DESCRIPTION                                                           */
43 /*                                                                        */
44 /*    This function checks for errors in the button deselect function     */
45 /*    call.                                                               */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    button                                Pointer to button control     */
50 /*                                            block                       */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    status                                Completion status             */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    _gx_button_deselect                   Actual button deselect        */
59 /*                                            function.                   */
60 /*                                                                        */
61 /*  CALLED BY                                                             */
62 /*                                                                        */
63 /*    Application Code                                                    */
64 /*                                                                        */
65 /*  RELEASE HISTORY                                                       */
66 /*                                                                        */
67 /*    DATE              NAME                      DESCRIPTION             */
68 /*                                                                        */
69 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
70 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
71 /*                                            resulting in version 6.1    */
72 /*                                                                        */
73 /**************************************************************************/
_gxe_button_deselect(GX_BUTTON * button,GX_BOOL gen_event)74 UINT  _gxe_button_deselect(GX_BUTTON *button, GX_BOOL gen_event)
75 {
76 UINT       status;
77 GX_WIDGET *parent;
78 
79     /* Check for appropriate caller.  */
80     GX_INIT_AND_THREADS_CALLER_CHECKING
81 
82     /* Check for invalid input pointers.  */
83     if ((button == GX_NULL) || (button -> gx_widget_parent == GX_NULL))
84     {
85         return(GX_PTR_ERROR);
86     }
87 
88     parent = button -> gx_widget_parent;
89 
90     /* Check for the invalid button.  */
91     if ((parent -> gx_widget_type == 0) ||
92         (button -> gx_widget_type == 0))
93     {
94         return(GX_INVALID_WIDGET);
95     }
96 
97     /* Call the actual button deselect function.  */
98     status = _gx_button_deselect(button, gen_event);
99 
100     /* Return the completion status.  */
101     return status;
102 }
103 
104