1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** GUIX Component */
17 /** */
18 /** Window Management (Window) */
19 /** */
20 /**************************************************************************/
21
22 #define GX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "gx_api.h"
28 #include "gx_window.h"
29
30 /* Bring in externs for caller checking code. */
31 GX_CALLER_CHECKING_EXTERNS
32
33 /**************************************************************************/
34 /* */
35 /* FUNCTION RELEASE */
36 /* */
37 /* _gxe_window_client_scroll PORTABLE C */
38 /* 6.1 */
39 /* AUTHOR */
40 /* */
41 /* Kenneth Maxwell, Microsoft Corporation */
42 /* */
43 /* DESCRIPTION */
44 /* */
45 /* This function checks for errors in the window client scroll */
46 /* function call. */
47 /* */
48 /* */
49 /* INPUT */
50 /* */
51 /* window Pointer to window */
52 /* x_scroll Amount to scroll on x-axis */
53 /* y_scroll Amount to scroll on y-axis */
54 /* */
55 /* OUTPUT */
56 /* */
57 /* status Completion status */
58 /* */
59 /* CALLS */
60 /* */
61 /* _gx_window_client_scroll Actual window client scroll */
62 /* function */
63 /* */
64 /* CALLED BY */
65 /* */
66 /* Application Code */
67 /* */
68 /* RELEASE HISTORY */
69 /* */
70 /* DATE NAME DESCRIPTION */
71 /* */
72 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
73 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
74 /* resulting in version 6.1 */
75 /* */
76 /**************************************************************************/
_gxe_window_client_scroll(GX_WINDOW * window,GX_VALUE x_scroll,GX_VALUE y_scroll)77 UINT _gxe_window_client_scroll(GX_WINDOW *window, GX_VALUE x_scroll, GX_VALUE y_scroll)
78 {
79 UINT status;
80
81 /* Check for appropriate caller. */
82 GX_INIT_AND_THREADS_CALLER_CHECKING
83
84 /* Check for invalid input pointers. */
85 if (window == GX_NULL)
86 {
87 return(GX_PTR_ERROR);
88 }
89
90 /* Check for invalid widget. */
91 if (window -> gx_widget_type == 0)
92 {
93 return(GX_INVALID_WIDGET);
94 }
95
96 /* Call actual window client scroll function. */
97 status = _gx_window_client_scroll(window, x_scroll, y_scroll);
98
99 /* Return completion status. */
100 return(status);
101 }
102
103
