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 private string internalName = string.Empty;
76 private Position internalCurrentParentOrigin = null;
77 private Position internalCurrentAnchorPoint = null;
78 private Vector3 internalTargetSize = null;
79 private Size2D internalCurrentSize = null;
80 private Position internalCurrentPosition = null;
81 private Vector3 internalCurrentWorldPosition = null;
82 private Vector3 internalCurrentScale = null;
83 private Vector3 internalCurrentWorldScale = null;
84 private Vector4 internalCurrentColor = null;
85 private Vector4 internalCurrentWorldColor = null;
86 private Vector2 internalCurrentScreenPosition = null;
90 RegisterPropertyGroup(PositionProperty, positionPropertyGroup);
91 RegisterPropertyGroup(Position2DProperty, positionPropertyGroup);
92 RegisterPropertyGroup(PositionXProperty, positionPropertyGroup);
93 RegisterPropertyGroup(PositionYProperty, positionPropertyGroup);
95 RegisterPropertyGroup(SizeProperty, sizePropertyGroup);
96 RegisterPropertyGroup(Size2DProperty, sizePropertyGroup);
97 RegisterPropertyGroup(SizeWidthProperty, sizePropertyGroup);
98 RegisterPropertyGroup(SizeHeightProperty, sizePropertyGroup);
100 RegisterPropertyGroup(ScaleProperty, scalePropertyGroup);
101 RegisterPropertyGroup(ScaleXProperty, scalePropertyGroup);
102 RegisterPropertyGroup(ScaleYProperty, scalePropertyGroup);
103 RegisterPropertyGroup(ScaleZProperty, scalePropertyGroup);
105 RegisterAccessibilityDelegate();
108 static internal new void Preload()
112 // Do nothing. Just call for load static values.
113 var temporalPositionPropertyGroup = positionPropertyGroup;
114 var temporalSizePropertyGroup = sizePropertyGroup;
115 var temporalScalePropertyGroup = scalePropertyGroup;
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;
220 internal View(ViewImpl implementation, bool shown = true) : this(Interop.View.NewViewInternal(ViewImpl.getCPtr(implementation)), true)
222 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
231 /// The event that is triggered when the View's ControlState is changed.
233 [EditorBrowsable(EditorBrowsableState.Never)]
234 public event EventHandler<ControlStateChangedEventArgs> ControlStateChangedEvent;
236 internal event EventHandler<ControlStateChangedEventArgs> ControlStateChangeEventInternal;
240 /// Flag to indicate if layout set explicitly via API call or View was automatically given a Layout.
242 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
243 [EditorBrowsable(EditorBrowsableState.Never)]
244 public bool LayoutSet
253 /// Flag to allow Layouting to be disabled for Views.
254 /// Once a View has a Layout set then any children added to Views from then on will receive
255 /// automatic Layouts.
257 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
258 [EditorBrowsable(EditorBrowsableState.Never)]
259 public static bool LayoutingDisabled { get; set; } = true;
262 /// If set to true, the <see cref="GrabTouchAfterLeave"/> property value is set to true when all Views are created.
264 /// <param name="enable">Sets value of GrabTouchAfterLeave property</param>
265 [EditorBrowsable(EditorBrowsableState.Never)]
266 public static void SetDefaultGrabTouchAfterLeave(bool enable)
268 defaultGrabTouchAfterLeave = enable;
272 /// If set to true, the <see cref="AllowOnlyOwnTouch"/> property value is set to true when all Views are created.
274 /// <param name="enable">Sets value of AllowOnlyOwnTouch property</param>
275 [EditorBrowsable(EditorBrowsableState.Never)]
276 public static void SetDefaultAllowOnlyOwnTouch(bool enable)
278 defaultAllowOnlyOwnTouch = enable;
282 /// Deprecate. Do not use this.
283 /// The style instance applied to this view.
284 /// Note that do not modify the ViewStyle.
285 /// Modifying ViewStyle will affect other views with same ViewStyle.
287 [EditorBrowsable(EditorBrowsableState.Never)]
288 protected ViewStyle ViewStyle
292 if (themeData == null) themeData = new ThemeData();
294 if (themeData.viewStyle == null)
296 ApplyStyle(CreateViewStyle());
298 return themeData.viewStyle;
303 /// Get/Set the control state.
304 /// Note that the ControlState only available for the classes derived from Control.
305 /// If the classes that are not derived from Control (such as View, ImageView and TextLabel) want to use this system,
306 /// please set <see cref="EnableControlState"/> to true.
308 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
309 [EditorBrowsable(EditorBrowsableState.Never)]
310 public ControlState ControlState
314 return themeData == null ? ControlState.Normal : themeData.controlStates;
318 if (ControlState == value)
323 var prevState = ControlState;
325 if (themeData == null) themeData = new ThemeData();
326 themeData.controlStates = value;
328 var changeInfo = new ControlStateChangedEventArgs(prevState, value);
330 ControlStateChangeEventInternal?.Invoke(this, changeInfo);
332 if (themeData.ControlStatePropagation)
334 foreach (View child in Children)
336 ControlState allowed = child.PropagatableControlStates;
337 if (allowed.Contains(ControlState.All))
339 child.ControlState = value;
343 ControlState newControlState = child.ControlState;
345 if (allowed.Contains(ControlState.Normal))
347 if (value.Contains(ControlState.Normal))
349 newControlState += ControlState.Normal;
353 newControlState -= ControlState.Normal;
357 if (allowed.Contains(ControlState.Disabled))
359 if (value.Contains(ControlState.Disabled))
361 newControlState += ControlState.Disabled;
365 newControlState -= ControlState.Disabled;
369 if (allowed.Contains(ControlState.Selected))
371 if (value.Contains(ControlState.Selected))
373 newControlState += ControlState.Selected;
377 newControlState -= ControlState.Selected;
381 if (allowed.Contains(ControlState.Pressed))
383 if (value.Contains(ControlState.Pressed))
385 newControlState += ControlState.Pressed;
389 newControlState -= ControlState.Pressed;
393 if (allowed.Contains(ControlState.Focused))
395 if (value.Contains(ControlState.Focused))
397 newControlState += ControlState.Focused;
401 newControlState -= ControlState.Focused;
405 if (allowed.Contains(ControlState.Other))
407 if (value.Contains(ControlState.Other))
409 newControlState += ControlState.Other;
413 newControlState -= ControlState.Other;
417 if (child.ControlState != newControlState)
418 child.ControlState = newControlState;
423 OnControlStateChanged(changeInfo);
425 ControlStateChangedEvent?.Invoke(this, changeInfo);
430 /// Gets / Sets the status of whether the view is excluded from its parent's layouting or not.
432 /// This will be public opened later after ACR done. Before ACR, need to be hidden as inhouse API.
433 [EditorBrowsable(EditorBrowsableState.Never)]
434 public bool ExcludeLayouting
438 return (bool)GetValue(ExcludeLayoutingProperty);
442 SetValue(ExcludeLayoutingProperty, value);
443 NotifyPropertyChanged();
447 private bool InternalExcludeLayouting
451 return excludeLayouting;
455 excludeLayouting = value;
456 if (Layout != null && Layout.SetPositionByLayout == value)
458 Layout.SetPositionByLayout = !value;
459 Layout.RequestLayout();
465 /// The StyleName, type string.
466 /// The value indicates DALi style name defined in json theme file.
468 /// <since_tizen> 3 </since_tizen>
469 public string StyleName
473 return (string)GetValue(StyleNameProperty);
477 SetValue(StyleNameProperty, value);
478 NotifyPropertyChanged();
483 /// The KeyInputFocus, type bool.
485 [EditorBrowsable(EditorBrowsableState.Never)]
486 public bool KeyInputFocus
490 return (bool)GetValue(KeyInputFocusProperty);
494 SetValue(KeyInputFocusProperty, value);
495 NotifyPropertyChanged();
500 /// The mutually exclusive with "backgroundImage" and "background" type Vector4.
504 /// The property cascade chaining set is not recommended.
507 /// Animatable - This property can be animated using <c>Animation</c> class.
509 /// animation.AnimateTo(view, "BackgroundColor", new Color(r, g, b, a));
514 /// This way is recommended for setting the property
516 /// var view = new View();
517 /// view.BackgroundColor = new Color(0.5f, 0.1f, 0, 1);
519 /// This way to set the property is prohibited
521 /// view.BackgroundColor.R = 0.5f; //This does not guarantee a proper operation
524 /// <since_tizen> 3 </since_tizen>
525 public Color BackgroundColor
529 return (Color)GetValue(BackgroundColorProperty);
533 SetValue(BackgroundColorProperty, value);
534 NotifyPropertyChanged();
539 /// The mutually exclusive with "backgroundColor" and "background" type Map.
541 /// <since_tizen> 3 </since_tizen>
542 public string BackgroundImage
546 return (string)GetValue(BackgroundImageProperty);
550 SetValue(BackgroundImageProperty, value);
551 NotifyPropertyChanged();
556 /// Get or set the border of background image.
558 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
559 [EditorBrowsable(EditorBrowsableState.Never)]
560 public Rectangle BackgroundImageBorder
564 return (Rectangle)GetValue(BackgroundImageBorderProperty);
568 SetValue(BackgroundImageBorderProperty, value);
569 NotifyPropertyChanged();
574 /// The background of view.
576 /// <since_tizen> 3 </since_tizen>
577 public Tizen.NUI.PropertyMap Background
581 return (PropertyMap)GetValue(BackgroundProperty);
585 SetValue(BackgroundProperty, value);
586 NotifyPropertyChanged();
591 /// Describes a shadow as an image for a View.
592 /// It is null by default.
595 /// Getter returns copied instance of current shadow.
598 /// The mutually exclusive with "BoxShadow".
602 /// Animatable - This property can be animated using <c>Animation</c> class.
603 /// To animate this property, specify a sub-property with separator ".", for example, "ImageShadow.Offset".
605 /// animation.AnimateTo(view, "ImageShadow.Offset", new Vector2(10, 10));
607 /// Animatable sub-property : Offset.
610 [EditorBrowsable(EditorBrowsableState.Never)]
611 public ImageShadow ImageShadow
615 return (ImageShadow)GetValue(ImageShadowProperty);
619 SetValue(ImageShadowProperty, value);
620 NotifyPropertyChanged();
625 /// Describes a box shaped shadow drawing for a View.
626 /// It is null by default.
629 /// The mutually exclusive with "ImageShadow".
633 /// Animatable - This property can be animated using <c>Animation</c> class.
634 /// To animate this property, specify a sub-property with separator ".", for example, "BoxShadow.BlurRadius".
636 /// animation.AnimateTo(view, "BoxShadow.BlurRadius", 10.0f);
638 /// Animatable sub-property : Offset, Color, BlurRadius.
641 /// <since_tizen> 9 </since_tizen>
642 public Shadow BoxShadow
646 return (Shadow)GetValue(BoxShadowProperty);
650 SetValue(BoxShadowProperty, value);
651 NotifyPropertyChanged();
656 /// The radius for the rounded corners of the View.
657 /// This will rounds background and shadow edges.
658 /// 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).
659 /// Each radius will clamp internally to the half of smaller of the view's width or height.
660 /// Note that, an image background (or shadow) may not have rounded corners if it uses a Border property.
664 /// Animatable - This property can be animated using <c>Animation</c> class.
666 /// animation.AnimateTo(view, "CornerRadius", new Vector4(10, 10, 10, 10));
670 /// <since_tizen> 9 </since_tizen>
671 public Vector4 CornerRadius
675 return (Vector4)GetValue(CornerRadiusProperty);
679 SetValue(CornerRadiusProperty, value);
680 NotifyPropertyChanged();
685 /// Whether the CornerRadius property value is relative (percentage [0.0f to 0.5f] of the view size) or absolute (in world units).
686 /// It is absolute by default.
687 /// When the policy is relative, the corner radius is relative to the smaller of the view's width and height.
689 /// <since_tizen> 9 </since_tizen>
690 public VisualTransformPolicyType CornerRadiusPolicy
692 get => (VisualTransformPolicyType)GetValue(CornerRadiusPolicyProperty);
693 set => SetValue(CornerRadiusPolicyProperty, value);
697 /// The width for the borderline of the View.
701 /// Animatable - This property can be animated using <c>Animation</c> class.
703 /// animation.AnimateTo(view, "BorderlineWidth", 100.0f);
706 /// Note that, an image background may not have borderline if it uses the Border property.
708 /// <since_tizen> 9 </since_tizen>
709 public float BorderlineWidth
713 return (float)GetValue(BorderlineWidthProperty);
717 SetValue(BorderlineWidthProperty, value);
718 NotifyPropertyChanged();
723 /// The color for the borderline of the View.
724 /// It is Color.Black by default.
728 /// Animatable - This property can be animated using <c>Animation</c> class.
730 /// animation.AnimateTo(view, "BorderlineColor", new Color(r, g, b, a));
734 /// <since_tizen> 9 </since_tizen>
735 public Color BorderlineColor
739 return (Color)GetValue(BorderlineColorProperty);
743 SetValue(BorderlineColorProperty, value);
744 NotifyPropertyChanged();
749 /// The color selector for the borderline of the View.
750 /// Like BackgroundColor, color selector typed BorderlineColor should be used in ViewStyle only.
751 /// So this API is internally used only.
753 internal Selector<Color> BorderlineColorSelector
757 return (Selector<Color>)GetValue(BorderlineColorSelectorProperty);
761 SetValue(BorderlineColorSelectorProperty, value);
762 NotifyPropertyChanged();
767 /// The Relative offset for the borderline of the View.
768 /// Recommended range : [-1.0f to 1.0f].
769 /// If -1.0f, draw borderline inside of the View.
770 /// If 1.0f, draw borderline outside of the View.
771 /// If 0.0f, draw borderline half inside and half outside.
772 /// It is 0.0f by default.
776 /// Animatable - This property can be animated using <c>Animation</c> class.
778 /// animation.AnimateTo(view, "BorderlineOffset", -1.0f);
782 /// <since_tizen> 9 </since_tizen>
783 public float BorderlineOffset
787 return (float)GetValue(BorderlineOffsetProperty);
791 SetValue(BorderlineOffsetProperty, value);
792 NotifyPropertyChanged();
797 /// The current state of the view.
799 /// <since_tizen> 3 </since_tizen>
804 return (States)GetValue(StateProperty);
808 SetValue(StateProperty, value);
809 NotifyPropertyChanged();
814 /// The current sub state of the view.
816 /// <since_tizen> 3 </since_tizen>
817 public States SubState
821 return (States)GetValue(SubStateProperty);
825 SetValue(SubStateProperty, value);
826 NotifyPropertyChanged();
831 /// Displays a tooltip
833 /// <since_tizen> 3 </since_tizen>
834 public Tizen.NUI.PropertyMap Tooltip
838 return (PropertyMap)GetValue(TooltipProperty);
842 SetValue(TooltipProperty, value);
843 NotifyPropertyChanged();
848 /// Displays a tooltip as a text.
850 /// <since_tizen> 3 </since_tizen>
851 public string TooltipText
855 return GetValue(TooltipTextProperty) as string;
859 SetValue(TooltipTextProperty, value);
863 private string InternalTooltipText
867 using (var propertyValue = GetProperty(Property.TOOLTIP))
869 using var propertyMap = new PropertyMap();
870 if (propertyValue != null && propertyValue.Get(propertyMap))
872 using var retrivedContentValue = propertyMap?.Find(NDalic.TooltipContent);
873 if (retrivedContentValue != null)
875 using var contextPropertyMap = new PropertyMap();
876 if (retrivedContentValue.Get(contextPropertyMap))
878 using var retrivedTextValue = contextPropertyMap?.Find(NDalic.TextVisualText);
879 if (retrivedTextValue != null && retrivedTextValue.Get(out string retrivedValue))
881 return retrivedValue;
891 var temp = new Tizen.NUI.PropertyValue(value);
892 SetProperty(View.Property.TOOLTIP, temp);
894 NotifyPropertyChanged();
899 /// The Child property of FlexContainer.<br />
900 /// The proportion of the free space in the container, the flex item will receive.<br />
901 /// If all items in the container set this property, their sizes will be proportional to the specified flex factor.<br />
903 /// <since_tizen> 3 </since_tizen>
904 [Obsolete("Deprecated in API8, will be removed in API10.")]
909 return (float)GetValue(FlexProperty);
913 SetValue(FlexProperty, value);
914 NotifyPropertyChanged();
919 /// The Child property of FlexContainer.<br />
920 /// The alignment of the flex item along the cross axis, which, if set, overrides the default alignment for all items in the container.<br />
922 /// <since_tizen> 3 </since_tizen>
923 [Obsolete("Deprecated in API8, will be removed in API10.")]
928 return (int)GetValue(AlignSelfProperty);
932 SetValue(AlignSelfProperty, value);
933 NotifyPropertyChanged();
938 /// The Child property of FlexContainer.<br />
939 /// The space around the flex item.<br />
942 /// The property cascade chaining set is possible. For example, this (view.FlexMargin.X = 0.1f;) is possible.
944 /// <since_tizen> 3 </since_tizen>
945 [Obsolete("Deprecated in API8, will be removed in API10.")]
946 public Vector4 FlexMargin
950 Vector4 temp = (Vector4)GetValue(FlexMarginProperty);
951 return new Vector4(OnFlexMarginChanged, temp.X, temp.Y, temp.Z, temp.W);
955 SetValue(FlexMarginProperty, value);
956 NotifyPropertyChanged();
961 /// The top-left cell this child occupies, if not set, the first available cell is used.
964 /// The property cascade chaining set is not recommended.
965 /// Also, this property is for <see cref="TableView"/> class. Please use the property for the child position of <see cref="TableView"/>.
968 /// This way is recommended for setting the property
970 /// var view = new View();
971 /// view.CellIndex = new Vector2(1, 3);
973 /// This way to set the property is prohibited
975 /// view.CellIndex.X = 1; //This does not guarantee a proper operation
978 /// <since_tizen> 3 </since_tizen>
979 public Vector2 CellIndex
983 return (Vector2)GetValue(CellIndexProperty);
987 SetValue(CellIndexProperty, value);
988 NotifyPropertyChanged();
993 /// The number of rows this child occupies, if not set, the default value is 1.
996 /// This property is for <see cref="TableView"/> class. Use the property for the child position of <see cref="TableView"/>.
998 /// <since_tizen> 3 </since_tizen>
1003 return (float)GetValue(RowSpanProperty);
1007 SetValue(RowSpanProperty, value);
1008 NotifyPropertyChanged();
1013 /// The number of columns this child occupies, if not set, the default value is 1.
1016 /// This property is for <see cref="TableView"/> class. Use the property for the child position of <see cref="TableView"/>.
1018 /// <since_tizen> 3 </since_tizen>
1019 public float ColumnSpan
1023 return (float)GetValue(ColumnSpanProperty);
1027 SetValue(ColumnSpanProperty, value);
1028 NotifyPropertyChanged();
1033 /// The horizontal alignment of this child inside the cells, if not set, the default value is 'left'.
1036 /// This property is for <see cref="TableView"/> class. Use the property for the child position of <see cref="TableView"/>.
1038 /// <since_tizen> 3 </since_tizen>
1039 public Tizen.NUI.HorizontalAlignmentType CellHorizontalAlignment
1043 return (HorizontalAlignmentType)GetValue(CellHorizontalAlignmentProperty);
1047 SetValue(CellHorizontalAlignmentProperty, value);
1048 NotifyPropertyChanged();
1053 /// The vertical alignment of this child inside the cells, if not set, the default value is 'top'.
1056 /// This property is for <see cref="TableView"/> class. Use the property for the child position of <see cref="TableView"/>.
1058 /// <since_tizen> 3 </since_tizen>
1059 public Tizen.NUI.VerticalAlignmentType CellVerticalAlignment
1063 return (VerticalAlignmentType)GetValue(CellVerticalAlignmentProperty);
1067 SetValue(CellVerticalAlignmentProperty, value);
1068 NotifyPropertyChanged();
1073 /// The left focusable view.<br />
1074 /// This will return null if not set.<br />
1075 /// This will also return null if the specified left focusable view is not on a window.<br />
1077 /// <since_tizen> 3 </since_tizen>
1078 public View LeftFocusableView
1080 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
1083 return (View)GetValue(LeftFocusableViewProperty);
1087 SetValue(LeftFocusableViewProperty, value);
1088 NotifyPropertyChanged();
1093 /// The right focusable view.<br />
1094 /// This will return null if not set.<br />
1095 /// This will also return null if the specified right focusable view is not on a window.<br />
1097 /// <since_tizen> 3 </since_tizen>
1098 public View RightFocusableView
1100 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
1103 return (View)GetValue(RightFocusableViewProperty);
1107 SetValue(RightFocusableViewProperty, value);
1108 NotifyPropertyChanged();
1113 /// The up focusable view.<br />
1114 /// This will return null if not set.<br />
1115 /// This will also return null if the specified up focusable view is not on a window.<br />
1117 /// <since_tizen> 3 </since_tizen>
1118 public View UpFocusableView
1120 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
1123 return (View)GetValue(UpFocusableViewProperty);
1127 SetValue(UpFocusableViewProperty, value);
1128 NotifyPropertyChanged();
1133 /// The down focusable view.<br />
1134 /// This will return null if not set.<br />
1135 /// This will also return null if the specified down focusable view is not on a window.<br />
1137 /// <since_tizen> 3 </since_tizen>
1138 public View DownFocusableView
1140 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
1143 return (View)GetValue(DownFocusableViewProperty);
1147 SetValue(DownFocusableViewProperty, value);
1148 NotifyPropertyChanged();
1153 /// The clockwise focusable view by rotary wheel.<br />
1154 /// This will return null if not set.<br />
1155 /// This will also return null if the specified clockwise focusable view is not on a window.<br />
1157 [EditorBrowsable(EditorBrowsableState.Never)]
1158 public View ClockwiseFocusableView
1160 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
1163 return (View)GetValue(ClockwiseFocusableViewProperty);
1167 SetValue(ClockwiseFocusableViewProperty, value);
1168 NotifyPropertyChanged();
1173 /// The counter clockwise focusable view by rotary wheel.<br />
1174 /// This will return null if not set.<br />
1175 /// This will also return null if the specified counter clockwise focusable view is not on a window.<br />
1177 [EditorBrowsable(EditorBrowsableState.Never)]
1178 public View CounterClockwiseFocusableView
1180 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
1183 return (View)GetValue(CounterClockwiseFocusableViewProperty);
1187 SetValue(CounterClockwiseFocusableViewProperty, value);
1188 NotifyPropertyChanged();
1193 /// Whether the view should be focusable by keyboard navigation.
1195 /// <since_tizen> 3 </since_tizen>
1196 public bool Focusable
1200 SetValue(FocusableProperty, value);
1201 NotifyPropertyChanged();
1205 return (bool)GetValue(FocusableProperty);
1210 /// 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.
1211 /// Note : Default value is true.
1213 [EditorBrowsable(EditorBrowsableState.Never)]
1214 public bool FocusableChildren
1218 SetValue(FocusableChildrenProperty, value);
1219 NotifyPropertyChanged();
1223 return (bool)GetValue(FocusableChildrenProperty);
1228 /// Whether this view can focus by touch.
1229 /// If Focusable is false, FocusableInTouch is disabled.
1230 /// If you want to have focus on touch, you need to set both Focusable and FocusableInTouch settings to true.
1232 [EditorBrowsable(EditorBrowsableState.Never)]
1233 public bool FocusableInTouch
1237 SetValue(FocusableInTouchProperty, value);
1238 NotifyPropertyChanged();
1242 return (bool)GetValue(FocusableInTouchProperty);
1247 /// Retrieves the position of the view.
1248 /// The coordinates are relative to the view's parent.
1251 /// The <see cref="Size"/>, <see cref="Position"/>, <see cref="Color"/>, and <see cref="Scale"/> properties are set in the main thread.
1252 /// 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).
1253 /// However, <see cref="CurrentSize"/>, <see cref="CurrentPosition"/>, <see cref="CurrentColor"/>, and <see cref="CurrentScale"/> properties are updated in real time,
1254 /// and users can get the current actual values through them.
1256 /// <since_tizen> 3 </since_tizen>
1257 public Position CurrentPosition
1261 return GetCurrentPosition();
1266 /// Sets the size of a view for the width and the height.<br />
1267 /// Geometry can be scaled to fit within this area.<br />
1268 /// This does not interfere with the view's scale factor.<br />
1269 /// The views default depth is the minimum of width and height.<br />
1272 /// The property cascade chaining set is not recommended.
1275 /// This way is recommended for setting the property
1277 /// var view = new View();
1278 /// view.Size2D = new Size2D(100, 200);
1280 /// This way to set the property is prohibited
1282 /// view.Size2D.Width = 100; //This does not guarantee a proper operation
1285 /// <since_tizen> 3 </since_tizen>
1286 public Size2D Size2D
1290 var temp = (Size2D)GetValue(Size2DProperty);
1292 if (this.Layout == null)
1294 if (temp.Width < 0) { temp.Width = 0; }
1295 if (temp.Height < 0) { temp.Height = 0; }
1302 SetValue(Size2DProperty, value);
1304 NotifyPropertyChanged();
1309 /// Retrieves the size of the view.
1310 /// The coordinates are relative to the view's parent.
1313 /// The <see cref="Size"/>, <see cref="Position"/>, <see cref="Color"/>, and <see cref="Scale"/> properties are set in the main thread.
1314 /// 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).
1315 /// However, <see cref="CurrentSize"/>, <see cref="CurrentPosition"/>, <see cref="CurrentColor"/>, and <see cref="CurrentScale"/> properties are updated in real time,
1316 /// and users can get the current actual values through them.
1318 /// <since_tizen> 3 </since_tizen>
1319 public Size2D CurrentSize
1323 return GetCurrentSize();
1328 /// Retrieves and sets the view's opacity.<br />
1332 /// Animatable - This property can be animated using <c>Animation</c> class.
1334 /// animation.AnimateTo(view, "Opacity", 0.5f);
1338 /// <since_tizen> 3 </since_tizen>
1339 public float Opacity
1343 return (float)GetValue(OpacityProperty);
1347 SetValue(OpacityProperty, value);
1348 NotifyPropertyChanged();
1353 /// Sets the position of the view for X and Y.<br />
1354 /// By default, sets the position vector between the parent origin and the pivot point (default).<br />
1355 /// If the position inheritance is disabled, sets the world position.<br />
1358 /// The property cascade chaining set is not recommended.
1361 /// This way is recommended for setting the property
1363 /// var view = new View();
1364 /// view.Position2D = new Position2D(100, 200);
1366 /// This way to set the property is prohibited
1368 /// view.Position2D.X = 100; //This does not guarantee a proper operation
1371 /// <since_tizen> 3 </since_tizen>
1372 public Position2D Position2D
1376 return (Position2D)GetValue(Position2DProperty);
1380 SetValue(Position2DProperty, value);
1381 NotifyPropertyChanged();
1386 /// Retrieves the screen position of the view.<br />
1388 /// <since_tizen> 3 </since_tizen>
1389 public Vector2 ScreenPosition
1393 return GetCurrentScreenPosition();
1398 /// Retrieves the screen position and size of the view.<br />
1401 /// The float type Rectangle class is not ready yet.
1402 /// Therefore, it transmits data in Vector4 class.
1403 /// This type should later be changed to the appropriate data type.
1405 [EditorBrowsable(EditorBrowsableState.Never)]
1406 public Vector4 ScreenPositionSize
1410 return GetCurrentScreenPositionSize();
1415 /// Determines whether the pivot point should be used to determine the position of the view.
1416 /// This is false by default.
1418 /// <remarks>If false, then the top-left of the view is used for the position.
1419 /// Setting this to false will allow scaling or rotation around the pivot point without affecting the view's position.
1421 /// <since_tizen> 3 </since_tizen>
1422 public bool PositionUsesPivotPoint
1426 return (bool)GetValue(PositionUsesPivotPointProperty);
1430 SetValue(PositionUsesPivotPointProperty, value);
1431 NotifyPropertyChanged();
1436 /// This has been deprecated in API5 and Will be removed in API8. Use PositionUsesPivotPoint instead.
1438 /// <since_tizen> 3 </since_tizen>
1439 [Obsolete("This has been deprecated in API5 and will be removed in API8. Use PositionUsesPivotPoint instead. " +
1441 "View view = new View(); " +
1442 "view.PivotPoint = PivotPoint.Center; " +
1443 "view.PositionUsesPivotPoint = true;" +
1444 " This has been deprecated in API5 and will be removed in API8")]
1445 [EditorBrowsable(EditorBrowsableState.Never)]
1446 public bool PositionUsesAnchorPoint
1450 return (bool)GetValue(PositionUsesAnchorPointProperty);
1454 SetValue(PositionUsesAnchorPointProperty, value);
1458 private bool InternalPositionUsesAnchorPoint
1462 return Object.InternalGetPropertyBool(SwigCPtr, View.Property.PositionUsesAnchorPoint);
1466 Object.InternalSetPropertyBool(SwigCPtr, View.Property.PositionUsesAnchorPoint, value);
1467 NotifyPropertyChanged();
1472 /// Queries whether the view is connected to the stage.<br />
1473 /// When a view is connected, it will be directly or indirectly parented to the root view.<br />
1475 /// <since_tizen> 3 </since_tizen>
1476 public bool IsOnWindow
1485 /// Gets the depth in the hierarchy for the view.
1487 /// <since_tizen> 3 </since_tizen>
1488 public int HierarchyDepth
1492 return GetHierarchyDepth();
1497 /// Sets the sibling order of the view so the depth position can be defined within the same parent.
1500 /// Note the initial value is 0. SiblingOrder should be bigger than 0 or equal to 0.
1501 /// Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove, and LowerBelow will override the sibling order.
1502 /// The values set by this property will likely change.
1504 /// <since_tizen> 3 </since_tizen>
1505 public int SiblingOrder
1509 return (int)GetValue(SiblingOrderProperty);
1513 SetValue(SiblingOrderProperty, value);
1515 Layout?.ChangeLayoutSiblingOrder(value);
1517 NotifyPropertyChanged();
1522 /// Returns the natural size of the view.
1525 /// Deriving classes stipulate the natural size and by default a view has a zero natural size.
1527 /// <since_tizen> 5 </since_tizen>
1528 public Vector3 NaturalSize
1532 Vector3 ret = GetNaturalSize();
1533 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
1539 /// Returns the natural size (Size2D) of the view.
1542 /// Deriving classes stipulate the natural size and by default a view has a zero natural size.
1544 /// <since_tizen> 4 </since_tizen>
1545 public Size2D NaturalSize2D
1549 Vector3 temp = GetNaturalSize();
1550 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
1554 sz = new Size2D((int)temp.Width, (int)temp.Height);
1562 /// Gets or sets the origin of a view within its parent's area.<br />
1563 /// 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 />
1564 /// The default parent-origin is ParentOrigin.TopLeft (0.0, 0.0, 0.5).<br />
1565 /// A view's position is the distance between this origin and the view's anchor-point.<br />
1567 /// <pre>The view has been initialized.</pre>
1568 /// <since_tizen> 3 </since_tizen>
1569 public Position ParentOrigin
1573 Position tmp = (Position)GetValue(ParentOriginProperty);
1574 return new Position(OnParentOriginChanged, tmp.X, tmp.Y, tmp.Z);
1578 SetValue(ParentOriginProperty, value);
1579 NotifyPropertyChanged();
1584 /// Gets or sets the anchor-point of a view.<br />
1585 /// 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 />
1586 /// The default pivot point is PivotPoint.Center (0.5, 0.5, 0.5).<br />
1587 /// A view position is the distance between its parent-origin and this anchor-point.<br />
1588 /// A view's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.<br />
1589 /// <pre>The view has been initialized.</pre>
1592 /// The property cascade chaining set is not recommended.
1595 /// This way is recommended for setting the property
1597 /// var view = new View();
1598 /// view.PivotPoint = PivotPoint.Center;
1600 /// This way to set the property is prohibited
1602 /// view.PivotPoint.X = 0.5f; //This does not guarantee a proper operation
1605 /// <since_tizen> 3 </since_tizen>
1606 public Position PivotPoint
1610 return (Position)GetValue(PivotPointProperty);
1614 SetValue(PivotPointProperty, value);
1615 NotifyPropertyChanged();
1620 /// Gets or sets the size width of the view.
1624 /// Animatable - This property can be animated using <c>Animation</c> class.
1626 /// animation.AnimateTo(view, "SizeWidth", 500.0f);
1630 /// <since_tizen> 3 </since_tizen>
1631 public float SizeWidth
1635 return (float)GetValue(SizeWidthProperty);
1639 SetValue(SizeWidthProperty, value);
1640 NotifyPropertyChanged();
1645 /// Gets or sets the size height of the view.
1649 /// Animatable - This property can be animated using <c>Animation</c> class.
1652 /// animation.AnimateTo(view, "SizeHeight", 500.0f);
1655 /// <since_tizen> 3 </since_tizen>
1656 public float SizeHeight
1660 return (float)GetValue(SizeHeightProperty);
1664 SetValue(SizeHeightProperty, value);
1665 NotifyPropertyChanged();
1670 /// Gets or sets the position of the view.<br />
1671 /// By default, sets the position vector between the parent origin and pivot point (default).<br />
1672 /// If the position inheritance is disabled, sets the world position.<br />
1676 /// Animatable - This property can be animated using <c>Animation</c> class.
1678 /// animation.AnimateTo(view, "Position", new Position(50, 0));
1681 /// The property cascade chaining set is not recommended.
1684 /// This way is recommended for setting the property
1686 /// var view = new View();
1687 /// view.Position = new Position(100, 200.5f, 0);
1689 /// This way to set the property is prohibited
1691 /// view.Position.Y = 200.5f; //This does not guarantee a proper operation
1694 /// <since_tizen> 3 </since_tizen>
1695 public Position Position
1699 return (Position)GetValue(PositionProperty);
1703 SetValue(PositionProperty, value);
1704 NotifyPropertyChanged();
1709 /// Gets or sets the position X of the view.
1713 /// Animatable - This property can be animated using <c>Animation</c> class.
1715 /// animation.AnimateTo(view, "PositionX", 50.0f);
1719 /// <since_tizen> 3 </since_tizen>
1720 public float PositionX
1724 return (float)GetValue(PositionXProperty);
1728 SetValue(PositionXProperty, value);
1729 NotifyPropertyChanged();
1734 /// Gets or sets the position Y of the view.
1738 /// Animatable - This property can be animated using <c>Animation</c> class.
1740 /// animation.AnimateTo(view, "PositionY", 50.0f);
1744 /// <since_tizen> 3 </since_tizen>
1745 public float PositionY
1749 return (float)GetValue(PositionYProperty);
1753 SetValue(PositionYProperty, value);
1754 NotifyPropertyChanged();
1759 /// Gets or sets the position Z of the view.
1763 /// Animatable - This property can be animated using <c>Animation</c> class.
1765 /// animation.AnimateTo(view, "PositionZ", 50.0f);
1769 /// <since_tizen> 3 </since_tizen>
1770 public float PositionZ
1774 return (float)GetValue(PositionZProperty);
1778 SetValue(PositionZProperty, value);
1779 NotifyPropertyChanged();
1784 /// Gets or sets the world position of the view.
1786 /// <since_tizen> 3 </since_tizen>
1787 public Vector3 WorldPosition
1791 return GetCurrentWorldPosition();
1796 /// Gets or sets the orientation of the view.<br />
1797 /// The view's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.<br />
1801 /// This is an asynchronous method.
1804 /// Animatable - This property can be animated using <c>Animation</c> class.
1806 /// animation.AnimateTo(view, "Orientation", new Rotation(new Radian((float)Math.PI), Vector3.XAxis));
1810 /// <since_tizen> 3 </since_tizen>
1811 public Rotation Orientation
1815 return (Rotation)GetValue(OrientationProperty);
1819 SetValue(OrientationProperty, value);
1820 NotifyPropertyChanged();
1825 /// Gets or sets the world orientation of the view.<br />
1827 /// <since_tizen> 3 </since_tizen>
1828 public Rotation WorldOrientation
1832 Rotation temp = new Rotation();
1833 var pValue = GetProperty(View.Property.WorldOrientation);
1841 /// Gets or sets the scale factor applied to the view.<br />
1845 /// Animatable - This property can be animated using <c>Animation</c> class.
1847 /// animation.AnimateTo(view, "Scale", new Vector3(1.5f, 1.5f, 1.0f));
1850 /// The property cascade chaining set is not recommended.
1853 /// This way is recommended for setting the property
1855 /// var view = new View();
1856 /// view.Scale = new Vector3(1.5f, 2.0f, 1.0f);
1858 /// This way to set the property is prohibited
1860 /// view.Scale.Width = 1.5f; //This does not guarantee a proper operation
1863 /// <since_tizen> 3 </since_tizen>
1864 public Vector3 Scale
1868 return (Vector3)GetValue(ScaleProperty);
1872 SetValue(ScaleProperty, value);
1873 NotifyPropertyChanged();
1878 /// Gets or sets the scale X factor applied to the view.
1882 /// Animatable - This property can be animated using <c>Animation</c> class.
1884 /// animation.AnimateTo(view, "ScaleX", 1.5f);
1888 /// <since_tizen> 3 </since_tizen>
1893 return (float)GetValue(ScaleXProperty);
1897 SetValue(ScaleXProperty, value);
1898 NotifyPropertyChanged();
1903 /// Gets or sets the scale Y factor applied to the view.
1907 /// Animatable - This property can be animated using <c>Animation</c> class.
1909 /// animation.AnimateTo(view, "ScaleY", 1.5f);
1913 /// <since_tizen> 3 </since_tizen>
1918 return (float)GetValue(ScaleYProperty);
1922 SetValue(ScaleYProperty, value);
1923 NotifyPropertyChanged();
1928 /// Gets or sets the scale Z factor applied to the view.
1932 /// Animatable - This property can be animated using <c>Animation</c> class.
1934 /// animation.AnimateTo(view, "ScaleZ", 1.5f);
1938 /// <since_tizen> 3 </since_tizen>
1943 return (float)GetValue(ScaleZProperty);
1947 SetValue(ScaleZProperty, value);
1948 NotifyPropertyChanged();
1953 /// Gets the world scale of the view.
1955 /// <since_tizen> 3 </since_tizen>
1956 public Vector3 WorldScale
1960 return GetCurrentWorldScale();
1965 /// Retrieves the visibility flag of the view.
1969 /// If the view is not visible, then the view and its children will not be rendered.
1970 /// 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.
1973 /// Animatable - This property can be animated using <c>Animation</c> class.
1975 /// animation.AnimateTo(view, "Visibility", false);
1979 /// <since_tizen> 3 </since_tizen>
1980 public bool Visibility
1984 return Object.InternalGetPropertyBool(SwigCPtr, View.Property.VISIBLE);
1989 /// Gets the view's world color.
1991 /// <since_tizen> 3 </since_tizen>
1992 public Vector4 WorldColor
1996 return GetCurrentWorldColor();
2001 /// Gets or sets the view's name.
2003 /// <since_tizen> 3 </since_tizen>
2008 return (string)GetValue(NameProperty);
2012 SetValue(NameProperty, value);
2013 NotifyPropertyChanged();
2018 /// Get the number of children held by the view.
2020 /// <since_tizen> 3 </since_tizen>
2021 public new uint ChildCount
2025 return Convert.ToUInt32(Children.Count);
2030 /// Gets the view's ID.
2033 /// <since_tizen> 3 </since_tizen>
2043 /// Gets or sets the status of whether the view should emit touch or hover signals.
2044 /// If a View is made insensitive, then the View and its children are not hittable.
2046 /// <since_tizen> 3 </since_tizen>
2047 public bool Sensitive
2051 return (bool)GetValue(SensitiveProperty);
2055 SetValue(SensitiveProperty, value);
2056 NotifyPropertyChanged();
2061 /// Gets or sets the status of whether the view should be enabled user interactions.
2062 /// If a View is made disabled, then user interactions including touch, focus, and actiavation is disabled.
2064 /// <since_tizen> tizen_next </since_tizen>
2065 [EditorBrowsable(EditorBrowsableState.Never)]
2066 public bool IsEnabled
2070 return (bool)GetValue(IsEnabledProperty);
2074 SetValue(IsEnabledProperty, value);
2075 NotifyPropertyChanged();
2080 /// 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.
2082 /// <since_tizen> 3 </since_tizen>
2083 public bool LeaveRequired
2087 return (bool)GetValue(LeaveRequiredProperty);
2091 SetValue(LeaveRequiredProperty, value);
2092 NotifyPropertyChanged();
2097 /// Gets or sets the status of whether a child view inherits it's parent's orientation.
2099 /// <since_tizen> 3 </since_tizen>
2100 public bool InheritOrientation
2104 return (bool)GetValue(InheritOrientationProperty);
2108 SetValue(InheritOrientationProperty, value);
2109 NotifyPropertyChanged();
2114 /// Gets or sets the status of whether a child view inherits it's parent's scale.
2116 /// <since_tizen> 3 </since_tizen>
2117 public bool InheritScale
2121 return (bool)GetValue(InheritScaleProperty);
2125 SetValue(InheritScaleProperty, value);
2126 NotifyPropertyChanged();
2131 /// Gets or sets the status of how the view and its children should be drawn.<br />
2132 /// Not all views are renderable, but DrawMode can be inherited from any view.<br />
2133 /// 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 />
2134 /// If DrawMode.Overlay2D is used, the view and its children will be drawn as a 2D overlay.<br />
2135 /// Overlay views are drawn in a separate pass, after all non-overlay views within the layer.<br />
2136 /// For overlay views, the drawing order is with respect to tree levels of views, and depth-testing will not be used.<br />
2138 /// <since_tizen> 3 </since_tizen>
2139 public DrawModeType DrawMode
2143 return (DrawModeType)GetValue(DrawModeProperty);
2147 SetValue(DrawModeProperty, value);
2148 NotifyPropertyChanged();
2153 /// Gets or sets the relative to parent size factor of the view.<br />
2154 /// This factor is only used when ResizePolicyType is set to either: ResizePolicyType.SizeRelativeToParent or ResizePolicyType.SizeFixedOffsetFromParent.<br />
2155 /// This view's size is set to the view's size multiplied by or added to this factor, depending on ResizePolicyType.<br />
2158 /// The property cascade chaining set is not recommended.
2161 /// This way is recommended for setting the property
2163 /// var text = new TextField();
2164 /// text.SizeModeFactor = new Vector3(1.0f, 0.45f, 1.0f);
2166 /// This way to set the property is prohibited
2168 /// text.SizeModeFactor.Width = 1.0f; //This does not guarantee a proper operation
2171 /// <since_tizen> 3 </since_tizen>
2172 public Vector3 SizeModeFactor
2176 return (Vector3)GetValue(SizeModeFactorProperty);
2180 SetValue(SizeModeFactorProperty, value);
2181 NotifyPropertyChanged();
2186 /// Gets or sets the width resize policy to be used.
2188 /// <since_tizen> 3 </since_tizen>
2189 public ResizePolicyType WidthResizePolicy
2193 return (ResizePolicyType)GetValue(WidthResizePolicyProperty);
2197 SetValue(WidthResizePolicyProperty, value);
2198 NotifyPropertyChanged();
2203 /// Gets or sets the height resize policy to be used.
2205 /// <since_tizen> 3 </since_tizen>
2206 public ResizePolicyType HeightResizePolicy
2210 return (ResizePolicyType)GetValue(HeightResizePolicyProperty);
2214 SetValue(HeightResizePolicyProperty, value);
2215 NotifyPropertyChanged();
2220 /// Gets or sets the policy to use when setting size with size negotiation.<br />
2221 /// Defaults to SizeScalePolicyType.UseSizeSet.<br />
2223 /// <since_tizen> 3 </since_tizen>
2224 public SizeScalePolicyType SizeScalePolicy
2228 return (SizeScalePolicyType)GetValue(SizeScalePolicyProperty);
2232 SetValue(SizeScalePolicyProperty, value);
2233 NotifyPropertyChanged();
2238 /// Gets or sets the status of whether the width size is dependent on the height size.
2240 /// <since_tizen> 3 </since_tizen>
2241 public bool WidthForHeight
2245 return (bool)GetValue(WidthForHeightProperty);
2249 SetValue(WidthForHeightProperty, value);
2250 NotifyPropertyChanged();
2255 /// Gets or sets the status of whether the height size is dependent on the width size.
2257 /// <since_tizen> 3 </since_tizen>
2258 public bool HeightForWidth
2262 return (bool)GetValue(HeightForWidthProperty);
2266 SetValue(HeightForWidthProperty, value);
2267 NotifyPropertyChanged();
2272 /// Gets or sets the padding for use in layout.
2275 /// The property cascade chaining set is not recommended.
2278 /// This way is recommended for setting the property
2280 /// var view = new View();
2281 /// view.Padding = new Extents(5, 5, 5, 5);
2283 /// This way to set the property is prohibited
2285 /// view.Padding.Start = 5; //This does not guarantee a proper operation
2288 /// <since_tizen> 5 </since_tizen>
2289 public Extents Padding
2293 return (Extents)GetValue(PaddingProperty);
2297 SetValue(PaddingProperty, value);
2298 NotifyPropertyChanged();
2303 /// Gets or sets the minimum size the view can be assigned in size negotiation.
2305 /// <exception cref="ArgumentNullException"> Thrown when value is null. </exception>
2307 /// The property cascade chaining set is not recommended.
2310 /// This way is recommended for setting the property
2312 /// var view = new View();
2313 /// view.MinimumSize = new Size2D(100, 200);
2315 /// This way to set the property is prohibited
2317 /// view.MinimumSize.Width = 100; //This does not guarantee a proper operation
2320 /// <since_tizen> 3 </since_tizen>
2321 public Size2D MinimumSize
2325 return (Size2D)GetValue(MinimumSizeProperty);
2331 throw new ArgumentNullException(nameof(value));
2335 // Note: it only works if minimum size is >= than natural size.
2336 // To force the size it should be done through the width&height spec or Size2D.
2337 layout.MinimumWidth = new Tizen.NUI.LayoutLength(value.Width);
2338 layout.MinimumHeight = new Tizen.NUI.LayoutLength(value.Height);
2339 layout.RequestLayout();
2341 SetValue(MinimumSizeProperty, value);
2342 NotifyPropertyChanged();
2347 /// Gets or sets the maximum size the view can be assigned in size negotiation.
2350 /// This way is recommended for setting the property
2352 /// var view = new View();
2353 /// view.MaximumSize = new Size2D(100, 200);
2355 /// This way to set the property is prohibited
2357 /// view.MaximumSize.Height = 200; //This does not guarantee a proper operation
2360 /// <since_tizen> 3 </since_tizen>
2361 public Size2D MaximumSize
2365 return (Size2D)GetValue(MaximumSizeProperty);
2369 // We don't have Layout.Maximum(Width|Height) so we cannot apply it to layout.
2370 // MATCH_PARENT spec + parent container size can be used to limit
2373 layout.RequestLayout();
2375 SetValue(MaximumSizeProperty, value);
2376 NotifyPropertyChanged();
2381 /// Gets or sets whether a child view inherits it's parent's position.<br />
2382 /// Default is to inherit.<br />
2383 /// 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 />
2385 /// <since_tizen> 3 </since_tizen>
2386 public bool InheritPosition
2390 return (bool)GetValue(InheritPositionProperty);
2394 SetValue(InheritPositionProperty, value);
2395 NotifyPropertyChanged();
2400 /// Gets or sets the clipping behavior (mode) of it's children.
2402 /// <since_tizen> 3 </since_tizen>
2403 public ClippingModeType ClippingMode
2407 return (ClippingModeType)GetValue(ClippingModeProperty);
2411 SetValue(ClippingModeProperty, value);
2412 NotifyPropertyChanged();
2417 /// Gets the number of renderers held by the view.
2419 /// <since_tizen> 3 </since_tizen>
2420 public uint RendererCount
2424 return GetRendererCount();
2429 /// This has been deprecated in API5 and will be removed in API8. Use PivotPoint instead.
2432 /// The property cascade chaining set is possible. For example, this (view.AnchorPoint.X = 0.1f;) is possible.
2434 /// <since_tizen> 3 </since_tizen>
2435 [Obsolete("This has been deprecated in API5 and will be removed in API8. Use PivotPoint instead. " +
2437 "View view = new View(); " +
2438 "view.PivotPoint = PivotPoint.Center; " +
2439 "view.PositionUsesPivotPoint = true;")]
2440 [EditorBrowsable(EditorBrowsableState.Never)]
2441 public Position AnchorPoint
2445 return GetValue(AnchorPointProperty) as Position;
2449 SetValue(AnchorPointProperty, value);
2453 private Position InternalAnchorPoint
2457 return GetCurrentAnchorPoint();
2461 SetAnchorPoint(value);
2462 NotifyPropertyChanged();
2467 /// Sets the size of a view for the width, the height and the depth.<br />
2468 /// Geometry can be scaled to fit within this area.<br />
2469 /// This does not interfere with the view's scale factor.<br />
2470 /// The views default depth is the minimum of width and height.<br />
2474 /// Animatable - This property can be animated using <c>Animation</c> class.
2476 /// animation.AnimateTo(view, "Size", new Size(100, 100));
2479 /// The property cascade chaining set is not recommended.
2482 /// This way is recommended for setting the property
2484 /// var view = new View();
2485 /// view.Size = new Size(100.5f, 200, 0);
2487 /// This way to set the property is prohibited
2489 /// view.Size.Width = 100.5f; //This does not guarantee a proper operation
2492 /// <since_tizen> 5 </since_tizen>
2497 return (Size)GetValue(SizeProperty);
2501 SetValue(SizeProperty, value);
2502 NotifyPropertyChanged();
2507 /// This has been deprecated in API5 and will be removed in API8. Use 'Container GetParent() for derived class' instead.
2509 /// <since_tizen> 3 </since_tizen>
2510 [Obsolete("This has been deprecated in API5 and will be removed in API8. Use 'Container GetParent() for derived class' instead. " +
2512 "Container parent = view.GetParent(); " +
2513 "View view = parent as View;")]
2514 [EditorBrowsable(EditorBrowsableState.Never)]
2515 public new View Parent
2520 IntPtr cPtr = Interop.Actor.GetParent(SwigCPtr);
2521 HandleRef CPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
2522 BaseHandle basehandle = Registry.GetManagedBaseHandleFromNativePtr(CPtr.Handle);
2524 if (basehandle is Layer layer)
2526 ret = new View(Layer.getCPtr(layer).Handle, false);
2527 NUILog.Error("This Parent property is deprecated, should do not be used");
2531 ret = basehandle as View;
2534 Interop.BaseHandle.DeleteBaseHandle(CPtr);
2535 CPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
2537 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
2543 /// Gets/Sets whether inherit parent's the layout Direction.
2545 /// <since_tizen> 4 </since_tizen>
2546 public bool InheritLayoutDirection
2550 return (bool)GetValue(InheritLayoutDirectionProperty);
2554 SetValue(InheritLayoutDirectionProperty, value);
2555 NotifyPropertyChanged();
2560 /// Gets/Sets the layout Direction.
2562 /// <since_tizen> 4 </since_tizen>
2563 public ViewLayoutDirectionType LayoutDirection
2567 return (ViewLayoutDirectionType)GetValue(LayoutDirectionProperty);
2571 SetValue(LayoutDirectionProperty, value);
2572 NotifyPropertyChanged();
2573 layout?.RequestLayout();
2578 /// Gets or sets the Margin for use in layout.
2581 /// Margin property is supported by Layout algorithms and containers.
2582 /// Please Set Layout if you want to use Margin property.
2583 /// The property cascade chaining set is not recommended.
2586 /// This way is recommended for setting the property
2588 /// var view = new View();
2589 /// view.Margin = new Extents(10, 5, 15, 20);
2591 /// This way to set the property is prohibited
2593 /// view.Margin.Top = 15; //This does not guarantee a proper operation
2596 /// <since_tizen> 4 </since_tizen>
2597 public Extents Margin
2601 return (Extents)GetValue(MarginProperty);
2605 SetValue(MarginProperty, value);
2606 NotifyPropertyChanged();
2611 /// The required policy for this dimension, <see cref="LayoutParamPolicies"/> values or exact value.
2615 /// // matchParentView matches its size to its parent size.
2616 /// matchParentView.WidthSpecification = LayoutParamPolicies.MatchParent;
2617 /// matchParentView.HeightSpecification = LayoutParamPolicies.MatchParent;
2619 /// // wrapContentView wraps its children with their desired size.
2620 /// wrapContentView.WidthSpecification = LayoutParamPolicies.WrapContent;
2621 /// wrapContentView.HeightSpecification = LayoutParamPolicies.WrapContent;
2623 /// // exactSizeView shows itself with an exact size.
2624 /// exactSizeView.WidthSpecification = 100;
2625 /// exactSizeView.HeightSpecification = 100;
2628 /// <since_tizen> 6 </since_tizen>
2629 [Binding.TypeConverter(typeof(IntGraphicsTypeConverter))]
2630 public int WidthSpecification
2634 return (int)GetValue(WidthSpecificationProperty);
2638 SetValue(WidthSpecificationProperty, value);
2639 NotifyPropertyChanged();
2643 private int InternalWidthSpecification
2651 if (value == widthPolicy)
2654 widthPolicy = value;
2655 if (widthPolicy >= 0)
2657 SizeWidth = widthPolicy;
2659 layout?.RequestLayout();
2664 /// The required policy for this dimension, <see cref="LayoutParamPolicies"/> values or exact value.
2668 /// // matchParentView matches its size to its parent size.
2669 /// matchParentView.WidthSpecification = LayoutParamPolicies.MatchParent;
2670 /// matchParentView.HeightSpecification = LayoutParamPolicies.MatchParent;
2672 /// // wrapContentView wraps its children with their desired size.
2673 /// wrapContentView.WidthSpecification = LayoutParamPolicies.WrapContent;
2674 /// wrapContentView.HeightSpecification = LayoutParamPolicies.WrapContent;
2676 /// // exactSizeView shows itself with an exact size.
2677 /// exactSizeView.WidthSpecification = 100;
2678 /// exactSizeView.HeightSpecification = 100;
2681 /// <since_tizen> 6 </since_tizen>
2682 [Binding.TypeConverter(typeof(IntGraphicsTypeConverter))]
2683 public int HeightSpecification
2687 return (int)GetValue(HeightSpecificationProperty);
2691 SetValue(HeightSpecificationProperty, value);
2692 NotifyPropertyChanged();
2696 private int InternalHeightSpecification
2700 return heightPolicy;
2704 if (value == heightPolicy)
2707 heightPolicy = value;
2708 if (heightPolicy >= 0)
2710 SizeHeight = heightPolicy;
2712 layout?.RequestLayout();
2717 /// Gets the List of transitions for this View.
2719 /// <since_tizen> 6 </since_tizen>
2720 public Dictionary<TransitionCondition, TransitionList> LayoutTransitions
2724 if (layoutTransitions == null)
2726 layoutTransitions = new Dictionary<TransitionCondition, TransitionList>();
2728 return layoutTransitions;
2733 /// Sets a layout transitions for this View.
2735 /// <exception cref="ArgumentNullException"> Thrown when value is null. </exception>
2737 /// Use LayoutTransitions to receive a collection of LayoutTransitions set on the View.
2739 /// <since_tizen> 6 </since_tizen>
2740 public LayoutTransition LayoutTransition
2744 return GetValue(LayoutTransitionProperty) as LayoutTransition;
2748 SetValue(LayoutTransitionProperty, value);
2749 NotifyPropertyChanged();
2753 private LayoutTransition InternalLayoutTransition
2757 return layoutTransition;
2763 throw new global::System.ArgumentNullException(nameof(value));
2765 if (layoutTransitions == null)
2767 layoutTransitions = new Dictionary<TransitionCondition, TransitionList>();
2770 LayoutTransitionsHelper.AddTransitionForCondition(layoutTransitions, value.Condition, value, true);
2772 AttachTransitionsToChildren(value);
2774 layoutTransition = value;
2779 /// This has been deprecated in API5 and will be removed in API8. Use Padding instead.
2782 /// The property cascade chaining set is possible. For example, this (view.DecorationBoundingBox.X = 0.1f;) is possible.
2784 /// <since_tizen> 4 </since_tizen>
2785 [Obsolete("This has been deprecated in API5 and will be removed in API8. Use Padding instead.")]
2786 [EditorBrowsable(EditorBrowsableState.Never)]
2787 public Extents PaddingEX
2791 return GetValue(PaddingEXProperty) as Extents;
2795 SetValue(PaddingEXProperty, value);
2799 private Extents InternalPaddingEX
2803 Extents temp = new Extents(0, 0, 0, 0);
2804 var pValue = GetProperty(View.Property.PADDING);
2807 Extents ret = new Extents(OnPaddingEXChanged, temp.Start, temp.End, temp.Top, temp.Bottom);
2813 var temp = new Tizen.NUI.PropertyValue(value);
2814 SetProperty(View.Property.PADDING, temp);
2816 NotifyPropertyChanged();
2817 layout?.RequestLayout();
2822 /// The Color of View. This is an RGBA value.
2823 /// Each RGBA components match as <see cref="ColorRed"/>, <see cref="ColorGreen"/>, <see cref="ColorBlue"/>, and <see cref="Opacity"/>.
2824 /// This property will multiply the final color of this view. (BackgroundColor, BorderlineColor, BackgroundImage, etc).
2825 /// For example, if view.BackgroundColor = Color.Yellow and view.Color = Color.Purple, this view will shown as Red.
2826 /// Inherient of color value depend on <see cref="ColorMode"/>.
2830 /// Animatable - This property can be animated using <c>Animation</c> class.
2832 /// The property cascade chaining set is not recommended.
2835 /// This way is recommended for setting the property
2837 /// var view = new View();
2838 /// view.Color = new Color(0.5f, 0.2f, 0.1f, 0.5f);
2840 /// This way to set the property is prohibited
2842 /// view.Color.A = 0.5f; //This does not guarantee a proper operation
2845 [EditorBrowsable(EditorBrowsableState.Never)]
2850 return (Color)GetValue(ColorProperty);
2854 SetValue(ColorProperty, value);
2855 NotifyPropertyChanged();
2860 /// The Red component of View.Color.
2864 /// Animatable - This property can be animated using <c>Animation</c> class.
2867 [EditorBrowsable(EditorBrowsableState.Never)]
2868 public float ColorRed
2872 return (float)GetValue(ColorRedProperty);
2876 SetValue(ColorRedProperty, value);
2877 NotifyPropertyChanged();
2882 /// The Green component of View.Color.
2886 /// Animatable - This property can be animated using <c>Animation</c> class.
2889 [EditorBrowsable(EditorBrowsableState.Never)]
2890 public float ColorGreen
2894 return (float)GetValue(ColorGreenProperty);
2898 SetValue(ColorGreenProperty, value);
2899 NotifyPropertyChanged();
2904 /// The Blue component of View.Color.
2908 /// Animatable - This property can be animated using <c>Animation</c> class.
2911 [EditorBrowsable(EditorBrowsableState.Never)]
2912 public float ColorBlue
2916 return (float)GetValue(ColorBlueProperty);
2920 SetValue(ColorBlueProperty, value);
2921 NotifyPropertyChanged();
2926 /// Set the layout on this View. Replaces any existing Layout.
2929 /// If this Layout is set as null explicitly, it means this View itself and it's child Views will not use Layout anymore.
2931 /// <since_tizen> 6 </since_tizen>
2932 public LayoutItem Layout
2936 return GetValue(LayoutProperty) as LayoutItem;
2940 SetValue(LayoutProperty, value);
2944 private LayoutItem InternalLayout
2952 // Do nothing if layout provided is already set on this View.
2953 if (value == layout)
2958 LayoutingDisabled = false;
2961 // If new layout being set already has a owner then that owner receives a replacement default layout.
2962 // First check if the layout to be set already has a owner.
2963 if (value?.Owner != null)
2965 // Previous owner of the layout gets a default layout as a replacement.
2966 value.Owner.Layout = new AbsoluteLayout()
2968 // Copy Margin and Padding to replacement LayoutGroup.
2969 Margin = value.Margin,
2970 Padding = value.Padding,
2974 // Copy Margin and Padding to new layout being set or restore padding and margin back to
2975 // View if no replacement. Previously margin and padding values would have been moved from
2976 // the View to the layout.
2977 if (layout != null) // Existing layout
2981 // Existing layout being replaced so copy over margin and padding values.
2982 value.Margin = layout.Margin;
2983 value.Padding = layout.Padding;
2984 value.SetPositionByLayout = !excludeLayouting;
2988 // Layout not being replaced so restore margin and padding to View.
2989 SetValue(MarginProperty, layout.Margin);
2990 SetValue(PaddingProperty, layout.Padding);
2991 NotifyPropertyChanged();
2996 // First Layout to be added to the View hence copy
2998 // Do not try to set Margins or Padding on a null Layout (when a layout is being removed from a View)
3001 Extents margin = Margin;
3002 Extents padding = Padding;
3003 bool setMargin = false;
3004 bool setPadding = false;
3006 if (margin.Top != 0 || margin.Bottom != 0 || margin.Start != 0 || margin.End != 0)
3008 // If View already has a margin set then store it in Layout instead.
3009 value.Margin = margin;
3010 SetValue(MarginProperty, new Extents(0, 0, 0, 0));
3014 if (padding.Top != 0 || padding.Bottom != 0 || padding.Start != 0 || padding.End != 0)
3016 // If View already has a padding set then store it in Layout instead.
3017 value.Padding = padding;
3018 SetValue(PaddingProperty, new Extents(0, 0, 0, 0));
3022 if (setMargin || setPadding)
3024 NotifyPropertyChanged();
3027 value.SetPositionByLayout = !excludeLayouting;
3031 // Remove existing layout from it's parent layout group.
3034 // Set layout to this view
3040 /// The weight of the View, used to share available space in a layout with siblings.
3042 /// <since_tizen> 6 </since_tizen>
3052 layout?.RequestLayout();
3057 /// Whether to load the BackgroundImage synchronously.
3058 /// If not specified, the default is false, i.e. the BackgroundImage is loaded asynchronously.
3059 /// Note: For Normal Quad images only.
3061 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
3062 [EditorBrowsable(EditorBrowsableState.Never)]
3063 public bool BackgroundImageSynchronosLoading
3067 return (bool)GetValue(BackgroundImageSynchronosLoadingProperty);
3071 SetValue(BackgroundImageSynchronosLoadingProperty, value);
3072 NotifyPropertyChanged();
3076 private bool InternalBackgroundImageSynchronosLoading
3080 return BackgroundImageSynchronousLoading;
3084 BackgroundImageSynchronousLoading = value;
3089 /// Whether to load the BackgroundImage synchronously.
3090 /// If not specified, the default is false, i.e. the BackgroundImage is loaded asynchronously.
3091 /// Note: For Normal Quad images only.
3093 /// This will be public opened in tizen_7.0 after ACR done. Before ACR, need to be hidden as inhouse API.
3094 [EditorBrowsable(EditorBrowsableState.Never)]
3095 public bool BackgroundImageSynchronousLoading
3099 return (bool)GetValue(BackgroundImageSynchronousLoadingProperty);
3103 SetValue(BackgroundImageSynchronousLoadingProperty, value);
3104 NotifyPropertyChanged();
3108 private bool InternalBackgroundImageSynchronousLoading
3112 return backgroundImageSynchronousLoading;
3116 backgroundImageSynchronousLoading = value;
3118 if (!string.IsNullOrEmpty(BackgroundImage))
3120 PropertyMap bgMap = this.Background;
3121 var temp = new PropertyValue(backgroundImageSynchronousLoading);
3122 bgMap[ImageVisualProperty.SynchronousLoading] = temp;
3129 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
3130 [EditorBrowsable(EditorBrowsableState.Never)]
3131 public Vector4 UpdateAreaHint
3135 return (Vector4)GetValue(UpdateAreaHintProperty);
3139 SetValue(UpdateAreaHintProperty, value);
3140 NotifyPropertyChanged();
3145 /// Enable/Disable ControlState propagation for children.
3146 /// It is false by default.
3147 /// If the View needs to share ControlState with descendants, please set it true.
3148 /// Please note that, changing the value will also changes children's EnableControlStatePropagation value recursively.
3150 [EditorBrowsable(EditorBrowsableState.Never)]
3151 public bool EnableControlStatePropagation
3155 return (bool)GetValue(EnableControlStatePropagationProperty);
3159 SetValue(EnableControlStatePropagationProperty, value);
3160 NotifyPropertyChanged();
3164 private bool InternalEnableControlStatePropagation
3166 get => themeData?.ControlStatePropagation ?? false;
3169 if (InternalEnableControlStatePropagation == value) return;
3171 if (themeData == null) themeData = new ThemeData();
3173 themeData.ControlStatePropagation = value;
3175 foreach (View child in Children)
3177 child.EnableControlStatePropagation = value;
3183 /// The ControlStates can propagate from the parent.
3184 /// Listed ControlStates will be accepted propagation of the parent ControlState changes
3185 /// if parent view EnableControlState is true.
3186 /// <see cref="EnableControlState"/>.
3187 /// Default is ControlState.All, so every ControlStates will be propagated from the parent.
3189 [EditorBrowsable(EditorBrowsableState.Never)]
3190 public ControlState PropagatableControlStates
3194 return (ControlState)GetValue(PropagatableControlStatesProperty);
3198 SetValue(PropagatableControlStatesProperty, value);
3199 NotifyPropertyChanged();
3203 private ControlState InternalPropagatableControlStates
3205 get => propagatableControlStates;
3206 set => propagatableControlStates = value;
3210 /// By default, it is false in View, true in Control.
3211 /// Note that if the value is true, the View will be a touch receptor.
3213 [EditorBrowsable(EditorBrowsableState.Never)]
3214 public bool EnableControlState
3218 return (bool)GetValue(EnableControlStateProperty);
3222 SetValue(EnableControlStateProperty, value);
3227 /// Whether the actor grab all touches even if touch leaves its boundary.
3229 /// <returns>true, if it grab all touch after start</returns>
3230 [EditorBrowsable(EditorBrowsableState.Never)]
3231 public bool GrabTouchAfterLeave
3235 return (bool)GetValue(GrabTouchAfterLeaveProperty);
3239 SetValue(GrabTouchAfterLeaveProperty, value);
3243 private bool InternalGrabTouchAfterLeave
3247 return Object.InternalGetPropertyBool(SwigCPtr, View.Property.CaptureAllTouchAfterStart);
3251 Object.InternalSetPropertyBool(SwigCPtr, View.Property.CaptureAllTouchAfterStart, value);
3253 // Use custom HitTest callback only if GrabTouchAfterLeave is true.
3256 RegisterHitTestCallback();
3260 UnregisterHitTestCallback();
3263 NotifyPropertyChanged();
3268 /// Whether the view will only receive own touch.
3270 /// <returns>true, if it only receives touches that started from itself.</returns>
3271 [EditorBrowsable(EditorBrowsableState.Never)]
3272 public bool AllowOnlyOwnTouch
3276 return (bool)GetValue(AllowOnlyOwnTouchProperty);
3280 SetValue(AllowOnlyOwnTouchProperty, value);
3284 private bool InternalAllowOnlyOwnTouch
3288 return Object.InternalGetPropertyBool(SwigCPtr, View.Property.AllowOnlyOwnTouch);
3292 Object.InternalSetPropertyBool(SwigCPtr, View.Property.AllowOnlyOwnTouch, value);
3293 NotifyPropertyChanged();
3298 /// Determines which blend equation will be used to render renderers of this actor.
3300 /// <returns>blend equation enum currently assigned</returns>
3301 /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API.
3302 [EditorBrowsable(EditorBrowsableState.Never)]
3303 public BlendEquationType BlendEquation
3307 return (BlendEquationType)GetValue(BlendEquationProperty);
3311 SetValue(BlendEquationProperty, value);
3315 private BlendEquationType InternalBlendEquation
3319 return (BlendEquationType)Object.InternalGetPropertyInt(SwigCPtr, View.Property.BlendEquation);
3323 Object.InternalSetPropertyInt(SwigCPtr, View.Property.BlendEquation, (int)value);
3324 NotifyPropertyChanged();
3329 /// If the value is true, the View will change its style as the theme changes.
3330 /// The default value is false in normal case but it can be true when the NUIApplication is created with <see cref="NUIApplication.ThemeOptions.ThemeChangeSensitive"/>.
3332 /// <since_tizen> 9 </since_tizen>
3333 public bool ThemeChangeSensitive
3335 get => (bool)GetValue(ThemeChangeSensitiveProperty);
3336 set => SetValue(ThemeChangeSensitiveProperty, value);
3340 /// Create Style, it is abstract function and must be override.
3342 [EditorBrowsable(EditorBrowsableState.Never)]
3343 protected virtual ViewStyle CreateViewStyle()
3345 return new ViewStyle();
3349 /// Called after the View's ControlStates changed.
3351 /// <param name="controlStateChangedInfo">The information including state changed variables.</param>
3352 [EditorBrowsable(EditorBrowsableState.Never)]
3353 protected virtual void OnControlStateChanged(ControlStateChangedEventArgs controlStateChangedInfo)
3359 [EditorBrowsable(EditorBrowsableState.Never)]
3360 protected virtual void OnThemeChanged(object sender, ThemeChangedEventArgs e)
3362 isThemeChanged = true;
3363 if (string.IsNullOrEmpty(styleName)) ApplyStyle(ThemeManager.GetUpdateStyleWithoutClone(GetType()));
3364 else ApplyStyle(ThemeManager.GetUpdateStyleWithoutClone(styleName));
3365 isThemeChanged = false;
3369 /// Apply style instance to the view.
3370 /// Basically it sets the bindable property to the value of the bindable property with same name in the style.
3372 /// <since_tizen> 9 </since_tizen>
3373 public virtual void ApplyStyle(ViewStyle viewStyle)
3375 if (viewStyle == null || themeData?.viewStyle == viewStyle) return;
3377 if (themeData == null) themeData = new ThemeData();
3379 themeData.viewStyle = viewStyle;
3381 if (viewStyle.DirtyProperties == null || viewStyle.DirtyProperties.Count == 0)
3387 BindableProperty.GetBindablePropertysOfType(GetType(), out var bindablePropertyOfView);
3389 if (bindablePropertyOfView == null)
3394 var dirtyStyleProperties = new BindableProperty[viewStyle.DirtyProperties.Count];
3395 viewStyle.DirtyProperties.CopyTo(dirtyStyleProperties);
3397 foreach (var sourceProperty in dirtyStyleProperties)
3399 var sourceValue = viewStyle.GetValue(sourceProperty);
3401 if (sourceValue == null)
3406 bindablePropertyOfView.TryGetValue(sourceProperty.PropertyName, out var destinationProperty);
3408 // Do not set value again when theme is changed and the value has been set already.
3409 if (isThemeChanged && ChangedPropertiesSetExcludingStyle.Contains(destinationProperty))
3414 if (destinationProperty != null)
3416 InternalSetValue(destinationProperty, sourceValue);
3422 /// Get whether the View is culled or not.
3423 /// True means that the View is out of the view frustum.
3426 /// Hidden-API (Inhouse-API).
3428 [EditorBrowsable(EditorBrowsableState.Never)]
3433 return Object.InternalGetPropertyBool(SwigCPtr, View.Property.Culled);
3438 /// Set or Get TransitionOptions for the page transition.
3439 /// This property is used to define how this view will be transitioned during Page switching.
3441 /// <since_tizen> 9 </since_tizen>
3442 public TransitionOptions TransitionOptions
3446 return GetValue(TransitionOptionsProperty) as TransitionOptions;
3450 SetValue(TransitionOptionsProperty, value);
3451 NotifyPropertyChanged();
3455 private TransitionOptions InternalTransitionOptions
3459 transitionOptions = value;
3463 return transitionOptions;
3468 /// Called when the view is hit through TouchEvent or GestureEvent.
3469 /// If it returns true, it means that it was hit, and the touch/gesture event is called from the view.
3470 /// If it returns false, it means that it will not be hit, and the hit-test continues to the next view.
3471 /// User can override whether hit or not in HitTest.
3472 /// You can get the coordinates relative to tthe top-left of the hit view by touch.GetLocalPosition(0).
3473 /// or you can get the coordinates relative to the top-left of the screen by touch.GetScreenPosition(0).
3475 // <param name="touch"><see cref="Tizen.NUI.Touch"/>The touch data</param>
3476 [EditorBrowsable(EditorBrowsableState.Never)]
3477 protected virtual bool HitTest(Touch touch)
3483 /// Retrieve the View's current Color.
3486 /// The <see cref="Size"/>, <see cref="Position"/>, <see cref="Color"/>, and <see cref="Scale"/> properties are set in the main thread.
3487 /// 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).
3488 /// However, <see cref="CurrentSize"/>, <see cref="CurrentPosition"/>, <see cref="CurrentColor"/>, and <see cref="CurrentScale"/> properties are updated in real time,
3489 /// and users can get the current actual values through them.
3491 [EditorBrowsable(EditorBrowsableState.Never)]
3492 public Color CurrentColor => GetCurrentColor();
3495 /// Retrieve the current scale factor applied to the View.
3498 /// The <see cref="Size"/>, <see cref="Position"/>, <see cref="Color"/>, and <see cref="Scale"/> properties are set in the main thread.
3499 /// 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).
3500 /// However, <see cref="CurrentSize"/>, <see cref="CurrentPosition"/>, <see cref="CurrentColor"/>, and <see cref="CurrentScale"/> properties are updated in real time,
3501 /// and users can get the current actual values through them.
3503 [EditorBrowsable(EditorBrowsableState.Never)]
3504 public Vector3 CurrentScale => GetCurrentScale();