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 /**   String Scroll Wheel Management (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 /*  FUNCTION                                               RELEASE        */
34 /*                                                                        */
35 /*    _gxe_string_scroll_wheel_event_process              PORTABLE C      */
36 /*                                                           6.1          */
37 /*  AUTHOR                                                                */
38 /*                                                                        */
39 /*    Kenneth Maxwell, Microsoft Corporation                              */
40 /*                                                                        */
41 /*  DESCRIPTION                                                           */
42 /*                                                                        */
43 /*    This function checks for errors in string scroll wheel event        */
44 /*    process call.                                                       */
45 /*                                                                        */
46 /*  INPUT                                                                 */
47 /*                                                                        */
48 /*    wheel                                 Text scroll wheel control     */
49 /*                                            block                       */
50 /*    event_ptr                             Event to be processed         */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    status                                Completion status             */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    _gx_string_scroll_wheel_event_process Actual string scroll wheel    */
59 /*                                            event process call          */
60 /*                                                                        */
61 /*  CALLED BY                                                             */
62 /*                                                                        */
63 /*    Application Code                                                    */
64 /*                                                                        */
65 /*  RELEASE HISTORY                                                       */
66 /*                                                                        */
67 /*    DATE              NAME                      DESCRIPTION             */
68 /*                                                                        */
69 /*  09-30-2020     Kenneth Maxwell          Initial Version 6.1           */
70 /*                                                                        */
71 /**************************************************************************/
_gxe_string_scroll_wheel_event_process(GX_STRING_SCROLL_WHEEL * wheel,GX_EVENT * event_ptr)72 UINT _gxe_string_scroll_wheel_event_process(GX_STRING_SCROLL_WHEEL *wheel, GX_EVENT *event_ptr)
73 {
74 UINT status;
75 
76     /* Check for appropriate caller.  */
77     GX_INIT_AND_THREADS_CALLER_CHECKING
78 
79     /* Check for invalid pointer. */
80     if ((wheel == GX_NULL) || (event_ptr == GX_NULL))
81     {
82         return GX_PTR_ERROR;
83     }
84 
85     /* Check for invalid widget.  */
86     if (wheel -> gx_widget_type == 0)
87     {
88         return(GX_INVALID_WIDGET);
89     }
90 
91     status = _gx_string_scroll_wheel_event_process(wheel, event_ptr);
92 
93     return status;
94 }
95 
96