Replace duplicate documentation of CopyFrom with inheritdoc
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI.Components / Style / PickerStyle.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     /// PickerStyle is a class which saves PickerStyle's ux data.
25     /// </summary>
26     [EditorBrowsable(EditorBrowsableState.Never)]
27     public class PickerStyle : ControlStyle
28     {
29         /// <summary>
30         /// Creates a new instance of a PickerStyle.
31         /// </summary>
32         [EditorBrowsable(EditorBrowsableState.Never)]
33         public PickerStyle() : base()
34         {
35         }
36
37         /// <summary>
38         /// Creates a new instance of a PickerStyle with style.
39         /// </summary>
40         /// <param name="style">Creates PickerStyle by style customized by user.</param>
41         [EditorBrowsable(EditorBrowsableState.Never)]
42         public PickerStyle(PickerStyle style) : base(style)
43         {
44         }
45
46         /// <summary>
47         /// Gets or sets the PickerStyle Item TextLabel style.
48         /// This style is applied if PickerStyle Item is a TextLabel.
49         /// </summary>
50         [EditorBrowsable(EditorBrowsableState.Never)]
51         public TextLabelStyle ItemTextLabel { get; set; } = new TextLabelStyle();
52
53         /// <summary>
54         /// Gets or sets the PickerStyle Center line style.
55         /// </summary>
56         public ViewStyle Divider { get; set;} = new ViewStyle();
57         
58         /// <summary>
59         /// Gets or sets the PickerStyle Item list start offset value.
60         /// </summary>
61         [EditorBrowsable(EditorBrowsableState.Never)]
62         public Size StartScrollOffset { get; set; } = new Size();
63
64         /// <inheritdoc/>
65         [EditorBrowsable(EditorBrowsableState.Never)]
66         public override void CopyFrom(BindableObject bindableObject)
67         {
68             base.CopyFrom(bindableObject);
69
70             if (bindableObject is PickerStyle pickerStyle)
71             {
72                 ItemTextLabel.CopyFrom(pickerStyle.ItemTextLabel);
73                 Divider.CopyFrom(pickerStyle.Divider);
74                 StartScrollOffset = (pickerStyle.StartScrollOffset == null) ?
75                                     new Size() : new Size(pickerStyle.StartScrollOffset.Width, pickerStyle.StartScrollOffset.Height);
76             }
77         }
78     }
79 }