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 /**   Slider Management (Slider)                                          */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 /* Include necessary system files.  */
24 
25 #include "gx_api.h"
26 #include "gx_slider.h"
27 
28 /* Bring in externs for caller checking code.  */
29 GX_CALLER_CHECKING_EXTERNS
30 
31 /**************************************************************************/
32 /*                                                                        */
33 /*  FUNCTION                                               RELEASE        */
34 /*                                                                        */
35 /*    _gxe_slider_value_calculate                         PORTABLE C      */
36 /*                                                           6.1          */
37 /*  AUTHOR                                                                */
38 /*                                                                        */
39 /*    Kenneth Maxwell, Microsoft Corporation                              */
40 /*                                                                        */
41 /*  DESCRIPTION                                                           */
42 /*                                                                        */
43 /*    This function checks for errors in slider value calculate call.     */
44 /*                                                                        */
45 /*  INPUT                                                                 */
46 /*                                                                        */
47 /*    slider                                Slider widget control block   */
48 /*    info                                  Pointer to slider info        */
49 /*    new_position                          New slider position           */
50 /*                                                                        */
51 /*  OUTPUT                                                                */
52 /*                                                                        */
53 /*    status                                Completion status             */
54 /*                                                                        */
55 /*  CALLS                                                                 */
56 /*                                                                        */
57 /*  _gx_slider_value_calculate              Actual slider value calculate */
58 /*                                            call                        */
59 /*  CALLED BY                                                             */
60 /*                                                                        */
61 /*    Application Code                                                    */
62 /*                                                                        */
63 /*  RELEASE HISTORY                                                       */
64 /*                                                                        */
65 /*    DATE              NAME                      DESCRIPTION             */
66 /*                                                                        */
67 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
68 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
69 /*                                            resulting in version 6.1    */
70 /*                                                                        */
71 /**************************************************************************/
_gxe_slider_value_calculate(GX_SLIDER * slider,GX_SLIDER_INFO * info,INT new_position)72 UINT  _gxe_slider_value_calculate(GX_SLIDER *slider, GX_SLIDER_INFO *info, INT new_position)
73 {
74 UINT status;
75 
76     /* Check for invalid caller.  */
77     GX_INIT_AND_THREADS_CALLER_CHECKING
78 
79     /* Check for invalid pointer.  */
80     if ((slider == GX_NULL) || (info == GX_NULL))
81     {
82         return(GX_PTR_ERROR);
83     }
84 
85     /* Check for invalid widget.  */
86     if (slider -> gx_widget_type == 0)
87     {
88         return(GX_INVALID_WIDGET);
89     }
90 
91     /* Check for invalid slider info.  */
92     if ((info -> gx_slider_info_current_val < info -> gx_slider_info_min_val) ||
93         (info -> gx_slider_info_current_val > info -> gx_slider_info_max_val) ||
94         (info -> gx_slider_info_min_val >= info -> gx_slider_info_max_val))
95     {
96         return(GX_INVALID_VALUE);
97     }
98 
99     /* Call actual slider value caculate function.  */
100     status = _gx_slider_value_calculate(slider, info, new_position);
101 
102     return(status);
103 }
104 
105