1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** GUIX Component */
17 /** */
18 /** Canvas Management (Canvas) */
19 /** */
20 /**************************************************************************/
21
22 #define GX_SOURCE_CODE
23
24
25
26 /* Include necessary system files. */
27
28 #include "gx_api.h"
29 #include "gx_canvas.h"
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _gx_canvas_mouse_hide PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Kenneth Maxwell, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This service makes the mouse hidden. */
44 /* */
45 /* INPUT */
46 /* */
47 /* canvas Canvas control block */
48 /* */
49 /* OUTPUT */
50 /* */
51 /* status Completion status */
52 /* */
53 /* CALLS */
54 /* */
55 /* [gx_display_mouse_enable] enabled or disabled mouse */
56 /* */
57 /* CALLED BY */
58 /* */
59 /* Application code */
60 /* */
61 /* RELEASE HISTORY */
62 /* */
63 /* DATE NAME DESCRIPTION */
64 /* */
65 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
66 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
67 /* resulting in version 6.1 */
68 /* */
69 /**************************************************************************/
70 #if defined(GX_MOUSE_SUPPORT)
_gx_canvas_mouse_hide(GX_CANVAS * canvas)71 UINT _gx_canvas_mouse_hide(GX_CANVAS *canvas)
72 {
73 GX_DISPLAY *display;
74
75 display = canvas -> gx_canvas_display;
76
77 if (display -> gx_display_mouse.gx_mouse_canvas == canvas && (display -> gx_display_mouse_enable != GX_NULL))
78 {
79 display -> gx_display_mouse_enable(display, GX_FALSE);
80 return GX_SUCCESS;
81 }
82
83 return GX_FAILURE;
84 }
85 #endif
86
87