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 /**   System Management (System)                                          */
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_color_get                                PORTABLE C      */
35 /*                                                           6.1          */
36 /*  AUTHOR                                                                */
37 /*                                                                        */
38 /*    Kenneth Maxwell, Microsoft Corporation                              */
39 /*                                                                        */
40 /*  DESCRIPTION                                                           */
41 /*                                                                        */
42 /*    This service gets the color associated with the supplied            */
43 /*      resource ID from the system color table.                          */
44 /*                                                                        */
45 /*  INPUT                                                                 */
46 /*                                                                        */
47 /*    widget                                caller identify               */
48 /*    color_id                              Resource ID of color          */
49 /*    return_color                          Pointer to destination for    */
50 /*                                            color                       */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    status                                Completion status             */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    _gx_widget_canvas_get                 Get canvas pointer            */
59 /*                                                                        */
60 /*  CALLED BY                                                             */
61 /*                                                                        */
62 /*    Application Code                                                    */
63 /*    GUIX default draw funtions                                          */
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 /**************************************************************************/
_gx_widget_color_get(GX_WIDGET * widget,GX_RESOURCE_ID color_id,GX_COLOR * return_color)74 UINT _gx_widget_color_get(GX_WIDGET *widget, GX_RESOURCE_ID color_id, GX_COLOR *return_color)
75 {
76 UINT        status = GX_INVALID_CANVAS;
77 GX_COLOR    colorval = 0;
78 GX_CANVAS  *canvas;
79 GX_DISPLAY *display;
80 
81     if (widget -> gx_widget_status & GX_STATUS_VISIBLE)
82     {
83         _gx_widget_canvas_get(widget, &canvas);
84 
85         if (canvas)
86         {
87             display = canvas -> gx_canvas_display;
88 
89             /* Determine if the ID is within range.  */
90             if (color_id < display -> gx_display_color_table_size)
91             {
92                 /* Yes, the ID is within range. Perform a table lookup and return the
93                    color.  */
94                 colorval = display -> gx_display_color_table[color_id];
95                 status = GX_SUCCESS;
96             }
97             else
98             {
99                 status = GX_INVALID_RESOURCE_ID;
100             }
101         }
102     }
103     *return_color = colorval;
104     return(status);
105 }
106 
107