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 /*                                                                        */
32 /*  FUNCTION                                               RELEASE        */
33 /*                                                                        */
34 /*    _gx_widget_client_get                               PORTABLE C      */
35 /*                                                           6.1          */
36 /*  AUTHOR                                                                */
37 /*                                                                        */
38 /*    Kenneth Maxwell, Microsoft Corporation                              */
39 /*                                                                        */
40 /*  DESCRIPTION                                                           */
41 /*                                                                        */
42 /*    This function retrieves client area of a widget                     */
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_border_width_get           Get widget border width       */
57 /*                                                                        */
58 /*  CALLED BY                                                             */
59 /*                                                                        */
60 /*    Application Code                                                    */
61 /*    GUIX draw functions                                                 */
62 /*                                                                        */
63 /*  RELEASE HISTORY                                                       */
64 /*                                                                        */
65 /*    DATE              NAME                      DESCRIPTION             */
66 /*                                                                        */
67 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
68 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
69 /*                                            resulting in version 6.1    */
70 /*                                                                        */
71 /**************************************************************************/
_gx_widget_client_get(GX_WIDGET * widget,GX_VALUE width,GX_RECTANGLE * return_size)72 UINT  _gx_widget_client_get(GX_WIDGET *widget, GX_VALUE width, GX_RECTANGLE *return_size)
73 {
74 GX_VALUE border_width;
75 
76     if (width < 0)
77     {
78         _gx_widget_border_width_get(widget, &border_width);
79     }
80     else
81     {
82         border_width = width;
83     }
84     /* Yes, return the widget's client rectangle.  */
85     return_size -> gx_rectangle_top = (GX_VALUE)(widget -> gx_widget_size.gx_rectangle_top + border_width);
86     return_size -> gx_rectangle_bottom = (GX_VALUE)(widget -> gx_widget_size.gx_rectangle_bottom - border_width);
87     return_size -> gx_rectangle_left = (GX_VALUE)(widget -> gx_widget_size.gx_rectangle_left + border_width);
88     return_size -> gx_rectangle_right = (GX_VALUE)(widget -> gx_widget_size.gx_rectangle_right - border_width);
89 
90     /* Return successful completion.  */
91     return(GX_SUCCESS);
92 }
93 
94