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 /**   Scroll Wheel Management (Generic Scroll Wheel)                      */
19 /**                                                                       */
20 /**************************************************************************/
21 
22 #define GX_SOURCE_CODE
23 
24 
25 /* Include necessary system files.  */
26 
27 #include "gx_api.h"
28 #include "gx_scroll_wheel.h"
29 
30 GX_CALLER_CHECKING_EXTERNS
31 
32 /**************************************************************************/
33 /*                                                                        */
34 /*  FUNCTION                                               RELEASE        */
35 /*                                                                        */
36 /*    _gxe_generic_scroll_wheel_total_rows_set            PORTABLE C      */
37 /*                                                           6.1.7        */
38 /*  AUTHOR                                                                */
39 /*                                                                        */
40 /*    Ting Zhu, Microsoft Corporation                                     */
41 /*                                                                        */
42 /*  DESCRIPTION                                                           */
43 /*                                                                        */
44 /*    This function checks for errors in generic scroll wheel total rows  */
45 /*    set.                                                                */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    wheel                                 Generic scroll wheel control  */
50 /*                                            block                       */
51 /*    total_rows                            Total rows of the scroll wheel*/
52 /*                                                                        */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    status                                Completion status             */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    _gx_generic_scroll_wheel_total_rows_set                             */
60 /*                                          Actual scroll wheel total rows*/
61 /*                                            set call                    */
62 /*                                                                        */
63 /*  CALLED BY                                                             */
64 /*                                                                        */
65 /*    Application Code                                                    */
66 /*                                                                        */
67 /*  RELEASE HISTORY                                                       */
68 /*                                                                        */
69 /*    DATE              NAME                      DESCRIPTION             */
70 /*                                                                        */
71 /*  06-02-2021     Ting Zhu                 Initial Version 6.1.7         */
72 /*                                                                        */
73 /**************************************************************************/
_gxe_generic_scroll_wheel_total_rows_set(GX_GENERIC_SCROLL_WHEEL * wheel,INT total_rows)74 UINT _gxe_generic_scroll_wheel_total_rows_set(GX_GENERIC_SCROLL_WHEEL *wheel, INT total_rows)
75 {
76 
77     /* Check for appropriate caller.  */
78     GX_INIT_AND_THREADS_CALLER_CHECKING
79 
80     if (wheel == GX_NULL)
81     {
82         return GX_PTR_ERROR;
83     }
84 
85     if (wheel -> gx_widget_type == 0)
86     {
87         return GX_INVALID_WIDGET;
88     }
89 
90     if (total_rows < 0)
91     {
92         return GX_INVALID_VALUE;
93     }
94 
95     return _gx_generic_scroll_wheel_total_rows_set(wheel, total_rows);
96 }
97 
98