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