1 /***************************************************************************
2  * Copyright (c) 2024 Microsoft Corporation
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the MIT License which is available at
6  * https://opensource.org/licenses/MIT.
7  *
8  * SPDX-License-Identifier: MIT
9  **************************************************************************/
10 
11 
12 /**************************************************************************/
13 /**************************************************************************/
14 /**                                                                       */
15 /** GUIX Component                                                        */
16 /**                                                                       */
17 /**   Scroll Wheel Management (Generic Scroll Wheel)                      */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 
24 /* Include necessary system files.  */
25 
26 #include "gx_api.h"
27 #include "gx_scroll_wheel.h"
28 
29 GX_CALLER_CHECKING_EXTERNS
30 
31 
32 /**************************************************************************/
33 /*                                                                        */
34 /*  FUNCTION                                               RELEASE        */
35 /*                                                                        */
36 /*    _gxe_generic_scroll_wheel_row_height_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 row height  */
45 /*    set.                                                                */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    wheel                                 Generic scroll wheel control  */
50 /*                                            block                       */
51 /*    count                                 Number of rows                */
52 /*                                                                        */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    status                                Completion status             */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    _gx_generic_scroll_wheel_row_height_set                             */
60 /*                                          Actual generic scroll wheel   */
61 /*                                            row height set call         */
62 /*                                                                        */
63 /*  CALLED BY                                                             */
64 /*                                                                        */
65 /*    Application Code                                                    */
66 /*                                                                        */
67 /*  RELEASE HISTORY                                                       */
68 /*                                                                        */
69 /*    DATE              NAME                      DESCRIPTION             */
70 /*                                                                        */
71 /*  06-02-2021     Kenneth Maxwell          Initial Version 6.1.7         */
72 /*                                                                        */
73 /**************************************************************************/
_gxe_generic_scroll_wheel_row_height_set(GX_GENERIC_SCROLL_WHEEL * wheel,GX_VALUE row_height)74 UINT _gxe_generic_scroll_wheel_row_height_set(GX_GENERIC_SCROLL_WHEEL *wheel, GX_VALUE row_height)
75 {
76 UINT status;
77 
78     /* Check for appropriate caller.  */
79     GX_INIT_AND_THREADS_CALLER_CHECKING
80 
81     if (wheel == GX_NULL)
82     {
83         return GX_PTR_ERROR;
84     }
85 
86     if (wheel -> gx_widget_type == 0)
87     {
88         return GX_INVALID_WIDGET;
89     }
90 
91     if (row_height <= 0)
92     {
93         return GX_INVALID_VALUE;
94     }
95 
96     status = _gx_generic_scroll_wheel_row_height_set(wheel, row_height);
97     return status;
98 }
99 
100