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 /**   Button Management (Scroll Thumb)                                    */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 
24 /* Include necessary system files.  */
25 
26 #include "gx_api.h"
27 #include "gx_scrollbar.h"
28 
29 /* Bring in externs for caller checking code.  */
30 GX_CALLER_CHECKING_EXTERNS
31 
32 /**************************************************************************/
33 /*                                                                        */
34 /*  FUNCTION                                               RELEASE        */
35 /*                                                                        */
36 /*    _gxe_scroll_thumb_event_process                     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 scroll thumb event process   */
45 /*    function call.                                                      */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    scroll_thumb                          Scroll thumb widget control   */
50 /*                                            block                       */
51 /*    event                                 Pointer to event to process   */
52 /*                                                                        */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    status                                Completion status             */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    _gx_scroll_thumb_event_process        Actual scroll thumb event     */
60 /*                                            process function            */
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_scroll_thumb_event_process(GX_SCROLL_THUMB * scroll_thumb,GX_EVENT * event_ptr)75 UINT  _gxe_scroll_thumb_event_process(GX_SCROLL_THUMB *scroll_thumb, GX_EVENT *event_ptr)
76 {
77 
78     /* Check for appropriate caller.  */
79     GX_INIT_AND_THREADS_CALLER_CHECKING
80 
81     /* Check for invalid input pointers.  */
82     if ((scroll_thumb == GX_NULL) || (event_ptr == GX_NULL))
83     {
84         return(GX_PTR_ERROR);
85     }
86 
87     /* Check for invalid widget. */
88     if (scroll_thumb -> gx_widget_type == 0)
89     {
90         return(GX_INVALID_WIDGET);
91     }
92 
93     /* Call actual scroll thumb event process function.  */
94     _gx_scroll_thumb_event_process(scroll_thumb, event_ptr);
95 
96     /* Return completion status.  */
97     return(GX_SUCCESS);
98 }
99 
100