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 /**   Vertical List (List)                                                */
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 #include "gx_window.h"
30 #include "gx_system.h"
31 #include "gx_scrollbar.h"
32 
33 /**************************************************************************/
34 /*                                                                        */
35 /*  FUNCTION                                               RELEASE        */
36 /*                                                                        */
37 /*    _gx_vertical_list_selected_visible                  PORTABLE C      */
38 /*                                                           6.1          */
39 /*  AUTHOR                                                                */
40 /*                                                                        */
41 /*    Kenneth Maxwell, Microsoft Corporation                              */
42 /*                                                                        */
43 /*  DESCRIPTION                                                           */
44 /*                                                                        */
45 /*    This service make the selected list item visible.                   */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    vertical_list                         Vertical list widget control  */
50 /*                                          block                         */
51 /*    list_entry                            Pointer to new list entry     */
52 /*                                                                        */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    NONE                                                                */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    _gx_vertical_list_scroll                                            */
60 /*    _gx_window_scrollbar_find                                           */
61 /*    _gx_scrollbar_reset                                                 */
62 /*                                                                        */
63 /*  CALLED BY                                                             */
64 /*                                                                        */
65 /*    _gx_vertical_list_selected_set                                      */
66 /*                                                                        */
67 /*  RELEASE HISTORY                                                       */
68 /*                                                                        */
69 /*    DATE              NAME                      DESCRIPTION             */
70 /*                                                                        */
71 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
72 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
73 /*                                            resulting in version 6.1    */
74 /*                                                                        */
75 /**************************************************************************/
_gx_vertical_list_selected_visible(GX_VERTICAL_LIST * list,GX_WIDGET * child)76 VOID _gx_vertical_list_selected_visible(GX_VERTICAL_LIST *list, GX_WIDGET *child)
77 {
78 GX_SCROLLBAR *pScroll;
79 GX_BOOL       update_scroll = GX_FALSE;
80 
81     if (child -> gx_widget_size.gx_rectangle_top < list -> gx_window_client.gx_rectangle_top)
82     {
83         /* need to scroll children down */
84         _gx_vertical_list_scroll(list, list -> gx_window_client.gx_rectangle_top - child -> gx_widget_size.gx_rectangle_top);
85         update_scroll = GX_TRUE;
86     }
87     else
88     {
89         if (child -> gx_widget_size.gx_rectangle_bottom > list -> gx_window_client.gx_rectangle_bottom)
90         {
91             /* need to scroll children up */
92             _gx_vertical_list_scroll(list, list -> gx_window_client.gx_rectangle_bottom - child -> gx_widget_size.gx_rectangle_bottom);
93             update_scroll = GX_TRUE;
94         }
95     }
96 
97     if (update_scroll)
98     {
99         _gx_window_scrollbar_find((GX_WINDOW *)list, GX_TYPE_VERTICAL_SCROLL, &pScroll);
100 
101         if (pScroll)
102         {
103             _gx_scrollbar_reset(pScroll, GX_NULL);
104         }
105     }
106 }
107 
108