[NUI] Fixing the emtpy finalizers(CA1821)
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / VisualConstants.cs
1 // Copyright (c) 2019 Samsung Electronics Co., Ltd.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 using System.ComponentModel;
16
17 namespace Tizen.NUI
18 {
19     /// <summary>
20     /// Specifies the release policy types.<br />
21     /// Decides if the image should be cached in different conditions.
22     /// </summary>
23     /// <since_tizen> 5 </since_tizen>
24     public enum ReleasePolicyType
25     {
26         /// <summary>
27         /// Image is released when visual detached from scene.
28         /// </summary>
29         Detached = 0,
30         /// <summary>
31         /// Image is only released when visual is destroyed.
32         /// </summary>
33         Destroyed,
34         /// <summary>
35         /// Image is not released.
36         /// </summary>
37         Never
38     }
39
40     /// <summary>
41     /// Specifies the load policy types.<br />
42     /// Decides when the image texture should be loaded.
43     /// </summary>
44     /// <since_tizen> 5 </since_tizen>
45     public enum LoadPolicyType
46     {
47         /// <summary>
48         /// Load texture once the image source has been provided. Even if not being used yet.
49         /// </summary>
50         Immediate = 0,
51         /// <summary>
52         /// Only load texture once the visual is attached, when the image needs to be shown.
53         /// </summary>
54         Attached
55     }
56
57     /// <summary>
58     /// Enumeration for the text horizontal aligning.
59     /// </summary>
60     /// <since_tizen> 3 </since_tizen>
61     public enum HorizontalAlignment
62     {
63         /// <summary>
64         /// Texts place at the begin of horizontal direction.
65         /// </summary>
66         [Description("BEGIN")]
67         Begin,
68         /// <summary>
69         /// Texts place at the center of horizontal direction.
70         /// </summary>
71         [Description("CENTER")]
72         Center,
73         /// <summary>
74         /// Texts place at the end of horizontal direction.
75         /// </summary>
76         [Description("END")]
77         End
78     }
79
80     /// <summary>
81     /// Enumeration for the text horizontal aligning.
82     /// </summary>
83     /// <since_tizen> 3 </since_tizen>
84     public enum VerticalAlignment
85     {
86         /// <summary>
87         /// Texts place at the top of vertical direction.
88         /// </summary>
89         [Description("TOP")]
90         Top,
91         /// <summary>
92         /// Texts place at the center of vertical direction.
93         /// </summary>
94         [Description("CENTER")]
95         Center,
96         /// <summary>
97         /// Texts place at the bottom of vertical direction.
98         /// </summary>
99         [Description("BOTTOM")]
100         Bottom
101     }
102
103     /// <summary>
104     /// This specifies wrap mode types.<br />
105     /// WrapModeU and WrapModeV separately decide how the texture should be sampled when the u and v coordinate exceeds the range of 0.0 to 1.0.
106     /// </summary>
107     /// <since_tizen> 3 </since_tizen>
108     public enum WrapModeType
109     {
110         /// <summary>
111         /// The default value.
112         /// </summary>
113         Default = 0,
114         /// <summary>
115         /// Clamp to edge.
116         /// </summary>
117         ClampToEdge,
118         /// <summary>
119         /// Repeat.
120         /// </summary>
121         Repeat,
122         /// <summary>
123         /// Mirrored repeat.
124         /// </summary>
125         MirroredRepeat
126     }
127
128     /// <summary>
129     /// This specifies fitting mode types. Fitting options, used when resizing images to fit desired dimensions.<br />
130     /// A fitting mode controls the region of a loaded image to be mapped to the desired image rectangle.<br />
131     /// All fitting modes preserve the aspect ratio of the image contents.<br />
132     /// </summary>
133     /// <since_tizen> 3 </since_tizen>
134     public enum FittingModeType
135     {
136         /// <summary>
137         /// Full-screen image display: Limit loaded image resolution to device resolution using the ShrinkToFit mode.
138         /// </summary>
139         ShrinkToFit,
140         /// <summary>
141         /// Thumbnail gallery grid: Limit loaded image resolution to screen tile using the ScaleToFill mode.
142         /// </summary>
143         ScaleToFill,
144         /// <summary>
145         /// Image columns: Limit loaded image resolution to column width using the FitWidth mode.
146         /// </summary>
147         FitWidth,
148         /// <summary>
149         /// Image rows: Limit loaded image resolution to row height using the FitHeight mode.
150         /// </summary>
151         FitHeight,
152         /// <summary>
153         /// Thumbnail gallery grid: Limit loaded image resolution to screen tile using the Center mode.
154         /// </summary>
155         [EditorBrowsable(EditorBrowsableState.Never)]
156         Center,
157         /// <summary>
158         /// Thumbnail gallery grid: Limit loaded image resolution to screen tile using the ScaleToFill mode.
159         /// </summary>
160         [EditorBrowsable(EditorBrowsableState.Never)]
161         Fill
162     }
163
164     /// <summary>
165     /// This specifies sampling mode types. Filtering options are used when resizing images to sample original pixels.<br />
166     /// A SamplingMode controls how pixels in an input image are sampled and combined to generate each pixel of a destination image during scaling.<br />
167     /// NoFilter and Box modes do not guarantee that the output pixel array exactly matches the rectangle specified by the desired dimensions and the FittingMode,<br />
168     /// but all other filter modes do if the desired dimensions are not more than the raw dimensions of the input image file.<br />
169     /// </summary>
170     /// <since_tizen> 3 </since_tizen>
171     public enum SamplingModeType
172     {
173         /// <summary>
174         /// Iteratively box filter to generate an image of 1/2, 1/4, 1/8, etc. width and height and approximately the desired size. <br />
175         /// This is the default.
176         /// </summary>
177         Box,
178         /// <summary>
179         /// For each output pixel, read one input pixel.
180         /// </summary>
181         Nearest,
182         /// <summary>
183         /// For each output pixel, read a quad of four input pixels and write a weighted average of them.
184         /// </summary>
185         Linear,
186         /// <summary>
187         /// Iteratively box filter to generate an image of 1/2, 1/4, 1/8, etc. width and height and approximately the desired size, <br />
188         /// then for each output pixel, read one pixel from the last level of box filtering.<br />
189         /// </summary>
190         BoxThenNearest,
191         /// <summary>
192         /// Iteratively box filter to almost the right size, then for each output pixel, read four pixels from the last level of box filtering and write their weighted average.
193         /// </summary>
194         BoxThenLinear,
195         /// <summary>
196         /// No filtering is performed. If the SCALE_TO_FILL scaling mode is enabled, the borders of the image may be trimmed to match the aspect ratio of the desired dimensions.
197         /// </summary>
198         NoFilter,
199         /// <summary>
200         /// For caching algorithms where a client strongly prefers a cache-hit to reuse a cached image.
201         /// </summary>
202         DontCare
203     }
204
205     /// <summary>
206     /// The type of coordinate system for certain attributes of the points in a gradient.
207     /// </summary>
208     /// <since_tizen> 3 </since_tizen>
209     public enum GradientVisualUnitsType
210     {
211         /// <summary>
212         /// Uses the normals for the start, end, and center points, i.e., top-left is (-0.5, -0.5) and bottom-right is (0.5, 0.5).
213         /// </summary>
214         ObjectBoundingBox,
215         /// <summary>
216         /// Uses the user coordinates for the start, end, and center points, i.e., in a 200 by 200 control, top-left is (0, 0) and bottom-right is (200, 200).
217         /// </summary>
218         UserSpace
219     }
220
221     /// <summary>
222     /// This specifies SpreadMethod types.<br />
223     /// SpreadMethod defines what happens if the gradient starts or ends inside the bounds of the target rectangle.<br />
224     /// </summary>
225     /// <since_tizen> 3 </since_tizen>
226     public enum GradientVisualSpreadMethodType
227     {
228         /// <summary>
229         /// Uses the terminal colors of the gradient to fill the remainder of the quad.
230         /// </summary>
231         Pad,
232         /// <summary>
233         /// Reflects the gradient pattern start-to-end, end-to-start, start-to-end, etc. until the quad is filled.
234         /// </summary>
235         Reflect,
236         /// <summary>
237         /// Repeats the gradient pattern start-to-end, start-to-end, start-to-end, etc. until the quad is filled.
238         /// </summary>
239         Repeat
240     }
241
242     /// <summary>
243     /// The shading mode used by the mesh visual.
244     /// </summary>
245     /// <since_tizen> 3 </since_tizen>
246     public enum MeshVisualShadingModeValue
247     {
248         /// <summary>
249         /// *Simplest*. One color that is lit by ambient and diffuse lighting.
250         /// </summary>
251         TexturelessWithDiffuseLighting,
252         /// <summary>
253         /// Uses only the visual image textures provided with specular lighting in addition to ambient and diffuse lighting.
254         /// </summary>
255         TexturedWithSpecularLighting,
256         /// <summary>
257         /// Uses all textures provided including gloss, normal, and texture map along with specular, ambient, and diffuse lighting.
258         /// </summary>
259         TexturedWithDetailedSpecularLighting
260     }
261
262     /// <summary>
263     /// The primitive shape to render as a primitive visual.
264     /// </summary>
265     /// <since_tizen> 3 </since_tizen>
266     public enum PrimitiveVisualShapeType
267     {
268         /// <summary>
269         /// A perfectly round geometrical object in the three-dimensional space.
270         /// </summary>
271         Sphere,
272         /// <summary>
273         /// The area bound between two circles, i.e., a cone with the tip removed.
274         /// </summary>
275         ConicalFrustrum,
276         /// <summary>
277         /// Equivalent to a conical frustrum with the top radius of zero.
278         /// </summary>Equivalent to a conical frustrum with the top radius of zero.
279         Cone,
280         /// <summary>
281         /// Equivalent to a conical frustrum with the top radius of zero.
282         /// </summary>
283         Cylinder,
284         /// <summary>
285         /// Equivalent to a conical frustrum with equal radii for the top and bottom circles.
286         /// </summary>
287         Cube,
288         /// <summary>
289         /// Equivalent to a bevelled cube with a bevel percentage of zero.
290         /// </summary>
291         Octahedron,
292         /// <summary>
293         /// Equivalent to a bevelled cube with a bevel percentage of one.
294         /// </summary>
295         BevelledCube
296     }
297
298     /// <summary>
299     /// The values of this enum determine how the visual should fit into the view.
300     /// </summary>
301     /// <since_tizen> 5 </since_tizen>
302     public enum VisualFittingModeType
303     {
304         /// <summary>
305         /// The visual should be scaled to fit, preserving aspect ratio.
306         /// </summary>
307         FitKeepAspectRatio,
308         /// <summary>
309         /// The visual should be stretched to fill, not preserving aspect ratio.
310         /// </summary>
311         Fill,
312         /// <summary>
313         /// The visual should be scaled to fit, preserving aspect ratio. The visual will be fillled without empty area, and outside is cropped away.
314         /// </summary>
315         [EditorBrowsable(EditorBrowsableState.Never)]
316         OverFitKeepAspectRatio,
317         /// <summary>
318         /// The visual should keep original size of image. it is not scaled and not strecthed.
319         /// </summary>
320         [EditorBrowsable(EditorBrowsableState.Never)]
321         Center,
322         /// <summary>
323         /// The visual should be scaled to fit, preserving aspect ratio. Height is scaled proportionately to maintain aspect ratio.
324         /// </summary>
325         [EditorBrowsable(EditorBrowsableState.Never)]
326         FitHeight,
327         /// <summary>
328         /// The visual should be scaled to fit, preserving aspect ratio. WIDTH is scaled proportionately to maintain aspect ratio.
329         /// </summary>
330         [EditorBrowsable(EditorBrowsableState.Never)]
331         FitWidth,
332     }
333
334     /// <summary>
335     /// This specifies policy types that could be used by the transform for the offset or size.
336     /// </summary>
337     /// <since_tizen> 3 </since_tizen>
338     public enum VisualTransformPolicyType
339     {
340         /// <summary>
341         /// Relative to the control (percentage [0.0f to 1.0f] of the control).
342         /// </summary>
343         Relative = 0,
344         /// <summary>
345         /// Absolute value in world units.
346         /// </summary>
347         Absolute = 1
348     }
349
350     /// <summary>
351     /// This specifies all the transform property types.
352     /// </summary>
353     /// <since_tizen> 3 </since_tizen>
354     public enum VisualTransformPropertyType
355     {
356         /// <summary>
357         /// Offset of the visual, which can be either relative (percentage [0.0f to 1.0f] of the parent) or absolute (in world units).
358         /// </summary>
359         Offset,
360         /// <summary>
361         /// Size of the visual, which can be either relative (percentage [0.0f to 1.0f] of the parent) or absolute (in world units).
362         /// </summary>
363         Size,
364         /// <summary>
365         /// The origin of the visual within its control area.
366         /// </summary>
367         Origin,
368         /// <summary>
369         /// The anchor-point of the visual.
370         /// </summary>
371         AnchorPoint,
372         /// <summary>
373         /// Whether the x or y offset values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
374         /// </summary>
375         OffsetPolicy,
376         /// <summary>
377         /// Whether the width or the height size values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units).
378         /// </summary>
379         SizePolicy,
380         /// <summary>
381         /// Extra size value that will be added to the computed visual size.
382         /// </summary>
383         [EditorBrowsable(EditorBrowsableState.Never)]
384         ExtraSize,
385     }
386
387     /// <summary>
388     /// This specifies visual types.
389     /// </summary>
390     /// <since_tizen> 3 </since_tizen>
391     public struct Visual
392     {
393         /// <summary>
394         /// The index for the visual type.
395         /// </summary>
396         /// <since_tizen> 3 </since_tizen>
397         public enum Type
398         {
399             /// <summary>
400             /// Renders a solid color as an internal border to the control's quad.
401             /// </summary>
402             Border,
403             /// <summary>
404             /// Renders a solid color to the control's quad.
405             /// </summary>
406             Color,
407             /// <summary>
408             /// Renders a smooth transition of colors to the control's quad.
409             /// </summary>
410             Gradient,
411             /// <summary>
412             /// Renders an image into the control's quad.
413             /// </summary>
414             Image,
415             /// <summary>
416             /// Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file.
417             /// </summary>
418             Mesh,
419             /// <summary>
420             /// Renders a simple 3D shape, such as a cube or a sphere.
421             /// </summary>
422             Primitive,
423             /// <summary>
424             /// Renders a simple wire-frame outlining a quad.
425             /// </summary>
426             Wireframe,
427             /// <summary>
428             /// Renders text.
429             /// </summary>
430             Text,
431             /// <summary>
432             /// Renders an NPatch image.
433             /// </summary>
434             NPatch,
435             /// <summary>
436             /// Renders an SVG image.
437             /// </summary>
438             SVG,
439             /// <summary>
440             /// Renders a animated image (animated GIF).
441             /// </summary>
442             AnimatedImage,
443             /// <summary>
444             /// Renders an arc.
445             /// </summary>
446             [EditorBrowsable(EditorBrowsableState.Never)]
447             Arc = AnimatedImage + 3,
448         }
449
450         /// <summary>
451         /// This specifies visual properties.
452         /// </summary>
453         /// <since_tizen> 3 </since_tizen>
454         public struct Property
455         {
456             /// <summary>
457             /// Type.
458             /// </summary>
459             /// <since_tizen> 3 </since_tizen>
460             public static readonly int Type = NDalic.VisualPropertyType;
461             /// <summary>
462             /// Shader.
463             /// </summary>
464             /// <since_tizen> 3 </since_tizen>
465             public static readonly int Shader = NDalic.VisualPropertyShader;
466             /// <summary>
467             /// Transform.
468             /// </summary>
469             /// <since_tizen> 3 </since_tizen>
470             public static readonly int Transform = NDalic.VisualPropertyTransform;
471             /// <summary>
472             /// PremultipliedAlpha.
473             /// </summary>
474             /// <since_tizen> 3 </since_tizen>
475             public static readonly int PremultipliedAlpha = NDalic.VisualPropertyPremultipliedAlpha;
476             /// <summary>
477             /// MixColor.
478             /// </summary>
479             /// <since_tizen> 3 </since_tizen>
480             public static readonly int MixColor = NDalic.VisualPropertyMixColor;
481             /// <summary>
482             /// Opacity.
483             /// </summary>
484             /// <since_tizen> 3 </since_tizen>
485             public static readonly int Opacity = NDalic.VisualPropertyMixColor + 1;
486             /// <summary>
487             /// The fitting mode of the visual.
488             /// </summary>
489             /// <since_tizen> 5 </since_tizen>
490             public static readonly int VisualFittingMode = NDalic.VisualPropertyMixColor + 2;
491             /// <summary>
492             /// The corner radius of the visual.
493             /// </summary>
494             [EditorBrowsable(EditorBrowsableState.Never)]
495             public static readonly int CornerRadius = NDalic.VisualPropertyMixColor + 3;
496             /// <summary>
497             /// The corner radius policy of the visual.
498             /// Whether the corner radius value is relative (percentage [0.0f to 1.0f] of the visual size) or absolute (in world units).
499             /// </summary>
500             [EditorBrowsable(EditorBrowsableState.Never)]
501             public static readonly int CornerRadiusPolicy = NDalic.VisualPropertyMixColor + 4;
502         }
503
504         /// <summary>
505         /// This specifies shader properties.
506         /// </summary>
507         /// <since_tizen> 3 </since_tizen>
508         public struct ShaderProperty
509         {
510             /// <summary>
511             /// Vertex shader code
512             /// </summary>
513             /// <since_tizen> 3 </since_tizen>
514             public static readonly int VertexShader = NDalic.VisualShaderVertex;
515             /// <summary>
516             /// Fragment shader code
517             /// </summary>
518             /// <since_tizen> 3 </since_tizen>
519             public static readonly int FragmentShader = NDalic.VisualShaderFragment;
520             /// <summary>
521             /// How to subdivide the grid along X
522             /// </summary>
523             /// <since_tizen> 3 </since_tizen>
524             public static readonly int ShaderSubdivideGridX = NDalic.VisualShaderSubdivideGridX;
525             /// <summary>
526             /// How to subdivide the grid along Y
527             /// </summary>
528             /// <since_tizen> 3 </since_tizen>
529             public static readonly int ShaderSubdivideGridY = NDalic.VisualShaderSubdivideGridY;
530             /// <summary>
531             /// Bitmask of hints
532             /// </summary>
533             /// <since_tizen> 3 </since_tizen>
534             public static readonly int ShaderHints = NDalic.VisualShaderHints;
535         }
536
537         /// <summary>
538         /// This specifies visaul align types.
539         /// </summary>
540         /// <since_tizen> 3 </since_tizen>
541         public enum AlignType
542         {
543             /// <summary>
544             /// TopBegin
545             /// </summary>
546             /// <since_tizen> 3 </since_tizen>
547             TopBegin = 0,
548             /// <summary>
549             /// TopCenter
550             /// </summary>
551             /// <since_tizen> 3 </since_tizen>
552             TopCenter,
553             /// <summary>
554             /// TopEnd
555             /// </summary>
556             /// <since_tizen> 3 </since_tizen>
557             TopEnd,
558             /// <summary>
559             /// CenterBegin
560             /// </summary>
561             /// <since_tizen> 3 </since_tizen>
562             CenterBegin,
563             /// <summary>
564             /// Center
565             /// </summary>
566             /// <since_tizen> 3 </since_tizen>
567             Center,
568             /// <summary>
569             /// CenterEnd
570             /// </summary>
571             /// <since_tizen> 3 </since_tizen>
572             CenterEnd,
573             /// <summary>
574             /// BottomBegin
575             /// </summary>
576             /// <since_tizen> 3 </since_tizen>
577             BottomBegin,
578             /// <summary>
579             /// BottomCenter
580             /// </summary>
581             /// <since_tizen> 3 </since_tizen>
582             BottomCenter,
583             /// <summary>
584             /// BottomEnd
585             /// </summary>
586             /// <since_tizen> 3 </since_tizen>
587             BottomEnd
588         }
589     }
590
591     /// <summary>
592     /// This specifies properties of the BorderVisual.
593     /// </summary>
594     /// <since_tizen> 3 </since_tizen>
595     public struct BorderVisualProperty
596     {
597         /// <summary>
598         /// The color of the border.
599         /// </summary>
600         /// <since_tizen> 3 </since_tizen>
601         public static readonly int Color = NDalic.BorderVisualColor;
602         /// <summary>
603         /// The width of the border (in pixels).
604         /// </summary>
605         /// <since_tizen> 3 </since_tizen>
606         public static readonly int Size = NDalic.BorderVisualSize;
607         /// <summary>
608         /// Whether anti-aliasing of the border is required.
609         /// </summary>
610         /// <since_tizen> 3 </since_tizen>
611         public static readonly int AntiAliasing = NDalic.BorderVisualAntiAliasing;
612     }
613
614     /// <summary>
615     /// This specifies properties of the ColorVisual.
616     /// </summary>
617     /// <since_tizen> 3 </since_tizen>
618     public struct ColorVisualProperty
619     {
620         /// <summary>
621         /// The solid color required.
622         /// </summary>
623         /// <since_tizen> 3 </since_tizen>
624         public static readonly int MixColor = NDalic.ColorVisualMixColor;
625         /// <summary>
626         /// Whether to render if the MixColor is transparent.
627         /// </summary>
628         /// <since_tizen> 5 </since_tizen>
629         public static readonly int RenderIfTransparent = NDalic.ColorVisualMixColor + 1;
630         /// <summary>
631         /// Then radius value for the area to blur.
632         /// </summary>
633         [EditorBrowsable(EditorBrowsableState.Never)]
634         public static readonly int BlurRadius = NDalic.ColorVisualMixColor + 2;
635     }
636
637     /// <summary>
638     /// This specifies properties of the GradientVisual.
639     /// </summary>
640     /// <since_tizen> 3 </since_tizen>
641     public struct GradientVisualProperty
642     {
643         /// <summary>
644         /// The start position of a linear gradient.
645         /// </summary>
646         /// <since_tizen> 3 </since_tizen>
647         public static readonly int StartPosition = NDalic.GradientVisualStartPosition;
648         /// <summary>
649         /// The end position of a linear gradient.
650         /// </summary>
651         /// <since_tizen> 3 </since_tizen>
652         public static readonly int EndPosition = NDalic.GradientVisualEndPosition;
653         /// <summary>
654         /// The center point of a radial gradient.
655         /// </summary>
656         /// <since_tizen> 3 </since_tizen>
657         public static readonly int Center = NDalic.GradientVisualCenter;
658         /// <summary>
659         /// The size of the radius of a radial gradient.
660         /// </summary>
661         /// <since_tizen> 3 </since_tizen>
662         public static readonly int Radius = NDalic.GradientVisualRadius;
663         /// <summary>
664         /// All the stop offsets.
665         /// </summary>
666         /// <since_tizen> 3 </since_tizen>
667         public static readonly int StopOffset = NDalic.GradientVisualStopOffset;
668         /// <summary>
669         /// The color at the stop offsets.
670         /// </summary>
671         /// <since_tizen> 3 </since_tizen>
672         public static readonly int StopColor = NDalic.GradientVisualStopColor;
673         /// <summary>
674         /// Defines the coordinate system for certain attributes of the points in a gradient.
675         /// </summary>
676         /// <since_tizen> 3 </since_tizen>
677         public static readonly int Units = NDalic.GradientVisualUnits;
678         /// <summary>
679         /// Indicates what happens if the gradient starts or ends inside the bounds of the target rectangle.
680         /// </summary>
681         /// <since_tizen> 3 </since_tizen>
682         public static readonly int SpreadMethod = NDalic.GradientVisualSpreadMethod;
683     }
684
685     /// <summary>
686     /// This specifies properties of the ImageVisual.
687     /// </summary>
688     /// <since_tizen> 3 </since_tizen>
689     public struct ImageVisualProperty
690     {
691         /// <summary>
692         /// The URL of the image.
693         /// </summary>
694         /// <since_tizen> 3 </since_tizen>
695         public static readonly int URL = NDalic.ImageVisualUrl;
696
697         /// <summary>
698         /// Fitting options, used when resizing images to fit desired dimensions.
699         /// </summary>
700         /// <since_tizen> 3 </since_tizen>
701         public static readonly int FittingMode = NDalic.ImageVisualFittingMode;
702
703         /// <summary>
704         /// Filtering options, used when resizing images to sample original pixels.
705         /// </summary>
706         /// <since_tizen> 3 </since_tizen>
707         public static readonly int SamplingMode = NDalic.ImageVisualSamplingMode;
708
709         /// <summary>
710         /// The desired image width.
711         /// </summary>
712         /// <since_tizen> 3 </since_tizen>
713         public static readonly int DesiredWidth = NDalic.ImageVisualDesiredWidth;
714
715         /// <summary>
716         /// The desired image height.
717         /// </summary>
718         /// <since_tizen> 3 </since_tizen>
719         public static readonly int DesiredHeight = NDalic.ImageVisualDesiredHeight;
720
721         /// <summary>
722         /// Whether to load the image synchronously.
723         /// </summary>
724         /// <since_tizen> 3 </since_tizen>
725         public static readonly int SynchronousLoading = NDalic.ImageVisualSynchronousLoading;
726
727         /// <summary>
728         /// If true, only draws the borders.
729         /// </summary>
730         /// <since_tizen> 3 </since_tizen>
731         public static readonly int BorderOnly = NDalic.ImageVisualBorderOnly;
732
733         /// <summary>
734         /// The image area to be displayed.
735         /// </summary>
736         /// <since_tizen> 3 </since_tizen>
737         public static readonly int PixelArea = NDalic.ImageVisualPixelArea;
738
739         /// <summary>
740         /// The wrap mode for u coordinate.
741         /// </summary>
742         /// <since_tizen> 3 </since_tizen>
743         public static readonly int WrapModeU = NDalic.ImageVisualWrapModeU;
744
745         /// <summary>
746         /// The wrap mode for v coordinate.
747         /// </summary>
748         /// <since_tizen> 3 </since_tizen>
749         public static readonly int WrapModeV = NDalic.ImageVisualWrapModeV;
750
751         /// <summary>
752         /// The border of the image.
753         /// </summary>
754         /// <since_tizen> 3 </since_tizen>
755         public static readonly int Border = NDalic.ImageVisualBorder;
756
757         /// <summary>
758         /// Whether to use the texture atlas.
759         /// </summary>
760         /// <since_tizen> 5 </since_tizen>
761         public static readonly int Atlasing = NDalic.ImageVisualBorder + 1;
762
763         /// <summary>
764         /// The URL of the alpha mask image.
765         /// </summary>
766         /// <since_tizen> 3 </since_tizen>
767         public static readonly int AlphaMaskURL = NDalic.ImageVisualAlphaMaskUrl;
768
769         /// <summary>
770         /// Defines the batch size for pre-loading images in the AnimatedImageVisual
771         /// </summary>
772         /// <since_tizen> 4 </since_tizen>
773         public static readonly int BatchSize = NDalic.ImageVisualBatchSize;
774
775         /// <summary>
776         /// Defines the cache size for loading images in the AnimatedImageVisual
777         /// </summary>
778         /// <since_tizen> 4 </since_tizen>
779         public static readonly int CacheSize = NDalic.ImageVisualCacheSize;
780
781         /// <summary>
782         /// The number of milliseconds between each frame in the AnimatedImageVisual
783         /// </summary>
784         /// <since_tizen> 4 </since_tizen>
785         public static readonly int FrameDelay = NDalic.ImageVisualFrameDelay;
786
787         /// <summary>
788         /// The scale factor to apply to the content image before masking.
789         /// </summary>
790         /// <since_tizen> 4 </since_tizen>
791         public static readonly int MaskContentScale = NDalic.ImageVisualMaskContentScale;
792
793         /// <summary>
794         /// Whether to crop image to mask or scale mask to fit image
795         /// </summary>
796         /// <since_tizen> 4 </since_tizen>
797         public static readonly int CropToMask = NDalic.ImageVisualCropToMask;
798
799         /// <summary>
800         /// The policy to determine when an image should be loaded.
801         /// </summary>
802         /// <since_tizen> 5 </since_tizen>
803         public static readonly int LoadPolicy = NDalic.ImageVisualLoadPolicy;
804
805         /// <summary>
806         /// The policy to determine when an image should no longer be cached.
807         /// </summary>
808         /// <since_tizen> 5 </since_tizen>
809         public static readonly int ReleasePolicy = NDalic.ImageVisualReleasePolicy;
810
811         /// <summary>
812         /// Determines if image orientation should be corrected so that the image displays as it was intended.
813         /// </summary>
814         /// <since_tizen> 5 </since_tizen>
815         public static readonly int OrientationCorrection = NDalic.ImageVisualOrientationCorrection;
816
817         /// <summary>
818         /// Overlays the auxiliary image on top of an NPatch image.
819         /// </summary>
820         /// <since_tizen> 5 </since_tizen>
821         public static readonly int AuxiliaryImageURL = NDalic.ImageVisualAuxiliaryImageUrl;
822
823         /// <summary>
824         /// Alpha value for the auxiliary image, without affecting the underlying NPatch image
825         /// </summary>
826         /// <since_tizen> 5 </since_tizen>
827         public static readonly int AuxiliaryImageAlpha = NDalic.ImageVisualAuxiliaryImageAlpha;
828
829         /// <summary>
830         /// The number of times the AnimatedImageVisual will be looped.
831         /// The default is -1. If the value is less than 0, loop unlimited. Otherwise, loop loopCount times.
832         /// </summary>
833         /// <since_tizen> 5 </since_tizen>
834         public static readonly int LoopCount = NDalic.ImageVisualLoopCount;
835
836         /// <summary>
837         /// @brief The playing range the AnimatedVectorImageVisual will use.
838         /// Animation will play between the values specified.The array can only have two values, and more will be ignored.
839         /// Both values should be between 0 and the total frame number, otherwise they will be ignored.
840         /// If the range provided is not in proper order (minimum, maximum), it will be reordered.
841         /// @details Name "playRange", Type Property::ARRAY of Property::INTEGER
842         /// @note Default 0 and the total frame number.
843         /// </summary>
844         /// <remarks>
845         /// Hidden API (Inhouse API)
846         /// </remarks>
847         [EditorBrowsable(EditorBrowsableState.Never)]
848         public static readonly int PlayRange = NDalic.ImageVisualOrientationCorrection + 4;
849
850         /// <summary>
851         /// @brief The playing state the AnimatedVectorImageVisual will use.
852         /// @details Name "playState", type PlayState (Property::INTEGER)
853         /// @note This property is read-only.
854         /// </summary>
855         /// <remarks>
856         /// Hidden API (Inhouse API)
857         /// </remarks>
858         [EditorBrowsable(EditorBrowsableState.Never)]
859         public static readonly int PlayState = NDalic.ImageVisualOrientationCorrection + 5;
860
861         /// <summary>
862         /// @brief The current frame number the AnimatedVectorImageVisual will use.
863         /// @details Name "currentFrameNumber", Type Property::INTEGER, between[0, the maximum frame number] or between the play range if specified
864         /// @note This property is read-only.
865         /// </summary>
866         /// <remarks>
867         /// Inhouse API
868         /// </remarks>
869         [EditorBrowsable(EditorBrowsableState.Never)]
870         public static readonly int CurrentFrameNumber = NDalic.ImageVisualOrientationCorrection + 6;
871
872         /// <summary>
873         /// @brief The total frame number the AnimatedVectorImageVisual will use.
874         /// @details Name "totalFrameNumber", Type Property::INTEGER.
875         /// @note This property is read-only.
876         /// </summary>
877         /// <remarks>
878         /// Inhouse API
879         /// </remarks>
880         [EditorBrowsable(EditorBrowsableState.Never)]
881         public static readonly int TotalFrameNumber = NDalic.ImageVisualOrientationCorrection + 7;
882
883         /// <summary>
884         /// @brief  The stop behavior the AnimatedVectorImageVisual will use.
885         /// @details Name "stopBehavior", Type StopBehavior::Type (Property::INTEGER)
886         /// @note Default value is StopBehavior::CURRENT_FRAME.
887         /// </summary>
888         /// <remarks>
889         /// Inhouse API
890         /// </remarks>
891         [EditorBrowsable(EditorBrowsableState.Never)]
892         public static readonly int StopBehavior = NDalic.ImageVisualOrientationCorrection + 8;
893
894         /// <summary>
895         /// @brief  The looping mode the AnimatedVectorImageVisual will use.
896         /// @details Name "loopingMode", Type LoopingMode::Type (Property::INTEGER)
897         /// @note Default value is LoopingMode::RESTART.
898         /// </summary>
899         /// <remarks>
900         /// Inhouse API
901         /// </remarks>
902         [EditorBrowsable(EditorBrowsableState.Never)]
903         public static readonly int LoopingMode = NDalic.ImageVisualOrientationCorrection + 9;
904
905         /// <summary>
906         /// @brief The content information the AnimatedVectorImageVisual will use.
907         /// @details Name "contentInfo", Type Property::MAP.
908         /// The map contains the layer name as a key and Property::Array as a value.
909         /// And the array contains 2 integer values which are the frame numbers, the start frame number and the end frame number of the layer.
910         /// @note This property is read-only.
911         /// </summary>
912         /// <remarks>
913         /// Inhouse API
914         /// </remarks>
915         [EditorBrowsable(EditorBrowsableState.Never)]
916         public static readonly int ContentInfo = NDalic.ImageVisualOrientationCorrection + 10;
917
918         /// <summary>
919         /// @brief Whether to redraw the image when the visual is scaled down.
920         /// @details Name "redrawInScalingDown", type Property::BOOLEAN.
921         /// @note It is used in the AnimatedVectorImageVisual.The default is true.
922         /// </summary>
923         /// <remarks>
924         /// Inhouse API
925         /// </remarks>
926         [EditorBrowsable(EditorBrowsableState.Never)]
927         public static readonly int RedrawInScalingDown = NDalic.ImageVisualOrientationCorrection + 11;
928     }
929
930     /// <summary>
931     /// This specifies properties of the MeshVisual.
932     /// </summary>
933     /// <since_tizen> 3 </since_tizen>
934     public struct MeshVisualProperty
935     {
936         /// <summary>
937         /// The location of the ".obj" file.
938         /// </summary>
939         /// <since_tizen> 3 </since_tizen>
940         public static readonly int ObjectURL = NDalic.MeshVisualObjectUrl;
941         /// <summary>
942         /// The location of the ".mtl" file.
943         /// </summary>
944         /// <since_tizen> 3 </since_tizen>
945         public static readonly int MaterialtURL = NDalic.MeshVisualMaterialUrl;
946         /// <summary>
947         /// Path to the directory the textures (including gloss and normal) are stored in.
948         /// </summary>
949         /// <since_tizen> 3 </since_tizen>
950         public static readonly int TexturesPath = NDalic.MeshVisualTexturesPath;
951         /// <summary>
952         /// Sets the type of shading mode that the mesh will use.
953         /// </summary>
954         /// <since_tizen> 3 </since_tizen>
955         public static readonly int ShadingMode = NDalic.MeshVisualShadingMode;
956         /// <summary>
957         /// Whether to use mipmaps for textures or not.
958         /// </summary>
959         /// <since_tizen> 3 </since_tizen>
960         public static readonly int UseMipmapping = NDalic.MeshVisualUseMipmapping;
961         /// <summary>
962         /// Whether to average normals at each point to smooth textures or not.
963         /// </summary>
964         /// <since_tizen> 3 </since_tizen>
965         public static readonly int UseSoftNormals = NDalic.MeshVisualUseSoftNormals;
966         /// <summary>
967         /// The position, in stage space, of the point light that applies lighting to the model.
968         /// </summary>
969         /// <since_tizen> 3 </since_tizen>
970         public static readonly int LightPosition = NDalic.MeshVisualLightPosition;
971     }
972
973     /// <summary>
974     /// This specifies properties of the PrimitiveVisual.
975     /// </summary>
976     /// <since_tizen> 3 </since_tizen>
977     public struct PrimitiveVisualProperty
978     {
979         /// <summary>
980         /// The specific shape to render.
981         /// </summary>
982         /// <since_tizen> 3 </since_tizen>
983         public static readonly int Shape = NDalic.PrimitiveVisualShape;
984         /// <summary>
985         /// The color of the shape.
986         /// </summary>
987         /// <since_tizen> 3 </since_tizen>
988         public static readonly int MixColor = NDalic.PrimitiveVisualMixColor;
989         /// <summary>
990         /// The number of slices as you go around the shape.
991         /// </summary>
992         /// <since_tizen> 3 </since_tizen>
993         public static readonly int Slices = NDalic.PrimitiveVisualSlices;
994         /// <summary>
995         /// The number of stacks as you go down the shape.
996         /// </summary>
997         /// <since_tizen> 3 </since_tizen>
998         public static readonly int Stacks = NDalic.PrimitiveVisualStacks;
999         /// <summary>
1000         /// The scale of the radius of the top circle of a conical frustrum.
1001         /// </summary>
1002         /// <since_tizen> 3 </since_tizen>
1003         public static readonly int ScaleTopRadius = NDalic.PrimitiveVisualScaleTopRadius;
1004         /// <summary>
1005         /// The scale of the radius of the bottom circle of a conical frustrum.
1006         /// </summary>
1007         /// <since_tizen> 3 </since_tizen>
1008         public static readonly int ScaleBottomRadius = NDalic.PrimitiveVisualScaleBottomRadius;
1009         /// <summary>
1010         /// The scale of the height of a conic.
1011         /// </summary>
1012         /// <since_tizen> 3 </since_tizen>
1013         public static readonly int ScaleHeight = NDalic.PrimitiveVisualScaleHeight;
1014         /// <summary>
1015         /// The scale of the radius of a cylinder.
1016         /// </summary>
1017         /// <since_tizen> 3 </since_tizen>
1018         public static readonly int ScaleRadius = NDalic.PrimitiveVisualScaleRadius;
1019         /// <summary>
1020         /// The dimensions of a cuboid. Scales in the same fashion as a 9-patch image.
1021         /// </summary>
1022         /// <since_tizen> 3 </since_tizen>
1023         public static readonly int ScaleDimensions = NDalic.PrimitiveVisualScaleDimensions;
1024         /// <summary>
1025         /// Determines how bevelled the cuboid should be, based off the smallest dimension.
1026         /// </summary>
1027         /// <since_tizen> 3 </since_tizen>
1028         public static readonly int BevelPercentage = NDalic.PrimitiveVisualBevelPercentage;
1029         /// <summary>
1030         /// Defines how smooth the bevelled edges should be.
1031         /// </summary>
1032         /// <since_tizen> 3 </since_tizen>
1033         public static readonly int BevelSmoothness = NDalic.PrimitiveVisualBevelSmoothness;
1034         /// <summary>
1035         /// The position, in stage space, of the point light that applies lighting to the model.
1036         /// </summary>
1037         /// <since_tizen> 3 </since_tizen>
1038         public static readonly int LightPosition = NDalic.PrimitiveVisualLightPosition;
1039     }
1040
1041     /// <summary>
1042     /// This specifies properties of the TextVisual.
1043     /// </summary>
1044     /// <since_tizen> 3 </since_tizen>
1045     public struct TextVisualProperty
1046     {
1047         /// <summary>
1048         /// The text to display in UTF-8 format.
1049         /// </summary>
1050         /// <since_tizen> 3 </since_tizen>
1051         public static readonly int Text = NDalic.TextVisualText;
1052         /// <summary>
1053         /// The requested font family to use.
1054         /// </summary>
1055         /// <since_tizen> 3 </since_tizen>
1056         public static readonly int FontFamily = NDalic.TextVisualFontFamily;
1057         /// <summary>
1058         /// The requested font style to use.
1059         /// </summary>
1060         /// <since_tizen> 3 </since_tizen>
1061         public static readonly int FontStyle = NDalic.TextVisualFontStyle;
1062         /// <summary>
1063         /// The size of font in points.
1064         /// </summary>
1065         /// <since_tizen> 3 </since_tizen>
1066         public static readonly int PointSize = NDalic.TextVisualPointSize;
1067         /// <summary>
1068         /// The single-line or multi-line layout option.
1069         /// </summary>
1070         /// <since_tizen> 3 </since_tizen>
1071         public static readonly int MultiLine = NDalic.TextVisualMultiLine;
1072         /// <summary>
1073         /// The line horizontal alignment.
1074         /// </summary>
1075         /// <since_tizen> 3 </since_tizen>
1076         public static readonly int HorizontalAlignment = NDalic.TextVisualHorizontalAlignment;
1077         /// <summary>
1078         /// The line vertical alignment.
1079         /// </summary>
1080         /// <since_tizen> 3 </since_tizen>
1081         public static readonly int VerticalAlignment = NDalic.TextVisualVerticalAlignment;
1082         /// <summary>
1083         /// The color of the text.
1084         /// </summary>
1085         /// <since_tizen> 3 </since_tizen>
1086         public static readonly int TextColor = NDalic.TextVisualTextColor;
1087         /// <summary>
1088         /// Whether the mark-up processing is enabled.
1089         /// </summary>
1090         /// <since_tizen> 3 </since_tizen>
1091         public static readonly int EnableMarkup = NDalic.TextVisualEnableMarkup;
1092         /// <summary>
1093         /// The shadow parameters.
1094         /// </summary>
1095         /// <since_tizen> 5 </since_tizen>
1096         public static readonly int Shadow = NDalic.TextVisualEnableMarkup + 1;
1097         /// <summary>
1098         /// The default underline parameters.
1099         /// </summary>
1100         /// <since_tizen> 5 </since_tizen>
1101         public static readonly int Underline = NDalic.TextVisualEnableMarkup + 2;
1102         /// <summary>
1103         /// The default outline parameters.
1104         /// </summary>
1105         /// <since_tizen> 5 </since_tizen>
1106         public static readonly int Outline = NDalic.TextVisualEnableMarkup + 3;
1107         /// <summary>
1108         /// The default text background parameters.
1109         /// </summary>
1110         /// <since_tizen> 5 </since_tizen>
1111         public static readonly int Background = NDalic.TextVisualEnableMarkup + 4;
1112     }
1113
1114     /// <summary>
1115     /// This specifies properties of the NpatchImageVisual.
1116     /// </summary>
1117     /// <since_tizen> 3 </since_tizen>
1118     public struct NpatchImageVisualProperty
1119     {
1120         /// <summary>
1121         /// The URL of the image.
1122         /// </summary>
1123         /// <since_tizen> 3 </since_tizen>
1124         public static readonly int URL = NDalic.ImageVisualUrl;
1125         /// <summary>
1126         /// Fitting options, used when resizing images to fit desired dimensions.
1127         /// </summary>
1128         /// <since_tizen> 3 </since_tizen>
1129         public static readonly int FittingMode = NDalic.ImageVisualFittingMode;
1130         /// <summary>
1131         /// Filtering options, used when resizing images to sample original pixels.
1132         /// </summary>
1133         /// <since_tizen> 3 </since_tizen>
1134         public static readonly int SamplingMode = NDalic.ImageVisualSamplingMode;
1135         /// <summary>
1136         /// The desired image width.
1137         /// </summary>
1138         /// <since_tizen> 3 </since_tizen>
1139         public static readonly int DesiredWidth = NDalic.ImageVisualDesiredWidth;
1140         /// <summary>
1141         /// The desired image height.
1142         /// </summary>
1143         /// <since_tizen> 3 </since_tizen>
1144         public static readonly int DesiredHeight = NDalic.ImageVisualDesiredHeight;
1145         /// <summary>
1146         /// Whether to load the image synchronously.
1147         /// </summary>
1148         /// <since_tizen> 3 </since_tizen>
1149         public static readonly int SynchronousLoading = NDalic.ImageVisualSynchronousLoading;
1150         /// <summary>
1151         /// If true, only draws the borders.
1152         /// </summary>
1153         /// <since_tizen> 3 </since_tizen>
1154         public static readonly int BorderOnly = NDalic.ImageVisualBorderOnly;
1155         /// <summary>
1156         /// The image area to be displayed.
1157         /// </summary>
1158         /// <since_tizen> 3 </since_tizen>
1159         public static readonly int PixelArea = NDalic.ImageVisualPixelArea;
1160         /// <summary>
1161         /// The wrap mode for u coordinate.
1162         /// </summary>
1163         /// <since_tizen> 3 </since_tizen>
1164         public static readonly int WrapModeU = NDalic.ImageVisualWrapModeU;
1165         /// <summary>
1166         /// The wrap mode for v coordinate.
1167         /// </summary>
1168         /// <since_tizen> 3 </since_tizen>
1169         public static readonly int WrapModeV = NDalic.ImageVisualWrapModeV;
1170         /// <summary>
1171         /// The border of the image.
1172         /// </summary>
1173         /// <since_tizen> 3 </since_tizen>
1174         public static readonly int Border = NDalic.ImageVisualWrapModeV + 1;
1175     }
1176
1177     /// <summary>
1178     /// This specifies properties of the ArcVisual.
1179     /// </summary>
1180     internal struct ArcVisualProperty
1181     {
1182         /// <summary>
1183         /// The thickness of the arc.
1184         /// </summary>
1185         /// <remarks>The value is float type.</remarks>
1186         /// <remarks>This is mandatory property.</remarks>
1187         internal static readonly int Thickness = NDalic.ImageVisualUrl;
1188
1189         /// <summary>
1190         /// The start angle where the arc begins in degrees.
1191         /// </summary>
1192         /// <remarks>The value is float type.</remarks>
1193         /// <remarks>The property of optional. The default value is 0.</remarks>
1194         internal static readonly int StartAngle = Thickness + 1;
1195
1196         /// <summary>
1197         /// The sweep angle of the arc in degrees.
1198         /// </summary>
1199         /// <remarks>The value is float type.</remarks>
1200         /// <remarks>The property of optional. The default value is 360.</remarks>
1201         internal static readonly int SweepAngle = Thickness + 2;
1202
1203         /// <summary>
1204         /// The cap style of the arc.
1205         /// </summary>
1206         /// <remarks>
1207         /// The value is integer type.
1208         /// The value 0 means butt, the arc does not extend beyond its two endpoints.
1209         /// The value 1 means round, the arc will be extended by a half circle with the center at the end.
1210         /// </remarks>
1211         /// <remarks>The property of optional. The default value is 0 (butt).</remarks>
1212         internal static readonly int Cap = Thickness + 3;
1213     }
1214
1215     /// <summary>
1216     /// Enumeration for Circular alignment.
1217     /// The @p horizontalAlignment and @p verticalAlignment can be used to align the text within the text area.
1218     /// </summary>
1219     [EditorBrowsable(EditorBrowsableState.Never)]
1220     public enum CircularAlignment
1221     {
1222         /// <summary>
1223         /// Texts place at the begin of Circular direction.
1224         /// </summary>
1225         [Description("BEGIN")]
1226         Begin,
1227         /// <summary>
1228         /// Texts place at the center of Circular direction.
1229         /// </summary>
1230         [Description("CENTER")]
1231         Center,
1232         /// <summary>
1233         /// Texts place at the end of Circular direction.
1234         /// </summary>
1235         [Description("END")]
1236         End
1237     }
1238
1239     /// <summary>
1240     /// Enumeration for Text Layout.
1241     /// </summary>
1242     [EditorBrowsable(EditorBrowsableState.Never)]
1243     public enum TextLayout
1244     {
1245         /// <summary>
1246         /// SingleLine.
1247         /// </summary>
1248         [Description("singleLine")]
1249         SingleLine,
1250         /// <summary>
1251         /// MultiLine.
1252         /// </summary>
1253         [Description("multiLine")]
1254         MultiLine,
1255         /// <summary>
1256         /// Circular.
1257         /// </summary>
1258         [Description("circular")]
1259         Circular
1260     }
1261
1262     /// <summary>
1263     /// Defines how a color is blended.
1264     /// </summary>
1265     /// This will be public opened after ACR done. Before ACR, need to be hidden as inhouse API.
1266     [EditorBrowsable(EditorBrowsableState.Never)]
1267     public enum ColorBlendingMode
1268     {
1269         /// <summary>
1270         ///  No blend.
1271         /// </summary>
1272         None,
1273         /// <summary>
1274         ///  The color is multiplied by another one.
1275         /// </summary>
1276         Multiply
1277     };
1278 }