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 /** Widget Management (Widget) */
19 /** */
20 /**************************************************************************/
21
22 #define GX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "gx_api.h"
28 #include "gx_widget.h"
29
30 /* Bring in externs for caller checking code. */
31 GX_CALLER_CHECKING_EXTERNS
32
33 /**************************************************************************/
34 /* */
35 /* FUNCTION RELEASE */
36 /* */
37 /* _gxe_widget_shift PORTABLE C */
38 /* 6.1 */
39 /* AUTHOR */
40 /* */
41 /* Kenneth Maxwell, Microsoft Corporation */
42 /* */
43 /* DESCRIPTION */
44 /* */
45 /* This function checks for errors in the widget shift function call. */
46 /* */
47 /* INPUT */
48 /* */
49 /* widget Pointer to widget */
50 /* x_shift Number of pixels to shift */
51 /* on x-axis */
52 /* y_shift Number of pixels to shift */
53 /* on y-axis */
54 /* mark_dirty GX_TRUE to indicate dirty, */
55 /* otherwise GX_FALSE */
56 /* */
57 /* OUTPUT */
58 /* */
59 /* status Completion status */
60 /* */
61 /* CALLS */
62 /* */
63 /* _gx_widget_shift Actual widget shift function */
64 /* */
65 /* CALLED BY */
66 /* */
67 /* Application Code */
68 /* */
69 /* RELEASE HISTORY */
70 /* */
71 /* DATE NAME DESCRIPTION */
72 /* */
73 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
74 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
75 /* resulting in version 6.1 */
76 /* */
77 /**************************************************************************/
_gxe_widget_shift(GX_WIDGET * widget,GX_VALUE x_shift,GX_VALUE y_shift,GX_BOOL mark_dirty)78 UINT _gxe_widget_shift(GX_WIDGET *widget, GX_VALUE x_shift, GX_VALUE y_shift, GX_BOOL mark_dirty)
79 {
80 UINT status;
81
82 /* Check for appropriate caller. */
83 GX_INIT_AND_THREADS_CALLER_CHECKING
84
85 /* Check for invalid input pointers. */
86 if (widget == GX_NULL)
87 {
88 return(GX_PTR_ERROR);
89 }
90
91 /* Check for invalid widget. */
92 if (widget -> gx_widget_type == 0)
93 {
94 return(GX_INVALID_WIDGET);
95 }
96
97 /* Call actual widget shift function. */
98 status = _gx_widget_shift(widget, x_shift, y_shift, mark_dirty);
99
100 /* Return successful completion. */
101 return(status);
102 }
103
104