[NUI] Fix build warning[CA1064]
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / TransitionData.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 using System.ComponentModel;
18
19 namespace Tizen.NUI
20 {
21     /// <summary>
22     /// This object translates data from a property array of maps into an array of animators.
23     /// </summary>
24     /// <since_tizen> 3 </since_tizen>
25     public class TransitionData : BaseHandle
26     {
27
28         /// <summary>
29         /// Create an instance of TransitionData.
30         /// </summary>
31         /// <param name="transition">The transition data to store (a single animator).</param>
32         /// <since_tizen> 3 </since_tizen>
33         public TransitionData(PropertyMap transition) : this(Interop.TransitionData.NewByMap(PropertyMap.getCPtr(transition)), true)
34         {
35             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
36
37         }
38
39         /// <summary>
40         /// Create an instance of TransitionData.
41         /// </summary>
42         /// <param name="transition">The transition data to store (an array of maps of animators).</param>
43         /// <since_tizen> 3 </since_tizen>
44         public TransitionData(PropertyArray transition) : this(Interop.TransitionData.NewByArray(PropertyArray.getCPtr(transition)), true)
45         {
46             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
47
48         }
49
50         /// <summary>
51         /// Create an instance of TransitionData by copy constructor.
52         /// </summary>
53         /// <param name="handle">Handle to an object.</param>
54         /// <since_tizen> 3 </since_tizen>
55         public TransitionData(TransitionData handle) : this(Interop.TransitionData.NewTransitionData(TransitionData.getCPtr(handle)), true)
56         {
57             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
58         }
59
60         internal TransitionData(global::System.IntPtr cPtr, bool cMemoryOwn) : base(Interop.TransitionData.Upcast(cPtr), cMemoryOwn)
61         {
62         }
63
64         /// <summary>
65         /// returns the count of the individual property transitions stored within this handle.
66         /// </summary>
67         /// <returns>A handle to the image at the the specified position.</returns>
68         /// <since_tizen> 3 </since_tizen>
69         public uint Count()
70         {
71             uint ret = Interop.TransitionData.Count(swigCPtr);
72             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
73             return ret;
74         }
75
76         /// <summary>
77         /// returns the count of the individual property transitions stored within this handle.
78         /// </summary>
79         /// <param name="index">The index of the animator.</param>
80         /// <returns>A property map representing the animator.</returns>
81         /// <since_tizen> 3 </since_tizen>
82         public PropertyMap GetAnimatorAt(uint index)
83         {
84             PropertyMap ret = new PropertyMap(Interop.TransitionData.GetAnimatorAt(swigCPtr, index), true);
85             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
86             return ret;
87         }
88
89         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(TransitionData obj)
90         {
91             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
92         }
93
94         /// This will not be public opened.
95         [EditorBrowsable(EditorBrowsableState.Never)]
96         protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
97         {
98             Interop.TransitionData.DeleteTransitionData(swigCPtr);
99         }
100     }
101 }