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 /**   Progress Bar Management (Progress Bar)                              */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 /* Include necessary system files.  */
24 
25 #include "gx_api.h"
26 #include "gx_system.h"
27 #include "gx_utility.h"
28 #include "gx_progress_bar.h"
29 #include "gx_widget.h"
30 
31 /**************************************************************************/
32 /*                                                                        */
33 /*  FUNCTION                                               RELEASE        */
34 /*                                                                        */
35 /*    _gx_progress_bar_value_set                          PORTABLE C      */
36 /*                                                           6.1          */
37 /*  AUTHOR                                                                */
38 /*                                                                        */
39 /*    Kenneth Maxwell, Microsoft Corporation                              */
40 /*                                                                        */
41 /*  DESCRIPTION                                                           */
42 /*                                                                        */
43 /*    This service sets the progress bar value.                           */
44 /*                                                                        */
45 /*                                                                        */
46 /*  INPUT                                                                 */
47 /*                                                                        */
48 /*    progress_bar                          Progress Bar control block    */
49 /*    new_value                             New progress bar value        */
50 /*                                                                        */
51 /*  OUTPUT                                                                */
52 /*                                                                        */
53 /*    status                                Completion status             */
54 /*                                                                        */
55 /*  CALLS                                                                 */
56 /*                                                                        */
57 /*    _gx_system_dirty_mark                 Mark the widget dirty         */
58 /*                                                                        */
59 /*  CALLED BY                                                             */
60 /*                                                                        */
61 /*    Application Code                                                    */
62 /*    GUIX Internal Code                                                  */
63 /*                                                                        */
64 /*  RELEASE HISTORY                                                       */
65 /*                                                                        */
66 /*    DATE              NAME                      DESCRIPTION             */
67 /*                                                                        */
68 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
69 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
70 /*                                            resulting in version 6.1    */
71 /*                                                                        */
72 /**************************************************************************/
_gx_progress_bar_value_set(GX_PROGRESS_BAR * progress_bar,INT new_value)73 UINT _gx_progress_bar_value_set(GX_PROGRESS_BAR *progress_bar, INT new_value)
74 {
75     if (new_value > progress_bar -> gx_progress_bar_info.gx_progress_bar_info_max_val)
76     {
77         new_value = progress_bar -> gx_progress_bar_info.gx_progress_bar_info_max_val;
78     }
79     else if (new_value < progress_bar -> gx_progress_bar_info.gx_progress_bar_info_min_val)
80     {
81         new_value = progress_bar -> gx_progress_bar_info.gx_progress_bar_info_min_val;
82     }
83 
84     if (new_value != progress_bar -> gx_progress_bar_info.gx_progress_bar_info_current_val)
85     {
86         /* Assign progress bar value */
87         progress_bar -> gx_progress_bar_info.gx_progress_bar_info_current_val = new_value;
88 
89         /* Mark as dirty so that I get redrawn */
90         if (progress_bar -> gx_widget_status & GX_STATUS_VISIBLE)
91         {
92             _gx_system_dirty_mark((GX_WIDGET *)progress_bar);
93         }
94 
95         /* notify my parent of my new value */
96         _gx_widget_event_generate((GX_WIDGET *)progress_bar, GX_EVENT_PROGRESS_VALUE, new_value);
97     }
98     return(GX_SUCCESS);
99 }
100 
101