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 /** Widget Management (Widget) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_widget.h"
28
29 /**************************************************************************/
30 /* */
31 /* FUNCTION RELEASE */
32 /* */
33 /* _gxe_widget_client_get PORTABLE C */
34 /* 6.1 */
35 /* AUTHOR */
36 /* */
37 /* Kenneth Maxwell, Microsoft Corporation */
38 /* */
39 /* DESCRIPTION */
40 /* */
41 /* This function checks for errors in the widget client get function */
42 /* call. */
43 /* */
44 /* INPUT */
45 /* */
46 /* widget Widget control block */
47 /* border_width width of widget border */
48 /* return_size Return rectangle pointer */
49 /* */
50 /* OUTPUT */
51 /* */
52 /* status Completion status */
53 /* */
54 /* CALLS */
55 /* */
56 /* _gx_widget_width_get Get widget width */
57 /* _gx_widget_height_get Get widget height */
58 /* _gx_widget_client_get Actual widget client get */
59 /* function */
60 /* */
61 /* CALLED BY */
62 /* */
63 /* Application Code */
64 /* GUIX draw functions */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
71 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* */
74 /**************************************************************************/
_gxe_widget_client_get(GX_WIDGET * widget,GX_VALUE border_width,GX_RECTANGLE * return_size)75 UINT _gxe_widget_client_get(GX_WIDGET *widget, GX_VALUE border_width, GX_RECTANGLE *return_size)
76 {
77 UINT status;
78 GX_VALUE widget_width;
79 GX_VALUE widget_height;
80
81 /* Check for invalid input pointers. */
82 if ((widget == GX_NULL) || (return_size == GX_NULL))
83 {
84 return(GX_PTR_ERROR);
85 }
86
87 /* Check for invalid widget. */
88 if (widget -> gx_widget_type == 0)
89 {
90 return(GX_INVALID_WIDGET);
91 }
92
93 /* Check for invalid widget border. */
94 _gx_widget_width_get(widget, &widget_width);
95 _gx_widget_height_get(widget, &widget_height);
96 if ((border_width > (widget_width / 2)) || (border_width > (widget_height / 2)))
97 {
98 return(GX_INVALID_VALUE);
99 }
100
101 /* Call actual widget client get function. */
102 status = _gx_widget_client_get(widget, border_width, return_size);
103
104 /* Return completion status. */
105 return(status);
106 }
107
108
