1 /**************************************************************************/
2 /*                                                                        */
3 /*       Copyright (c) Microsoft Corporation. All rights reserved.        */
4 /*                                                                        */
5 /*       This software is licensed under the Microsoft Software License   */
6 /*       Terms for Microsoft Azure RTOS. Full text of the license can be  */
7 /*       found in the LICENSE file at https://aka.ms/AzureRTOS_EULA       */
8 /*       and in the root directory of this software.                      */
9 /*                                                                        */
10 /**************************************************************************/
11 
12 
13 /**************************************************************************/
14 /**************************************************************************/
15 /**                                                                       */
16 /** GUIX Component                                                        */
17 /**                                                                       */
18 /**   Widget Management (Widget)                                          */
19 /**                                                                       */
20 /**************************************************************************/
21 
22 #define GX_SOURCE_CODE
23 
24 
25 /* Include necessary system files.  */
26 
27 #include "gx_api.h"
28 #include "gx_widget.h"
29 
30 /* Bring in externs for caller checking code.  */
31 GX_CALLER_CHECKING_EXTERNS
32 
33 /**************************************************************************/
34 /*                                                                        */
35 /*  FUNCTION                                               RELEASE        */
36 /*                                                                        */
37 /*    _gxe_widget_show                                    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 widget show function call.   */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    widget                                Pointer to widget             */
50 /*                                                                        */
51 /*  OUTPUT                                                                */
52 /*                                                                        */
53 /*    status                                Completion status             */
54 /*                                                                        */
55 /*  CALLS                                                                 */
56 /*                                                                        */
57 /*    _gx_widget_show                       Actual widget show function   */
58 /*                                                                        */
59 /*  CALLED BY                                                             */
60 /*                                                                        */
61 /*    Application Code                                                    */
62 /*                                                                        */
63 /*  RELEASE HISTORY                                                       */
64 /*                                                                        */
65 /*    DATE              NAME                      DESCRIPTION             */
66 /*                                                                        */
67 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
68 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
69 /*                                            resulting in version 6.1    */
70 /*                                                                        */
71 /**************************************************************************/
_gxe_widget_show(GX_WIDGET * widget)72 UINT  _gxe_widget_show(GX_WIDGET *widget)
73 {
74 UINT status;
75 
76     /* Check for appropriate caller.  */
77     GX_INIT_AND_THREADS_CALLER_CHECKING
78 
79     /* Check for invalid input pointers.  */
80     if (widget == GX_NULL)
81     {
82         return(GX_PTR_ERROR);
83     }
84 
85     /* Check for invalid widget. */
86     if (widget->gx_widget_type == 0)
87     {
88         return(GX_INVALID_WIDGET);
89     }
90 
91     if (widget -> gx_widget_type != GX_TYPE_ROOT_WINDOW)
92     {
93         if (widget -> gx_widget_parent == GX_NULL)
94         {
95             /* cannot show an un-attached widget */
96             return GX_INVALID_WIDGET;
97         }
98         if (!(widget -> gx_widget_parent -> gx_widget_status & GX_STATUS_VISIBLE))
99         {
100             /* cannot show a widget whose parent is not visible */
101             return GX_INVALID_WIDGET;
102         }
103     }
104 
105     /* Call actual widget show function.  */
106     status = _gx_widget_show(widget);
107 
108     /* Return successful completion.  */
109     return(status);
110 }
111 
112