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 /**   Widget Management (Widget)                                          */
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 
29 /* Bring in externs for caller checking code.  */
30 GX_CALLER_CHECKING_EXTERNS
31 
32 /**************************************************************************/
33 /*                                                                        */
34 /*  FUNCTION                                               RELEASE        */
35 /*                                                                        */
36 /*    _gxe_widget_show                                    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 widget show function call.   */
45 /*                                                                        */
46 /*  INPUT                                                                 */
47 /*                                                                        */
48 /*    widget                                Pointer to widget             */
49 /*                                                                        */
50 /*  OUTPUT                                                                */
51 /*                                                                        */
52 /*    status                                Completion status             */
53 /*                                                                        */
54 /*  CALLS                                                                 */
55 /*                                                                        */
56 /*    _gx_widget_show                       Actual widget show function   */
57 /*                                                                        */
58 /*  CALLED BY                                                             */
59 /*                                                                        */
60 /*    Application Code                                                    */
61 /*                                                                        */
62 /*  RELEASE HISTORY                                                       */
63 /*                                                                        */
64 /*    DATE              NAME                      DESCRIPTION             */
65 /*                                                                        */
66 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
67 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
68 /*                                            resulting in version 6.1    */
69 /*                                                                        */
70 /**************************************************************************/
_gxe_widget_show(GX_WIDGET * widget)71 UINT  _gxe_widget_show(GX_WIDGET *widget)
72 {
73 UINT status;
74 
75     /* Check for appropriate caller.  */
76     GX_INIT_AND_THREADS_CALLER_CHECKING
77 
78     /* Check for invalid input pointers.  */
79     if (widget == GX_NULL)
80     {
81         return(GX_PTR_ERROR);
82     }
83 
84     /* Check for invalid widget. */
85     if (widget->gx_widget_type == 0)
86     {
87         return(GX_INVALID_WIDGET);
88     }
89 
90     if (widget -> gx_widget_type != GX_TYPE_ROOT_WINDOW)
91     {
92         if (widget -> gx_widget_parent == GX_NULL)
93         {
94             /* cannot show an un-attached widget */
95             return GX_INVALID_WIDGET;
96         }
97         if (!(widget -> gx_widget_parent -> gx_widget_status & GX_STATUS_VISIBLE))
98         {
99             /* cannot show a widget whose parent is not visible */
100             return GX_INVALID_WIDGET;
101         }
102     }
103 
104     /* Call actual widget show function.  */
105     status = _gx_widget_show(widget);
106 
107     /* Return successful completion.  */
108     return(status);
109 }
110 
111