Release 4.0.0-preview1-00301
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / internal / DaliEnumConstants.cs
index a709af0..6a89353 100755 (executable)
@@ -1,4 +1,5 @@
-/** Copyright (c) 2016 Samsung Electronics Co., Ltd.
+/*
+ * Copyright (c) 2016 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,8 +28,16 @@ namespace Tizen.NUI
     /// </summary>
     public enum TextureType
     {
-      Texture2D     = Tizen.NUI.TextureType.TEXTURE_2D,   ///< One 2D image
-      TextureCube   = Tizen.NUI.TextureType.TEXTURE_CUBE  ///< Six 2D images arranged in a cube-shape
+            /// <summary>
+            /// One 2D image
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
+            Texture2D = Tizen.NUI.TextureType.TEXTURE_2D,
+            /// <summary>
+            /// Six 2D images arranged in a cube-shape
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
+            TextureCube = Tizen.NUI.TextureType.TEXTURE_CUBE
     }
 
     /// <summary>
@@ -36,49 +45,150 @@ namespace Tizen.NUI
     /// </summary>
     public enum ViewMode
     {
-      Mono              = Tizen.NUI.ViewMode.MONO,                          ///< Monoscopic (single camera). This is the default.
-      StereoHorizontal  = Tizen.NUI.ViewMode.STEREO_HORIZONTAL, ///< Stereoscopic. Frame buffer is split horizontally with the left and right camera views in their respective sides.
-      StereoVertical    = Tizen.NUI.ViewMode.STEREO_VERTICAL,     ///< Stereoscopic. Frame buffer is split vertically with the left camera view at the top and the right camera view at the bottom.
-      StereoInterlaced  = Tizen.NUI.ViewMode.STEREO_INTERLACED  ///< Stereoscopic. Left/Right camera views are rendered into the framebuffer on alternate frames.
+            /// <summary>
+            /// Monoscopic (single camera). This is the default.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
+            Mono = Tizen.NUI.ViewMode.MONO,
+            /// <summary>
+            /// Stereoscopic. Frame buffer is split horizontally with the left and right camera views in their respective sides.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
+            StereoHorizontal = Tizen.NUI.ViewMode.STEREO_HORIZONTAL,
+            /// <summary>
+            /// Stereoscopic. Frame buffer is split vertically with the left camera view at the top and the right camera view at the bottom.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
+            StereoVertical = Tizen.NUI.ViewMode.STEREO_VERTICAL,
+            /// <summary>
+            /// Stereoscopic. Left/Right camera views are rendered into the framebuffer on alternate frames.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
+            StereoInterlaced = Tizen.NUI.ViewMode.STEREO_INTERLACED
     }
 
+        /// <summary>
+        /// Enumeration for the direction
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public struct Direction
         {
+            /// <summary>
+            /// Enumeration for the Direction types.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public enum Type
             {
+                /// <summary>
+                /// from Left to Right
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 LeftToRight = Tizen.NUI.DirectionType.LEFT_TO_RIGHT,
+                /// <summary>
+                /// from Right to Left
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 RightToLeft = Tizen.NUI.DirectionType.RIGHT_TO_LEFT
             }
         }
 
 
 
-
+        /// <summary>
+        /// ToolTip
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public struct Tooltip
         {
+            /// <summary>
+            /// The properties used for a Tooltip.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public struct Property
             {
+                /// <summary>
+                /// The content to display.
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int Content = NDalic.TOOLTIP_CONTENT;
+                /// <summary>
+                /// The layout of the content.
+                /// </summary>\
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int Layout = NDalic.TOOLTIP_LAYOUT;
+                /// <summary>
+                /// Time to wait in seconds before a tooltip is shown while the is movement is within the allowed threshold.
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int WaitTime = NDalic.TOOLTIP_WAIT_TIME;
+                /// <summary>
+                /// The background of the tooltip.
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int Background = NDalic.TOOLTIP_BACKGROUND;
+                /// <summary>
+                /// The tail used by the tooltip.
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int Tail = NDalic.TOOLTIP_TAIL;
+                /// <summary>
+                /// The position of the tooltip in relation to the control.
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int Position = NDalic.TOOLTIP_POSITION;
+                /// <summary>
+                /// If Tooltip::Position::HOVER_POINT is used for the POSITION, then this is the offset the tooltip is displayed at from the hover point.
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int HoverPointOffset = NDalic.TOOLTIP_HOVER_POINT_OFFSET;
+                /// <summary>
+                /// The movement threshold allowed before showing (or hiding a popup).
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int MovementThreshold = NDalic.TOOLTIP_MOVEMENT_THRESHOLD;
+                /// <summary>
+                /// If true, the tooltip will disappear after hover movement beyond a certain distance.
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int DisappearOnMovement = NDalic.TOOLTIP_DISAPPEAR_ON_MOVEMENT;
             }
 
+            /// <summary>
+            /// Background Property
+            /// </summary>
             public struct BackgroundProperty
             {
+                /// <summary>
+                /// The image to use as the background.
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int Visual = NDalic.TOOLTIP_BACKGROUND_VISUAL;
+                /// <summary>
+                /// The size of the borders in the order: left, right, bottom, top.
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int Border = NDalic.TOOLTIP_BACKGROUND_BORDER;
             }
 
+            /// <summary>
+            /// The properties of the tail used by the tooltip.
+            /// </summary>
             public struct TailProperty
             {
+                /// <summary>
+                /// Whether to show the tail or not.
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int Visibility = NDalic.TOOLTIP_TAIL_VISIBILITY;
+                /// <summary>
+                /// The image used for the tail if it is above the tooltip.
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int AboveVisual = NDalic.TOOLTIP_TAIL_ABOVE_VISUAL;
+                /// <summary>
+                /// The image used for the tail if it is below the tooltip.
+                /// </summary>
+                /// <since_tizen> 3 </since_tizen>
                 public static readonly int BelowVisual = NDalic.TOOLTIP_TAIL_BELOW_VISUAL;
             }
         }