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_font_get                                 PORTABLE C      */
35 /*                                                           6.1          */
36 /*  AUTHOR                                                                */
37 /*                                                                        */
38 /*    Kenneth Maxwell, Microsoft Corporation                              */
39 /*                                                                        */
40 /*  DESCRIPTION                                                           */
41 /*                                                                        */
42 /*    This service gets the font associated with the specified            */
43 /*    resource ID.                                                        */
44 /*                                                                        */
45 /*  INPUT                                                                 */
46 /*                                                                        */
47 /*    widget                                Widget control block pointer  */
48 /*    resource_id                           Resource ID of font           */
49 /*    return_font                           Pointer to destination for    */
50 /*                                            font pointer                */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    status                                Completion status             */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    _gx_widget_canvas_get                 Get widget canvas pointer     */
59 /*                                                                        */
60 /*  CALLED BY                                                             */
61 /*                                                                        */
62 /*    Application Code                                                    */
63 /*    GUIX default drawing functions                                      */
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_font_get(GX_WIDGET * widget,GX_RESOURCE_ID resource_id,GX_FONT ** return_font)74 UINT  _gx_widget_font_get(GX_WIDGET *widget, GX_RESOURCE_ID resource_id, GX_FONT **return_font)
75 {
76 GX_FONT       *font = GX_NULL;
77 UINT           status = GX_INVALID_CANVAS;
78 
79 GX_CANVAS     *canvas;
80 GX_DISPLAY    *display;
81 GX_RESOURCE_ID font_table_size;
82 
83     if (widget -> gx_widget_status & GX_STATUS_VISIBLE)
84     {
85         _gx_widget_canvas_get(widget, &canvas);
86 
87         if (canvas)
88         {
89             display = canvas -> gx_canvas_display;
90 
91             /* Pickup the font table size.  */
92             font_table_size =  display -> gx_display_font_table_size;
93 
94             /* Determine if the ID is within range.  */
95             if (resource_id < font_table_size)
96             {
97                 /* Yes, the ID is within range. Perform a table lookup and return the
98                    font poiner.  */
99                 font = display -> gx_display_font_table[resource_id];
100                 status = GX_SUCCESS;
101             }
102             else
103             {
104                 status = GX_INVALID_RESOURCE_ID;
105             }
106         }
107     }
108     *return_font = font;
109     return(status);
110 }
111 
112