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 /** Window Management (Window) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_window.h"
28
29 /* Bring in externs for caller checking code. */
30 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_window_client_scroll PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Kenneth Maxwell, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function checks for errors in the window client scroll */
45 /* function call. */
46 /* */
47 /* */
48 /* INPUT */
49 /* */
50 /* window Pointer to window */
51 /* x_scroll Amount to scroll on x-axis */
52 /* y_scroll Amount to scroll on y-axis */
53 /* */
54 /* OUTPUT */
55 /* */
56 /* status Completion status */
57 /* */
58 /* CALLS */
59 /* */
60 /* _gx_window_client_scroll Actual window client scroll */
61 /* function */
62 /* */
63 /* CALLED BY */
64 /* */
65 /* Application Code */
66 /* */
67 /* RELEASE HISTORY */
68 /* */
69 /* DATE NAME DESCRIPTION */
70 /* */
71 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
72 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
73 /* resulting in version 6.1 */
74 /* */
75 /**************************************************************************/
_gxe_window_client_scroll(GX_WINDOW * window,GX_VALUE x_scroll,GX_VALUE y_scroll)76 UINT _gxe_window_client_scroll(GX_WINDOW *window, GX_VALUE x_scroll, GX_VALUE y_scroll)
77 {
78 UINT status;
79
80 /* Check for appropriate caller. */
81 GX_INIT_AND_THREADS_CALLER_CHECKING
82
83 /* Check for invalid input pointers. */
84 if (window == GX_NULL)
85 {
86 return(GX_PTR_ERROR);
87 }
88
89 /* Check for invalid widget. */
90 if (window -> gx_widget_type == 0)
91 {
92 return(GX_INVALID_WIDGET);
93 }
94
95 /* Call actual window client scroll function. */
96 status = _gx_window_client_scroll(window, x_scroll, y_scroll);
97
98 /* Return completion status. */
99 return(status);
100 }
101
102
