GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: gx_widget_detach.c Lines: 9 9 100.0 %
Date: 2024-12-05 08:52:37 Branches: 2 2 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_system.h"
28
#include "gx_widget.h"
29
#include "gx_utility.h"
30
31
32
/**************************************************************************/
33
/*                                                                        */
34
/*  FUNCTION                                               RELEASE        */
35
/*                                                                        */
36
/*    _gx_widget_detach                                   PORTABLE C      */
37
/*                                                           6.1          */
38
/*  AUTHOR                                                                */
39
/*                                                                        */
40
/*    Kenneth Maxwell, Microsoft Corporation                              */
41
/*                                                                        */
42
/*  DESCRIPTION                                                           */
43
/*                                                                        */
44
/*    This function detaches the widget from its parent.                  */
45
/*                                                                        */
46
/*  INPUT                                                                 */
47
/*                                                                        */
48
/*    widget                                Widget control block          */
49
/*                                                                        */
50
/*  OUTPUT                                                                */
51
/*                                                                        */
52
/*    status                                Completion status             */
53
/*                                                                        */
54
/*  CALLS                                                                 */
55
/*                                                                        */
56
/*    _gx_system_lock                        Lock access to GUIX          */
57
/*    _gx_widget_hide                        Hide the widget              */
58
/*    _gx_widget_unlink                      Unlink the widget            */
59
/*    _gx_system_unlock                      Release the protection       */
60
/*                                                                        */
61
/*  CALLED BY                                                             */
62
/*                                                                        */
63
/*    Application Code                                                    */
64
/*    GUIX Internal Code                                                  */
65
/*                                                                        */
66
/*  RELEASE HISTORY                                                       */
67
/*                                                                        */
68
/*    DATE              NAME                      DESCRIPTION             */
69
/*                                                                        */
70
/*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
71
/*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
72
/*                                            resulting in version 6.1    */
73
/*                                                                        */
74
/**************************************************************************/
75
16664
UINT _gx_widget_detach(GX_WIDGET *widget)
76
{
77
16664
GX_BOOL IsVisible = GX_FALSE;
78
79
    /* lock access to GUIX */
80
16664
    GX_ENTER_CRITICAL
81
82
16664
    IsVisible = widget -> gx_widget_status & GX_STATUS_VISIBLE;
83
84
16664
    if (IsVisible)
85
    {
86
2161
        _gx_widget_hide(widget);
87
    }
88
89
16664
    _gx_widget_unlink(widget);
90
91
    /* Release the protection.  */
92
16664
    GX_EXIT_CRITICAL
93
94
    /* Return successful status.  */
95
16664
    return(GX_SUCCESS);
96
}
97