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 /* Include necessary system files. */
24
25 #include "gx_api.h"
26 #include "gx_canvas.h"
27 #include "gx_port.h"
28
29 /* Bring in externs for caller checking code. */
30 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_canvas_mouse_show PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Kenneth Maxwell, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function checks for errors for the canvas mouse show call. */
45 /* */
46 /* INPUT */
47 /* */
48 /* canvas Canvas control block */
49 /* */
50 /* OUTPUT */
51 /* */
52 /* status Completion status */
53 /* */
54 /* CALLS */
55 /* */
56 /* _gx_canvas_mouse_show Actual canvas mouse show */
57 /* call */
58 /* */
59 /* CALLED BY */
60 /* */
61 /* Application Code */
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 /**************************************************************************/
72 #if defined(GX_MOUSE_SUPPORT)
_gxe_canvas_mouse_show(GX_CANVAS * canvas)73 UINT _gxe_canvas_mouse_show(GX_CANVAS *canvas)
74 {
75 UINT status;
76
77 /* Check for appropriate caller. */
78 GX_INIT_AND_THREADS_CALLER_CHECKING
79
80 /* Check for the invalid input pointers. */
81 if ((canvas == GX_NULL) ||
82 (canvas -> gx_canvas_display == GX_NULL) ||
83 (canvas -> gx_canvas_memory == GX_NULL))
84 {
85 return(GX_PTR_ERROR);
86 }
87
88 /* Call the actual mouse hotspot set function. */
89 status = _gx_canvas_mouse_show(canvas);
90
91 /* Return completion status. */
92 return status;
93 }
94 #endif
95
96
