[NUI] Make GetParent() protected (#165)
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / Container.cs
1 /*
2  * Copyright(c) 2017 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
18 using System;
19 using System.Collections.Generic;
20 using Tizen.NUI.BaseComponents;
21
22 namespace Tizen.NUI
23 {
24     /// <summary>
25     /// The Container is an abstract class to be inherited from by classes that desire to have views
26     /// added to them.
27     /// </summary>
28     /// <since_tizen> 4 </since_tizen>
29     public abstract class Container : Animatable
30     {
31
32         private List<View> _childViews = new List<View>();
33
34         /// <summary>
35         /// List of children of Container.
36         /// </summary>
37         /// <since_tizen> 4 </since_tizen>
38         public List<View> Children
39         {
40             get
41             {
42                 return _childViews;
43             }
44         }
45
46         internal Container(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn)
47         {
48             // No un-managed data hence no need to store a native ptr
49         }
50
51         /// <summary>
52         /// Dispose.
53         /// </summary>
54         /// <since_tizen> 4 </since_tizen>
55         protected override void Dispose(DisposeTypes type)
56         {
57             if (disposed)
58             {
59                 return;
60             }
61
62             base.Dispose(type);
63         }
64
65         protected abstract Container GetParent();
66
67         /// <summary>
68         /// Adds a child view to this Container.
69         /// </summary>
70         /// <pre>This Container (the parent) has been initialized. The child view has been initialized. The child view is not the same as the parent view.</pre>
71         /// <post>The child will be referenced by its parent. This means that the child will be kept alive, even if the handle passed into this method is reset or destroyed.</post>
72         /// <remarks>If the child already has a parent, it will be removed from the old parent and reparented to this view. This may change child's position, color, scale, etc. as it now inherits them from this view.</remarks>
73         /// <param name="view">The child view to add.</param>
74         /// <since_tizen> 4 </since_tizen>
75         public abstract void Add( View view );
76
77         /// <summary>
78         /// Removes a child view from this view. If the view was not a child of this view, this is a no-op.
79         /// </summary>
80         /// <pre>This View(the parent) has been initialized. The child view is not the same as the parent view.</pre>
81         /// <param name="view">The view to remove</param>
82         /// <since_tizen> 4 </since_tizen>
83         public abstract void Remove( View view );
84
85         /// <summary>
86         /// Retrieves the child view by the index.
87         /// </summary>
88         /// <pre>The view has been initialized.</pre>
89         /// <param name="index">The index of the child to retrieve.</param>
90         /// <returns>The view for the given index or empty handle if children are not initialized.</returns>
91         /// <since_tizen> 4 </since_tizen>
92         public abstract View GetChildAt( uint index );
93
94         /// <summary>
95         /// Gets the number of children for this container.
96         /// </summary>
97         /// <pre>The container has been initialized.</pre>
98         /// <returns>The number of children.</returns>
99         /// <since_tizen> 4 </since_tizen>
100         public abstract UInt32 GetChildCount();
101
102         /// <summary>
103         /// Gets the parent container.
104         /// Read only
105         /// </summary>
106         /// <pre>The child container has been initialized.</pre>
107         /// <returns>The parent container.</returns>
108         /// <since_tizen> 4 </since_tizen>
109         public Container Parent
110         {
111             get
112             {
113                 return GetParent();
114             }
115         }
116
117         /// <summary>
118         /// Gets the number of children for this container.
119         /// Read only
120         /// </summary>
121         /// <pre>The container has been initialized.</pre>
122         /// <returns>The number of children.</returns>
123         /// <since_tizen> 4 </since_tizen>
124         public uint ChildCount
125         {
126             get
127             {
128                 return GetChildCount();
129             }
130         }
131     }
132 } // namespace Tizen.NUI