Replace duplicate documentation of CopyFrom with inheritdoc
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI.Components / Style / ProgressStyle.cs
1 /*
2  * Copyright(c) 2021 Samsung Electronics Co., Ltd.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 using System.ComponentModel;
18 using Tizen.NUI.BaseComponents;
19 using Tizen.NUI.Binding;
20
21 namespace Tizen.NUI.Components
22 {
23     /// <summary>
24     /// ProgressStyle is a class which saves Progress's ux data.
25     /// </summary>
26     /// <since_tizen> 8 </since_tizen>
27     public class ProgressStyle : ControlStyle
28     {
29         static ProgressStyle() { }
30
31         /// <summary>
32         /// Creates a new instance of a ProgressStyle.
33         /// </summary>
34         /// <since_tizen> 8 </since_tizen>
35         public ProgressStyle() : base()
36         {
37         }
38
39         /// <summary>
40         /// Creates a new instance of a ProgressStyle with style.
41         /// </summary>
42         /// <param name="style">Create ProgressStyle by style customized by user.</param>
43         /// <since_tizen> 8 </since_tizen>
44         public ProgressStyle(ProgressStyle style) : base(style)
45         {
46         }
47
48         /// <summary>
49         /// Gets or sets track image.
50         /// </summary>
51         /// <since_tizen> 8 </since_tizen>
52         public ImageViewStyle Track { get; set; } = new ImageViewStyle();
53
54         /// <summary>
55         /// Gets or sets progress image.
56         /// </summary>
57         /// <since_tizen> 8 </since_tizen>
58         public ImageViewStyle Progress { get; set; } = new ImageViewStyle();
59
60         /// <summary>
61         /// Gets or sets buffer image.
62         /// </summary>
63         /// <since_tizen> 8 </since_tizen>
64         public ImageViewStyle Buffer { get; set; } = new ImageViewStyle();
65
66         /// <summary>
67         /// Gets or sets indeterminate progress resource.
68         /// </summary>
69         /// <since_tizen> 9 </since_tizen>
70         public string IndeterminateImageUrl { get; set; }
71
72         /// <inheritdoc/>
73         /// <since_tizen> 8 </since_tizen>
74         public override void CopyFrom(BindableObject bindableObject)
75         {
76             base.CopyFrom(bindableObject);
77
78             if (bindableObject is ProgressStyle progressStyle)
79             {
80                 Track.CopyFrom(progressStyle.Track);
81                 Progress.CopyFrom(progressStyle.Progress);
82                 Buffer.CopyFrom(progressStyle.Buffer);
83                 IndeterminateImageUrl = progressStyle.IndeterminateImageUrl;
84             }
85         }
86     }
87 }