2 * Copyright(c) 2021 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 internal BackgroundExtraData backgroundExtraData;
33 private bool layoutSet = false;
34 private LayoutItem layout; // Exclusive layout assigned to this View.
36 // List of transitions paired with the condition that uses the transition.
37 private Dictionary<TransitionCondition, TransitionList> layoutTransitions;
38 private int widthPolicy = LayoutParamPolicies.WrapContent; // Layout width policy
39 private int heightPolicy = LayoutParamPolicies.WrapContent; // Layout height policy
40 private float weight = 0.0f; // Weighting of child View in a Layout
41 private bool backgroundImageSynchronosLoading = false;
42 private bool controlStatePropagation = false;
43 private ViewStyle viewStyle;
44 private bool themeChangeSensitive = false;
45 private bool excludeLayouting = false;
46 private LayoutTransition layoutTransition;
47 private ControlState controlStates = ControlState.Normal;
48 private TransitionOptions transitionOptions = null;
53 /// Creates a new instance of a view.
55 /// <since_tizen> 3 </since_tizen>
56 public View() : this(Interop.View.New(), true)
58 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
61 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
62 [EditorBrowsable(EditorBrowsableState.Never)]
63 public View(ViewStyle viewStyle) : this(Interop.View.New(), true, viewStyle)
68 /// Create a new instance of a View with setting the status of shown or hidden.
70 /// <param name="shown">false : Not displayed (hidden), true : displayed (shown)</param>
71 /// This will be public opened in next release of tizen after ACR done. Before ACR, it is used as HiddenAPI (InhouseAPI).
72 [EditorBrowsable(EditorBrowsableState.Never)]
73 public View(bool shown) : this(Interop.View.New(), true)
75 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
79 internal View(View uiControl, bool shown = true) : this(Interop.View.NewView(View.getCPtr(uiControl)), true)
81 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
87 backgroundExtraData = uiControl.backgroundExtraData == null ? null : new BackgroundExtraData(uiControl.backgroundExtraData);
90 internal View(global::System.IntPtr cPtr, bool cMemoryOwn, ViewStyle viewStyle, bool shown = true) : this(cPtr, cMemoryOwn, shown)
92 InitializeStyle(viewStyle);
95 internal View(global::System.IntPtr cPtr, bool cMemoryOwn, bool shown = true) : base(cPtr, cMemoryOwn)
99 PositionUsesPivotPoint = false;
102 onWindowSendEventCallback = SendViewAddedEventToWindow;
103 this.OnWindowSignal().Connect(onWindowSendEventCallback);
111 internal View(ViewImpl implementation, bool shown = true) : this(Interop.View.NewViewInternal(ViewImpl.getCPtr(implementation)), true)
113 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
122 /// The event that is triggered when the View's ControlState is changed.
124 [EditorBrowsable(EditorBrowsableState.Never)]
125 public event EventHandler<ControlStateChangedEventArgs> ControlStateChangedEvent;
127 internal event EventHandler<ControlStateChangedEventArgs> ControlStateChangeEventInternal;
131 /// Flag to indicate if layout set explicitly via API call or View was automatically given a Layout.
133 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
134 [EditorBrowsable(EditorBrowsableState.Never)]
135 public bool LayoutSet
144 /// Flag to allow Layouting to be disabled for Views.
145 /// Once a View has a Layout set then any children added to Views from then on will receive
146 /// automatic Layouts.
148 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
149 [EditorBrowsable(EditorBrowsableState.Never)]
150 public static bool LayoutingDisabled { get; set; } = true;
153 /// The style instance applied to this view.
154 /// Note that please do not modify the ViewStyle.
155 /// Modifying ViewStyle will affect other views with same ViewStyle.
157 [EditorBrowsable(EditorBrowsableState.Never)]
158 protected ViewStyle ViewStyle
162 if (null == viewStyle)
164 ApplyStyle(CreateViewStyle());
172 /// Get/Set the control state.
173 /// Note that the ControlState only available for the classes derived from Control.
174 /// If the classes that are not derived from Control (such as View, ImageView and TextLabel) want to use this system,
175 /// please set <see cref="EnableControlState"/> to true.
177 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
178 [EditorBrowsable(EditorBrowsableState.Never)]
179 public ControlState ControlState
183 return controlStates;
187 if (controlStates == value)
192 var prevState = controlStates;
194 controlStates = value;
196 var changeInfo = new ControlStateChangedEventArgs(prevState, value);
198 ControlStateChangeEventInternal?.Invoke(this, changeInfo);
200 if (controlStatePropagation)
202 foreach (View child in Children)
204 child.ControlState = value;
208 OnControlStateChanged(changeInfo);
210 ControlStateChangedEvent?.Invoke(this, changeInfo);
215 /// Gets / Sets the status of whether the view is excluded from its parent's layouting or not.
217 /// This will be public opened later after ACR done. Before ACR, need to be hidden as inhouse API.
218 [EditorBrowsable(EditorBrowsableState.Never)]
219 public bool ExcludeLayouting
223 return excludeLayouting;
227 excludeLayouting = value;
228 if (Layout != null && Layout.SetPositionByLayout == value)
230 Layout.SetPositionByLayout = !value;
231 Layout.RequestLayout();
236 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
237 [EditorBrowsable(EditorBrowsableState.Never)]
238 public bool IsResourcesCreated
242 return Application.Current.IsResourcesCreated;
246 /// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
247 [EditorBrowsable(EditorBrowsableState.Never)]
248 public ResourceDictionary XamlResources
252 return Application.Current.XamlResources;
256 Application.Current.XamlResources = value;
261 /// The StyleName, type string.
262 /// The value indicates DALi style name defined in json theme file.
264 /// <since_tizen> 3 </since_tizen>
265 public string StyleName
269 return (string)GetValue(StyleNameProperty);
273 SetValue(StyleNameProperty, value);
274 NotifyPropertyChanged();
279 /// The KeyInputFocus, type bool.
281 [EditorBrowsable(EditorBrowsableState.Never)]
282 public bool KeyInputFocus
286 return (bool)GetValue(KeyInputFocusProperty);
290 SetValue(KeyInputFocusProperty, value);
291 NotifyPropertyChanged();
296 /// The mutually exclusive with "backgroundImage" and "background" type Vector4.
300 /// The property cascade chaining set is possible. For example, this (view.BackgroundColor.X = 0.1f;) is possible.
303 /// Animatable - This property can be animated using <c>Animation</c> class.
305 /// animation.AnimateTo(view, "BackgroundColor", new Color(r, g, b, a));
309 /// <since_tizen> 3 </since_tizen>
310 public Color BackgroundColor
314 Color temp = (Color)GetValue(BackgroundColorProperty);
315 return new Color(OnBackgroundColorChanged, temp.R, temp.G, temp.B, temp.A);
319 SetValue(BackgroundColorProperty, value);
320 NotifyPropertyChanged();
325 /// The mutually exclusive with "backgroundColor" and "background" type Map.
327 /// <since_tizen> 3 </since_tizen>
328 public string BackgroundImage
332 return (string)GetValue(BackgroundImageProperty);
336 SetValue(BackgroundImageProperty, value);
337 NotifyPropertyChanged();
342 /// Get or set the border of background image.
344 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
345 [EditorBrowsable(EditorBrowsableState.Never)]
346 public Rectangle BackgroundImageBorder
350 return (Rectangle)GetValue(BackgroundImageBorderProperty);
354 SetValue(BackgroundImageBorderProperty, value);
355 NotifyPropertyChanged();
360 /// The background of view.
362 /// <since_tizen> 3 </since_tizen>
363 public Tizen.NUI.PropertyMap Background
367 return (PropertyMap)GetValue(BackgroundProperty);
371 SetValue(BackgroundProperty, value);
372 NotifyPropertyChanged();
377 /// Describes a shadow as an image for a View.
378 /// It is null by default.
381 /// Getter returns copied instance of current shadow.
384 /// The mutually exclusive with "BoxShadow".
388 /// Animatable - This property can be animated using <c>Animation</c> class.
389 /// To animate this property, specify a sub-property with separator ".", for example, "ImageShadow.Offset".
391 /// animation.AnimateTo(view, "ImageShadow.Offset", new Vector2(10, 10));
393 /// Animatable sub-property : Offset.
396 [EditorBrowsable(EditorBrowsableState.Never)]
397 public ImageShadow ImageShadow
401 return (ImageShadow)GetValue(ImageShadowProperty);
405 SetValue(ImageShadowProperty, value);
406 NotifyPropertyChanged();
411 /// Describes a box shaped shadow drawing for a View.
412 /// It is null by default.
415 /// The mutually exclusive with "ImageShadow".
419 /// Animatable - This property can be animated using <c>Animation</c> class.
420 /// To animate this property, specify a sub-property with separator ".", for example, "BoxShadow.BlurRadius".
422 /// animation.AnimateTo(view, "BoxShadow.BlurRadius", 10.0f);
424 /// Animatable sub-property : Offset, Color, BlurRadius.
427 /// <since_tizen> 9 </since_tizen>
428 public Shadow BoxShadow
432 return (Shadow)GetValue(BoxShadowProperty);
436 SetValue(BoxShadowProperty, value);
437 NotifyPropertyChanged();
442 /// The radius for the rounded corners of the View.
443 /// This will rounds background and shadow edges.
444 /// 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).
445 /// Note that, an image background (or shadow) may not have rounded corners if it uses a Border property.
449 /// Animatable - This property can be animated using <c>Animation</c> class.
452 /// <since_tizen> 9 </since_tizen>
453 public Vector4 CornerRadius
457 return (Vector4)GetValue(CornerRadiusProperty);
461 SetValue(CornerRadiusProperty, value);
462 NotifyPropertyChanged();
470 [EditorBrowsable(EditorBrowsableState.Never)]
471 protected bool IsHighlighted
475 using (View view = Accessibility.Accessibility.Instance.GetCurrentlyHighlightedView())
482 [EditorBrowsable(EditorBrowsableState.Never)]
483 protected static readonly string AccessibilityActivateAction = "activate";
484 [EditorBrowsable(EditorBrowsableState.Never)]
485 protected static readonly string AccessibilityReadingSkippedAction = "ReadingSkipped";
486 [EditorBrowsable(EditorBrowsableState.Never)]
487 protected static readonly string AccessibilityReadingCancelledAction = "ReadingCancelled";
488 [EditorBrowsable(EditorBrowsableState.Never)]
489 protected static readonly string AccessibilityReadingStoppedAction = "ReadingStopped";
490 [EditorBrowsable(EditorBrowsableState.Never)]
491 protected static readonly string AccessibilityReadingPausedAction = "ReadingPaused";
492 [EditorBrowsable(EditorBrowsableState.Never)]
493 protected static readonly string AccessibilityReadingResumedAction = "ReadingResumed";
495 [EditorBrowsable(EditorBrowsableState.Never)]
496 private static readonly string[] AccessibilityActions = {
497 AccessibilityActivateAction,
498 AccessibilityReadingSkippedAction,
499 AccessibilityReadingCancelledAction,
500 AccessibilityReadingStoppedAction,
501 AccessibilityReadingPausedAction,
502 AccessibilityReadingResumedAction,
505 [EditorBrowsable(EditorBrowsableState.Never)]
506 protected virtual string AccessibilityGetName()
511 [EditorBrowsable(EditorBrowsableState.Never)]
512 protected virtual string AccessibilityGetDescription()
517 [EditorBrowsable(EditorBrowsableState.Never)]
518 protected virtual bool AccessibilityDoAction(string name)
523 [EditorBrowsable(EditorBrowsableState.Never)]
524 protected virtual AccessibilityStates AccessibilityCalculateStates()
526 var states = new AccessibilityStates();
527 states.Set(AccessibilityState.Highlightable, this.AccessibilityHighlightable);
528 states.Set(AccessibilityState.Focusable, this.Focusable);
529 states.Set(AccessibilityState.Focused, this.State == States.Focused);
530 states.Set(AccessibilityState.Highlighted, this.IsHighlighted);
531 states.Set(AccessibilityState.Enabled, this.State != States.Disabled);
532 states.Set(AccessibilityState.Sensitive, this.Sensitive);
533 states.Set(AccessibilityState.Animated, this.AccessibilityAnimated);
534 states.Set(AccessibilityState.Visible, true);
535 states.Set(AccessibilityState.Showing, this.Visibility);
536 states.Set(AccessibilityState.Defunct, !this.IsOnWindow);
540 [EditorBrowsable(EditorBrowsableState.Never)]
541 protected virtual int AccessibilityGetActionCount()
543 return AccessibilityActions.Length;
546 [EditorBrowsable(EditorBrowsableState.Never)]
547 protected virtual string AccessibilityGetActionName(int index)
549 if (index >= 0 && index < AccessibilityActions.Length)
550 return AccessibilityActions[index];
555 [EditorBrowsable(EditorBrowsableState.Never)]
556 protected virtual bool AccessibilityShouldReportZeroChildren()
561 [EditorBrowsable(EditorBrowsableState.Never)]
562 protected virtual double AccessibilityGetMinimum()
567 [EditorBrowsable(EditorBrowsableState.Never)]
568 protected virtual double AccessibilityGetCurrent()
573 [EditorBrowsable(EditorBrowsableState.Never)]
574 protected virtual double AccessibilityGetMaximum()
579 [EditorBrowsable(EditorBrowsableState.Never)]
580 protected virtual bool AccessibilitySetCurrent(double value)
585 [EditorBrowsable(EditorBrowsableState.Never)]
586 protected virtual double AccessibilityGetMinimumIncrement()
591 [EditorBrowsable(EditorBrowsableState.Never)]
592 protected virtual bool AccessibilityIsScrollable()
597 [EditorBrowsable(EditorBrowsableState.Never)]
598 protected virtual string AccessibilityGetText(int startOffset, int endOffset)
603 [EditorBrowsable(EditorBrowsableState.Never)]
604 protected virtual int AccessibilityGetCharacterCount()
609 [EditorBrowsable(EditorBrowsableState.Never)]
610 protected virtual int AccessibilityGetCaretOffset()
615 [EditorBrowsable(EditorBrowsableState.Never)]
616 protected virtual bool AccessibilitySetCaretOffset(int offset)
621 [EditorBrowsable(EditorBrowsableState.Never)]
622 protected virtual AccessibilityRange AccessibilityGetTextAtOffset(int offset, TextBoundary boundary)
624 return new AccessibilityRange();
627 [EditorBrowsable(EditorBrowsableState.Never)]
628 protected virtual AccessibilityRange AccessibilityGetSelection(int selectionNum)
630 return new AccessibilityRange();
633 [EditorBrowsable(EditorBrowsableState.Never)]
634 protected virtual bool AccessibilityRemoveSelection(int selectionNum)
639 [EditorBrowsable(EditorBrowsableState.Never)]
640 protected virtual bool AccessibilitySetSelection(int selectionNum, int startOffset, int endOffset)
645 [EditorBrowsable(EditorBrowsableState.Never)]
646 protected virtual bool AccessibilityCopyText(int startPosition, int endPosition)
651 [EditorBrowsable(EditorBrowsableState.Never)]
652 protected virtual bool AccessibilityCutText(int startPosition, int endPosition)
658 /// Whether the CornerRadius property value is relative (percentage [0.0f to 1.0f] of the view size) or absolute (in world units).
659 /// It is absolute by default.
660 /// When the policy is relative, the corner radius is relative to the smaller of the view's width and height.
662 /// <since_tizen> 9 </since_tizen>
663 public VisualTransformPolicyType CornerRadiusPolicy
665 get => (VisualTransformPolicyType)GetValue(CornerRadiusPolicyProperty);
666 set => SetValue(CornerRadiusPolicyProperty, value);
670 /// The current state of the view.
672 /// <since_tizen> 3 </since_tizen>
677 return (States)GetValue(StateProperty);
681 SetValue(StateProperty, value);
682 NotifyPropertyChanged();
687 /// The current sub state of the view.
689 /// <since_tizen> 3 </since_tizen>
690 public States SubState
694 return (States)GetValue(SubStateProperty);
698 SetValue(SubStateProperty, value);
699 NotifyPropertyChanged();
704 /// Displays a tooltip
706 /// <since_tizen> 3 </since_tizen>
707 public Tizen.NUI.PropertyMap Tooltip
711 return (PropertyMap)GetValue(TooltipProperty);
715 SetValue(TooltipProperty, value);
716 NotifyPropertyChanged();
721 /// Displays a tooltip as a text.
723 /// <since_tizen> 3 </since_tizen>
724 public string TooltipText
728 using (var propertyValue = GetProperty(Property.TOOLTIP))
730 if (propertyValue != null && propertyValue.Get(out string retrivedValue))
732 return retrivedValue;
734 NUILog.Error($"[ERROR] Fail to get TooltipText! Return error MSG (error to get TooltipText)!");
735 return "error to get TooltipText";
740 var temp = new Tizen.NUI.PropertyValue(value);
741 SetProperty(View.Property.TOOLTIP, temp);
743 NotifyPropertyChanged();
748 /// The Child property of FlexContainer.<br />
749 /// The proportion of the free space in the container, the flex item will receive.<br />
750 /// If all items in the container set this property, their sizes will be proportional to the specified flex factor.<br />
752 /// <since_tizen> 3 </since_tizen>
753 [Obsolete("Deprecated in API8, will be removed in API10.")]
758 return (float)GetValue(FlexProperty);
762 SetValue(FlexProperty, value);
763 NotifyPropertyChanged();
768 /// The Child property of FlexContainer.<br />
769 /// The alignment of the flex item along the cross axis, which, if set, overrides the default alignment for all items in the container.<br />
771 /// <since_tizen> 3 </since_tizen>
772 [Obsolete("Deprecated in API8, will be removed in API10.")]
777 return (int)GetValue(AlignSelfProperty);
781 SetValue(AlignSelfProperty, value);
782 NotifyPropertyChanged();
787 /// The Child property of FlexContainer.<br />
788 /// The space around the flex item.<br />
791 /// The property cascade chaining set is possible. For example, this (view.FlexMargin.X = 0.1f;) is possible.
793 /// <since_tizen> 3 </since_tizen>
794 [Obsolete("Deprecated in API8, will be removed in API10.")]
795 public Vector4 FlexMargin
799 Vector4 temp = (Vector4)GetValue(FlexMarginProperty);
800 return new Vector4(OnFlexMarginChanged, temp.X, temp.Y, temp.Z, temp.W);
804 SetValue(FlexMarginProperty, value);
805 NotifyPropertyChanged();
810 /// The top-left cell this child occupies, if not set, the first available cell is used.
813 /// The property cascade chaining set is possible. For example, this (view.CellIndex.X = 0.1f;) is possible.
815 /// <since_tizen> 3 </since_tizen>
816 public Vector2 CellIndex
820 Vector2 temp = (Vector2)GetValue(CellIndexProperty);
821 return new Vector2(OnCellIndexChanged, temp.X, temp.Y);
825 SetValue(CellIndexProperty, value);
826 NotifyPropertyChanged();
831 /// The number of rows this child occupies, if not set, the default value is 1.
833 /// <since_tizen> 3 </since_tizen>
838 return (float)GetValue(RowSpanProperty);
842 SetValue(RowSpanProperty, value);
843 NotifyPropertyChanged();
848 /// The number of columns this child occupies, if not set, the default value is 1.
850 /// <since_tizen> 3 </since_tizen>
851 public float ColumnSpan
855 return (float)GetValue(ColumnSpanProperty);
859 SetValue(ColumnSpanProperty, value);
860 NotifyPropertyChanged();
865 /// The horizontal alignment of this child inside the cells, if not set, the default value is 'left'.
867 /// <since_tizen> 3 </since_tizen>
868 public Tizen.NUI.HorizontalAlignmentType CellHorizontalAlignment
872 return (HorizontalAlignmentType)GetValue(CellHorizontalAlignmentProperty);
876 SetValue(CellHorizontalAlignmentProperty, value);
877 NotifyPropertyChanged();
882 /// The vertical alignment of this child inside the cells, if not set, the default value is 'top'.
884 /// <since_tizen> 3 </since_tizen>
885 public Tizen.NUI.VerticalAlignmentType CellVerticalAlignment
889 return (VerticalAlignmentType)GetValue(CellVerticalAlignmentProperty);
893 SetValue(CellVerticalAlignmentProperty, value);
894 NotifyPropertyChanged();
899 /// The left focusable view.<br />
900 /// This will return null if not set.<br />
901 /// This will also return null if the specified left focusable view is not on a window.<br />
903 /// <since_tizen> 3 </since_tizen>
904 public View LeftFocusableView
906 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
909 return (View)GetValue(LeftFocusableViewProperty);
913 SetValue(LeftFocusableViewProperty, value);
914 NotifyPropertyChanged();
919 /// The right focusable view.<br />
920 /// This will return null if not set.<br />
921 /// This will also return null if the specified right focusable view is not on a window.<br />
923 /// <since_tizen> 3 </since_tizen>
924 public View RightFocusableView
926 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
929 return (View)GetValue(RightFocusableViewProperty);
933 SetValue(RightFocusableViewProperty, value);
934 NotifyPropertyChanged();
939 /// The up focusable view.<br />
940 /// This will return null if not set.<br />
941 /// This will also return null if the specified up focusable view is not on a window.<br />
943 /// <since_tizen> 3 </since_tizen>
944 public View UpFocusableView
946 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
949 return (View)GetValue(UpFocusableViewProperty);
953 SetValue(UpFocusableViewProperty, value);
954 NotifyPropertyChanged();
959 /// The down focusable view.<br />
960 /// This will return null if not set.<br />
961 /// This will also return null if the specified down focusable view is not on a window.<br />
963 /// <since_tizen> 3 </since_tizen>
964 public View DownFocusableView
966 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
969 return (View)GetValue(DownFocusableViewProperty);
973 SetValue(DownFocusableViewProperty, value);
974 NotifyPropertyChanged();
979 /// Whether the view should be focusable by keyboard navigation.
981 /// <since_tizen> 3 </since_tizen>
982 public bool Focusable
986 SetValue(FocusableProperty, value);
987 NotifyPropertyChanged();
991 return (bool)GetValue(FocusableProperty);
996 /// Retrieves the position of the view.<br />
997 /// The coordinates are relative to the view's parent.<br />
999 /// <since_tizen> 3 </since_tizen>
1000 public Position CurrentPosition
1004 return GetCurrentPosition();
1009 /// Sets the size of a view for the width and the height.<br />
1010 /// Geometry can be scaled to fit within this area.<br />
1011 /// This does not interfere with the view's scale factor.<br />
1012 /// The views default depth is the minimum of width and height.<br />
1015 /// This NUI object (Size2D) typed property can be configured by multiple cascade setting. <br />
1016 /// For example, this code ( view.Size2D.Width = 100; view.Size2D.Height = 100; ) is equivalent to this ( view.Size2D = new Size2D(100, 100); ). <br />
1018 /// <since_tizen> 3 </since_tizen>
1019 public Size2D Size2D
1023 Size2D temp = (Size2D)GetValue(Size2DProperty);
1024 int width = temp.Width;
1025 int height = temp.Height;
1027 if (this.Layout == null)
1029 if (width < 0) { width = 0; }
1030 if (height < 0) { height = 0; }
1033 return new Size2D(OnSize2DChanged, width, height);
1037 SetValue(Size2DProperty, value);
1039 NotifyPropertyChanged();
1044 /// Retrieves the size of the view.<br />
1045 /// The coordinates are relative to the view's parent.<br />
1047 /// <since_tizen> 3 </since_tizen>
1048 public Size2D CurrentSize
1052 return GetCurrentSize();
1057 /// Retrieves and sets the view's opacity.<br />
1059 /// <since_tizen> 3 </since_tizen>
1060 public float Opacity
1064 return (float)GetValue(OpacityProperty);
1068 SetValue(OpacityProperty, value);
1069 NotifyPropertyChanged();
1074 /// Sets the position of the view for X and Y.<br />
1075 /// By default, sets the position vector between the parent origin and the pivot point (default).<br />
1076 /// If the position inheritance is disabled, sets the world position.<br />
1079 /// This NUI object (Position2D) typed property can be configured by multiple cascade setting. <br />
1080 /// For example, this code ( view.Position2D.X = 100; view.Position2D.Y = 100; ) is equivalent to this ( view.Position2D = new Position2D(100, 100); ). <br />
1082 /// <since_tizen> 3 </since_tizen>
1083 public Position2D Position2D
1087 Position2D temp = (Position2D)GetValue(Position2DProperty);
1088 return new Position2D(OnPosition2DChanged, temp.X, temp.Y);
1092 SetValue(Position2DProperty, value);
1093 NotifyPropertyChanged();
1098 /// Retrieves the screen position of the view.<br />
1100 /// <since_tizen> 3 </since_tizen>
1101 public Vector2 ScreenPosition
1105 Vector2 temp = new Vector2(0.0f, 0.0f);
1106 var pValue = GetProperty(View.Property.ScreenPosition);
1114 /// Determines whether the pivot point should be used to determine the position of the view.
1115 /// This is false by default.
1117 /// <remarks>If false, then the top-left of the view is used for the position.
1118 /// Setting this to false will allow scaling or rotation around the pivot point without affecting the view's position.
1120 /// <since_tizen> 3 </since_tizen>
1121 public bool PositionUsesPivotPoint
1125 return (bool)GetValue(PositionUsesPivotPointProperty);
1129 SetValue(PositionUsesPivotPointProperty, value);
1130 NotifyPropertyChanged();
1135 /// Deprecated in API5; Will be removed in API8. Please use PositionUsesPivotPoint instead!
1137 /// <since_tizen> 3 </since_tizen>
1138 [Obsolete("Deprecated in API5; Will be removed in API8. Please use PositionUsesPivotPoint instead! " +
1140 "View view = new View(); " +
1141 "view.PivotPoint = PivotPoint.Center; " +
1142 "view.PositionUsesPivotPoint = true;" +
1143 " Deprecated in API5: Will be removed in API8")]
1144 [EditorBrowsable(EditorBrowsableState.Never)]
1145 public bool PositionUsesAnchorPoint
1150 var pValue = GetProperty(View.Property.PositionUsesAnchorPoint);
1151 pValue.Get(out temp);
1157 var temp = new Tizen.NUI.PropertyValue(value);
1158 SetProperty(View.Property.PositionUsesAnchorPoint, temp);
1160 NotifyPropertyChanged();
1165 /// Queries whether the view is connected to the stage.<br />
1166 /// When a view is connected, it will be directly or indirectly parented to the root view.<br />
1168 /// <since_tizen> 3 </since_tizen>
1169 public bool IsOnWindow
1178 /// Gets the depth in the hierarchy for the view.
1180 /// <since_tizen> 3 </since_tizen>
1181 public int HierarchyDepth
1185 return GetHierarchyDepth();
1190 /// Sets the sibling order of the view so the depth position can be defined within the same parent.
1193 /// Note the initial value is 0. SiblingOrder should be bigger than 0 or equal to 0.
1194 /// Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove, and LowerBelow will override the sibling order.
1195 /// The values set by this property will likely change.
1197 /// <since_tizen> 3 </since_tizen>
1198 public int SiblingOrder
1202 return (int)GetValue(SiblingOrderProperty);
1206 SetValue(SiblingOrderProperty, value);
1208 LayoutGroup layout = Layout as LayoutGroup;
1209 layout?.ChangeLayoutSiblingOrder(value);
1211 NotifyPropertyChanged();
1216 /// Returns the natural size of the view.
1219 /// Deriving classes stipulate the natural size and by default a view has a zero natural size.
1221 /// <since_tizen> 5 </since_tizen>
1222 public Vector3 NaturalSize
1226 Vector3 ret = new Vector3(Interop.Actor.GetNaturalSize(SwigCPtr), true);
1227 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
1233 /// Returns the natural size (Size2D) of the view.
1236 /// Deriving classes stipulate the natural size and by default a view has a zero natural size.
1238 /// <since_tizen> 4 </since_tizen>
1239 public Size2D NaturalSize2D
1243 Vector3 temp = new Vector3(Interop.Actor.GetNaturalSize(SwigCPtr), true);
1244 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
1246 Size2D sz = new Size2D((int)temp.Width, (int)temp.Height);
1253 /// Gets or sets the origin of a view within its parent's area.<br />
1254 /// 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 />
1255 /// The default parent-origin is ParentOrigin.TopLeft (0.0, 0.0, 0.5).<br />
1256 /// A view's position is the distance between this origin and the view's anchor-point.<br />
1258 /// <pre>The view has been initialized.</pre>
1259 /// <since_tizen> 3 </since_tizen>
1260 public Position ParentOrigin
1264 Position tmp = (Position)GetValue(ParentOriginProperty);
1265 return new Position(OnParentOriginChanged, tmp.X, tmp.Y, tmp.Z);
1269 SetValue(ParentOriginProperty, value);
1270 NotifyPropertyChanged();
1275 /// Gets or sets the anchor-point of a view.<br />
1276 /// 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 />
1277 /// The default pivot point is PivotPoint.Center (0.5, 0.5, 0.5).<br />
1278 /// A view position is the distance between its parent-origin and this anchor-point.<br />
1279 /// A view's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.<br />
1280 /// <pre>The view has been initialized.</pre>
1283 /// The property cascade chaining set is possible. For example, this (view.PivotPoint.X = 0.1f;) is possible.
1285 /// <since_tizen> 3 </since_tizen>
1286 public Position PivotPoint
1290 Position tmp = (Position)GetValue(PivotPointProperty);
1291 return new Position(OnPivotPointChanged, tmp.X, tmp.Y, tmp.Z);
1295 SetValue(PivotPointProperty, value);
1296 NotifyPropertyChanged();
1301 /// Gets or sets the size width of the view.
1305 /// Animatable - This property can be animated using <c>Animation</c> class.
1308 /// <since_tizen> 3 </since_tizen>
1309 public float SizeWidth
1313 return (float)GetValue(SizeWidthProperty);
1317 SetValue(SizeWidthProperty, value);
1318 NotifyPropertyChanged();
1323 /// Gets or sets the size height of the view.
1327 /// Animatable - This property can be animated using <c>Animation</c> class.
1330 /// <since_tizen> 3 </since_tizen>
1331 public float SizeHeight
1335 return (float)GetValue(SizeHeightProperty);
1339 SetValue(SizeHeightProperty, value);
1340 NotifyPropertyChanged();
1345 /// Gets or sets the position of the view.<br />
1346 /// By default, sets the position vector between the parent origin and pivot point (default).<br />
1347 /// If the position inheritance is disabled, sets the world position.<br />
1351 /// Animatable - This property can be animated using <c>Animation</c> class.
1353 /// The property cascade chaining set is possible. For example, this (view.Position.X = 1.0f;) is possible.
1355 /// <since_tizen> 3 </since_tizen>
1356 public Position Position
1360 Position tmp = (Position)GetValue(PositionProperty);
1361 return new Position(OnPositionChanged, tmp.X, tmp.Y, tmp.Z);
1365 SetValue(PositionProperty, value);
1366 NotifyPropertyChanged();
1371 /// Gets or sets the position X of the view.
1375 /// Animatable - This property can be animated using <c>Animation</c> class.
1378 /// <since_tizen> 3 </since_tizen>
1379 public float PositionX
1383 return (float)GetValue(PositionXProperty);
1387 SetValue(PositionXProperty, value);
1388 NotifyPropertyChanged();
1393 /// Gets or sets the position Y of the view.
1397 /// Animatable - This property can be animated using <c>Animation</c> class.
1400 /// <since_tizen> 3 </since_tizen>
1401 public float PositionY
1405 return (float)GetValue(PositionYProperty);
1409 SetValue(PositionYProperty, value);
1410 NotifyPropertyChanged();
1415 /// Gets or sets the position Z of the view.
1419 /// Animatable - This property can be animated using <c>Animation</c> class.
1422 /// <since_tizen> 3 </since_tizen>
1423 public float PositionZ
1427 return (float)GetValue(PositionZProperty);
1431 SetValue(PositionZProperty, value);
1432 NotifyPropertyChanged();
1437 /// Gets or sets the world position of the view.
1439 /// <since_tizen> 3 </since_tizen>
1440 public Vector3 WorldPosition
1444 Vector3 temp = new Vector3(0.0f, 0.0f, 0.0f);
1445 var pValue = GetProperty(View.Property.WorldPosition);
1453 /// Gets or sets the orientation of the view.<br />
1454 /// The view's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.<br />
1458 /// This is an asynchronous method.
1461 /// Animatable - This property can be animated using <c>Animation</c> class.
1464 /// <since_tizen> 3 </since_tizen>
1465 public Rotation Orientation
1469 return (Rotation)GetValue(OrientationProperty);
1473 SetValue(OrientationProperty, value);
1474 NotifyPropertyChanged();
1479 /// Gets or sets the world orientation of the view.<br />
1481 /// <since_tizen> 3 </since_tizen>
1482 public Rotation WorldOrientation
1486 Rotation temp = new Rotation();
1487 var pValue = GetProperty(View.Property.WorldOrientation);
1495 /// Gets or sets the scale factor applied to the view.<br />
1499 /// Animatable - This property can be animated using <c>Animation</c> class.
1501 /// The property cascade chaining set is possible. For example, this (view.Scale.X = 0.1f;) is possible.
1503 /// <since_tizen> 3 </since_tizen>
1504 public Vector3 Scale
1508 Vector3 temp = (Vector3)GetValue(ScaleProperty);
1509 return new Vector3(OnScaleChanged, temp.X, temp.Y, temp.Z);
1513 SetValue(ScaleProperty, value);
1514 NotifyPropertyChanged();
1519 /// Gets or sets the scale X factor applied to the view.
1523 /// Animatable - This property can be animated using <c>Animation</c> class.
1526 /// <since_tizen> 3 </since_tizen>
1531 return (float)GetValue(ScaleXProperty);
1535 SetValue(ScaleXProperty, value);
1536 NotifyPropertyChanged();
1541 /// Gets or sets the scale Y factor applied to the view.
1545 /// Animatable - This property can be animated using <c>Animation</c> class.
1548 /// <since_tizen> 3 </since_tizen>
1553 return (float)GetValue(ScaleYProperty);
1557 SetValue(ScaleYProperty, value);
1558 NotifyPropertyChanged();
1563 /// Gets or sets the scale Z factor applied to the view.
1567 /// Animatable - This property can be animated using <c>Animation</c> class.
1570 /// <since_tizen> 3 </since_tizen>
1575 return (float)GetValue(ScaleZProperty);
1579 SetValue(ScaleZProperty, value);
1580 NotifyPropertyChanged();
1585 /// Gets the world scale of the view.
1587 /// <since_tizen> 3 </since_tizen>
1588 public Vector3 WorldScale
1592 Vector3 temp = new Vector3(0.0f, 0.0f, 0.0f);
1593 var pValue = GetProperty(View.Property.WorldScale);
1601 /// Retrieves the visibility flag of the view.
1605 /// If the view is not visible, then the view and its children will not be rendered.
1606 /// 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.
1609 /// Animatable - This property can be animated using <c>Animation</c> class.
1612 /// <since_tizen> 3 </since_tizen>
1613 public bool Visibility
1618 var pValue = GetProperty(View.Property.VISIBLE);
1619 pValue.Get(out temp);
1626 /// Gets the view's world color.
1628 /// <since_tizen> 3 </since_tizen>
1629 public Vector4 WorldColor
1633 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
1634 var pValue = GetProperty(View.Property.WorldColor);
1642 /// Gets or sets the view's name.
1644 /// <since_tizen> 3 </since_tizen>
1649 return (string)GetValue(NameProperty);
1653 SetValue(NameProperty, value);
1654 NotifyPropertyChanged();
1659 /// Get the number of children held by the view.
1661 /// <since_tizen> 3 </since_tizen>
1662 public new uint ChildCount
1666 return Convert.ToUInt32(Children.Count);
1671 /// Gets the view's ID.
1674 /// <since_tizen> 3 </since_tizen>
1684 /// Gets or sets the status of whether the view should emit touch or hover signals.
1686 /// <since_tizen> 3 </since_tizen>
1687 public bool Sensitive
1691 return (bool)GetValue(SensitiveProperty);
1695 SetValue(SensitiveProperty, value);
1696 NotifyPropertyChanged();
1701 /// 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.
1703 /// <since_tizen> 3 </since_tizen>
1704 public bool LeaveRequired
1708 return (bool)GetValue(LeaveRequiredProperty);
1712 SetValue(LeaveRequiredProperty, value);
1713 NotifyPropertyChanged();
1718 /// Gets or sets the status of whether a child view inherits it's parent's orientation.
1720 /// <since_tizen> 3 </since_tizen>
1721 public bool InheritOrientation
1725 return (bool)GetValue(InheritOrientationProperty);
1729 SetValue(InheritOrientationProperty, value);
1730 NotifyPropertyChanged();
1735 /// Gets or sets the status of whether a child view inherits it's parent's scale.
1737 /// <since_tizen> 3 </since_tizen>
1738 public bool InheritScale
1742 return (bool)GetValue(InheritScaleProperty);
1746 SetValue(InheritScaleProperty, value);
1747 NotifyPropertyChanged();
1752 /// Gets or sets the status of how the view and its children should be drawn.<br />
1753 /// Not all views are renderable, but DrawMode can be inherited from any view.<br />
1754 /// 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 />
1755 /// If DrawMode.Overlay2D is used, the view and its children will be drawn as a 2D overlay.<br />
1756 /// Overlay views are drawn in a separate pass, after all non-overlay views within the layer.<br />
1757 /// For overlay views, the drawing order is with respect to tree levels of views, and depth-testing will not be used.<br />
1759 /// <since_tizen> 3 </since_tizen>
1760 public DrawModeType DrawMode
1764 return (DrawModeType)GetValue(DrawModeProperty);
1768 SetValue(DrawModeProperty, value);
1769 NotifyPropertyChanged();
1774 /// Gets or sets the relative to parent size factor of the view.<br />
1775 /// This factor is only used when ResizePolicyType is set to either: ResizePolicyType.SizeRelativeToParent or ResizePolicyType.SizeFixedOffsetFromParent.<br />
1776 /// This view's size is set to the view's size multiplied by or added to this factor, depending on ResizePolicyType.<br />
1779 /// The property cascade chaining set is possible. For example, this (view.DecorationBoundingBox.X = 0.1f;) is possible.
1781 /// <since_tizen> 3 </since_tizen>
1782 public Vector3 SizeModeFactor
1786 Vector3 temp = (Vector3)GetValue(SizeModeFactorProperty);
1787 return new Vector3(OnSizeModeFactorChanged, temp.X, temp.Y, temp.Z);
1791 SetValue(SizeModeFactorProperty, value);
1792 NotifyPropertyChanged();
1797 /// Gets or sets the width resize policy to be used.
1799 /// <since_tizen> 3 </since_tizen>
1800 public ResizePolicyType WidthResizePolicy
1804 return (ResizePolicyType)GetValue(WidthResizePolicyProperty);
1808 SetValue(WidthResizePolicyProperty, value);
1809 NotifyPropertyChanged();
1814 /// Gets or sets the height resize policy to be used.
1816 /// <since_tizen> 3 </since_tizen>
1817 public ResizePolicyType HeightResizePolicy
1821 return (ResizePolicyType)GetValue(HeightResizePolicyProperty);
1825 SetValue(HeightResizePolicyProperty, value);
1826 NotifyPropertyChanged();
1831 /// Gets or sets the policy to use when setting size with size negotiation.<br />
1832 /// Defaults to SizeScalePolicyType.UseSizeSet.<br />
1834 /// <since_tizen> 3 </since_tizen>
1835 public SizeScalePolicyType SizeScalePolicy
1839 return (SizeScalePolicyType)GetValue(SizeScalePolicyProperty);
1843 SetValue(SizeScalePolicyProperty, value);
1844 NotifyPropertyChanged();
1849 /// Gets or sets the status of whether the width size is dependent on the height size.
1851 /// <since_tizen> 3 </since_tizen>
1852 public bool WidthForHeight
1856 return (bool)GetValue(WidthForHeightProperty);
1860 SetValue(WidthForHeightProperty, value);
1861 NotifyPropertyChanged();
1866 /// Gets or sets the status of whether the height size is dependent on the width size.
1868 /// <since_tizen> 3 </since_tizen>
1869 public bool HeightForWidth
1873 return (bool)GetValue(HeightForWidthProperty);
1877 SetValue(HeightForWidthProperty, value);
1878 NotifyPropertyChanged();
1883 /// Gets or sets the padding for use in layout.
1886 /// The property cascade chaining set is possible. For example, this (view.Padding.X = 0.1f;) is possible.
1888 /// <since_tizen> 5 </since_tizen>
1889 public Extents Padding
1893 // If View has a Layout then padding in stored in the base Layout class
1896 return Layout.Padding;
1900 Extents temp = (Extents)GetValue(PaddingProperty);
1901 return new Extents(OnPaddingChanged, temp.Start, temp.End, temp.Top, temp.Bottom);
1903 // Two return points to prevent creating a zeroed Extent native object before assignment
1907 Extents padding = value;
1910 // Layout set so store Padding in LayoutItem instead of in View.
1911 // If View stores the Padding value then Legacy Size Negotiation will overwrite
1912 // the position and sizes measure in the Layouting.
1913 Layout.Padding = value;
1914 // If Layout is a LayoutItem then it could be a View that handles it's own padding.
1915 // Let the View keeps it's padding. Still store Padding in Layout to reduce code paths.
1916 if (typeof(LayoutGroup).IsAssignableFrom(Layout.GetType())) // If a Layout container of some kind.
1918 padding = new Extents(0, 0, 0, 0); // Reset value stored in View.
1922 SetValue(PaddingProperty, padding);
1923 NotifyPropertyChanged();
1928 /// Gets or sets the minimum size the view can be assigned in size negotiation.
1930 /// <exception cref="ArgumentNullException"> Thrown when value is null. </exception>
1932 /// The property cascade chaining set is possible. For example, this (view.MinimumSize.Width = 1;) is possible.
1934 /// <since_tizen> 3 </since_tizen>
1935 public Size2D MinimumSize
1939 Size2D tmp = (Size2D)GetValue(MinimumSizeProperty);
1940 return new Size2D(OnMinimumSizeChanged, tmp.Width, tmp.Height);
1946 throw new ArgumentNullException(nameof(value));
1950 // Note: it only works if minimum size is >= than natural size.
1951 // To force the size it should be done through the width&height spec or Size2D.
1952 layout.MinimumWidth = new Tizen.NUI.LayoutLength(value.Width);
1953 layout.MinimumHeight = new Tizen.NUI.LayoutLength(value.Height);
1954 layout.RequestLayout();
1956 SetValue(MinimumSizeProperty, value);
1957 NotifyPropertyChanged();
1962 /// Gets or sets the maximum size the view can be assigned in size negotiation.
1965 /// The property cascade chaining set is possible. For example, this (view.MaximumSize.Width = 1;) is possible.
1967 /// <since_tizen> 3 </since_tizen>
1968 public Size2D MaximumSize
1972 Size2D tmp = (Size2D)GetValue(MaximumSizeProperty);
1973 return new Size2D(OnMaximumSizeChanged, tmp.Width, tmp.Height);
1977 // We don't have Layout.Maximum(Width|Height) so we cannot apply it to layout.
1978 // MATCH_PARENT spec + parent container size can be used to limit
1981 layout.RequestLayout();
1983 SetValue(MaximumSizeProperty, value);
1984 NotifyPropertyChanged();
1989 /// Gets or sets whether a child view inherits it's parent's position.<br />
1990 /// Default is to inherit.<br />
1991 /// 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 />
1993 /// <since_tizen> 3 </since_tizen>
1994 public bool InheritPosition
1998 return (bool)GetValue(InheritPositionProperty);
2002 SetValue(InheritPositionProperty, value);
2003 NotifyPropertyChanged();
2008 /// Gets or sets the clipping behavior (mode) of it's children.
2010 /// <since_tizen> 3 </since_tizen>
2011 public ClippingModeType ClippingMode
2015 return (ClippingModeType)GetValue(ClippingModeProperty);
2019 SetValue(ClippingModeProperty, value);
2020 NotifyPropertyChanged();
2025 /// Gets the number of renderers held by the view.
2027 /// <since_tizen> 3 </since_tizen>
2028 public uint RendererCount
2032 return GetRendererCount();
2037 /// Deprecated in API5; Will be removed in API8. Please use PivotPoint instead!
2040 /// The property cascade chaining set is possible. For example, this (view.AnchorPoint.X = 0.1f;) is possible.
2042 /// <since_tizen> 3 </since_tizen>
2043 [Obsolete("Deprecated in API5; Will be removed in API8. Please use PivotPoint instead! " +
2045 "View view = new View(); " +
2046 "view.PivotPoint = PivotPoint.Center; " +
2047 "view.PositionUsesPivotPoint = true;")]
2048 [EditorBrowsable(EditorBrowsableState.Never)]
2049 public Position AnchorPoint
2053 Position temp = new Position(0.0f, 0.0f, 0.0f);
2054 var pValue = GetProperty(View.Property.AnchorPoint);
2057 Position ret = new Position(OnAnchorPointChanged, temp.X, temp.Y, temp.Z);
2063 var temp = new Tizen.NUI.PropertyValue(value);
2064 SetProperty(View.Property.AnchorPoint, temp);
2066 NotifyPropertyChanged();
2071 /// Sets the size of a view for the width, the height and the depth.<br />
2072 /// Geometry can be scaled to fit within this area.<br />
2073 /// This does not interfere with the view's scale factor.<br />
2074 /// The views default depth is the minimum of width and height.<br />
2078 /// Animatable - This property can be animated using <c>Animation</c> class.
2080 /// The property cascade chaining set is possible. For example, this (view.Size.Width = 1.0f;) is possible.
2082 /// <since_tizen> 5 </since_tizen>
2087 Size tmp = (Size)GetValue(SizeProperty);
2088 return new Size(OnSizeChanged, tmp.Width, tmp.Height, tmp.Depth);
2092 SetValue(SizeProperty, value);
2093 NotifyPropertyChanged();
2098 /// Deprecated in API5; Will be removed in API8. Please use 'Container GetParent() for derived class' instead!
2100 /// <since_tizen> 3 </since_tizen>
2101 [Obsolete("Deprecated in API5; Will be removed in API8. Please use 'Container GetParent() for derived class' instead! " +
2103 "Container parent = view.GetParent(); " +
2104 "View view = parent as View;")]
2105 [EditorBrowsable(EditorBrowsableState.Never)]
2106 public new View Parent
2111 IntPtr cPtr = Interop.Actor.GetParent(SwigCPtr);
2112 HandleRef CPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
2113 BaseHandle basehandle = Registry.GetManagedBaseHandleFromNativePtr(CPtr.Handle);
2115 if (basehandle is Layer layer)
2117 ret = new View(Layer.getCPtr(layer).Handle, false);
2118 NUILog.Error("This Parent property is deprecated, should do not be used");
2122 ret = basehandle as View;
2125 Interop.BaseHandle.DeleteBaseHandle(CPtr);
2126 CPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
2128 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
2134 /// Gets/Sets whether inherit parent's the layout Direction.
2136 /// <since_tizen> 4 </since_tizen>
2137 public bool InheritLayoutDirection
2141 return (bool)GetValue(InheritLayoutDirectionProperty);
2145 SetValue(InheritLayoutDirectionProperty, value);
2146 NotifyPropertyChanged();
2151 /// Gets/Sets the layout Direction.
2153 /// <since_tizen> 4 </since_tizen>
2154 public ViewLayoutDirectionType LayoutDirection
2158 return (ViewLayoutDirectionType)GetValue(LayoutDirectionProperty);
2162 SetValue(LayoutDirectionProperty, value);
2163 NotifyPropertyChanged();
2164 layout?.RequestLayout();
2169 /// Gets or sets the Margin for use in layout.
2172 /// Margin property is supported by Layout algorithms and containers.
2173 /// Please Set Layout if you want to use Margin property.
2174 /// The property cascade chaining set is possible. For example, this (view.Margin.X = 0.1f;) is possible.
2176 /// <since_tizen> 4 </since_tizen>
2177 public Extents Margin
2181 // If View has a Layout then margin is stored in Layout.
2184 return Layout.Margin;
2188 // If Layout not set then return margin stored in View.
2189 Extents temp = (Extents)GetValue(MarginProperty);
2190 return new Extents(OnMarginChanged, temp.Start, temp.End, temp.Top, temp.Bottom);
2192 // Two return points to prevent creating a zeroed Extent native object before assignment
2198 // Layout set so store Margin in LayoutItem instead of View.
2199 // If View stores the Margin too then the Legacy Size Negotiation will
2200 // overwrite the position and size values measured in the Layouting.
2201 Layout.Margin = value;
2202 SetValue(MarginProperty, new Extents(0, 0, 0, 0));
2203 layout?.RequestLayout();
2207 SetValue(MarginProperty, value);
2209 NotifyPropertyChanged();
2210 layout?.RequestLayout();
2215 /// The required policy for this dimension, LayoutParamPolicies enum or exact value.
2217 /// <since_tizen> 6 </since_tizen>
2218 public int WidthSpecification
2226 if (value == widthPolicy)
2229 widthPolicy = value;
2230 if (widthPolicy >= 0)
2232 if (heightPolicy >= 0) // Policy an exact value
2234 // Create Size2D only both _widthPolicy and _heightPolicy are set.
2235 Size2D = new Size2D(widthPolicy, heightPolicy);
2238 layout?.RequestLayout();
2243 /// The required policy for this dimension, LayoutParamPolicies enum or exact value.
2245 /// <since_tizen> 6 </since_tizen>
2246 public int HeightSpecification
2250 return heightPolicy;
2254 if (value == heightPolicy)
2257 heightPolicy = value;
2258 if (heightPolicy >= 0)
2260 if (widthPolicy >= 0) // Policy an exact value
2262 // Create Size2D only both _widthPolicy and _heightPolicy are set.
2263 Size2D = new Size2D(widthPolicy, heightPolicy);
2266 layout?.RequestLayout();
2271 /// Gets the List of transitions for this View.
2273 /// <since_tizen> 6 </since_tizen>
2274 public Dictionary<TransitionCondition, TransitionList> LayoutTransitions
2278 if (layoutTransitions == null)
2280 layoutTransitions = new Dictionary<TransitionCondition, TransitionList>();
2282 return layoutTransitions;
2287 /// Set a layout transitions for this View.
2289 /// <exception cref="ArgumentNullException"> Thrown when value is null. </exception>
2291 /// Use LayoutTransitions to receive a collection of LayoutTransitions set on the View.
2293 /// <since_tizen> 6 </since_tizen>
2294 public LayoutTransition LayoutTransition
2298 return layoutTransition;
2304 throw new global::System.ArgumentNullException(nameof(value));
2306 if (layoutTransitions == null)
2308 layoutTransitions = new Dictionary<TransitionCondition, TransitionList>();
2311 LayoutTransitionsHelper.AddTransitionForCondition(layoutTransitions, value.Condition, value, true);
2313 AttachTransitionsToChildren(value);
2315 layoutTransition = value;
2320 /// Deprecated in API5; Will be removed in API8. Please use Padding instead.
2323 /// The property cascade chaining set is possible. For example, this (view.DecorationBoundingBox.X = 0.1f;) is possible.
2325 /// <since_tizen> 4 </since_tizen>
2326 [Obsolete("Deprecated in API5; Will be removed in API8. Please use Padding instead.")]
2327 [EditorBrowsable(EditorBrowsableState.Never)]
2328 public Extents PaddingEX
2332 Extents temp = new Extents(0, 0, 0, 0);
2333 var pValue = GetProperty(View.Property.PADDING);
2336 Extents ret = new Extents(OnPaddingEXChanged, temp.Start, temp.End, temp.Top, temp.Bottom);
2342 var temp = new Tizen.NUI.PropertyValue(value);
2343 SetProperty(View.Property.PADDING, temp);
2345 NotifyPropertyChanged();
2346 layout?.RequestLayout();
2351 /// The Color of View. This is an RGBA value.
2355 /// Animatable - This property can be animated using <c>Animation</c> class.
2357 /// The property cascade chaining set is possible. For example, this (view.Color.X = 0.1f;) is possible.
2359 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
2360 [EditorBrowsable(EditorBrowsableState.Never)]
2365 Color temp = (Color)GetValue(ColorProperty);
2366 return new Color(OnColorChanged, temp.R, temp.G, temp.B, temp.A);
2370 SetValue(ColorProperty, value);
2371 NotifyPropertyChanged();
2376 /// Set the layout on this View. Replaces any existing Layout.
2379 /// If this Layout is set as null explicitly, it means this View itself and it's child Views will not use Layout anymore.
2381 /// <since_tizen> 6 </since_tizen>
2382 public LayoutItem Layout
2390 // Do nothing if layout provided is already set on this View.
2391 if (value == layout)
2396 LayoutingDisabled = false;
2399 // If new layout being set already has a owner then that owner receives a replacement default layout.
2400 // First check if the layout to be set already has a owner.
2401 if (value?.Owner != null)
2403 // Previous owner of the layout gets a default layout as a replacement.
2404 value.Owner.Layout = new AbsoluteLayout();
2406 // Copy Margin and Padding to replacement LayoutGroup.
2407 if (value.Owner.Layout != null)
2409 value.Owner.Layout.Margin = value.Margin;
2410 value.Owner.Layout.Padding = value.Padding;
2414 // Copy Margin and Padding to new layout being set or restore padding and margin back to
2415 // View if no replacement. Previously margin and padding values would have been moved from
2416 // the View to the layout.
2417 if (layout != null) // Existing layout
2421 // Existing layout being replaced so copy over margin and padding values.
2422 value.Margin = layout.Margin;
2423 value.Padding = layout.Padding;
2427 // Layout not being replaced so restore margin and padding to View.
2428 SetValue(MarginProperty, layout.Margin);
2429 SetValue(PaddingProperty, layout.Padding);
2430 NotifyPropertyChanged();
2435 // First Layout to be added to the View hence copy
2437 // Do not try to set Margins or Padding on a null Layout (when a layout is being removed from a View)
2440 Extents margin = Margin;
2441 Extents padding = Padding;
2442 if (margin.Top != 0 || margin.Bottom != 0 || margin.Start != 0 || margin.End != 0)
2444 // If View already has a margin set then store it in Layout instead.
2445 value.Margin = margin;
2446 SetValue(MarginProperty, new Extents(0, 0, 0, 0));
2447 NotifyPropertyChanged();
2450 if (padding.Top != 0 || padding.Bottom != 0 || padding.Start != 0 || padding.End != 0)
2452 // If View already has a padding set then store it in Layout instead.
2453 value.Padding = padding;
2455 // If Layout is a LayoutItem then it could be a View that handles it's own padding.
2456 // Let the View keeps it's padding. Still store Padding in Layout to reduce code paths.
2457 if (typeof(LayoutGroup).IsAssignableFrom(value.GetType()))
2459 SetValue(PaddingProperty, new Extents(0, 0, 0, 0));
2460 NotifyPropertyChanged();
2466 // Remove existing layout from it's parent layout group.
2469 value.SetPositionByLayout = !excludeLayouting;
2471 // Set layout to this view
2477 /// The weight of the View, used to share available space in a layout with siblings.
2479 /// <since_tizen> 6 </since_tizen>
2489 layout?.RequestLayout();
2494 /// Whether to load the BackgroundImage synchronously.
2495 /// If not specified, the default is false, i.e. the BackgroundImage is loaded asynchronously.
2496 /// Note: For Normal Quad images only.
2498 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
2499 [EditorBrowsable(EditorBrowsableState.Never)]
2500 public bool BackgroundImageSynchronosLoading
2504 return backgroundImageSynchronosLoading;
2508 backgroundImageSynchronosLoading = value;
2510 string bgUrl = null;
2511 var pValue = Background.Find(ImageVisualProperty.URL);
2512 pValue?.Get(out bgUrl);
2515 if (!string.IsNullOrEmpty(bgUrl))
2517 PropertyMap bgMap = this.Background;
2518 var temp = new PropertyValue(backgroundImageSynchronosLoading);
2519 bgMap.Add("synchronousLoading", temp);
2526 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
2527 [EditorBrowsable(EditorBrowsableState.Never)]
2528 public Vector2 UpdateSizeHint
2532 return (Vector2)GetValue(UpdateSizeHintProperty);
2536 SetValue(UpdateSizeHintProperty, value);
2537 NotifyPropertyChanged();
2542 /// Enable/Disable ControlState propagation for children.
2543 /// It is false by default.
2544 /// If the View needs to share ControlState with descendants, please set it true.
2545 /// Please note that, changing the value will also changes children's EnableControlStatePropagation value recursively.
2547 [EditorBrowsable(EditorBrowsableState.Never)]
2548 public bool EnableControlStatePropagation
2550 get => controlStatePropagation;
2553 controlStatePropagation = value;
2555 foreach (View child in Children)
2557 child.EnableControlStatePropagation = value;
2563 /// By default, it is false in View, true in Control.
2564 /// Note that if the value is true, the View will be a touch receptor.
2566 [EditorBrowsable(EditorBrowsableState.Never)]
2567 public bool EnableControlState
2571 return (bool)GetValue(EnableControlStateProperty);
2575 SetValue(EnableControlStateProperty, value);
2580 /// Whether the actor grab all touches even if touch leaves its boundary.
2582 /// <returns>true, if it grab all touch after start</returns>
2583 [EditorBrowsable(EditorBrowsableState.Never)]
2584 public bool GrabTouchAfterLeave
2589 var pValue = GetProperty(View.Property.CaptureAllTouchAfterStart);
2590 pValue.Get(out temp);
2596 var temp = new Tizen.NUI.PropertyValue(value);
2597 SetProperty(View.Property.CaptureAllTouchAfterStart, temp);
2599 NotifyPropertyChanged();
2604 /// Determines which blend equation will be used to render renderers of this actor.
2606 /// <returns>blend equation enum currently assigned</returns>
2607 /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API.
2608 [EditorBrowsable(EditorBrowsableState.Never)]
2609 public BlendEquationType BlendEquation
2614 var pValue = GetProperty(View.Property.BlendEquation);
2615 pValue.Get(out temp);
2617 return (BlendEquationType)temp;
2621 var temp = new Tizen.NUI.PropertyValue((int)value);
2622 SetProperty(View.Property.BlendEquation, temp);
2624 NotifyPropertyChanged();
2629 /// If the value is true, the View will change its style as the theme changes.
2630 /// It is false by default, but turned to true when setting StyleName (by setting property or using specified constructor).
2632 /// <since_tizen> 9 </since_tizen>
2633 public bool ThemeChangeSensitive
2635 get => (bool)GetValue(ThemeChangeSensitiveProperty);
2636 set => SetValue(ThemeChangeSensitiveProperty, value);
2640 /// Create Style, it is abstract function and must be override.
2642 [EditorBrowsable(EditorBrowsableState.Never)]
2643 protected virtual ViewStyle CreateViewStyle()
2645 return new ViewStyle();
2649 /// Called after the View's ControlStates changed.
2651 /// <param name="controlStateChangedInfo">The information including state changed variables.</param>
2652 [EditorBrowsable(EditorBrowsableState.Never)]
2653 protected virtual void OnControlStateChanged(ControlStateChangedEventArgs controlStateChangedInfo)
2659 [EditorBrowsable(EditorBrowsableState.Never)]
2660 protected virtual void OnThemeChanged(object sender, ThemeChangedEventArgs e)
2665 private bool IsViewPropertyDirty(BindableProperty styleProperty)
2667 if (dirtyPropertySet.Count == 0)
2672 return dirtyPropertySet.Contains(styleProperty.PropertyName);
2676 /// Apply style instance to the view.
2677 /// Basically it sets the bindable property to the value of the bindable property with same name in the style.
2679 /// <since_tizen> 9 </since_tizen>
2680 public virtual void ApplyStyle(ViewStyle viewStyle)
2682 if (viewStyle == null || this.viewStyle == viewStyle) return;
2684 this.viewStyle = viewStyle;
2686 if (viewStyle.DirtyProperties == null || viewStyle.DirtyProperties.Count == 0)
2692 if (dirtyPropertySet == null)
2694 dirtyPropertySet = new HashSet<string>();
2697 BindableProperty.GetBindablePropertysOfType(GetType(), out var bindablePropertyOfView);
2699 if (bindablePropertyOfView == null)
2704 var dirtyStyleProperties = new BindableProperty[viewStyle.DirtyProperties.Count];
2705 viewStyle.DirtyProperties.CopyTo(dirtyStyleProperties);
2707 foreach (var sourceProperty in dirtyStyleProperties)
2709 if (blockSetDirty && IsViewPropertyDirty(sourceProperty))
2711 // Skip applying theme style for a property set by user.
2715 var sourceValue = viewStyle.GetValue(sourceProperty);
2717 if (sourceValue == null)
2722 bindablePropertyOfView.TryGetValue(sourceProperty.PropertyName, out var destinationProperty);
2724 if (destinationProperty != null)
2726 SetValue(destinationProperty, sourceValue);
2732 /// Get whether the View is culled or not.
2733 /// True means that the View is out of the view frustum.
2736 /// Hidden-API (Inhouse-API).
2738 [EditorBrowsable(EditorBrowsableState.Never)]
2744 var pValue = GetProperty(View.Property.Culled);
2745 pValue.Get(out temp);
2752 /// Set or Get TransitionOptions for the page transition.
2755 /// Hidden-API (Inhouse-API).
2757 [EditorBrowsable(EditorBrowsableState.Never)]
2758 public TransitionOptions TransitionOptions
2762 transitionOptions = value;
2766 return transitionOptions;