-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* 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.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * 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.
+ *
+ */
namespace Tizen.NUI.UIComponents
{
using Tizen.NUI.BaseComponents;
/// <summary>
- /// ProgressBar is a control to give the user an indication of the progress of an operation.
+ /// The ProgressBar is a control to give the user an indication of the progress of an operation.
/// </summary>
public class ProgressBar : View
{
}
/// <summary>
- /// To make ProgressBar instance be disposed.
+ /// To dispose the ProgressBar instance.
/// </summary>
protected override void Dispose(DisposeTypes type)
{
/// <summary>
- /// Event arguments that passed via ValueChangedEventArgs
+ /// Event arguments that passed via the ValueChangedEventArgs.
/// </summary>
public class ValueChangedEventArgs : EventArgs
{
private float _progressValue;
private float _secondaryProgressValue;
+ /// <summary>
+ /// ProgressBar
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ProgressBar ProgressBar
{
get
}
}
+ /// <summary>
+ /// The progress value of the progress bar, the progress runs from 0 to 1.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ProgressValue
{
get
}
}
+ /// <summary>
+ /// The secondary progress value of the progress bar, the secondary progress runs from 0 to 1.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float SecondaryProgressValue
{
get
private ValueChangedCallbackDelegate _progressBarValueChangedCallbackDelegate;
/// <summary>
- /// Event is sent when the ProgressBar value changes.
+ /// The event is sent when the ProgressBar value changes.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ValueChangedEventArgs> ValueChanged
{
add
}
}
- internal class Property
+ internal new class Property
{
internal static readonly int PROGRESS_VALUE = NDalicPINVOKE.ProgressBar_Property_PROGRESS_VALUE_get();
internal static readonly int SECONDARY_PROGRESS_VALUE = NDalicPINVOKE.ProgressBar_Property_SECONDARY_PROGRESS_VALUE_get();
/// <summary>
/// Creates the ProgressBar.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ProgressBar() : this(NDalicPINVOKE.ProgressBar_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// The progress value of progress bar, progress runs form 0 to 1.<br>
- /// If Value is set to 0, progress bar will be set to beginning.<br>
- /// If Value is set to 1, progress bar will be set to end.<br>
- /// Any Value outside of the range is ignored.<br>
+ /// The progress value of the progress bar, the progress runs from 0 to 1.<br />
+ /// If the value is set to 0, then the progress bar will be set to beginning.<br />
+ /// If the value is set to 1, then the progress bar will be set to end.<br />
+ /// Any value outside the range is ignored.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float ProgressValue
{
get
}
}
/// <summary>
- /// The secondary progress value of progress bar, secondary progress runs form 0 to 1.<br>
- /// Optional. If not supplied, the default is 0.<br>
- /// If Value is set to 0, progress bar will be set secondary progress to beginning.<br>
- /// If Value is set to 1, progress bar will be set secondary progress to end.<br>
- /// Any Value outside of the range is ignored.<br>
+ /// The secondary progress value of the progress bar, the secondary progress runs from 0 to 1.<br />
+ /// Optional. If not supplied, the default is 0.<br />
+ /// If the value is set to 0, then the progress bar will be set secondary progress to beginning.<br />
+ /// If the value is set to 1, then the progress bar will be set secondary progress to end.<br />
+ /// Any value outside of the range is ignored.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public float SecondaryProgressValue
{
get
}
}
/// <summary>
- /// Sets the progress-bar as \e indeterminate state.
+ /// Sets the progress bar as \e indeterminate state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool Indeterminate
{
get
}
}
/// <summary>
- /// The track Visual value of progress bar, it's a full progress area and it's shown behind PROGRESS_VISUAL.<br>
- /// Optional. If not supplied, the default track visual will be shown.<br>
+ /// The track visual value of progress bar, it's full progress area, and it's shown behind the PROGRESS_VISUAL.<br />
+ /// Optional. If not supplied, the default track visual will be shown.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap TrackVisual
{
get
}
}
/// <summary>
- /// The progress Visual value of progress bar, size of the progress visual is changed based on PROGRESS_VALUE.<br>
- /// Optional. If not supplied, the default progress visual will be shown.<br>
+ /// The progress visual value of the progress bar, the size of the progress visual is changed based on the PROGRESS_VALUE.<br />
+ /// Optional. If not supplied, then the default progress visual will be shown.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap ProgressVisual
{
get
}
}
/// <summary>
- /// The secondary progress visual of progress bar, size of the secondary progress visual is changed based on SECONDARY_PROGRESS_VALUE.<br>
- /// Optional. If not supplied, the secondary progress visual will not be shown.<br>
+ /// The secondary progress visual of the progress bar, the size of the secondary progress visual is changed based on the SECONDARY_PROGRESS_VALUE.<br />
+ /// Optional. If not supplied, then the secondary progress visual will not be shown.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap SecondaryProgressVisual
{
get
}
}
/// <summary>
- /// The indeterminate visual of progress bar.<br>
- /// Optional. If not supplied, the default inditerminate visual will be shown.<br>
+ /// The indeterminate visual of the progress bar.<br />
+ /// Optional. If not supplied, then the default indeterminate visual will be shown.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap IndeterminateVisual
{
get
}
}
/// <summary>
- /// The transition data for indeterminate visual animation.<br>
- /// Optional. If not supplied, default animation will be played.<br>
+ /// The transition data for the indeterminate visual animation.<br />
+ /// Optional. If not supplied, then the default animation will be played.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyArray IndeterminateVisualAnimation
{
get
}
}
/// <summary>
- /// The Label visual of progress bar.
+ /// The label visual of the progress bar.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Tizen.NUI.PropertyMap LabelVisual
{
get
}
-}
+}
\ No newline at end of file
projects / platform / core / csapi / tizenfx.git / blobdiff