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 /**************************************************************************/
31 /*                                                                        */
32 /*  FUNCTION                                               RELEASE        */
33 /*                                                                        */
34 /*    _gxe_widget_top_visible_child_find                  PORTABLE C      */
35 /*                                                           6.1          */
36 /*  AUTHOR                                                                */
37 /*                                                                        */
38 /*    Kenneth Maxwell, Microsoft Corporation                              */
39 /*                                                                        */
40 /*  DESCRIPTION                                                           */
41 /*                                                                        */
42 /*    This function checks for errors in the                              */
43 /*    gx_widget_top_visible_child_find function call.                     */
44 /*                                                                        */
45 /*  INPUT                                                                 */
46 /*                                                                        */
47 /*    parent                               Pointer to parent widget to    */
48 /*                                            start search from           */
49 /*    return_widget                         Pointer to destination for    */
50 /*                                            found widget                */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    status                                Completion status             */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    _gx_widget_top_visible_child_find     Actual                        */
59 /*                                            widget_previous_sibling_get */
60 /*                                            function.                   */
61 /*                                                                        */
62 /*  CALLED BY                                                             */
63 /*                                                                        */
64 /*    Application Code                                                    */
65 /*                                                                        */
66 /*  RELEASE HISTORY                                                       */
67 /*                                                                        */
68 /*    DATE              NAME                      DESCRIPTION             */
69 /*                                                                        */
70 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
71 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
72 /*                                            resulting in version 6.1    */
73 /*                                                                        */
74 /**************************************************************************/
_gxe_widget_top_visible_child_find(GX_WIDGET * parent,GX_WIDGET ** return_widget)75 UINT _gxe_widget_top_visible_child_find(GX_WIDGET *parent, GX_WIDGET **return_widget)
76 {
77 UINT status;
78     /* Check for invalid input pointers.  */
79     if ((parent == GX_NULL) || (return_widget == GX_NULL))
80     {
81         return(GX_PTR_ERROR);
82     }
83 
84     /* Check for invalid widget.  */
85     if (parent -> gx_widget_type == 0)
86     {
87         return(GX_INVALID_WIDGET);
88     }
89 
90     /* Call actual widget find function.  */
91     status = _gx_widget_top_visible_child_find(parent, return_widget);
92 
93     /* Return successful completion.  */
94     return(status);
95 }
96 
97