[NUI] Fix a build warning CA1717 (#2422)
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / BaseComponents / ViewEnum.cs
1 /*
2  * Copyright(c) 2019 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.ComponentModel;
19
20 namespace Tizen.NUI.BaseComponents
21 {
22     /// <summary>
23     /// The View layout Direction type.
24     /// </summary>
25     /// <since_tizen> 4 </since_tizen>
26     public enum ViewLayoutDirectionType
27     {
28         /// <summary>
29         /// Left to right.
30         /// </summary>
31         /// <since_tizen> 4 </since_tizen>
32         LTR,
33         /// <summary>
34         /// Right to left.
35         /// </summary>
36         /// <since_tizen> 4 </since_tizen>
37         RTL
38     }
39
40     /// <summary>
41     /// [Draft] Available policies for layout parameters
42     /// </summary>
43     /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
44     [EditorBrowsable(EditorBrowsableState.Never)]
45     public static class LayoutParamPolicies
46     {
47         /// <summary>
48         /// Constant which indicates child size should match parent size
49         /// </summary>
50         /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
51         [EditorBrowsable(EditorBrowsableState.Never)]
52         public const int MatchParent = -1;
53         /// <summary>
54         /// Constant which indicates parent should take the smallest size possible to wrap it's children with their desired size
55         /// </summary>
56         /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
57         [EditorBrowsable(EditorBrowsableState.Never)]
58         public const int WrapContent = -2;
59     }
60
61     internal enum ResourceLoadingStatusType
62     {
63         Invalid = -1,
64         Preparing = 0,
65         Ready,
66         Failed,
67     }
68
69     /// <summary>
70     /// View is the base class for all views.
71     /// </summary>
72     /// <since_tizen> 3 </since_tizen>
73     public partial class View
74     {
75         /// <summary>
76         /// Enumeration for describing the states of the view.
77         /// </summary>
78         /// <since_tizen> 3 </since_tizen>
79         [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1717:Only FlagsAttribute enums should have plural names")]
80         public enum States
81         {
82             /// <summary>
83             /// The normal state.
84             /// </summary>
85             [Description("NORMAL")]
86             Normal,
87             /// <summary>
88             /// The focused state.
89             /// </summary>
90             [Description("FOCUSED")]
91             Focused,
92             /// <summary>
93             /// The disabled state.
94             /// </summary>
95             [Description("DISABLED")]
96             Disabled
97         }
98
99         /// <summary>
100         /// Describes the direction to move the focus towards.
101         /// </summary>
102         /// <since_tizen> 3 </since_tizen>
103         public enum FocusDirection
104         {
105             /// <summary>
106             /// Move keyboard focus towards the left direction.
107             /// </summary>
108             /// <since_tizen> 3 </since_tizen>
109             Left,
110             /// <summary>
111             /// Move keyboard focus towards the right direction.
112             /// </summary>
113             /// <since_tizen> 3 </since_tizen>
114             Right,
115             /// <summary>
116             /// Move keyboard focus towards the up direction.
117             /// </summary>
118             /// <since_tizen> 3 </since_tizen>
119             Up,
120             /// <summary>
121             /// Move keyboard focus towards the down direction.
122             /// </summary>
123             /// <since_tizen> 3 </since_tizen>
124             Down,
125             /// <summary>
126             /// Move keyboard focus towards the previous page direction.
127             /// </summary>
128             /// <since_tizen> 3 </since_tizen>
129             PageUp,
130             /// <summary>
131             /// Move keyboard focus towards the next page direction.
132             /// </summary>
133             /// <since_tizen> 3 </since_tizen>
134             PageDown
135         }
136
137         internal enum PropertyRange
138         {
139             PROPERTY_START_INDEX = PropertyRanges.PROPERTY_REGISTRATION_START_INDEX,
140             CONTROL_PROPERTY_START_INDEX = PROPERTY_START_INDEX,
141             CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000
142         }
143
144         internal class Property
145         {
146             internal static readonly int TOOLTIP = Interop.ViewProperty.TooltipGet();
147             internal static readonly int STATE = Interop.ViewProperty.StateGet();
148             internal static readonly int SubState = Interop.ViewProperty.SubStateGet();
149             internal static readonly int LeftFocusableViewId = Interop.ViewProperty.LeftFocusableActorIdGet();
150             internal static readonly int RightFocusableViewId = Interop.ViewProperty.RightFocusableActorIdGet();
151             internal static readonly int UpFocusableViewId = Interop.ViewProperty.UpFocusableActorIdGet();
152             internal static readonly int DownFocusableViewId = Interop.ViewProperty.DownFocusableActorIdGet();
153             internal static readonly int StyleName = Interop.ViewProperty.StyleNameGet();
154             internal static readonly int KeyInputFocus = Interop.ViewProperty.KeyInputFocusGet();
155             internal static readonly int BACKGROUND = Interop.ViewProperty.BackgroundGet();
156             internal static readonly int SiblingOrder = Interop.ActorProperty.SiblingOrderGet();
157             internal static readonly int OPACITY = Interop.ActorProperty.OpacityGet();
158             internal static readonly int ScreenPosition = Interop.ActorProperty.ScreenPositionGet();
159             internal static readonly int PositionUsesAnchorPoint = Interop.ActorProperty.PositionUsesAnchorPointGet();
160             internal static readonly int ParentOrigin = Interop.ActorProperty.ParentOriginGet();
161             internal static readonly int ParentOriginX = Interop.ActorProperty.ParentOriginXGet();
162             internal static readonly int ParentOriginY = Interop.ActorProperty.ParentOriginYGet();
163             internal static readonly int ParentOriginZ = Interop.ActorProperty.ParentOriginZGet();
164             internal static readonly int AnchorPoint = Interop.ActorProperty.AnchorPointGet();
165             internal static readonly int AnchorPointX = Interop.ActorProperty.AnchorPointXGet();
166             internal static readonly int AnchorPointY = Interop.ActorProperty.AnchorPointYGet();
167             internal static readonly int AnchorPointZ = Interop.ActorProperty.AnchorPointZGet();
168             internal static readonly int SIZE = Interop.ActorProperty.SizeGet();
169             internal static readonly int SizeWidth = Interop.ActorProperty.SizeWidthGet();
170             internal static readonly int SizeHeight = Interop.ActorProperty.SizeHeightGet();
171             internal static readonly int SizeDepth = Interop.ActorProperty.SizeDepthGet();
172             internal static readonly int POSITION = Interop.ActorProperty.PositionGet();
173             internal static readonly int PositionX = Interop.ActorProperty.PositionXGet();
174             internal static readonly int PositionY = Interop.ActorProperty.PositionYGet();
175             internal static readonly int PositionZ = Interop.ActorProperty.PositionZGet();
176             internal static readonly int WorldPosition = Interop.ActorProperty.WorldPositionGet();
177             internal static readonly int WorldPositionX = Interop.ActorProperty.WorldPositionXGet();
178             internal static readonly int WorldPositionY = Interop.ActorProperty.WorldPositionYGet();
179             internal static readonly int WorldPositionZ = Interop.ActorProperty.WorldPositionZGet();
180             internal static readonly int ORIENTATION = Interop.ActorProperty.OrientationGet();
181             internal static readonly int WorldOrientation = Interop.ActorProperty.WorldOrientationGet();
182             internal static readonly int SCALE = Interop.ActorProperty.ScaleGet();
183             internal static readonly int ScaleX = Interop.ActorProperty.ScaleXGet();
184             internal static readonly int ScaleY = Interop.ActorProperty.ScaleYGet();
185             internal static readonly int ScaleZ = Interop.ActorProperty.ScaleZGet();
186             internal static readonly int WorldScale = Interop.ActorProperty.WorldScaleGet();
187             internal static readonly int VISIBLE = Interop.ActorProperty.VisibleGet();
188             internal static readonly int WorldColor = Interop.ActorProperty.WorldColorGet();
189             internal static readonly int WorldMatrix = Interop.ActorProperty.WorldMatrixGet();
190             internal static readonly int NAME = Interop.ActorProperty.NameGet();
191             internal static readonly int SENSITIVE = Interop.ActorProperty.SensitiveGet();
192             internal static readonly int LeaveRequired = Interop.ActorProperty.LeaveRequiredGet();
193             internal static readonly int InheritOrientation = Interop.ActorProperty.InheritOrientationGet();
194             internal static readonly int InheritScale = Interop.ActorProperty.InheritScaleGet();
195             internal static readonly int DrawMode = Interop.ActorProperty.DrawModeGet();
196             internal static readonly int SizeModeFactor = Interop.ActorProperty.SizeModeFactorGet();
197             internal static readonly int WidthResizePolicy = Interop.ActorProperty.WidthResizePolicyGet();
198             internal static readonly int HeightResizePolicy = Interop.ActorProperty.HeightResizePolicyGet();
199             internal static readonly int SizeScalePolicy = Interop.ActorProperty.SizeScalePolicyGet();
200             internal static readonly int WidthForHeight = Interop.ActorProperty.WidthForHeightGet();
201             internal static readonly int HeightForWidth = Interop.ActorProperty.HeightForWidthGet();
202             internal static readonly int MinimumSize = Interop.ActorProperty.MinimumSizeGet();
203             internal static readonly int MaximumSize = Interop.ActorProperty.MaximumSizeGet();
204             internal static readonly int InheritPosition = Interop.ActorProperty.InheritPositionGet();
205             internal static readonly int ClippingMode = Interop.ActorProperty.ClippingModeGet();
206             internal static readonly int InheritLayoutDirection = Interop.ActorProperty.InheritLayoutDirectionGet();
207             internal static readonly int LayoutDirection = Interop.ActorProperty.LayoutDirectionGet();
208             internal static readonly int MARGIN = Interop.ViewProperty.MarginGet();
209             internal static readonly int PADDING = Interop.ViewProperty.PaddingGet();
210             internal static readonly int SHADOW = Interop.ViewProperty.ShadowGet();
211             internal static readonly int CaptureAllTouchAfterStart = Interop.ActorProperty.CaptureAllTouchAfterStartGet();
212             internal static readonly int BlendEquation = Interop.ActorProperty.BlendEquationGet();
213         }
214     }
215 }