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 /* Bring in externs for caller checking code. */
30 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_generic_scroll_wheel_children_position 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 the generic scroll wheel */
45 /* children position function call */
46 /* */
47 /* INPUT */
48 /* */
49 /* wheel Generic scroll wheel control */
50 /* block */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _gx_generic_scroll_wheel_children_position */
59 /* Actual scroll wheel children */
60 /* position function call */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Application Code */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 06-02-2021 Ting Zhu Initial Version 6.1.7 */
71 /* */
72 /**************************************************************************/
_gxe_generic_scroll_wheel_children_position(GX_GENERIC_SCROLL_WHEEL * wheel)73 UINT _gxe_generic_scroll_wheel_children_position(GX_GENERIC_SCROLL_WHEEL *wheel)
74 {
75 UINT status;
76
77 /* Check for appropriate caller. */
78 GX_INIT_AND_THREADS_CALLER_CHECKING
79
80 if (!wheel)
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 /* Call actual generic scroll wheel children position call. */
92 status = _gx_generic_scroll_wheel_children_position(wheel);
93
94 /* Return completion status. */
95 return(status);
96 }
97
98