GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: gxe_widget_shift.c Lines: 8 8 100.0 %
Date: 2024-12-05 08:52:37 Branches: 10 10 100.0 %

Line Branch Exec Source
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
/* Bring in externs for caller checking code.  */
30
GX_CALLER_CHECKING_EXTERNS
31
32
/**************************************************************************/
33
/*                                                                        */
34
/*  FUNCTION                                               RELEASE        */
35
/*                                                                        */
36
/*    _gxe_widget_shift                                   PORTABLE C      */
37
/*                                                           6.1          */
38
/*  AUTHOR                                                                */
39
/*                                                                        */
40
/*    Kenneth Maxwell, Microsoft Corporation                              */
41
/*                                                                        */
42
/*  DESCRIPTION                                                           */
43
/*                                                                        */
44
/*    This function checks for errors in the widget shift function call.  */
45
/*                                                                        */
46
/*  INPUT                                                                 */
47
/*                                                                        */
48
/*    widget                                Pointer to widget             */
49
/*    x_shift                               Number of pixels to shift     */
50
/*                                            on x-axis                   */
51
/*    y_shift                               Number of pixels to shift     */
52
/*                                            on y-axis                   */
53
/*    mark_dirty                            GX_TRUE to indicate dirty,    */
54
/*                                            otherwise GX_FALSE          */
55
/*                                                                        */
56
/*  OUTPUT                                                                */
57
/*                                                                        */
58
/*    status                                Completion status             */
59
/*                                                                        */
60
/*  CALLS                                                                 */
61
/*                                                                        */
62
/*    _gx_widget_shift                      Actual widget shift function  */
63
/*                                                                        */
64
/*  CALLED BY                                                             */
65
/*                                                                        */
66
/*    Application Code                                                    */
67
/*                                                                        */
68
/*  RELEASE HISTORY                                                       */
69
/*                                                                        */
70
/*    DATE              NAME                      DESCRIPTION             */
71
/*                                                                        */
72
/*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
73
/*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
74
/*                                            resulting in version 6.1    */
75
/*                                                                        */
76
/**************************************************************************/
77
7205
UINT  _gxe_widget_shift(GX_WIDGET *widget, GX_VALUE x_shift, GX_VALUE y_shift, GX_BOOL mark_dirty)
78
{
79
UINT status;
80
81
    /* Check for appropriate caller.  */
82

7205
    GX_INIT_AND_THREADS_CALLER_CHECKING
83
84
    /* Check for invalid input pointers.  */
85
7203
    if (widget == GX_NULL)
86
    {
87
2
        return(GX_PTR_ERROR);
88
    }
89
90
    /* Check for invalid widget.  */
91
7201
    if (widget -> gx_widget_type == 0)
92
    {
93
1
        return(GX_INVALID_WIDGET);
94
    }
95
96
    /* Call actual widget shift function.  */
97
7200
    status = _gx_widget_shift(widget, x_shift, y_shift, mark_dirty);
98
99
    /* Return successful completion.  */
100
7200
    return(status);
101
}
102