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 /**   Animation Management (Animation)                                    */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 
24 /* Include necessary system files.  */
25 
26 #include "gx_api.h"
27 #include "gx_animation.h"
28 
29 
30 /**************************************************************************/
31 /*                                                                        */
32 /*  FUNCTION                                               RELEASE        */
33 /*                                                                        */
34 /*    _gxe_animation_drag_enable                          PORTABLE C      */
35 /*                                                           6.1          */
36 /*  AUTHOR                                                                */
37 /*                                                                        */
38 /*    Kenneth Maxwell, Microsoft Corporation                              */
39 /*                                                                        */
40 /*  DESCRIPTION                                                           */
41 /*                                                                        */
42 /*    This function checks for error in animation slide enable call.      */
43 /*                                                                        */
44 /*                                                                        */
45 /*  INPUT                                                                 */
46 /*                                                                        */
47 /*    animation                             Pointer to animation control  */
48 /*                                            block                       */
49 /*    widget                                Pointer to widget control     */
50 /*                                            block                       */
51 /*    info                                  Animation information         */
52 /*                                                                        */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    status                                Completion status             */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    _gx_animation_slide_enable            Actual animation slide enable */
60 /*                                            call.                       */
61 /*                                                                        */
62 /*  CALLED BY                                                             */
63 /*                                                                        */
64 /*    Application 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 /**************************************************************************/
_gxe_animation_drag_enable(GX_ANIMATION * animation,GX_WIDGET * widget,GX_ANIMATION_INFO * info)75 UINT _gxe_animation_drag_enable(GX_ANIMATION *animation, GX_WIDGET *widget, GX_ANIMATION_INFO *info)
76 {
77     /* Check for invalid pointer. */
78     if ((animation == GX_NULL) ||
79         (widget == GX_NULL) ||
80         (info == GX_NULL))
81     {
82         return GX_PTR_ERROR;
83     }
84 
85     /* animation drag is already enabled ? */
86     if (animation -> gx_animation_original_event_process_function != GX_NULL)
87     {
88         return GX_INVALID_ANIMATION;
89     }
90 
91     if ((info -> gx_animation_style & GX_ANIMATION_EASING_FUNC_MASK) &&
92         (info -> gx_animation_steps < 2))
93     {
94         return GX_INVALID_VALUE;
95     }
96 
97     if (info -> gx_animation_frame_interval < 1)
98     {
99         return GX_INVALID_VALUE;
100     }
101 
102     if (info -> gx_animation_slide_screen_list == GX_NULL)
103     {
104         /* Slide screen list has not been created */
105         return GX_INVALID_WIDGET;
106     }
107 
108     return(_gx_animation_drag_enable(animation, widget, info));
109 }
110 
111