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 (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_scroll_wheel_speed_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 scroll wheel speed set. */
45 /* */
46 /* INPUT */
47 /* */
48 /* wheel Scroll wheel control block */
49 /* wheel Scroll wheel control block */
50 /* start_speed_rate The rate of start speed to */
51 /* flick speed. */
52 /* end_speed_rate The rate of end speed to */
53 /* flick speed. */
54 /* max_steps Max steps for scrolling */
55 /* delay Delay time of each step */
56 /* */
57 /* OUTPUT */
58 /* */
59 /* status Completion status */
60 /* */
61 /* CALLS */
62 /* */
63 /* _gx_scroll_wheel_speed_set Actual scroll wheel speed set */
64 /* call */
65 /* */
66 /* CALLED BY */
67 /* */
68 /* Application Code */
69 /* */
70 /* RELEASE HISTORY */
71 /* */
72 /* DATE NAME DESCRIPTION */
73 /* */
74 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
75 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
76 /* resulting in version 6.1 */
77 /* */
78 /**************************************************************************/
_gxe_scroll_wheel_speed_set(GX_SCROLL_WHEEL * wheel,GX_FIXED_VAL start_speed_rate,GX_FIXED_VAL end_speed_rate,GX_VALUE max_steps,GX_VALUE delay)79 UINT _gxe_scroll_wheel_speed_set(GX_SCROLL_WHEEL *wheel, GX_FIXED_VAL start_speed_rate, GX_FIXED_VAL end_speed_rate,
80 GX_VALUE max_steps, GX_VALUE delay)
81 {
82 UINT status;
83
84 /* Check for appropriate caller. */
85 GX_INIT_AND_THREADS_CALLER_CHECKING
86
87 if (wheel == GX_NULL)
88 {
89 return GX_PTR_ERROR;
90 }
91
92 if (wheel -> gx_widget_type == 0)
93 {
94 return GX_INVALID_WIDGET;
95 }
96
97 if (delay <= 0)
98 {
99 return GX_INVALID_VALUE;
100 }
101
102 status = _gx_scroll_wheel_speed_set(wheel, start_speed_rate, end_speed_rate, max_steps, delay);
103
104 return status;
105 }
106
107
