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 Management (Scroll) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_scrollbar.h"
28
29 /* Bring in externs for caller checking code. */
30 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_scroll_thumb_create PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Kenneth Maxwell, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function checks errors in the scroll thumb create function. */
45 /* */
46 /* INPUT */
47 /* */
48 /* scroll_thumb Scroll thumb control block */
49 /* parent Pointer to parent scrollbar */
50 /* style Style of scroll bar */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _gx_scroll_thumb_create The actual scroll thumb */
59 /* create routine */
60 /* */
61 /* CALLED BY */
62 /* */
63 /* Application Code */
64 /* */
65 /* RELEASE HISTORY */
66 /* */
67 /* DATE NAME DESCRIPTION */
68 /* */
69 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
70 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
71 /* resulting in version 6.1 */
72 /* */
73 /**************************************************************************/
_gxe_scroll_thumb_create(GX_SCROLL_THUMB * scroll_thumb,GX_SCROLLBAR * parent,ULONG style,UINT scroll_thumb_control_block_size)74 UINT _gxe_scroll_thumb_create(GX_SCROLL_THUMB *scroll_thumb, GX_SCROLLBAR *parent, ULONG style, UINT scroll_thumb_control_block_size)
75 {
76 UINT status;
77
78 /* Check for appropriate caller. */
79 GX_INIT_AND_THREADS_CALLER_CHECKING
80
81 /* Check for invalid input pointers. */
82 if (scroll_thumb == GX_NULL)
83 {
84 return(GX_PTR_ERROR);
85 }
86
87 /* Check for widget already created. */
88 if (scroll_thumb -> gx_widget_type != 0)
89 {
90 return(GX_ALREADY_CREATED);
91 }
92
93 /* Check for invalid control block size. */
94 if (scroll_thumb_control_block_size != sizeof(GX_SCROLL_THUMB))
95 {
96 return(GX_INVALID_SIZE);
97 }
98
99 /* Check for invalid parent widget. */
100 if (parent && parent -> gx_widget_type == 0)
101 {
102 return(GX_INVALID_WIDGET);
103 }
104
105 /* Call actual multi line text input create function. */
106 status = _gx_scroll_thumb_create(scroll_thumb, parent, style);
107
108 /* Return the error status from window create. */
109 return(status);
110 }
111
112