1 /**************************************************************************/
2 /*                                                                        */
3 /*       Copyright (c) Microsoft Corporation. All rights reserved.        */
4 /*                                                                        */
5 /*       This software is licensed under the Microsoft Software License   */
6 /*       Terms for Microsoft Azure RTOS. Full text of the license can be  */
7 /*       found in the LICENSE file at https://aka.ms/AzureRTOS_EULA       */
8 /*       and in the root directory of this software.                      */
9 /*                                                                        */
10 /**************************************************************************/
11 
12 
13 /**************************************************************************/
14 /**************************************************************************/
15 /**                                                                       */
16 /** GUIX Component                                                        */
17 /**                                                                       */
18 /**   Scrollbar Management (Scrollbar)                                    */
19 /**                                                                       */
20 /**************************************************************************/
21 
22 #define GX_SOURCE_CODE
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_scrollbar_reset                                PORTABLE C      */
37 /*                                                           6.1          */
38 /*  AUTHOR                                                                */
39 /*                                                                        */
40 /*    Kenneth Maxwell, Microsoft Corporation                              */
41 /*                                                                        */
42 /*  DESCRIPTION                                                           */
43 /*                                                                        */
44 /*    This service checks errors in the scrollbar reset function call.    */
45 /*                                                                        */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    scrollbar                             Scrollbar control block       */
50 /*    info                                  Pointer to GX_SCROLL          */
51 /*                                            structure that defines the  */
52 /*                                            scrollbar limits, current   */
53 /*                                            value, and step/increment.  */
54 /*                                                                        */
55 /*  OUTPUT                                                                */
56 /*                                                                        */
57 /*    status               Completion status                              */
58 /*                                                                        */
59 /*  CALLS                                                                 */
60 /*                                                                        */
61 /*    _gx_scrollbar_reset     The actual 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_scrollbar_reset(GX_SCROLLBAR * scrollbar,GX_SCROLL_INFO * info)76 UINT _gxe_scrollbar_reset(GX_SCROLLBAR *scrollbar, GX_SCROLL_INFO *info)
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 ((scrollbar == GX_NULL))
85     {
86         return(GX_PTR_ERROR);
87     }
88 
89     /* Check for invalid widget.  */
90     if (scrollbar -> gx_widget_type == 0)
91     {
92         return(GX_INVALID_WIDGET);
93     }
94 
95     /* Check fro valid scroll info.  */
96     if ((info != GX_NULL) && ((info -> gx_scroll_value > info -> gx_scroll_maximum) ||
97                               (info -> gx_scroll_value < info -> gx_scroll_minimum)))
98     {
99         return(GX_INVALID_VALUE);
100     }
101 
102     /* Call the actual function.  */
103     status = _gx_scrollbar_reset(scrollbar, info);
104 
105     /* Return successful completion.  */
106     return(status);
107 }
108 
109