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_blink_interval_set PORTABLE C */
35 /* 6.1 */
36 /* AUTHOR */
37 /* */
38 /* Kenneth Maxwell, Microsoft Corporation */
39 /* */
40 /* DESCRIPTION */
41 /* */
42 /* This function checks for errors in the text input cursor blink */
43 /* interval set function call. */
44 /* */
45 /* */
46 /* INPUT */
47 /* */
48 /* cursor_ptr Pointer to text input cursor */
49 /* control block */
50 /* blink_interval Cursor blink interval value */
51 /* to be set */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* status Completion status */
56 /* */
57 /* CALLS */
58 /* */
59 /* _gx_text_input_cursor_blink_interval_set */
60 /* Actual text input cursor */
61 /* blink interval 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_blink_interval_set(GX_TEXT_INPUT_CURSOR * cursor_ptr,GX_UBYTE blink_interval)76 UINT _gxe_text_input_cursor_blink_interval_set(GX_TEXT_INPUT_CURSOR *cursor_ptr, GX_UBYTE blink_interval)
77 {
78 UINT status;
79
80 if (!cursor_ptr)
81 {
82 return(GX_PTR_ERROR);
83 }
84
85 if (blink_interval == 0)
86 {
87 return(GX_INVALID_VALUE);
88 }
89
90 status = _gx_text_input_cursor_blink_interval_set(cursor_ptr, blink_interval);
91
92 return(status);
93 }
94
95
