2 * Copyright(c) 2022 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 using System.Collections.Generic;
19 using System.ComponentModel;
20 using System.Runtime.InteropServices;
21 using Tizen.NUI.Binding;
23 namespace Tizen.NUI.BaseComponents
26 /// View is the base class for all views.
28 /// <since_tizen> 3 </since_tizen>
29 public partial class View : Container, IResourcesProvider
31 private static HashSet<BindableProperty> positionPropertyGroup = new HashSet<BindableProperty>();
32 private static HashSet<BindableProperty> sizePropertyGroup = new HashSet<BindableProperty>();
33 private static HashSet<BindableProperty> scalePropertyGroup = new HashSet<BindableProperty>();
34 private static bool defaultGrabTouchAfterLeave = false;
35 private static bool defaultAllowOnlyOwnTouch = false;
37 internal BackgroundExtraData backgroundExtraData;
39 private bool layoutSet = false;
40 private LayoutItem layout; // Exclusive layout assigned to this View.
42 // List of transitions paired with the condition that uses the transition.
43 private Dictionary<TransitionCondition, TransitionList> layoutTransitions;
44 private int widthPolicy = LayoutParamPolicies.WrapContent; // Layout width policy
45 private int heightPolicy = LayoutParamPolicies.WrapContent; // Layout height policy
46 private float weight = 0.0f; // Weighting of child View in a Layout
47 private bool backgroundImageSynchronousLoading = false;
48 private bool excludeLayouting = false;
49 private LayoutTransition layoutTransition;
50 private TransitionOptions transitionOptions = null;
51 private ThemeData themeData;
52 private bool isThemeChanged = false;
54 // List of constraints
55 private Constraint widthConstraint = null;
56 private Constraint heightConstraint = null;
58 private Size2D internalMaximumSize = null;
59 private Size2D internalMinimumSize = null;
60 private Extents internalMargin = null;
61 private Extents internalPadding = null;
62 private Vector3 internalSizeModeFactor = null;
63 private Vector2 internalCellIndex = null;
64 private Color internalBackgroundColor = null;
65 private Color internalColor = null;
66 private Position internalPivotPoint = null;
67 private Position internalPosition = null;
68 private Position2D internalPosition2D = null;
69 private Vector3 internalScale = null;
70 private Size internalSize = null;
71 private Size2D internalSize2D = null;
72 private int layoutCount = 0;
73 private ControlState propagatableControlStates = ControlState.All;
75 // List of dispatch Event
76 private PanGestureDetector panGestureDetector = null;
77 private LongPressGestureDetector longGestureDetector = null;
78 private PinchGestureDetector pinchGestureDetector = null;
79 private TapGestureDetector tapGestureDetector = null;
80 private RotationGestureDetector rotationGestureDetector = null;
81 private int configGestureCount = 0;
82 private bool dispatchTouchEvents = true;
83 private bool dispatchGestureEvents = true;
84 private bool dispatchParentGestureEvents = true;
85 private string internalName = string.Empty;
86 private Position internalCurrentParentOrigin = null;
87 private Position internalCurrentAnchorPoint = null;
88 private Vector3 internalTargetSize = null;
89 private Size2D internalCurrentSize = null;
90 private Position internalCurrentPosition = null;
91 private Vector3 internalCurrentWorldPosition = null;
92 private Vector3 internalCurrentScale = null;
93 private Vector3 internalCurrentWorldScale = null;
94 private Vector4 internalCurrentColor = null;
95 private Vector4 internalCurrentWorldColor = null;
96 private Vector2 internalCurrentScreenPosition = null;
100 RegisterPropertyGroup(PositionProperty, positionPropertyGroup);
101 RegisterPropertyGroup(Position2DProperty, positionPropertyGroup);
102 RegisterPropertyGroup(PositionXProperty, positionPropertyGroup);
103 RegisterPropertyGroup(PositionYProperty, positionPropertyGroup);
105 RegisterPropertyGroup(SizeProperty, sizePropertyGroup);
106 RegisterPropertyGroup(Size2DProperty, sizePropertyGroup);
107 RegisterPropertyGroup(SizeWidthProperty, sizePropertyGroup);
108 RegisterPropertyGroup(SizeHeightProperty, sizePropertyGroup);
110 RegisterPropertyGroup(ScaleProperty, scalePropertyGroup);
111 RegisterPropertyGroup(ScaleXProperty, scalePropertyGroup);
112 RegisterPropertyGroup(ScaleYProperty, scalePropertyGroup);
113 RegisterPropertyGroup(ScaleZProperty, scalePropertyGroup);
115 RegisterAccessibilityDelegate();
119 /// Accessibility mode for controlling View's Accessible implementation.
120 /// It is only relevant when deriving custom controls from View directly,
121 /// as classes derived from CustomView (or any of its subclasses) get the
122 /// Custom mode by default.
124 [EditorBrowsable(EditorBrowsableState.Never)]
125 public enum ViewAccessibilityMode
128 /// Default accessibility implementation. Overriding View.Accessibility...()
129 /// virtual methods will have no effect.
131 [EditorBrowsable(EditorBrowsableState.Never)]
134 /// Custom accessibility implementation. Overriding View.Accessibility...()
135 /// will be necessary to provide accessibility support for the View.
137 [EditorBrowsable(EditorBrowsableState.Never)]
141 private static IntPtr NewWithAccessibilityMode(ViewAccessibilityMode accessibilityMode)
143 switch (accessibilityMode)
145 case ViewAccessibilityMode.Custom:
147 return Interop.View.NewCustom();
149 case ViewAccessibilityMode.Default:
152 return Interop.View.New();
158 /// Creates a new instance of a view.
160 /// <since_tizen> 3 </since_tizen>
161 public View() : this(ViewAccessibilityMode.Default)
165 [EditorBrowsable(EditorBrowsableState.Never)]
166 public View(ViewAccessibilityMode accessibilityMode) : this(NewWithAccessibilityMode(accessibilityMode), true)
168 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
171 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
172 [EditorBrowsable(EditorBrowsableState.Never)]
173 public View(ViewStyle viewStyle) : this(Interop.View.New(), true, viewStyle)
178 /// Create a new instance of a View with setting the status of shown or hidden.
180 /// <param name="shown">false : Not displayed (hidden), true : displayed (shown)</param>
181 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
182 [EditorBrowsable(EditorBrowsableState.Never)]
183 public View(bool shown) : this(Interop.View.New(), true)
185 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
189 internal View(View uiControl, bool shown = true) : this(Interop.View.NewView(View.getCPtr(uiControl)), true)
191 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
197 backgroundExtraData = uiControl.backgroundExtraData == null ? null : new BackgroundExtraData(uiControl.backgroundExtraData);
200 internal View(global::System.IntPtr cPtr, bool cMemoryOwn, ViewStyle viewStyle, bool shown = true) : this(cPtr, cMemoryOwn, shown)
202 InitializeStyle(viewStyle);
205 internal View(global::System.IntPtr cPtr, bool cMemoryOwn, bool shown = true) : base(cPtr, cMemoryOwn)
209 PositionUsesPivotPoint = false;
210 GrabTouchAfterLeave = defaultGrabTouchAfterLeave;
211 AllowOnlyOwnTouch = defaultAllowOnlyOwnTouch;
213 // TODO : Can we call this function only for required subclass?
214 RegisterHitTestCallback();
223 internal View(ViewImpl implementation, bool shown = true) : this(Interop.View.NewViewInternal(ViewImpl.getCPtr(implementation)), true)
225 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
234 /// The event that is triggered when the View's ControlState is changed.
236 [EditorBrowsable(EditorBrowsableState.Never)]
237 public event EventHandler<ControlStateChangedEventArgs> ControlStateChangedEvent;
239 internal event EventHandler<ControlStateChangedEventArgs> ControlStateChangeEventInternal;
243 /// Flag to indicate if layout set explicitly via API call or View was automatically given a Layout.
245 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
246 [EditorBrowsable(EditorBrowsableState.Never)]
247 public bool LayoutSet
256 /// Flag to allow Layouting to be disabled for Views.
257 /// Once a View has a Layout set then any children added to Views from then on will receive
258 /// automatic Layouts.
260 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
261 [EditorBrowsable(EditorBrowsableState.Never)]
262 public static bool LayoutingDisabled { get; set; } = true;
265 /// If set to true, the <see cref="GrabTouchAfterLeave"/> property value is set to true when all Views are created.
267 /// <param name="enable">Sets value of GrabTouchAfterLeave property</param>
268 [EditorBrowsable(EditorBrowsableState.Never)]
269 public static void SetDefaultGrabTouchAfterLeave(bool enable)
271 defaultGrabTouchAfterLeave = enable;
275 /// If set to true, the <see cref="AllowOnlyOwnTouch"/> property value is set to true when all Views are created.
277 /// <param name="enable">Sets value of AllowOnlyOwnTouch property</param>
278 [EditorBrowsable(EditorBrowsableState.Never)]
279 public static void SetDefaultAllowOnlyOwnTouch(bool enable)
281 defaultAllowOnlyOwnTouch = enable;
285 /// Deprecate. Do not use this.
286 /// The style instance applied to this view.
287 /// Note that do not modify the ViewStyle.
288 /// Modifying ViewStyle will affect other views with same ViewStyle.
290 [EditorBrowsable(EditorBrowsableState.Never)]
291 protected ViewStyle ViewStyle
295 if (themeData == null) themeData = new ThemeData();
297 if (themeData.viewStyle == null)
299 ApplyStyle(CreateViewStyle());
301 return themeData.viewStyle;
306 /// Get/Set the control state.
307 /// Note that the ControlState only available for the classes derived from Control.
308 /// If the classes that are not derived from Control (such as View, ImageView and TextLabel) want to use this system,
309 /// please set <see cref="EnableControlState"/> to true.
311 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
312 [EditorBrowsable(EditorBrowsableState.Never)]
313 public ControlState ControlState
317 return themeData == null ? ControlState.Normal : themeData.controlStates;
321 if (ControlState == value)
326 var prevState = ControlState;
328 if (themeData == null) themeData = new ThemeData();
329 themeData.controlStates = value;
331 var changeInfo = new ControlStateChangedEventArgs(prevState, value);
333 ControlStateChangeEventInternal?.Invoke(this, changeInfo);
335 if (themeData.ControlStatePropagation)
337 foreach (View child in Children)
339 ControlState allowed = child.PropagatableControlStates;
340 if (allowed.Contains(ControlState.All))
342 child.ControlState = value;
346 ControlState newControlState = child.ControlState;
348 if (allowed.Contains(ControlState.Normal))
350 if (value.Contains(ControlState.Normal))
352 newControlState += ControlState.Normal;
356 newControlState -= ControlState.Normal;
360 if (allowed.Contains(ControlState.Disabled))
362 if (value.Contains(ControlState.Disabled))
364 newControlState += ControlState.Disabled;
368 newControlState -= ControlState.Disabled;
372 if (allowed.Contains(ControlState.Selected))
374 if (value.Contains(ControlState.Selected))
376 newControlState += ControlState.Selected;
380 newControlState -= ControlState.Selected;
384 if (allowed.Contains(ControlState.Pressed))
386 if (value.Contains(ControlState.Pressed))
388 newControlState += ControlState.Pressed;
392 newControlState -= ControlState.Pressed;
396 if (allowed.Contains(ControlState.Focused))
398 if (value.Contains(ControlState.Focused))
400 newControlState += ControlState.Focused;
404 newControlState -= ControlState.Focused;
408 if (allowed.Contains(ControlState.Other))
410 if (value.Contains(ControlState.Other))
412 newControlState += ControlState.Other;
416 newControlState -= ControlState.Other;
420 if (child.ControlState != newControlState)
421 child.ControlState = newControlState;
426 OnControlStateChanged(changeInfo);
428 ControlStateChangedEvent?.Invoke(this, changeInfo);
433 /// Gets / Sets the status of whether the view is excluded from its parent's layouting or not.
435 /// This will be public opened later after ACR done. Before ACR, need to be hidden as inhouse API.
436 [EditorBrowsable(EditorBrowsableState.Never)]
437 public bool ExcludeLayouting
441 return (bool)GetValue(ExcludeLayoutingProperty);
445 SetValue(ExcludeLayoutingProperty, value);
446 NotifyPropertyChanged();
450 private bool InternalExcludeLayouting
454 return excludeLayouting;
458 excludeLayouting = value;
459 if (Layout != null && Layout.SetPositionByLayout == value)
461 Layout.SetPositionByLayout = !value;
462 Layout.RequestLayout();
468 /// The StyleName, type string.
469 /// The value indicates DALi style name defined in json theme file.
471 /// <since_tizen> 3 </since_tizen>
472 public string StyleName
476 return (string)GetValue(StyleNameProperty);
480 SetValue(StyleNameProperty, value);
481 NotifyPropertyChanged();
486 /// The KeyInputFocus, type bool.
488 [EditorBrowsable(EditorBrowsableState.Never)]
489 public bool KeyInputFocus
493 return (bool)GetValue(KeyInputFocusProperty);
497 SetValue(KeyInputFocusProperty, value);
498 NotifyPropertyChanged();
503 /// The mutually exclusive with "backgroundImage" and "background" type Vector4.
507 /// The property cascade chaining set is not recommended.
510 /// Animatable - This property can be animated using <c>Animation</c> class.
512 /// animation.AnimateTo(view, "BackgroundColor", new Color(r, g, b, a));
517 /// This way is recommended for setting the property
519 /// var view = new View();
520 /// view.BackgroundColor = new Color(0.5f, 0.1f, 0, 1);
522 /// This way to set the property is prohibited
524 /// view.BackgroundColor.R = 0.5f; //This does not guarantee a proper operation
527 /// <since_tizen> 3 </since_tizen>
528 public Color BackgroundColor
532 return (Color)GetValue(BackgroundColorProperty);
536 SetValue(BackgroundColorProperty, value);
537 NotifyPropertyChanged();
542 /// The mutually exclusive with "backgroundColor" and "background" type Map.
544 /// <since_tizen> 3 </since_tizen>
545 public string BackgroundImage
549 return (string)GetValue(BackgroundImageProperty);
553 SetValue(BackgroundImageProperty, value);
554 NotifyPropertyChanged();
559 /// Get or set the border of background image.
561 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
562 [EditorBrowsable(EditorBrowsableState.Never)]
563 public Rectangle BackgroundImageBorder
567 return (Rectangle)GetValue(BackgroundImageBorderProperty);
571 SetValue(BackgroundImageBorderProperty, value);
572 NotifyPropertyChanged();
577 /// The background of view.
579 /// <since_tizen> 3 </since_tizen>
580 public Tizen.NUI.PropertyMap Background
584 return (PropertyMap)GetValue(BackgroundProperty);
588 SetValue(BackgroundProperty, value);
589 NotifyPropertyChanged();
594 /// Describes a shadow as an image for a View.
595 /// It is null by default.
598 /// Getter returns copied instance of current shadow.
601 /// The mutually exclusive with "BoxShadow".
605 /// Animatable - This property can be animated using <c>Animation</c> class.
606 /// To animate this property, specify a sub-property with separator ".", for example, "ImageShadow.Offset".
608 /// animation.AnimateTo(view, "ImageShadow.Offset", new Vector2(10, 10));
610 /// Animatable sub-property : Offset.
613 [EditorBrowsable(EditorBrowsableState.Never)]
614 public ImageShadow ImageShadow
618 return (ImageShadow)GetValue(ImageShadowProperty);
622 SetValue(ImageShadowProperty, value);
623 NotifyPropertyChanged();
628 /// Describes a box shaped shadow drawing for a View.
629 /// It is null by default.
632 /// The mutually exclusive with "ImageShadow".
636 /// Animatable - This property can be animated using <c>Animation</c> class.
637 /// To animate this property, specify a sub-property with separator ".", for example, "BoxShadow.BlurRadius".
639 /// animation.AnimateTo(view, "BoxShadow.BlurRadius", 10.0f);
641 /// Animatable sub-property : Offset, Color, BlurRadius.
644 /// <since_tizen> 9 </since_tizen>
645 public Shadow BoxShadow
649 return (Shadow)GetValue(BoxShadowProperty);
653 SetValue(BoxShadowProperty, value);
654 NotifyPropertyChanged();
659 /// The radius for the rounded corners of the View.
660 /// This will rounds background and shadow edges.
661 /// The values in Vector4 are used in clockwise order from top-left to bottom-left : Vector4(top-left-corner, top-right-corner, bottom-right-corner, bottom-left-corner).
662 /// Each radius will clamp internally to the half of smaller of the view's width or height.
663 /// Note that, an image background (or shadow) may not have rounded corners if it uses a Border property.
667 /// Animatable - This property can be animated using <c>Animation</c> class.
669 /// animation.AnimateTo(view, "CornerRadius", new Vector4(10, 10, 10, 10));
673 /// <since_tizen> 9 </since_tizen>
674 public Vector4 CornerRadius
678 return (Vector4)GetValue(CornerRadiusProperty);
682 SetValue(CornerRadiusProperty, value);
683 NotifyPropertyChanged();
688 /// Whether the CornerRadius property value is relative (percentage [0.0f to 0.5f] of the view size) or absolute (in world units).
689 /// It is absolute by default.
690 /// When the policy is relative, the corner radius is relative to the smaller of the view's width and height.
692 /// <since_tizen> 9 </since_tizen>
693 public VisualTransformPolicyType CornerRadiusPolicy
695 get => (VisualTransformPolicyType)GetValue(CornerRadiusPolicyProperty);
696 set => SetValue(CornerRadiusPolicyProperty, value);
700 /// The width for the borderline of the View.
704 /// Animatable - This property can be animated using <c>Animation</c> class.
706 /// animation.AnimateTo(view, "BorderlineWidth", 100.0f);
709 /// Note that, an image background may not have borderline if it uses the Border property.
711 /// <since_tizen> 9 </since_tizen>
712 public float BorderlineWidth
716 return (float)GetValue(BorderlineWidthProperty);
720 SetValue(BorderlineWidthProperty, value);
721 NotifyPropertyChanged();
726 /// The color for the borderline of the View.
727 /// It is Color.Black by default.
731 /// Animatable - This property can be animated using <c>Animation</c> class.
733 /// animation.AnimateTo(view, "BorderlineColor", new Color(r, g, b, a));
737 /// <since_tizen> 9 </since_tizen>
738 public Color BorderlineColor
742 return (Color)GetValue(BorderlineColorProperty);
746 SetValue(BorderlineColorProperty, value);
747 NotifyPropertyChanged();
752 /// The color selector for the borderline of the View.
753 /// Like BackgroundColor, color selector typed BorderlineColor should be used in ViewStyle only.
754 /// So this API is internally used only.
756 internal Selector<Color> BorderlineColorSelector
760 return (Selector<Color>)GetValue(BorderlineColorSelectorProperty);
764 SetValue(BorderlineColorSelectorProperty, value);
765 NotifyPropertyChanged();
770 /// The Relative offset for the borderline of the View.
771 /// Recommended range : [-1.0f to 1.0f].
772 /// If -1.0f, draw borderline inside of the View.
773 /// If 1.0f, draw borderline outside of the View.
774 /// If 0.0f, draw borderline half inside and half outside.
775 /// It is 0.0f by default.
779 /// Animatable - This property can be animated using <c>Animation</c> class.
781 /// animation.AnimateTo(view, "BorderlineOffset", -1.0f);
785 /// <since_tizen> 9 </since_tizen>
786 public float BorderlineOffset
790 return (float)GetValue(BorderlineOffsetProperty);
794 SetValue(BorderlineOffsetProperty, value);
795 NotifyPropertyChanged();
800 /// The current state of the view.
802 /// <since_tizen> 3 </since_tizen>
807 return (States)GetValue(StateProperty);
811 SetValue(StateProperty, value);
812 NotifyPropertyChanged();
817 /// The current sub state of the view.
819 /// <since_tizen> 3 </since_tizen>
820 public States SubState
824 return (States)GetValue(SubStateProperty);
828 SetValue(SubStateProperty, value);
829 NotifyPropertyChanged();
834 /// Displays a tooltip
836 /// <since_tizen> 3 </since_tizen>
837 public Tizen.NUI.PropertyMap Tooltip
841 return (PropertyMap)GetValue(TooltipProperty);
845 SetValue(TooltipProperty, value);
846 NotifyPropertyChanged();
851 /// Displays a tooltip as a text.
853 /// <since_tizen> 3 </since_tizen>
854 public string TooltipText
858 return GetValue(TooltipTextProperty) as string;
862 SetValue(TooltipTextProperty, value);
866 private string InternalTooltipText
870 using (var propertyValue = GetProperty(Property.TOOLTIP))
872 if (propertyValue != null && propertyValue.Get(out string retrivedValue))
874 return retrivedValue;
876 NUILog.Error($"[ERROR] Fail to get TooltipText! Return error MSG (error to get TooltipText)!");
877 return "error to get TooltipText";
882 var temp = new Tizen.NUI.PropertyValue(value);
883 SetProperty(View.Property.TOOLTIP, temp);
885 NotifyPropertyChanged();
890 /// The Child property of FlexContainer.<br />
891 /// The proportion of the free space in the container, the flex item will receive.<br />
892 /// If all items in the container set this property, their sizes will be proportional to the specified flex factor.<br />
894 /// <since_tizen> 3 </since_tizen>
895 [Obsolete("Deprecated in API8, will be removed in API10.")]
900 return (float)GetValue(FlexProperty);
904 SetValue(FlexProperty, value);
905 NotifyPropertyChanged();
910 /// The Child property of FlexContainer.<br />
911 /// The alignment of the flex item along the cross axis, which, if set, overrides the default alignment for all items in the container.<br />
913 /// <since_tizen> 3 </since_tizen>
914 [Obsolete("Deprecated in API8, will be removed in API10.")]
919 return (int)GetValue(AlignSelfProperty);
923 SetValue(AlignSelfProperty, value);
924 NotifyPropertyChanged();
929 /// The Child property of FlexContainer.<br />
930 /// The space around the flex item.<br />
933 /// The property cascade chaining set is possible. For example, this (view.FlexMargin.X = 0.1f;) is possible.
935 /// <since_tizen> 3 </since_tizen>
936 [Obsolete("Deprecated in API8, will be removed in API10.")]
937 public Vector4 FlexMargin
941 Vector4 temp = (Vector4)GetValue(FlexMarginProperty);
942 return new Vector4(OnFlexMarginChanged, temp.X, temp.Y, temp.Z, temp.W);
946 SetValue(FlexMarginProperty, value);
947 NotifyPropertyChanged();
952 /// The top-left cell this child occupies, if not set, the first available cell is used.
955 /// The property cascade chaining set is not recommended.
956 /// Also, this property is for <see cref="TableView"/> class. Please use the property for the child position of <see cref="TableView"/>.
959 /// This way is recommended for setting the property
961 /// var view = new View();
962 /// view.CellIndex = new Vector2(1, 3);
964 /// This way to set the property is prohibited
966 /// view.CellIndex.X = 1; //This does not guarantee a proper operation
969 /// <since_tizen> 3 </since_tizen>
970 public Vector2 CellIndex
974 return (Vector2)GetValue(CellIndexProperty);
978 SetValue(CellIndexProperty, value);
979 NotifyPropertyChanged();
984 /// The number of rows this child occupies, if not set, the default value is 1.
987 /// This property is for <see cref="TableView"/> class. Use the property for the child position of <see cref="TableView"/>.
989 /// <since_tizen> 3 </since_tizen>
994 return (float)GetValue(RowSpanProperty);
998 SetValue(RowSpanProperty, value);
999 NotifyPropertyChanged();
1004 /// The number of columns this child occupies, if not set, the default value is 1.
1007 /// This property is for <see cref="TableView"/> class. Use the property for the child position of <see cref="TableView"/>.
1009 /// <since_tizen> 3 </since_tizen>
1010 public float ColumnSpan
1014 return (float)GetValue(ColumnSpanProperty);
1018 SetValue(ColumnSpanProperty, value);
1019 NotifyPropertyChanged();
1024 /// The horizontal alignment of this child inside the cells, if not set, the default value is 'left'.
1027 /// This property is for <see cref="TableView"/> class. Use the property for the child position of <see cref="TableView"/>.
1029 /// <since_tizen> 3 </since_tizen>
1030 public Tizen.NUI.HorizontalAlignmentType CellHorizontalAlignment
1034 return (HorizontalAlignmentType)GetValue(CellHorizontalAlignmentProperty);
1038 SetValue(CellHorizontalAlignmentProperty, value);
1039 NotifyPropertyChanged();
1044 /// The vertical alignment of this child inside the cells, if not set, the default value is 'top'.
1047 /// This property is for <see cref="TableView"/> class. Use the property for the child position of <see cref="TableView"/>.
1049 /// <since_tizen> 3 </since_tizen>
1050 public Tizen.NUI.VerticalAlignmentType CellVerticalAlignment
1054 return (VerticalAlignmentType)GetValue(CellVerticalAlignmentProperty);
1058 SetValue(CellVerticalAlignmentProperty, value);
1059 NotifyPropertyChanged();
1064 /// The left focusable view.<br />
1065 /// This will return null if not set.<br />
1066 /// This will also return null if the specified left focusable view is not on a window.<br />
1068 /// <since_tizen> 3 </since_tizen>
1069 public View LeftFocusableView
1071 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
1074 return (View)GetValue(LeftFocusableViewProperty);
1078 SetValue(LeftFocusableViewProperty, value);
1079 NotifyPropertyChanged();
1084 /// The right focusable view.<br />
1085 /// This will return null if not set.<br />
1086 /// This will also return null if the specified right focusable view is not on a window.<br />
1088 /// <since_tizen> 3 </since_tizen>
1089 public View RightFocusableView
1091 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
1094 return (View)GetValue(RightFocusableViewProperty);
1098 SetValue(RightFocusableViewProperty, value);
1099 NotifyPropertyChanged();
1104 /// The up focusable view.<br />
1105 /// This will return null if not set.<br />
1106 /// This will also return null if the specified up focusable view is not on a window.<br />
1108 /// <since_tizen> 3 </since_tizen>
1109 public View UpFocusableView
1111 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
1114 return (View)GetValue(UpFocusableViewProperty);
1118 SetValue(UpFocusableViewProperty, value);
1119 NotifyPropertyChanged();
1124 /// The down focusable view.<br />
1125 /// This will return null if not set.<br />
1126 /// This will also return null if the specified down focusable view is not on a window.<br />
1128 /// <since_tizen> 3 </since_tizen>
1129 public View DownFocusableView
1131 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
1134 return (View)GetValue(DownFocusableViewProperty);
1138 SetValue(DownFocusableViewProperty, value);
1139 NotifyPropertyChanged();
1144 /// The clockwise focusable view by rotary wheel.<br />
1145 /// This will return null if not set.<br />
1146 /// This will also return null if the specified clockwise focusable view is not on a window.<br />
1148 [EditorBrowsable(EditorBrowsableState.Never)]
1149 public View ClockwiseFocusableView
1151 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
1154 return (View)GetValue(ClockwiseFocusableViewProperty);
1158 SetValue(ClockwiseFocusableViewProperty, value);
1159 NotifyPropertyChanged();
1164 /// The counter clockwise focusable view by rotary wheel.<br />
1165 /// This will return null if not set.<br />
1166 /// This will also return null if the specified counter clockwise focusable view is not on a window.<br />
1168 [EditorBrowsable(EditorBrowsableState.Never)]
1169 public View CounterClockwiseFocusableView
1171 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
1174 return (View)GetValue(CounterClockwiseFocusableViewProperty);
1178 SetValue(CounterClockwiseFocusableViewProperty, value);
1179 NotifyPropertyChanged();
1184 /// Whether the view should be focusable by keyboard navigation.
1186 /// <since_tizen> 3 </since_tizen>
1187 public bool Focusable
1191 SetValue(FocusableProperty, value);
1192 NotifyPropertyChanged();
1196 return (bool)GetValue(FocusableProperty);
1201 /// Whether the children of this view can be focusable by keyboard navigation. If user sets this to false, the children of this actor view will not be focused.
1202 /// Note : Default value is true.
1204 [EditorBrowsable(EditorBrowsableState.Never)]
1205 public bool FocusableChildren
1209 SetValue(FocusableChildrenProperty, value);
1210 NotifyPropertyChanged();
1214 return (bool)GetValue(FocusableChildrenProperty);
1219 /// Whether this view can focus by touch.
1220 /// If Focusable is false, FocusableInTouch is disabled.
1221 /// If you want to have focus on touch, you need to set both Focusable and FocusableInTouch settings to true.
1223 [EditorBrowsable(EditorBrowsableState.Never)]
1224 public bool FocusableInTouch
1228 SetValue(FocusableInTouchProperty, value);
1229 NotifyPropertyChanged();
1233 return (bool)GetValue(FocusableInTouchProperty);
1238 /// Retrieves the position of the view.
1239 /// The coordinates are relative to the view's parent.
1242 /// The <see cref="Size"/>, <see cref="Position"/>, <see cref="Color"/>, and <see cref="Scale"/> properties are set in the main thread.
1243 /// Therefore, it is not updated in real time when the value is changed in the render thread (for example, the value is changed during animation).
1244 /// However, <see cref="CurrentSize"/>, <see cref="CurrentPosition"/>, <see cref="CurrentColor"/>, and <see cref="CurrentScale"/> properties are updated in real time,
1245 /// and users can get the current actual values through them.
1247 /// <since_tizen> 3 </since_tizen>
1248 public Position CurrentPosition
1252 return GetCurrentPosition();
1257 /// Sets the size of a view for the width and the height.<br />
1258 /// Geometry can be scaled to fit within this area.<br />
1259 /// This does not interfere with the view's scale factor.<br />
1260 /// The views default depth is the minimum of width and height.<br />
1263 /// The property cascade chaining set is not recommended.
1266 /// This way is recommended for setting the property
1268 /// var view = new View();
1269 /// view.Size2D = new Size2D(100, 200);
1271 /// This way to set the property is prohibited
1273 /// view.Size2D.Width = 100; //This does not guarantee a proper operation
1276 /// <since_tizen> 3 </since_tizen>
1277 public Size2D Size2D
1281 var temp = (Size2D)GetValue(Size2DProperty);
1283 if (this.Layout == null)
1285 if (temp.Width < 0) { temp.Width = 0; }
1286 if (temp.Height < 0) { temp.Height = 0; }
1293 SetValue(Size2DProperty, value);
1295 NotifyPropertyChanged();
1300 /// Retrieves the size of the view.
1301 /// The coordinates are relative to the view's parent.
1304 /// The <see cref="Size"/>, <see cref="Position"/>, <see cref="Color"/>, and <see cref="Scale"/> properties are set in the main thread.
1305 /// Therefore, it is not updated in real time when the value is changed in the render thread (for example, the value is changed during animation).
1306 /// However, <see cref="CurrentSize"/>, <see cref="CurrentPosition"/>, <see cref="CurrentColor"/>, and <see cref="CurrentScale"/> properties are updated in real time,
1307 /// and users can get the current actual values through them.
1309 /// <since_tizen> 3 </since_tizen>
1310 public Size2D CurrentSize
1314 return GetCurrentSize();
1319 /// Retrieves and sets the view's opacity.<br />
1323 /// Animatable - This property can be animated using <c>Animation</c> class.
1325 /// animation.AnimateTo(view, "Opacity", 0.5f);
1329 /// <since_tizen> 3 </since_tizen>
1330 public float Opacity
1334 return (float)GetValue(OpacityProperty);
1338 SetValue(OpacityProperty, value);
1339 NotifyPropertyChanged();
1344 /// Sets the position of the view for X and Y.<br />
1345 /// By default, sets the position vector between the parent origin and the pivot point (default).<br />
1346 /// If the position inheritance is disabled, sets the world position.<br />
1349 /// The property cascade chaining set is not recommended.
1352 /// This way is recommended for setting the property
1354 /// var view = new View();
1355 /// view.Position2D = new Position2D(100, 200);
1357 /// This way to set the property is prohibited
1359 /// view.Position2D.X = 100; //This does not guarantee a proper operation
1362 /// <since_tizen> 3 </since_tizen>
1363 public Position2D Position2D
1367 return (Position2D)GetValue(Position2DProperty);
1371 SetValue(Position2DProperty, value);
1372 NotifyPropertyChanged();
1377 /// Retrieves the screen position of the view.<br />
1379 /// <since_tizen> 3 </since_tizen>
1380 public Vector2 ScreenPosition
1384 return GetCurrentScreenPosition();
1389 /// Retrieves the screen position and size of the view.<br />
1392 /// The float type Rectangle class is not ready yet.
1393 /// Therefore, it transmits data in Vector4 class.
1394 /// This type should later be changed to the appropriate data type.
1396 [EditorBrowsable(EditorBrowsableState.Never)]
1397 public Vector4 ScreenPositionSize
1401 return GetCurrentScreenPositionSize();
1406 /// Determines whether the pivot point should be used to determine the position of the view.
1407 /// This is false by default.
1409 /// <remarks>If false, then the top-left of the view is used for the position.
1410 /// Setting this to false will allow scaling or rotation around the pivot point without affecting the view's position.
1412 /// <since_tizen> 3 </since_tizen>
1413 public bool PositionUsesPivotPoint
1417 return (bool)GetValue(PositionUsesPivotPointProperty);
1421 SetValue(PositionUsesPivotPointProperty, value);
1422 NotifyPropertyChanged();
1427 /// This has been deprecated in API5 and Will be removed in API8. Use PositionUsesPivotPoint instead.
1429 /// <since_tizen> 3 </since_tizen>
1430 [Obsolete("This has been deprecated in API5 and will be removed in API8. Use PositionUsesPivotPoint instead. " +
1432 "View view = new View(); " +
1433 "view.PivotPoint = PivotPoint.Center; " +
1434 "view.PositionUsesPivotPoint = true;" +
1435 " This has been deprecated in API5 and will be removed in API8")]
1436 [EditorBrowsable(EditorBrowsableState.Never)]
1437 public bool PositionUsesAnchorPoint
1441 return (bool)GetValue(PositionUsesAnchorPointProperty);
1445 SetValue(PositionUsesAnchorPointProperty, value);
1449 private bool InternalPositionUsesAnchorPoint
1453 return Object.InternalGetPropertyBool(SwigCPtr, View.Property.PositionUsesAnchorPoint);
1457 Object.InternalSetPropertyBool(SwigCPtr, View.Property.PositionUsesAnchorPoint, value);
1458 NotifyPropertyChanged();
1463 /// Queries whether the view is connected to the stage.<br />
1464 /// When a view is connected, it will be directly or indirectly parented to the root view.<br />
1466 /// <since_tizen> 3 </since_tizen>
1467 public bool IsOnWindow
1476 /// Gets the depth in the hierarchy for the view.
1478 /// <since_tizen> 3 </since_tizen>
1479 public int HierarchyDepth
1483 return GetHierarchyDepth();
1488 /// Sets the sibling order of the view so the depth position can be defined within the same parent.
1491 /// Note the initial value is 0. SiblingOrder should be bigger than 0 or equal to 0.
1492 /// Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove, and LowerBelow will override the sibling order.
1493 /// The values set by this property will likely change.
1495 /// <since_tizen> 3 </since_tizen>
1496 public int SiblingOrder
1500 return (int)GetValue(SiblingOrderProperty);
1504 SetValue(SiblingOrderProperty, value);
1506 Layout?.ChangeLayoutSiblingOrder(value);
1508 NotifyPropertyChanged();
1513 /// Returns the natural size of the view.
1516 /// Deriving classes stipulate the natural size and by default a view has a zero natural size.
1518 /// <since_tizen> 5 </since_tizen>
1519 public Vector3 NaturalSize
1523 Vector3 ret = GetNaturalSize();
1524 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
1530 /// Returns the natural size (Size2D) of the view.
1533 /// Deriving classes stipulate the natural size and by default a view has a zero natural size.
1535 /// <since_tizen> 4 </since_tizen>
1536 public Size2D NaturalSize2D
1540 Vector3 temp = GetNaturalSize();
1541 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
1543 Size2D sz = new Size2D((int)temp.Width, (int)temp.Height);
1550 /// Gets or sets the origin of a view within its parent's area.<br />
1551 /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent, and (1.0, 1.0, 0.5) is the bottom-right corner.<br />
1552 /// The default parent-origin is ParentOrigin.TopLeft (0.0, 0.0, 0.5).<br />
1553 /// A view's position is the distance between this origin and the view's anchor-point.<br />
1555 /// <pre>The view has been initialized.</pre>
1556 /// <since_tizen> 3 </since_tizen>
1557 public Position ParentOrigin
1561 Position tmp = (Position)GetValue(ParentOriginProperty);
1562 return new Position(OnParentOriginChanged, tmp.X, tmp.Y, tmp.Z);
1566 SetValue(ParentOriginProperty, value);
1567 NotifyPropertyChanged();
1572 /// Gets or sets the anchor-point of a view.<br />
1573 /// This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the view, and (1.0, 1.0, 0.5) is the bottom-right corner.<br />
1574 /// The default pivot point is PivotPoint.Center (0.5, 0.5, 0.5).<br />
1575 /// A view position is the distance between its parent-origin and this anchor-point.<br />
1576 /// A view's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.<br />
1577 /// <pre>The view has been initialized.</pre>
1580 /// The property cascade chaining set is not recommended.
1583 /// This way is recommended for setting the property
1585 /// var view = new View();
1586 /// view.PivotPoint = PivotPoint.Center;
1588 /// This way to set the property is prohibited
1590 /// view.PivotPoint.X = 0.5f; //This does not guarantee a proper operation
1593 /// <since_tizen> 3 </since_tizen>
1594 public Position PivotPoint
1598 return (Position)GetValue(PivotPointProperty);
1602 SetValue(PivotPointProperty, value);
1603 NotifyPropertyChanged();
1608 /// Gets or sets the size width of the view.
1612 /// Animatable - This property can be animated using <c>Animation</c> class.
1614 /// animation.AnimateTo(view, "SizeWidth", 500.0f);
1618 /// <since_tizen> 3 </since_tizen>
1619 public float SizeWidth
1623 return (float)GetValue(SizeWidthProperty);
1627 SetValue(SizeWidthProperty, value);
1628 NotifyPropertyChanged();
1633 /// Gets or sets the size height of the view.
1637 /// Animatable - This property can be animated using <c>Animation</c> class.
1640 /// animation.AnimateTo(view, "SizeHeight", 500.0f);
1643 /// <since_tizen> 3 </since_tizen>
1644 public float SizeHeight
1648 return (float)GetValue(SizeHeightProperty);
1652 SetValue(SizeHeightProperty, value);
1653 NotifyPropertyChanged();
1658 /// Gets or sets the position of the view.<br />
1659 /// By default, sets the position vector between the parent origin and pivot point (default).<br />
1660 /// If the position inheritance is disabled, sets the world position.<br />
1664 /// Animatable - This property can be animated using <c>Animation</c> class.
1666 /// animation.AnimateTo(view, "Position", new Position(50, 0));
1669 /// The property cascade chaining set is not recommended.
1672 /// This way is recommended for setting the property
1674 /// var view = new View();
1675 /// view.Position = new Position(100, 200.5f, 0);
1677 /// This way to set the property is prohibited
1679 /// view.Position.Y = 200.5f; //This does not guarantee a proper operation
1682 /// <since_tizen> 3 </since_tizen>
1683 public Position Position
1687 return (Position)GetValue(PositionProperty);
1691 SetValue(PositionProperty, value);
1692 NotifyPropertyChanged();
1697 /// Gets or sets the position X of the view.
1701 /// Animatable - This property can be animated using <c>Animation</c> class.
1703 /// animation.AnimateTo(view, "PositionX", 50.0f);
1707 /// <since_tizen> 3 </since_tizen>
1708 public float PositionX
1712 return (float)GetValue(PositionXProperty);
1716 SetValue(PositionXProperty, value);
1717 NotifyPropertyChanged();
1722 /// Gets or sets the position Y of the view.
1726 /// Animatable - This property can be animated using <c>Animation</c> class.
1728 /// animation.AnimateTo(view, "PositionY", 50.0f);
1732 /// <since_tizen> 3 </since_tizen>
1733 public float PositionY
1737 return (float)GetValue(PositionYProperty);
1741 SetValue(PositionYProperty, value);
1742 NotifyPropertyChanged();
1747 /// Gets or sets the position Z of the view.
1751 /// Animatable - This property can be animated using <c>Animation</c> class.
1753 /// animation.AnimateTo(view, "PositionZ", 50.0f);
1757 /// <since_tizen> 3 </since_tizen>
1758 public float PositionZ
1762 return (float)GetValue(PositionZProperty);
1766 SetValue(PositionZProperty, value);
1767 NotifyPropertyChanged();
1772 /// Gets or sets the world position of the view.
1774 /// <since_tizen> 3 </since_tizen>
1775 public Vector3 WorldPosition
1779 return GetCurrentWorldPosition();
1784 /// Gets or sets the orientation of the view.<br />
1785 /// The view's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.<br />
1789 /// This is an asynchronous method.
1792 /// Animatable - This property can be animated using <c>Animation</c> class.
1794 /// animation.AnimateTo(view, "Orientation", new Rotation(new Radian((float)Math.PI), Vector3.XAxis));
1798 /// <since_tizen> 3 </since_tizen>
1799 public Rotation Orientation
1803 return (Rotation)GetValue(OrientationProperty);
1807 SetValue(OrientationProperty, value);
1808 NotifyPropertyChanged();
1813 /// Gets or sets the world orientation of the view.<br />
1815 /// <since_tizen> 3 </since_tizen>
1816 public Rotation WorldOrientation
1820 Rotation temp = new Rotation();
1821 var pValue = GetProperty(View.Property.WorldOrientation);
1829 /// Gets or sets the scale factor applied to the view.<br />
1833 /// Animatable - This property can be animated using <c>Animation</c> class.
1835 /// animation.AnimateTo(view, "Scale", new Vector3(1.5f, 1.5f, 1.0f));
1838 /// The property cascade chaining set is not recommended.
1841 /// This way is recommended for setting the property
1843 /// var view = new View();
1844 /// view.Scale = new Vector3(1.5f, 2.0f, 1.0f);
1846 /// This way to set the property is prohibited
1848 /// view.Scale.Width = 1.5f; //This does not guarantee a proper operation
1851 /// <since_tizen> 3 </since_tizen>
1852 public Vector3 Scale
1856 return (Vector3)GetValue(ScaleProperty);
1860 SetValue(ScaleProperty, value);
1861 NotifyPropertyChanged();
1866 /// Gets or sets the scale X factor applied to the view.
1870 /// Animatable - This property can be animated using <c>Animation</c> class.
1872 /// animation.AnimateTo(view, "ScaleX", 1.5f);
1876 /// <since_tizen> 3 </since_tizen>
1881 return (float)GetValue(ScaleXProperty);
1885 SetValue(ScaleXProperty, value);
1886 NotifyPropertyChanged();
1891 /// Gets or sets the scale Y factor applied to the view.
1895 /// Animatable - This property can be animated using <c>Animation</c> class.
1897 /// animation.AnimateTo(view, "ScaleY", 1.5f);
1901 /// <since_tizen> 3 </since_tizen>
1906 return (float)GetValue(ScaleYProperty);
1910 SetValue(ScaleYProperty, value);
1911 NotifyPropertyChanged();
1916 /// Gets or sets the scale Z factor applied to the view.
1920 /// Animatable - This property can be animated using <c>Animation</c> class.
1922 /// animation.AnimateTo(view, "ScaleZ", 1.5f);
1926 /// <since_tizen> 3 </since_tizen>
1931 return (float)GetValue(ScaleZProperty);
1935 SetValue(ScaleZProperty, value);
1936 NotifyPropertyChanged();
1941 /// Gets the world scale of the view.
1943 /// <since_tizen> 3 </since_tizen>
1944 public Vector3 WorldScale
1948 return GetCurrentWorldScale();
1953 /// Retrieves the visibility flag of the view.
1957 /// If the view is not visible, then the view and its children will not be rendered.
1958 /// This is regardless of the individual visibility values of the children, i.e., the view will only be rendered if all of its parents have visibility set to true.
1961 /// Animatable - This property can be animated using <c>Animation</c> class.
1963 /// animation.AnimateTo(view, "Visibility", false);
1967 /// <since_tizen> 3 </since_tizen>
1968 public bool Visibility
1972 return Object.InternalGetPropertyBool(SwigCPtr, View.Property.VISIBLE);
1977 /// Gets the view's world color.
1979 /// <since_tizen> 3 </since_tizen>
1980 public Vector4 WorldColor
1984 return GetCurrentWorldColor();
1989 /// Gets or sets the view's name.
1991 /// <since_tizen> 3 </since_tizen>
1996 return (string)GetValue(NameProperty);
2000 SetValue(NameProperty, value);
2001 NotifyPropertyChanged();
2006 /// Get the number of children held by the view.
2008 /// <since_tizen> 3 </since_tizen>
2009 public new uint ChildCount
2013 return Convert.ToUInt32(Children.Count);
2018 /// Gets the view's ID.
2021 /// <since_tizen> 3 </since_tizen>
2031 /// Gets or sets the status of whether the view should emit touch or hover signals.
2032 /// If a View is made insensitive, then the View and its children are not hittable.
2034 /// <since_tizen> 3 </since_tizen>
2035 public bool Sensitive
2039 return (bool)GetValue(SensitiveProperty);
2043 SetValue(SensitiveProperty, value);
2044 NotifyPropertyChanged();
2049 /// Gets or sets the status of whether the view should be enabled user interactions.
2050 /// If a View is made disabled, then user interactions including touch, focus, and actiavation is disabled.
2052 /// <since_tizen> tizen_next </since_tizen>
2053 [EditorBrowsable(EditorBrowsableState.Never)]
2054 public bool IsEnabled
2058 return (bool)GetValue(IsEnabledProperty);
2062 SetValue(IsEnabledProperty, value);
2063 NotifyPropertyChanged();
2068 /// Gets or sets the status of whether the view should receive a notification when touch or hover motion events leave the boundary of the view.
2070 /// <since_tizen> 3 </since_tizen>
2071 public bool LeaveRequired
2075 return (bool)GetValue(LeaveRequiredProperty);
2079 SetValue(LeaveRequiredProperty, value);
2080 NotifyPropertyChanged();
2085 /// Gets or sets the status of whether a child view inherits it's parent's orientation.
2087 /// <since_tizen> 3 </since_tizen>
2088 public bool InheritOrientation
2092 return (bool)GetValue(InheritOrientationProperty);
2096 SetValue(InheritOrientationProperty, value);
2097 NotifyPropertyChanged();
2102 /// Gets or sets the status of whether a child view inherits it's parent's scale.
2104 /// <since_tizen> 3 </since_tizen>
2105 public bool InheritScale
2109 return (bool)GetValue(InheritScaleProperty);
2113 SetValue(InheritScaleProperty, value);
2114 NotifyPropertyChanged();
2119 /// Gets or sets the status of how the view and its children should be drawn.<br />
2120 /// Not all views are renderable, but DrawMode can be inherited from any view.<br />
2121 /// If an object is in a 3D layer, it will be depth-tested against other objects in the world, i.e., it may be obscured if other objects are in front.<br />
2122 /// If DrawMode.Overlay2D is used, the view and its children will be drawn as a 2D overlay.<br />
2123 /// Overlay views are drawn in a separate pass, after all non-overlay views within the layer.<br />
2124 /// For overlay views, the drawing order is with respect to tree levels of views, and depth-testing will not be used.<br />
2126 /// <since_tizen> 3 </since_tizen>
2127 public DrawModeType DrawMode
2131 return (DrawModeType)GetValue(DrawModeProperty);
2135 SetValue(DrawModeProperty, value);
2136 NotifyPropertyChanged();
2141 /// Gets or sets the relative to parent size factor of the view.<br />
2142 /// This factor is only used when ResizePolicyType is set to either: ResizePolicyType.SizeRelativeToParent or ResizePolicyType.SizeFixedOffsetFromParent.<br />
2143 /// This view's size is set to the view's size multiplied by or added to this factor, depending on ResizePolicyType.<br />
2146 /// The property cascade chaining set is not recommended.
2149 /// This way is recommended for setting the property
2151 /// var text = new TextField();
2152 /// text.SizeModeFactor = new Vector3(1.0f, 0.45f, 1.0f);
2154 /// This way to set the property is prohibited
2156 /// text.SizeModeFactor.Width = 1.0f; //This does not guarantee a proper operation
2159 /// <since_tizen> 3 </since_tizen>
2160 public Vector3 SizeModeFactor
2164 return (Vector3)GetValue(SizeModeFactorProperty);
2168 SetValue(SizeModeFactorProperty, value);
2169 NotifyPropertyChanged();
2174 /// Gets or sets the width resize policy to be used.
2176 /// <since_tizen> 3 </since_tizen>
2177 public ResizePolicyType WidthResizePolicy
2181 return (ResizePolicyType)GetValue(WidthResizePolicyProperty);
2185 SetValue(WidthResizePolicyProperty, value);
2186 NotifyPropertyChanged();
2191 /// Gets or sets the height resize policy to be used.
2193 /// <since_tizen> 3 </since_tizen>
2194 public ResizePolicyType HeightResizePolicy
2198 return (ResizePolicyType)GetValue(HeightResizePolicyProperty);
2202 SetValue(HeightResizePolicyProperty, value);
2203 NotifyPropertyChanged();
2208 /// Gets or sets the policy to use when setting size with size negotiation.<br />
2209 /// Defaults to SizeScalePolicyType.UseSizeSet.<br />
2211 /// <since_tizen> 3 </since_tizen>
2212 public SizeScalePolicyType SizeScalePolicy
2216 return (SizeScalePolicyType)GetValue(SizeScalePolicyProperty);
2220 SetValue(SizeScalePolicyProperty, value);
2221 NotifyPropertyChanged();
2226 /// Gets or sets the status of whether the width size is dependent on the height size.
2228 /// <since_tizen> 3 </since_tizen>
2229 public bool WidthForHeight
2233 return (bool)GetValue(WidthForHeightProperty);
2237 SetValue(WidthForHeightProperty, value);
2238 NotifyPropertyChanged();
2243 /// Gets or sets the status of whether the height size is dependent on the width size.
2245 /// <since_tizen> 3 </since_tizen>
2246 public bool HeightForWidth
2250 return (bool)GetValue(HeightForWidthProperty);
2254 SetValue(HeightForWidthProperty, value);
2255 NotifyPropertyChanged();
2260 /// Gets or sets the padding for use in layout.
2263 /// The property cascade chaining set is not recommended.
2266 /// This way is recommended for setting the property
2268 /// var view = new View();
2269 /// view.Padding = new Extents(5, 5, 5, 5);
2271 /// This way to set the property is prohibited
2273 /// view.Padding.Start = 5; //This does not guarantee a proper operation
2276 /// <since_tizen> 5 </since_tizen>
2277 public Extents Padding
2281 return (Extents)GetValue(PaddingProperty);
2285 SetValue(PaddingProperty, value);
2286 NotifyPropertyChanged();
2291 /// Gets or sets the minimum size the view can be assigned in size negotiation.
2293 /// <exception cref="ArgumentNullException"> Thrown when value is null. </exception>
2295 /// The property cascade chaining set is not recommended.
2298 /// This way is recommended for setting the property
2300 /// var view = new View();
2301 /// view.MinimumSize = new Size2D(100, 200);
2303 /// This way to set the property is prohibited
2305 /// view.MinimumSize.Width = 100; //This does not guarantee a proper operation
2308 /// <since_tizen> 3 </since_tizen>
2309 public Size2D MinimumSize
2313 return (Size2D)GetValue(MinimumSizeProperty);
2319 throw new ArgumentNullException(nameof(value));
2323 // Note: it only works if minimum size is >= than natural size.
2324 // To force the size it should be done through the width&height spec or Size2D.
2325 layout.MinimumWidth = new Tizen.NUI.LayoutLength(value.Width);
2326 layout.MinimumHeight = new Tizen.NUI.LayoutLength(value.Height);
2327 layout.RequestLayout();
2329 SetValue(MinimumSizeProperty, value);
2330 NotifyPropertyChanged();
2335 /// Gets or sets the maximum size the view can be assigned in size negotiation.
2338 /// This way is recommended for setting the property
2340 /// var view = new View();
2341 /// view.MaximumSize = new Size2D(100, 200);
2343 /// This way to set the property is prohibited
2345 /// view.MaximumSize.Height = 200; //This does not guarantee a proper operation
2348 /// <since_tizen> 3 </since_tizen>
2349 public Size2D MaximumSize
2353 return (Size2D)GetValue(MaximumSizeProperty);
2357 // We don't have Layout.Maximum(Width|Height) so we cannot apply it to layout.
2358 // MATCH_PARENT spec + parent container size can be used to limit
2361 layout.RequestLayout();
2363 SetValue(MaximumSizeProperty, value);
2364 NotifyPropertyChanged();
2369 /// Gets or sets whether a child view inherits it's parent's position.<br />
2370 /// Default is to inherit.<br />
2371 /// Switching this off means that using position sets the view's world position, i.e., translates from the world origin (0,0,0) to the pivot point of the view.<br />
2373 /// <since_tizen> 3 </since_tizen>
2374 public bool InheritPosition
2378 return (bool)GetValue(InheritPositionProperty);
2382 SetValue(InheritPositionProperty, value);
2383 NotifyPropertyChanged();
2388 /// Gets or sets the clipping behavior (mode) of it's children.
2390 /// <since_tizen> 3 </since_tizen>
2391 public ClippingModeType ClippingMode
2395 return (ClippingModeType)GetValue(ClippingModeProperty);
2399 SetValue(ClippingModeProperty, value);
2400 NotifyPropertyChanged();
2405 /// Gets the number of renderers held by the view.
2407 /// <since_tizen> 3 </since_tizen>
2408 public uint RendererCount
2412 return GetRendererCount();
2417 /// This has been deprecated in API5 and will be removed in API8. Use PivotPoint instead.
2420 /// The property cascade chaining set is possible. For example, this (view.AnchorPoint.X = 0.1f;) is possible.
2422 /// <since_tizen> 3 </since_tizen>
2423 [Obsolete("This has been deprecated in API5 and will be removed in API8. Use PivotPoint instead. " +
2425 "View view = new View(); " +
2426 "view.PivotPoint = PivotPoint.Center; " +
2427 "view.PositionUsesPivotPoint = true;")]
2428 [EditorBrowsable(EditorBrowsableState.Never)]
2429 public Position AnchorPoint
2433 return GetValue(AnchorPointProperty) as Position;
2437 SetValue(AnchorPointProperty, value);
2441 private Position InternalAnchorPoint
2445 return GetCurrentAnchorPoint();
2449 SetAnchorPoint(value);
2450 NotifyPropertyChanged();
2455 /// Sets the size of a view for the width, the height and the depth.<br />
2456 /// Geometry can be scaled to fit within this area.<br />
2457 /// This does not interfere with the view's scale factor.<br />
2458 /// The views default depth is the minimum of width and height.<br />
2462 /// Animatable - This property can be animated using <c>Animation</c> class.
2464 /// animation.AnimateTo(view, "Size", new Size(100, 100));
2467 /// The property cascade chaining set is not recommended.
2470 /// This way is recommended for setting the property
2472 /// var view = new View();
2473 /// view.Size = new Size(100.5f, 200, 0);
2475 /// This way to set the property is prohibited
2477 /// view.Size.Width = 100.5f; //This does not guarantee a proper operation
2480 /// <since_tizen> 5 </since_tizen>
2485 return (Size)GetValue(SizeProperty);
2489 SetValue(SizeProperty, value);
2490 NotifyPropertyChanged();
2495 /// This has been deprecated in API5 and will be removed in API8. Use 'Container GetParent() for derived class' instead.
2497 /// <since_tizen> 3 </since_tizen>
2498 [Obsolete("This has been deprecated in API5 and will be removed in API8. Use 'Container GetParent() for derived class' instead. " +
2500 "Container parent = view.GetParent(); " +
2501 "View view = parent as View;")]
2502 [EditorBrowsable(EditorBrowsableState.Never)]
2503 public new View Parent
2508 IntPtr cPtr = Interop.Actor.GetParent(SwigCPtr);
2509 HandleRef CPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
2510 BaseHandle basehandle = Registry.GetManagedBaseHandleFromNativePtr(CPtr.Handle);
2512 if (basehandle is Layer layer)
2514 ret = new View(Layer.getCPtr(layer).Handle, false);
2515 NUILog.Error("This Parent property is deprecated, should do not be used");
2519 ret = basehandle as View;
2522 Interop.BaseHandle.DeleteBaseHandle(CPtr);
2523 CPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
2525 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
2531 /// Gets/Sets whether inherit parent's the layout Direction.
2533 /// <since_tizen> 4 </since_tizen>
2534 public bool InheritLayoutDirection
2538 return (bool)GetValue(InheritLayoutDirectionProperty);
2542 SetValue(InheritLayoutDirectionProperty, value);
2543 NotifyPropertyChanged();
2548 /// Gets/Sets the layout Direction.
2550 /// <since_tizen> 4 </since_tizen>
2551 public ViewLayoutDirectionType LayoutDirection
2555 return (ViewLayoutDirectionType)GetValue(LayoutDirectionProperty);
2559 SetValue(LayoutDirectionProperty, value);
2560 NotifyPropertyChanged();
2561 layout?.RequestLayout();
2566 /// Gets or sets the Margin for use in layout.
2569 /// Margin property is supported by Layout algorithms and containers.
2570 /// Please Set Layout if you want to use Margin property.
2571 /// The property cascade chaining set is not recommended.
2574 /// This way is recommended for setting the property
2576 /// var view = new View();
2577 /// view.Margin = new Extents(10, 5, 15, 20);
2579 /// This way to set the property is prohibited
2581 /// view.Margin.Top = 15; //This does not guarantee a proper operation
2584 /// <since_tizen> 4 </since_tizen>
2585 public Extents Margin
2589 return (Extents)GetValue(MarginProperty);
2593 SetValue(MarginProperty, value);
2594 NotifyPropertyChanged();
2599 /// The required policy for this dimension, <see cref="LayoutParamPolicies"/> values or exact value.
2603 /// // matchParentView matches its size to its parent size.
2604 /// matchParentView.WidthSpecification = LayoutParamPolicies.MatchParent;
2605 /// matchParentView.HeightSpecification = LayoutParamPolicies.MatchParent;
2607 /// // wrapContentView wraps its children with their desired size.
2608 /// wrapContentView.WidthSpecification = LayoutParamPolicies.WrapContent;
2609 /// wrapContentView.HeightSpecification = LayoutParamPolicies.WrapContent;
2611 /// // exactSizeView shows itself with an exact size.
2612 /// exactSizeView.WidthSpecification = 100;
2613 /// exactSizeView.HeightSpecification = 100;
2616 /// <since_tizen> 6 </since_tizen>
2617 [Binding.TypeConverter(typeof(IntGraphicsTypeConverter))]
2618 public int WidthSpecification
2622 return (int)GetValue(WidthSpecificationProperty);
2626 SetValue(WidthSpecificationProperty, value);
2627 NotifyPropertyChanged();
2631 private int InternalWidthSpecification
2639 if (value == widthPolicy)
2642 widthPolicy = value;
2643 if (widthPolicy >= 0)
2645 SizeWidth = widthPolicy;
2647 layout?.RequestLayout();
2652 /// The required policy for this dimension, <see cref="LayoutParamPolicies"/> values or exact value.
2656 /// // matchParentView matches its size to its parent size.
2657 /// matchParentView.WidthSpecification = LayoutParamPolicies.MatchParent;
2658 /// matchParentView.HeightSpecification = LayoutParamPolicies.MatchParent;
2660 /// // wrapContentView wraps its children with their desired size.
2661 /// wrapContentView.WidthSpecification = LayoutParamPolicies.WrapContent;
2662 /// wrapContentView.HeightSpecification = LayoutParamPolicies.WrapContent;
2664 /// // exactSizeView shows itself with an exact size.
2665 /// exactSizeView.WidthSpecification = 100;
2666 /// exactSizeView.HeightSpecification = 100;
2669 /// <since_tizen> 6 </since_tizen>
2670 [Binding.TypeConverter(typeof(IntGraphicsTypeConverter))]
2671 public int HeightSpecification
2675 return (int)GetValue(HeightSpecificationProperty);
2679 SetValue(HeightSpecificationProperty, value);
2680 NotifyPropertyChanged();
2684 private int InternalHeightSpecification
2688 return heightPolicy;
2692 if (value == heightPolicy)
2695 heightPolicy = value;
2696 if (heightPolicy >= 0)
2698 SizeHeight = heightPolicy;
2700 layout?.RequestLayout();
2705 /// Gets the List of transitions for this View.
2707 /// <since_tizen> 6 </since_tizen>
2708 public Dictionary<TransitionCondition, TransitionList> LayoutTransitions
2712 if (layoutTransitions == null)
2714 layoutTransitions = new Dictionary<TransitionCondition, TransitionList>();
2716 return layoutTransitions;
2721 /// Sets a layout transitions for this View.
2723 /// <exception cref="ArgumentNullException"> Thrown when value is null. </exception>
2725 /// Use LayoutTransitions to receive a collection of LayoutTransitions set on the View.
2727 /// <since_tizen> 6 </since_tizen>
2728 public LayoutTransition LayoutTransition
2732 return GetValue(LayoutTransitionProperty) as LayoutTransition;
2736 SetValue(LayoutTransitionProperty, value);
2737 NotifyPropertyChanged();
2741 private LayoutTransition InternalLayoutTransition
2745 return layoutTransition;
2751 throw new global::System.ArgumentNullException(nameof(value));
2753 if (layoutTransitions == null)
2755 layoutTransitions = new Dictionary<TransitionCondition, TransitionList>();
2758 LayoutTransitionsHelper.AddTransitionForCondition(layoutTransitions, value.Condition, value, true);
2760 AttachTransitionsToChildren(value);
2762 layoutTransition = value;
2767 /// This has been deprecated in API5 and will be removed in API8. Use Padding instead.
2770 /// The property cascade chaining set is possible. For example, this (view.DecorationBoundingBox.X = 0.1f;) is possible.
2772 /// <since_tizen> 4 </since_tizen>
2773 [Obsolete("This has been deprecated in API5 and will be removed in API8. Use Padding instead.")]
2774 [EditorBrowsable(EditorBrowsableState.Never)]
2775 public Extents PaddingEX
2779 return GetValue(PaddingEXProperty) as Extents;
2783 SetValue(PaddingEXProperty, value);
2787 private Extents InternalPaddingEX
2791 Extents temp = new Extents(0, 0, 0, 0);
2792 var pValue = GetProperty(View.Property.PADDING);
2795 Extents ret = new Extents(OnPaddingEXChanged, temp.Start, temp.End, temp.Top, temp.Bottom);
2801 var temp = new Tizen.NUI.PropertyValue(value);
2802 SetProperty(View.Property.PADDING, temp);
2804 NotifyPropertyChanged();
2805 layout?.RequestLayout();
2810 /// The Color of View. This is an RGBA value.
2811 /// Each RGBA components match as <see cref="ColorRed"/>, <see cref="ColorGreen"/>, <see cref="ColorBlue"/>, and <see cref="Opacity"/>.
2812 /// This property will multiply the final color of this view. (BackgroundColor, BorderlineColor, BackgroundImage, etc).
2813 /// For example, if view.BackgroundColor = Color.Yellow and view.Color = Color.Purple, this view will shown as Red.
2814 /// Inherient of color value depend on <see cref="ColorMode"/>.
2818 /// Animatable - This property can be animated using <c>Animation</c> class.
2820 /// The property cascade chaining set is not recommended.
2823 /// This way is recommended for setting the property
2825 /// var view = new View();
2826 /// view.Color = new Color(0.5f, 0.2f, 0.1f, 0.5f);
2828 /// This way to set the property is prohibited
2830 /// view.Color.A = 0.5f; //This does not guarantee a proper operation
2833 [EditorBrowsable(EditorBrowsableState.Never)]
2838 return (Color)GetValue(ColorProperty);
2842 SetValue(ColorProperty, value);
2843 NotifyPropertyChanged();
2848 /// The Red component of View.Color.
2852 /// Animatable - This property can be animated using <c>Animation</c> class.
2855 [EditorBrowsable(EditorBrowsableState.Never)]
2856 public float ColorRed
2860 return (float)GetValue(ColorRedProperty);
2864 SetValue(ColorRedProperty, value);
2865 NotifyPropertyChanged();
2870 /// The Green component of View.Color.
2874 /// Animatable - This property can be animated using <c>Animation</c> class.
2877 [EditorBrowsable(EditorBrowsableState.Never)]
2878 public float ColorGreen
2882 return (float)GetValue(ColorGreenProperty);
2886 SetValue(ColorGreenProperty, value);
2887 NotifyPropertyChanged();
2892 /// The Blue component of View.Color.
2896 /// Animatable - This property can be animated using <c>Animation</c> class.
2899 [EditorBrowsable(EditorBrowsableState.Never)]
2900 public float ColorBlue
2904 return (float)GetValue(ColorBlueProperty);
2908 SetValue(ColorBlueProperty, value);
2909 NotifyPropertyChanged();
2914 /// Set the layout on this View. Replaces any existing Layout.
2917 /// If this Layout is set as null explicitly, it means this View itself and it's child Views will not use Layout anymore.
2919 /// <since_tizen> 6 </since_tizen>
2920 public LayoutItem Layout
2924 return GetValue(LayoutProperty) as LayoutItem;
2928 SetValue(LayoutProperty, value);
2932 private LayoutItem InternalLayout
2940 // Do nothing if layout provided is already set on this View.
2941 if (value == layout)
2946 LayoutingDisabled = false;
2949 // If new layout being set already has a owner then that owner receives a replacement default layout.
2950 // First check if the layout to be set already has a owner.
2951 if (value?.Owner != null)
2953 // Previous owner of the layout gets a default layout as a replacement.
2954 value.Owner.Layout = new AbsoluteLayout()
2956 // Copy Margin and Padding to replacement LayoutGroup.
2957 Margin = value.Margin,
2958 Padding = value.Padding,
2962 // Copy Margin and Padding to new layout being set or restore padding and margin back to
2963 // View if no replacement. Previously margin and padding values would have been moved from
2964 // the View to the layout.
2965 if (layout != null) // Existing layout
2969 // Existing layout being replaced so copy over margin and padding values.
2970 value.Margin = layout.Margin;
2971 value.Padding = layout.Padding;
2972 value.SetPositionByLayout = !excludeLayouting;
2976 // Layout not being replaced so restore margin and padding to View.
2977 SetValue(MarginProperty, layout.Margin);
2978 SetValue(PaddingProperty, layout.Padding);
2979 NotifyPropertyChanged();
2984 // First Layout to be added to the View hence copy
2986 // Do not try to set Margins or Padding on a null Layout (when a layout is being removed from a View)
2989 Extents margin = Margin;
2990 Extents padding = Padding;
2991 bool setMargin = false;
2992 bool setPadding = false;
2994 if (margin.Top != 0 || margin.Bottom != 0 || margin.Start != 0 || margin.End != 0)
2996 // If View already has a margin set then store it in Layout instead.
2997 value.Margin = margin;
2998 SetValue(MarginProperty, new Extents(0, 0, 0, 0));
3002 if (padding.Top != 0 || padding.Bottom != 0 || padding.Start != 0 || padding.End != 0)
3004 // If View already has a padding set then store it in Layout instead.
3005 value.Padding = padding;
3006 SetValue(PaddingProperty, new Extents(0, 0, 0, 0));
3010 if (setMargin || setPadding)
3012 NotifyPropertyChanged();
3015 value.SetPositionByLayout = !excludeLayouting;
3019 // Remove existing layout from it's parent layout group.
3022 // Set layout to this view
3028 /// The weight of the View, used to share available space in a layout with siblings.
3030 /// <since_tizen> 6 </since_tizen>
3040 layout?.RequestLayout();
3045 /// Whether to load the BackgroundImage synchronously.
3046 /// If not specified, the default is false, i.e. the BackgroundImage is loaded asynchronously.
3047 /// Note: For Normal Quad images only.
3049 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
3050 [EditorBrowsable(EditorBrowsableState.Never)]
3051 public bool BackgroundImageSynchronosLoading
3055 return (bool)GetValue(BackgroundImageSynchronosLoadingProperty);
3059 SetValue(BackgroundImageSynchronosLoadingProperty, value);
3060 NotifyPropertyChanged();
3064 private bool InternalBackgroundImageSynchronosLoading
3068 return BackgroundImageSynchronousLoading;
3072 BackgroundImageSynchronousLoading = value;
3077 /// Whether to load the BackgroundImage synchronously.
3078 /// If not specified, the default is false, i.e. the BackgroundImage is loaded asynchronously.
3079 /// Note: For Normal Quad images only.
3081 /// This will be public opened in tizen_7.0 after ACR done. Before ACR, need to be hidden as inhouse API.
3082 [EditorBrowsable(EditorBrowsableState.Never)]
3083 public bool BackgroundImageSynchronousLoading
3087 return (bool)GetValue(BackgroundImageSynchronousLoadingProperty);
3091 SetValue(BackgroundImageSynchronousLoadingProperty, value);
3092 NotifyPropertyChanged();
3096 private bool InternalBackgroundImageSynchronousLoading
3100 return backgroundImageSynchronousLoading;
3104 backgroundImageSynchronousLoading = value;
3106 if (!string.IsNullOrEmpty(BackgroundImage))
3108 PropertyMap bgMap = this.Background;
3109 var temp = new PropertyValue(backgroundImageSynchronousLoading);
3110 bgMap[ImageVisualProperty.SynchronousLoading] = temp;
3117 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
3118 [EditorBrowsable(EditorBrowsableState.Never)]
3119 public Vector4 UpdateAreaHint
3123 return (Vector4)GetValue(UpdateAreaHintProperty);
3127 SetValue(UpdateAreaHintProperty, value);
3128 NotifyPropertyChanged();
3133 /// Enable/Disable ControlState propagation for children.
3134 /// It is false by default.
3135 /// If the View needs to share ControlState with descendants, please set it true.
3136 /// Please note that, changing the value will also changes children's EnableControlStatePropagation value recursively.
3138 [EditorBrowsable(EditorBrowsableState.Never)]
3139 public bool EnableControlStatePropagation
3143 return (bool)GetValue(EnableControlStatePropagationProperty);
3147 SetValue(EnableControlStatePropagationProperty, value);
3148 NotifyPropertyChanged();
3152 private bool InternalEnableControlStatePropagation
3154 get => themeData?.ControlStatePropagation ?? false;
3157 if (InternalEnableControlStatePropagation == value) return;
3159 if (themeData == null) themeData = new ThemeData();
3161 themeData.ControlStatePropagation = value;
3163 foreach (View child in Children)
3165 child.EnableControlStatePropagation = value;
3171 /// The ControlStates can propagate from the parent.
3172 /// Listed ControlStates will be accepted propagation of the parent ControlState changes
3173 /// if parent view EnableControlState is true.
3174 /// <see cref="EnableControlState"/>.
3175 /// Default is ControlState.All, so every ControlStates will be propagated from the parent.
3177 [EditorBrowsable(EditorBrowsableState.Never)]
3178 public ControlState PropagatableControlStates
3182 return (ControlState)GetValue(PropagatableControlStatesProperty);
3186 SetValue(PropagatableControlStatesProperty, value);
3187 NotifyPropertyChanged();
3191 private ControlState InternalPropagatableControlStates
3193 get => propagatableControlStates;
3194 set => propagatableControlStates = value;
3198 /// By default, it is false in View, true in Control.
3199 /// Note that if the value is true, the View will be a touch receptor.
3201 [EditorBrowsable(EditorBrowsableState.Never)]
3202 public bool EnableControlState
3206 return (bool)GetValue(EnableControlStateProperty);
3210 SetValue(EnableControlStateProperty, value);
3215 /// Whether the actor grab all touches even if touch leaves its boundary.
3217 /// <returns>true, if it grab all touch after start</returns>
3218 [EditorBrowsable(EditorBrowsableState.Never)]
3219 public bool GrabTouchAfterLeave
3223 return (bool)GetValue(GrabTouchAfterLeaveProperty);
3227 SetValue(GrabTouchAfterLeaveProperty, value);
3231 private bool InternalGrabTouchAfterLeave
3235 return Object.InternalGetPropertyBool(SwigCPtr, View.Property.CaptureAllTouchAfterStart);
3239 Object.InternalSetPropertyBool(SwigCPtr, View.Property.CaptureAllTouchAfterStart, value);
3240 NotifyPropertyChanged();
3245 /// Whether the view will only receive own touch.
3247 /// <returns>true, if it only receives touches that started from itself.</returns>
3248 [EditorBrowsable(EditorBrowsableState.Never)]
3249 public bool AllowOnlyOwnTouch
3253 return (bool)GetValue(AllowOnlyOwnTouchProperty);
3257 SetValue(AllowOnlyOwnTouchProperty, value);
3261 private bool InternalAllowOnlyOwnTouch
3265 return Object.InternalGetPropertyBool(SwigCPtr, View.Property.AllowOnlyOwnTouch);
3269 Object.InternalSetPropertyBool(SwigCPtr, View.Property.AllowOnlyOwnTouch, value);
3270 NotifyPropertyChanged();
3275 /// Determines which blend equation will be used to render renderers of this actor.
3277 /// <returns>blend equation enum currently assigned</returns>
3278 /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API.
3279 [EditorBrowsable(EditorBrowsableState.Never)]
3280 public BlendEquationType BlendEquation
3284 return (BlendEquationType)GetValue(BlendEquationProperty);
3288 SetValue(BlendEquationProperty, value);
3292 private BlendEquationType InternalBlendEquation
3296 return (BlendEquationType)Object.InternalGetPropertyInt(SwigCPtr, View.Property.BlendEquation);
3300 Object.InternalSetPropertyInt(SwigCPtr, View.Property.BlendEquation, (int)value);
3301 NotifyPropertyChanged();
3306 /// If the value is true, the View will change its style as the theme changes.
3307 /// The default value is false in normal case but it can be true when the NUIApplication is created with <see cref="NUIApplication.ThemeOptions.ThemeChangeSensitive"/>.
3309 /// <since_tizen> 9 </since_tizen>
3310 public bool ThemeChangeSensitive
3312 get => (bool)GetValue(ThemeChangeSensitiveProperty);
3313 set => SetValue(ThemeChangeSensitiveProperty, value);
3317 /// Create Style, it is abstract function and must be override.
3319 [EditorBrowsable(EditorBrowsableState.Never)]
3320 protected virtual ViewStyle CreateViewStyle()
3322 return new ViewStyle();
3326 /// Called after the View's ControlStates changed.
3328 /// <param name="controlStateChangedInfo">The information including state changed variables.</param>
3329 [EditorBrowsable(EditorBrowsableState.Never)]
3330 protected virtual void OnControlStateChanged(ControlStateChangedEventArgs controlStateChangedInfo)
3336 [EditorBrowsable(EditorBrowsableState.Never)]
3337 protected virtual void OnThemeChanged(object sender, ThemeChangedEventArgs e)
3339 isThemeChanged = true;
3340 if (string.IsNullOrEmpty(styleName)) ApplyStyle(ThemeManager.GetUpdateStyleWithoutClone(GetType()));
3341 else ApplyStyle(ThemeManager.GetUpdateStyleWithoutClone(styleName));
3342 isThemeChanged = false;
3346 /// Apply style instance to the view.
3347 /// Basically it sets the bindable property to the value of the bindable property with same name in the style.
3349 /// <since_tizen> 9 </since_tizen>
3350 public virtual void ApplyStyle(ViewStyle viewStyle)
3352 if (viewStyle == null || themeData?.viewStyle == viewStyle) return;
3354 if (themeData == null) themeData = new ThemeData();
3356 themeData.viewStyle = viewStyle;
3358 if (viewStyle.DirtyProperties == null || viewStyle.DirtyProperties.Count == 0)
3364 BindableProperty.GetBindablePropertysOfType(GetType(), out var bindablePropertyOfView);
3366 if (bindablePropertyOfView == null)
3371 var dirtyStyleProperties = new BindableProperty[viewStyle.DirtyProperties.Count];
3372 viewStyle.DirtyProperties.CopyTo(dirtyStyleProperties);
3374 foreach (var sourceProperty in dirtyStyleProperties)
3376 var sourceValue = viewStyle.GetValue(sourceProperty);
3378 if (sourceValue == null)
3383 bindablePropertyOfView.TryGetValue(sourceProperty.PropertyName, out var destinationProperty);
3385 // Do not set value again when theme is changed and the value has been set already.
3386 if (isThemeChanged && ChangedPropertiesSetExcludingStyle.Contains(destinationProperty))
3391 if (destinationProperty != null)
3393 InternalSetValue(destinationProperty, sourceValue);
3399 /// Get whether the View is culled or not.
3400 /// True means that the View is out of the view frustum.
3403 /// Hidden-API (Inhouse-API).
3405 [EditorBrowsable(EditorBrowsableState.Never)]
3410 return Object.InternalGetPropertyBool(SwigCPtr, View.Property.Culled);
3415 /// Set or Get TransitionOptions for the page transition.
3416 /// This property is used to define how this view will be transitioned during Page switching.
3418 /// <since_tizen> 9 </since_tizen>
3419 public TransitionOptions TransitionOptions
3423 return GetValue(TransitionOptionsProperty) as TransitionOptions;
3427 SetValue(TransitionOptionsProperty, value);
3428 NotifyPropertyChanged();
3432 private TransitionOptions InternalTransitionOptions
3436 transitionOptions = value;
3440 return transitionOptions;
3445 /// Gets or sets the status of whether the view should emit key event signals.
3446 /// If a View's DispatchKeyEvents is set to false, then itself and parents will not receive key event signals.
3448 [EditorBrowsable(EditorBrowsableState.Never)]
3449 public bool DispatchKeyEvents
3453 return (bool)GetValue(DispatchKeyEventsProperty);
3457 SetValue(DispatchKeyEventsProperty, value);
3458 NotifyPropertyChanged();
3463 /// Gets or sets the status of whether touch events can be dispatched.
3464 /// If a View's DispatchTouchEvents is set to false, then it's can not will receive touch and parents will not receive a touch event signal either.
3465 /// This works without adding a TouchEvent callback in the View.
3467 /// If the <see cref="Tizen.NUI.BaseComponents.View.Sensitive"/> is a property that determines whether or not to be hittable, then this property prevents the propagation of the hit touch event.
3470 [EditorBrowsable(EditorBrowsableState.Never)]
3471 public bool DispatchTouchEvents
3475 return dispatchTouchEvents;
3479 if (dispatchTouchEvents != value)
3481 dispatchTouchEvents = value;
3482 if (dispatchTouchEvents == false)
3484 TouchEvent += OnDispatchTouchEvent;
3488 TouchEvent -= OnDispatchTouchEvent;
3494 private bool OnDispatchTouchEvent(object source, View.TouchEventArgs e)
3500 /// Gets or sets the status of whether the view should emit Gesture event signals.
3501 /// If a View's DispatchGestureEvents is set to false, then itself and parents will not receive all gesture event signals.
3502 /// The itself and parents does not receive tap, pinch, pan, rotation, or longpress gestures.
3504 [EditorBrowsable(EditorBrowsableState.Never)]
3505 public bool DispatchGestureEvents
3509 return dispatchGestureEvents;
3513 if (dispatchGestureEvents != value)
3515 dispatchGestureEvents = value;
3516 ConfigGestureDetector(dispatchGestureEvents);
3522 /// Gets or sets the status of whether the view should emit Gesture event signals.
3523 /// If a View's DispatchParentGestureEvents is set to false, then parents will not receive all gesture event signals.
3524 /// The parents does not receive tap, pinch, pan, rotation, or longpress gestures.
3526 [EditorBrowsable(EditorBrowsableState.Never)]
3527 public bool DispatchParentGestureEvents
3531 return dispatchParentGestureEvents;
3535 if (dispatchParentGestureEvents != value)
3537 dispatchParentGestureEvents = value;
3538 ConfigGestureDetector(dispatchParentGestureEvents);
3543 private void ConfigGestureDetector(bool dispatch)
3545 if (panGestureDetector == null) panGestureDetector = new PanGestureDetector();
3546 if (longGestureDetector == null) longGestureDetector = new LongPressGestureDetector();
3547 if (pinchGestureDetector == null) pinchGestureDetector = new PinchGestureDetector();
3548 if (tapGestureDetector == null) tapGestureDetector = new TapGestureDetector();
3549 if (rotationGestureDetector == null) rotationGestureDetector = new RotationGestureDetector();
3551 if (dispatch == true)
3553 configGestureCount = configGestureCount > 0 ? configGestureCount-- : 0;
3554 if (configGestureCount == 0)
3556 panGestureDetector.Detach(this);
3557 longGestureDetector.Detach(this);
3558 pinchGestureDetector.Detach(this);
3559 tapGestureDetector.Detach(this);
3560 rotationGestureDetector.Detach(this);
3562 panGestureDetector.Detected -= OnGestureDetected;
3563 longGestureDetector.Detected -= OnGestureDetected;
3564 pinchGestureDetector.Detected -= OnGestureDetected;
3565 tapGestureDetector.Detected -= OnGestureDetected;
3566 rotationGestureDetector.Detected -= OnGestureDetected;
3568 panGestureDetector = null;
3569 longGestureDetector = null;
3570 pinchGestureDetector = null;
3571 tapGestureDetector = null;
3572 rotationGestureDetector = null;
3577 if (configGestureCount == 0)
3579 panGestureDetector.Attach(this);
3580 longGestureDetector.Attach(this);
3581 pinchGestureDetector.Attach(this);
3582 tapGestureDetector.Attach(this);
3583 rotationGestureDetector.Attach(this);
3585 panGestureDetector.Detected += OnGestureDetected;
3586 longGestureDetector.Detected += OnGestureDetected;
3587 pinchGestureDetector.Detected += OnGestureDetected;
3588 tapGestureDetector.Detected += OnGestureDetected;
3589 rotationGestureDetector.Detected += OnGestureDetected;
3591 configGestureCount++;
3595 private void OnGestureDetected(object source, EventArgs e)
3597 // Does notting. This is to consume the gesture.
3601 /// Called when the view is hit through TouchEvent or GestureEvent.
3602 /// If it returns true, it means that it was hit, and the touch/gesture event is called from the view.
3603 /// If it returns false, it means that it will not be hit, and the hit-test continues to the next view.
3604 /// User can override whether hit or not in HitTest.
3605 /// You can get the coordinates relative to tthe top-left of the hit view by touch.GetLocalPosition(0).
3606 /// or you can get the coordinates relative to the top-left of the screen by touch.GetScreenPosition(0).
3608 // <param name="touch"><see cref="Tizen.NUI.Touch"/>The touch data</param>
3609 [EditorBrowsable(EditorBrowsableState.Never)]
3610 protected virtual bool HitTest(Touch touch)
3616 /// Retrieve the View's current Color.
3619 /// The <see cref="Size"/>, <see cref="Position"/>, <see cref="Color"/>, and <see cref="Scale"/> properties are set in the main thread.
3620 /// Therefore, it is not updated in real time when the value is changed in the render thread (for example, the value is changed during animation).
3621 /// However, <see cref="CurrentSize"/>, <see cref="CurrentPosition"/>, <see cref="CurrentColor"/>, and <see cref="CurrentScale"/> properties are updated in real time,
3622 /// and users can get the current actual values through them.
3624 [EditorBrowsable(EditorBrowsableState.Never)]
3625 public Color CurrentColor => GetCurrentColor();
3628 /// Retrieve the current scale factor applied to the View.
3631 /// The <see cref="Size"/>, <see cref="Position"/>, <see cref="Color"/>, and <see cref="Scale"/> properties are set in the main thread.
3632 /// Therefore, it is not updated in real time when the value is changed in the render thread (for example, the value is changed during animation).
3633 /// However, <see cref="CurrentSize"/>, <see cref="CurrentPosition"/>, <see cref="CurrentColor"/>, and <see cref="CurrentScale"/> properties are updated in real time,
3634 /// and users can get the current actual values through them.
3636 [EditorBrowsable(EditorBrowsableState.Never)]
3637 public Vector3 CurrentScale => GetCurrentScale();