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 /** Text Input Cursor Managment (Text Input Cursor) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_system.h"
28 #include "gx_text_input_cursor.h"
29
30 /**************************************************************************/
31 /* */
32 /* FUNCTION RELEASE */
33 /* */
34 /* _gxe_text_input_cursor_height_set PORTABLE C */
35 /* 6.3.0 */
36 /* AUTHOR */
37 /* */
38 /* Kenneth Maxwell, Microsoft Corporation */
39 /* */
40 /* DESCRIPTION */
41 /* */
42 /* This function checks for errors in the text input cursor height */
43 /* set function call. */
44 /* */
45 /* */
46 /* INPUT */
47 /* */
48 /* cursor_ptr Pointer to text input cursor */
49 /* control block */
50 /* height Cursor height value to be set */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _gx_text_input_cursor_height_set */
59 /* Actual text input cursor */
60 /* height set function */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Application Code */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
71 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* 10-31-2023 Ting Zhu Modified comment(s), */
74 /* added invalid height check, */
75 /* resulting in version 6.3.0 */
76 /* */
77 /**************************************************************************/
_gxe_text_input_cursor_height_set(GX_TEXT_INPUT_CURSOR * cursor_ptr,GX_UBYTE height)78 UINT _gxe_text_input_cursor_height_set(GX_TEXT_INPUT_CURSOR *cursor_ptr, GX_UBYTE height)
79 {
80 UINT status;
81
82 if (!cursor_ptr)
83 {
84 return(GX_PTR_ERROR);
85 }
86
87 if (height == 0)
88 {
89 return(GX_INVALID_VALUE);
90 }
91
92 status = _gx_text_input_cursor_height_set(cursor_ptr, height);
93
94 return(status);
95 }
96
97
