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 /**   Canvas Management (Canvas)                                          */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 
24 
25 /* Include necessary system files.  */
26 
27 #include "gx_api.h"
28 #include "gx_canvas.h"
29 
30 /**************************************************************************/
31 /*                                                                        */
32 /*  FUNCTION                                               RELEASE        */
33 /*                                                                        */
34 /*    _gx_canvas_mouse_show                               PORTABLE C      */
35 /*                                                           6.3.0        */
36 /*  AUTHOR                                                                */
37 /*                                                                        */
38 /*    Kenneth Maxwell, Microsoft Corporation                              */
39 /*                                                                        */
40 /*  DESCRIPTION                                                           */
41 /*                                                                        */
42 /*    This service makes the mouse visible.                               */
43 /*                                                                        */
44 /*  INPUT                                                                 */
45 /*                                                                        */
46 /*    canvas                                Canvas control block          */
47 /*                                                                        */
48 /*  OUTPUT                                                                */
49 /*                                                                        */
50 /*    status                                Completion status             */
51 /*                                                                        */
52 /*  CALLS                                                                 */
53 /*                                                                        */
54 /*    [gx_display_mouse_enable]             enabled or disabled mouse     */
55 /*                                                                        */
56 /*  CALLED BY                                                             */
57 /*                                                                        */
58 /*    Application code                                                    */
59 /*                                                                        */
60 /*  RELEASE HISTORY                                                       */
61 /*                                                                        */
62 /*    DATE              NAME                      DESCRIPTION             */
63 /*                                                                        */
64 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
65 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
66 /*                                            resulting in version 6.1    */
67 /*  10-31-2023     Ting Zhu                 Modified comment(s),          */
68 /*                                            added canvas status check,  */
69 /*                                            resulting in version 6.3.0  */
70 /*                                                                        */
71 /**************************************************************************/
72 #if defined(GX_MOUSE_SUPPORT)
_gx_canvas_mouse_show(GX_CANVAS * canvas)73 UINT _gx_canvas_mouse_show(GX_CANVAS *canvas)
74 {
75 GX_DISPLAY           *display;
76 GX_MOUSE_CURSOR_INFO *mouse_info;
77 
78 #if defined(GX_ENABLE_CANVAS_PARTIAL_FRAME_BUFFER)
79     if (canvas -> gx_canvas_status & GX_CANVAS_PARTIAL_FRAME_BUFFER)
80     {
81         /* Not supported.  */
82         return GX_FAILURE;
83     }
84 #endif
85 
86     display = canvas -> gx_canvas_display;
87     mouse_info = display -> gx_display_mouse.gx_mouse_cursor_info;
88 
89     if ((mouse_info != GX_NULL) && (display -> gx_display_mouse_enable != GX_NULL))
90     {
91         if (display -> gx_display_mouse.gx_mouse_canvas == canvas)
92         {
93             display -> gx_display_mouse_enable(display, GX_TRUE);
94             return GX_SUCCESS;
95         }
96     }
97     return GX_FAILURE;
98 }
99 #endif
100 
101