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 /**   Veritical 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_window.h"
29 
30 GX_CALLER_CHECKING_EXTERNS
31 
32 /**************************************************************************/
33 /*                                                                        */
34 /*  FUNCTION                                               RELEASE        */
35 /*                                                                        */
36 /*    _gxe_vertical_list_page_index_set                   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 vertical list index set      */
45 /*      function call.                                                    */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    vertical_list                         Vertical list widget control  */
50 /*                                          block                         */
51 /*    index                                 The new top index             */
52 /*                                                                        */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    status                                Completion status             */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    _gx_vertical_list_page_index_set      Actual vertial list page      */
60 /*                                            index set 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_vertical_list_page_index_set(GX_VERTICAL_LIST * vertical_list,INT index)75 UINT  _gxe_vertical_list_page_index_set(GX_VERTICAL_LIST *vertical_list, INT index)
76 {
77 
78     /* Check for appropriate caller.  */
79     GX_INIT_AND_THREADS_CALLER_CHECKING
80 
81     /* Check for invalid input pointers.  */
82     if (vertical_list == GX_NULL)
83     {
84         return GX_PTR_ERROR;
85     }
86 
87     /* Check for invalid widget. */
88     if (vertical_list -> gx_widget_type == 0)
89     {
90         return GX_INVALID_WIDGET;
91     }
92 
93     /* Check for invalid list entry.  */
94     if ((index < 0) ||
95         (index >= vertical_list -> gx_vertical_list_total_rows))
96     {
97         return GX_INVALID_VALUE;
98     }
99 
100     /* Call the actual vertical list page index set function.  */
101     _gx_vertical_list_page_index_set(vertical_list, index);
102 
103     /* Return completion status.  */
104     return GX_SUCCESS;
105 }
106 
107