summaryrefslogtreecommitdiff
path: root/ElmSharp/ElmSharp/ProgressBar.cs
blob: 5ef887b796ff1587fde1e2677b67ea18c3c67ec6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/*
 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

using System;

namespace ElmSharp
{
    /// <summary>
    /// The ProgressBar is a widget for visually representing the progress status of a given job/task.
    /// </summary>
    public class ProgressBar : Layout
    {
        SmartEvent _changed;

        /// <summary>
        /// Creates and initializes a new instance of the ProgressBar class.
        /// </summary>
        /// <param name="parent">The EvasObject to which the new ProgressBar will be attached as a child.</param>
        public ProgressBar(EvasObject parent) : base(parent)
        {
            _changed = new SmartEvent(this, this.RealHandle, "changed");
            _changed.On += (s, e) =>
            {
                ValueChanged?.Invoke(this, EventArgs.Empty);
            };
        }

        /// <summary>
        /// ValueChanged will be triggered when value of ProgressBar change.
        /// </summary>
        public event EventHandler ValueChanged;

        /// <summary>
        /// Sets or gets the value wheather a given ProgressBar widget is at the "pulsing mode".
        /// </summary>
        /// <remarks>
        /// By default, progress bars display values from low to high value boundaries.
        /// There are, though, contexts in which the progress of a given task is unknown.
        /// For such cases, one can set a progress bar widget to a "pulsing state",
        /// to give the user an idea that some computation is being held,
        /// but without exact progress values. In the default theme,
        /// it animates its bar with the contents filling in constantly and back to non-filled, in a loop.
        /// </remarks>
        public bool IsPulseMode
        {
            get
            {
                return Interop.Elementary.elm_progressbar_pulse_get(RealHandle);
            }
            set
            {
                Interop.Elementary.elm_progressbar_pulse_set(RealHandle, value);
            }
        }

        /// <summary>
        /// Sets or gets the value of ProgressBar.
        /// </summary>
        /// <remarks>
        /// Use this property to set the progress bar levels.
        /// If you pass a value out of the specified range(0.0~1.0),
        /// it is interpreted as the closest of the boundary values in the range.
        /// </remarks>
        public double Value
        {
            get
            {
                return Interop.Elementary.elm_progressbar_value_get(RealHandle);
            }
            set
            {
                Interop.Elementary.elm_progressbar_value_set(RealHandle, value);
            }
        }

        /// <summary>
        /// Sets or gets the span value of ProgressBar.
        /// </summary>
        public int SpanSize
        {
            get
            {
                return Interop.Elementary.elm_progressbar_span_size_get(RealHandle);
            }
            set
            {
                Interop.Elementary.elm_progressbar_span_size_set(RealHandle, value);
            }
        }

        /// <summary>
        /// Sets or gets the value wheather a given ProgressBar widget is horizontal.
        /// </summary>
        public bool IsHorizontal
        {
            get
            {
                return Interop.Elementary.elm_progressbar_horizontal_get(RealHandle);
            }
            set
            {
                Interop.Elementary.elm_progressbar_horizontal_set(RealHandle, value);
            }
        }

        /// <summary>
        /// Sets or gets the value whether a given progress bar widget's displaying values are inverted.
        /// </summary>
        public bool IsInverted
        {
            get
            {
                return Interop.Elementary.elm_progressbar_inverted_get(RealHandle);
            }
            set
            {
                Interop.Elementary.elm_progressbar_inverted_set(RealHandle, value);
            }
        }

        /// <summary>
        /// Sets or gets format string for a given progress bar widget's units label.
        /// </summary>
        /// <remarks>
        /// If NULL is passed on format, it makes obj units area to be hidden completely.
        /// If not, it sets the format string for the units label's text.
        /// The units label is provided with a floating point value, so the units text displays at most one floating point value.
        /// Note that the units label is optional. Use a format string such as "%1.2f meters" for example.
        /// The default format string for a progress bar is an integer percentage, as in "%.0f %%".
        /// </remarks>
        public string UnitFormat
        {
            get
            {
                return Interop.Elementary.elm_progressbar_unit_format_get(RealHandle);
            }
            set
            {
                Interop.Elementary.elm_progressbar_unit_format_set(RealHandle, value);
            }
        }

        /// <summary>
        /// Starts a given progress bar "pulsing" animation, if its under that mode.
        /// </summary>
        public void PlayPulse()
        {
            Interop.Elementary.elm_progressbar_pulse(RealHandle, true);
        }

        [Obsolete("use StopPulse instead")]
        public void StopPluse()
        {
            Interop.Elementary.elm_progressbar_pulse(RealHandle, false);
        }

        /// <summary>
        /// Stops a given progress bar "pulsing" animation, if its under that mode.
        /// </summary>
        public void StopPulse()
        {
            Interop.Elementary.elm_progressbar_pulse(RealHandle, false);
        }

        protected override IntPtr CreateHandle(EvasObject parent)
        {
            IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle);
            Interop.Elementary.elm_layout_theme_set(handle, "layout", "elm_widget", "default");

            RealHandle = Interop.Elementary.elm_progressbar_add(handle);
            Interop.Elementary.elm_object_part_content_set(handle, "elm.swallow.content", RealHandle);

            return handle;
        }
    }
}