X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=src%2FTizen.NUI%2Fsrc%2Fpublic%2FBaseComponents%2FView.cs;h=73218bc32e67c70c6a684a5af7bc6d1e005c591e;hb=ed2578ca861a723ac519a5150f5cb626fae0500b;hp=36f88a77b7ab080b3008bfaa66bc56c7bfb3ee48;hpb=d60e8d9dd1ca6ab324adbd6be9fb8932f5c93a2f;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git diff --git a/src/Tizen.NUI/src/public/BaseComponents/View.cs b/src/Tizen.NUI/src/public/BaseComponents/View.cs index 36f88a7..73218bc 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/View.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/View.cs @@ -14,16 +14,16 @@ * limitations under the License. * */ +using System; +using System.ComponentModel; +using System.Runtime.InteropServices; namespace Tizen.NUI.BaseComponents { - - using System; - using System.Runtime.InteropServices; - /// /// View is the base class for all views. /// + /// 3 public class View : Container { private global::System.Runtime.InteropServices.HandleRef swigCPtr; @@ -91,6 +91,7 @@ namespace Tizen.NUI.BaseComponents /// Retrieves the number of children held by the view. /// /// + /// 4 public override uint GetChildCount() { return Convert.ToUInt32(Children.Count); @@ -100,6 +101,7 @@ namespace Tizen.NUI.BaseComponents /// Gets the views parent. /// /// + /// 4 public override Container GetParent() { IntPtr cPtr = NDalicPINVOKE.Actor_GetParent(swigCPtr); @@ -341,6 +343,7 @@ namespace Tizen.NUI.BaseComponents /// /// Event arguments that passed via the KeyEvent signal. /// + /// 3 public class KeyEventArgs : EventArgs { private Key _key; @@ -371,7 +374,7 @@ namespace Tizen.NUI.BaseComponents /// An event for the KeyPressed signal which can be used to subscribe or unsubscribe the event handler provided by the user.
/// The KeyPressed signal is emitted when the key event is received.
/// - /// 4 + /// 3 public event EventHandlerWithReturnType KeyEvent { add @@ -465,6 +468,7 @@ namespace Tizen.NUI.BaseComponents /// /// Event arguments that passed via the touch signal. /// + /// 3 public class TouchEventArgs : EventArgs { private Touch _touch; @@ -495,7 +499,7 @@ namespace Tizen.NUI.BaseComponents /// An event for the touched signal which can be used to subscribe or unsubscribe the event handler provided by the user.
/// The touched signal is emitted when the touch input is received.
/// - /// 4 + /// 3 public event EventHandlerWithReturnType TouchEvent { add @@ -539,6 +543,7 @@ namespace Tizen.NUI.BaseComponents /// /// Event arguments that passed via the hover signal. /// + /// 3 public class HoverEventArgs : EventArgs { private Hover _hover; @@ -569,7 +574,7 @@ namespace Tizen.NUI.BaseComponents /// An event for the hovered signal which can be used to subscribe or unsubscribe the event handler provided by the user.
/// The hovered signal is emitted when the hover input is received.
/// - /// 4 + /// 3 public event EventHandlerWithReturnType HoverEvent { add @@ -613,6 +618,7 @@ namespace Tizen.NUI.BaseComponents /// /// Event arguments that passed via the wheel signal. /// + /// 3 public class WheelEventArgs : EventArgs { private Wheel _wheel; @@ -643,7 +649,7 @@ namespace Tizen.NUI.BaseComponents /// An event for the WheelMoved signal which can be used to subscribe or unsubscribe the event handler provided by the user.
/// The WheelMoved signal is emitted when the wheel event is received.
/// - /// 4 + /// 3 public event EventHandlerWithReturnType WheelEvent { add @@ -774,6 +780,7 @@ namespace Tizen.NUI.BaseComponents /// /// Event arguments of visibility changed. /// + /// 3 public class VisibilityChangedEventArgs : EventArgs { private View _view; @@ -884,6 +891,7 @@ namespace Tizen.NUI.BaseComponents /// /// Event arguments of layout direction changed. /// + /// 4 public class LayoutDirectionChangedEventArgs : EventArgs { private View _view; @@ -989,7 +997,7 @@ namespace Tizen.NUI.BaseComponents /// An event for the ResourcesLoadedSignal signal which can be used to subscribe or unsubscribe the event handler provided by the user.
/// This signal is emitted after all resources required by a view are loaded and ready.
/// - /// 4 + /// 3 public event EventHandler ResourcesLoaded { add @@ -1154,7 +1162,9 @@ namespace Tizen.NUI.BaseComponents /// /// A handle to an object. /// A handle to a view or an uninitialized handle. - [Obsolete("Please do not use! this will be deprecated, instead please use as keyword.")] + /// 3 + [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")] + [EditorBrowsable(EditorBrowsableState.Never)] public static View DownCast(BaseHandle handle) { View ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as View; @@ -1166,7 +1176,8 @@ namespace Tizen.NUI.BaseComponents /// [Obsolete("Please do not use! this will be deprecated, instead please use as keyword.")] /// /// 3 - [Obsolete("Please do not use! this will be deprecated, instead please use as keyword.")] + [Obsolete("Please do not use! This will be deprecated! Please use as keyword instead!")] + [EditorBrowsable(EditorBrowsableState.Never)] public static T DownCast(View view) where T : View { T ret = Registry.GetManagedBaseHandleFromNativePtr(view) as T; @@ -1380,7 +1391,7 @@ namespace Tizen.NUI.BaseComponents /// Creates an animation to animate the background color visual. If there is no /// background visual, creates one with transparent black as it's mixColor. /// - /// 4 + /// 3 public Animation AnimateBackgroundColor( object destinationValue, int startTime, int endTime, @@ -1402,7 +1413,7 @@ namespace Tizen.NUI.BaseComponents /// /// Creates an animation to animate the mixColor of the named visual. /// - /// 4 + /// 3 public Animation AnimateColor( string targetVisual, object destinationColor, int startTime, int endTime, AlphaFunction.BuiltinFunctions? alphaFunction = null, object initialColor = null ) { Animation animation = null; @@ -2097,7 +2108,8 @@ namespace Tizen.NUI.BaseComponents /// [Obsolete("Please do not use! this will be deprecated. Please use Visibility instead.")] /// /// 3 - [Obsolete("Please do not use! this will be deprecated. Please use Visibility instead.")] + [Obsolete("Please do not use! This will be deprecated! Please use Visibility instead!")] + [EditorBrowsable(EditorBrowsableState.Never)] public bool Visible { get @@ -2165,7 +2177,7 @@ namespace Tizen.NUI.BaseComponents /// If false, then the top-left of the view is used for the position. /// Setting this to false will allow scaling or rotation around the anchor-point without affecting the view's position. /// - /// 4 + /// 3 public bool PositionUsesPivotPoint { get @@ -2181,10 +2193,17 @@ namespace Tizen.NUI.BaseComponents } /// - /// [Obsolete("Please do not use! this will be deprecated")] + /// Please do not use! this will be deprecated. /// + /// Please do not use! this will be deprecated! + /// Instead please use PositionUsesPivotPoint. /// 3 - [Obsolete("Please do not use! this will be deprecated")] + [Obsolete("Please do not use! This will be deprecated! Please use PositionUsesPivotPoint instead! " + + "Like: " + + "View view = new View(); " + + "view.PivotPoint = PivotPoint.Center; " + + "view.PositionUsesPivotPoint = true;")] + [EditorBrowsable(EditorBrowsableState.Never)] public bool PositionUsesAnchorPoint { get @@ -2265,7 +2284,14 @@ namespace Tizen.NUI.BaseComponents /// /// Deriving classes stipulate the natural size and by default a view has a zero natural size. /// - [Obsolete("Please do not use! this will be deprecated, please use NaturalSize2D instead")] + /// /// Please do not use! this will be deprecated! + /// Instead please use NaturalSize2D. + /// 3 + [Obsolete("Please do not use! This will be deprecated! Please use NaturalSize2D instead! " + + "Like: " + + "TextLabel label = new TextLabel(\"Hello World!\"); " + + "Size2D size = label.NaturalSize2D;")] + [EditorBrowsable(EditorBrowsableState.Never)] public Vector3 NaturalSize { get @@ -2417,7 +2443,7 @@ namespace Tizen.NUI.BaseComponents /// /// Most resources are only loaded when the control is placed on the stage. /// - /// 4 + /// 3 public bool IsResourceReady() { bool ret = NDalicPINVOKE.IsResourceReady(swigCPtr); @@ -2525,7 +2551,15 @@ namespace Tizen.NUI.BaseComponents return ret; } - internal Layer GetLayer() + /// + /// Gets the parent layer of this view.If a view has no parent, this method does nothing. + /// + ///
The view has been initialized. 
+ /// the parent layer of view + /// 5 + /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API. + [EditorBrowsable(EditorBrowsableState.Never)] + public Layer GetLayer() { IntPtr cPtr = NDalicPINVOKE.Actor_GetLayer(swigCPtr); Layer ret = Registry.GetManagedBaseHandleFromNativePtr(cPtr) as Layer; @@ -3142,7 +3176,7 @@ namespace Tizen.NUI.BaseComponents return ret; } - /// 4 + /// 3 public uint AddRenderer(Renderer renderer) { uint ret = NDalicPINVOKE.Actor_AddRenderer(swigCPtr, Renderer.getCPtr(renderer)); @@ -3159,7 +3193,7 @@ namespace Tizen.NUI.BaseComponents return ret; } - /// 4 + /// 3 public Renderer GetRendererAt(uint index) { IntPtr cPtr = NDalicPINVOKE.Actor_GetRendererAt(swigCPtr, index); @@ -3170,7 +3204,7 @@ namespace Tizen.NUI.BaseComponents return ret; } - /// 4 + /// 3 public void RemoveRenderer(Renderer renderer) { NDalicPINVOKE.Actor_RemoveRenderer__SWIG_0(swigCPtr, Renderer.getCPtr(renderer)); @@ -3178,7 +3212,7 @@ namespace Tizen.NUI.BaseComponents throw NDalicPINVOKE.SWIGPendingException.Retrieve(); } - /// 4 + /// 3 public void RemoveRenderer(uint index) { NDalicPINVOKE.Actor_RemoveRenderer__SWIG_1(swigCPtr, index); @@ -4153,7 +4187,7 @@ namespace Tizen.NUI.BaseComponents /// /// Gets the number of renderers held by the view. /// - /// 4 + /// 3 public uint RendererCount { get @@ -4168,7 +4202,10 @@ namespace Tizen.NUI.BaseComponents /// [Obsolete("Please do not use! this will be deprecated")] /// /// 3 - [Obsolete("Please do not use! this will be deprecated")] + /// Please do not use! this will be deprecated! + /// Instead please use TouchEvent. + [Obsolete("Please do not use! This will be deprecated! Please use TouchEvent instead!")] + [EditorBrowsable(EditorBrowsableState.Never)] public event EventHandlerWithReturnType Touched { add @@ -4198,7 +4235,10 @@ namespace Tizen.NUI.BaseComponents /// [Obsolete("Please do not use! this will be deprecated")] /// /// 3 - [Obsolete("Please do not use! this will be deprecated")] + /// Please do not use! this will be deprecated! + /// Instead please use HoverEvent. + [Obsolete("Please do not use! This will be deprecated! Please use HoverEvent instead!")] + [EditorBrowsable(EditorBrowsableState.Never)] public event EventHandlerWithReturnType Hovered { add @@ -4225,10 +4265,13 @@ namespace Tizen.NUI.BaseComponents } /// - /// [Obsolete("Please do not use! this will be deprecated")] + /// Please do not use! this will be deprecated. /// /// 3 - [Obsolete("Please do not use! this will be deprecated")] + /// Please do not use! this will be deprecated! + /// Instead please use WheelEvent. + [Obsolete("Please do not use! This will be deprecated! Please use WheelEvent instead!")] + [EditorBrowsable(EditorBrowsableState.Never)] public event EventHandlerWithReturnType WheelMoved { add @@ -4258,7 +4301,14 @@ namespace Tizen.NUI.BaseComponents /// [Obsolete("Please do not use! this will be deprecated")] /// /// 3 - [Obsolete("Please do not use! this will be deprecated")] + /// Please do not use! this will be deprecated! + /// Instead please use PivotPoint. + [Obsolete("Please do not use! This will be deprecated! Please use PivotPoint instead! " + + "Like: " + + "View view = new View(); " + + "view.PivotPoint = PivotPoint.Center; " + + "view.PositionUsesPivotPoint = true;")] + [EditorBrowsable(EditorBrowsableState.Never)] public Position AnchorPoint { get @@ -4277,7 +4327,11 @@ namespace Tizen.NUI.BaseComponents /// [Obsolete("Please do not use! this will be deprecated")] /// /// 3 - [Obsolete("Please do not use! this will be deprecated, please use Size2D instead")] + [Obsolete("Please do not use! This will be deprecated! Please use Size2D instead! " + + "Like: " + + "View view = new View(); " + + "view.Size2D = new Size2D(100, 100);")] + [EditorBrowsable(EditorBrowsableState.Never)] public Size Size { get @@ -4296,7 +4350,10 @@ namespace Tizen.NUI.BaseComponents /// [Obsolete("Please do not use! this will be deprecated")] /// /// 3 - [Obsolete("Please do not use! this will be deprecated")] + /// Please do not use! this will be deprecated! + /// Instead please use AddedToWindow. + [Obsolete("Please do not use! This will be deprecated! Please use AddedToWindow instead!")] + [EditorBrowsable(EditorBrowsableState.Never)] public event EventHandler OnWindowEvent { add @@ -4325,7 +4382,10 @@ namespace Tizen.NUI.BaseComponents /// [Obsolete("Please do not use! this will be deprecated")] /// /// 3 - [Obsolete("Please do not use! this will be deprecated")] + /// Please do not use! this will be deprecated! + /// Instead please use RemovedFromWindow. + [Obsolete("Please do not use! This will be deprecated! Please use RemovedFromWindow instead!")] + [EditorBrowsable(EditorBrowsableState.Never)] public event EventHandler OffWindowEvent { add @@ -4354,7 +4414,10 @@ namespace Tizen.NUI.BaseComponents /// [Obsolete("Please do not use! this will be deprecated")] /// /// 3 - [Obsolete("Please do not use! this will be deprecated")] + /// Please do not use! this will be deprecated! + /// Instead please use Relayout. + [Obsolete("Please do not use! This will be deprecated! Please use Relayout instead!")] + [EditorBrowsable(EditorBrowsableState.Never)] public event EventHandler OnRelayoutEvent { add @@ -4384,8 +4447,11 @@ namespace Tizen.NUI.BaseComponents /// "Please DO NOT use! This will be deprecated! Please use 'Container GetParent() for derived class' instead!" /// /// 3 - //"Please DO NOT use! This will be deprecated! Please use 'Container GetParent() for derived class' instead!" - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [Obsolete("Please do not use! This will be deprecated! Please use 'Container GetParent() for derived class' instead! " + + "Like: " + + "Container parent = view.GetParent(); " + + "View view = parent as View;")] + [EditorBrowsable(EditorBrowsableState.Never)] public new View Parent { get @@ -4452,6 +4518,7 @@ namespace Tizen.NUI.BaseComponents /// /// Gets or sets the Margin for use in layout. /// + /// 4 public Extents Margin { get @@ -4469,6 +4536,7 @@ namespace Tizen.NUI.BaseComponents /// /// Gets or sets the Padding for use in layout. /// + /// 4 public Extents PaddingEX { get @@ -4493,10 +4561,12 @@ namespace Tizen.NUI.BaseComponents /// /// Left to right. /// + /// 4 LTR, /// /// Right to left. /// + /// 4 RTL } }