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_create 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 create call. */
45 /* */
46 /* INPUT */
47 /* */
48 /* wheel Scroll wheel control block */
49 /* name Name of widget */
50 /* parent Parent widget control block */
51 /* total_rows Total rows of the scroll wheel*/
52 /* style Style of widget */
53 /* Id Application-defined ID of the */
54 /* the widget */
55 /* size Widget size */
56 /* control_block_size Size of the scroll wheel */
57 /* control block */
58 /* */
59 /* OUTPUT */
60 /* */
61 /* status Completion status */
62 /* */
63 /* CALLS */
64 /* */
65 /* _gx_scroll_wheel_create Actual scroll wheel */
66 /* create call */
67 /* */
68 /* CALLED BY */
69 /* */
70 /* Application Code */
71 /* */
72 /* RELEASE HISTORY */
73 /* */
74 /* DATE NAME DESCRIPTION */
75 /* */
76 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
77 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
78 /* resulting in version 6.1 */
79 /* */
80 /**************************************************************************/
_gxe_scroll_wheel_create(GX_SCROLL_WHEEL * wheel,GX_CONST GX_CHAR * name,GX_WIDGET * parent,INT total_rows,ULONG style,USHORT Id,GX_CONST GX_RECTANGLE * size,UINT control_block_size)81 UINT _gxe_scroll_wheel_create(GX_SCROLL_WHEEL *wheel, GX_CONST GX_CHAR *name, GX_WIDGET *parent, INT total_rows,
82 ULONG style, USHORT Id, GX_CONST GX_RECTANGLE *size, UINT control_block_size)
83 {
84 UINT status;
85
86 /* Check for appropriate caller. */
87 GX_INIT_AND_THREADS_CALLER_CHECKING
88
89 /* Check for invalid pointer. */
90 if ((wheel == GX_NULL) || (size == GX_NULL))
91 {
92 return GX_PTR_ERROR;
93 }
94
95 /* Check for invalid control block size. */
96 if (control_block_size != sizeof(GX_SCROLL_WHEEL))
97 {
98 return GX_INVALID_SIZE;
99 }
100
101 /* Check for widget already created. */
102 if (wheel -> gx_widget_type != 0)
103 {
104 return(GX_ALREADY_CREATED);
105 }
106
107 /* Check for invalid parent widget. */
108 if (parent && parent -> gx_widget_type == 0)
109 {
110 return(GX_INVALID_WIDGET);
111 }
112
113 status = _gx_scroll_wheel_create(wheel, name, parent, total_rows, style, Id, size);
114
115 return status;
116 }
117
118
