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 /** Widget Management (Widget) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_widget.h"
28
29 GX_CALLER_CHECKING_EXTERNS
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _gxe_widget_block_move 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 widget block move function. */
44 /* */
45 /* INPUT */
46 /* */
47 /* widget Pointer to widget */
48 /* block Rectangle to move */
49 /* x_shift Number of pixels to shift on */
50 /* the x-axis */
51 /* y_shift Number of pixels to shift on */
52 /* the y-axis */
53 /* */
54 /* OUTPUT */
55 /* */
56 /* status Completion status */
57 /* */
58 /* CALLS */
59 /* */
60 /* _gx_widget_block_move Actual widget block move */
61 /* 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_widget_block_move(GX_WIDGET * widget,GX_RECTANGLE * block,INT x_shift,INT y_shift)76 UINT _gxe_widget_block_move(GX_WIDGET *widget, GX_RECTANGLE *block, INT x_shift, INT y_shift)
77 {
78 UINT status;
79
80 /* Check for appropriate caller. */
81 GX_INIT_AND_THREADS_CALLER_CHECKING
82
83 /* Check for invalid input pointers. */
84 if ((widget == GX_NULL) || (block == NULL))
85 {
86 return GX_PTR_ERROR;
87 }
88
89 /* Check for valid widget. */
90 if (widget -> gx_widget_type == 0)
91 {
92 return GX_INVALID_WIDGET;
93 }
94
95 /* Check for valid rectangle. */
96 if ((block -> gx_rectangle_left > block -> gx_rectangle_right) ||
97 (block -> gx_rectangle_top > block -> gx_rectangle_bottom))
98 {
99 return GX_INVALID_VALUE;
100 }
101
102 /* Call actual widget back move function. */
103 status = _gx_widget_block_move(widget, block, x_shift, y_shift);
104
105 /* Return completion status. */
106 return(status);
107 }
108
109
