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.
814 /// Also, this property is for <see cref="TableView"/> class. Please use the property for the child position of <see cref="TableView"/>.
816 /// <since_tizen> 3 </since_tizen>
817 public Vector2 CellIndex
821 Vector2 temp = (Vector2)GetValue(CellIndexProperty);
822 return new Vector2(OnCellIndexChanged, temp.X, temp.Y);
826 SetValue(CellIndexProperty, value);
827 NotifyPropertyChanged();
832 /// The number of rows this child occupies, if not set, the default value is 1.
835 /// This property is for <see cref="TableView"/> class. Please use the property for the child position of <see cref="TableView"/>.
837 /// <since_tizen> 3 </since_tizen>
842 return (float)GetValue(RowSpanProperty);
846 SetValue(RowSpanProperty, value);
847 NotifyPropertyChanged();
852 /// The number of columns this child occupies, if not set, the default value is 1.
855 /// This property is for <see cref="TableView"/> class. Please use the property for the child position of <see cref="TableView"/>.
857 /// <since_tizen> 3 </since_tizen>
858 public float ColumnSpan
862 return (float)GetValue(ColumnSpanProperty);
866 SetValue(ColumnSpanProperty, value);
867 NotifyPropertyChanged();
872 /// The horizontal alignment of this child inside the cells, if not set, the default value is 'left'.
875 /// This property is for <see cref="TableView"/> class. Please use the property for the child position of <see cref="TableView"/>.
877 /// <since_tizen> 3 </since_tizen>
878 public Tizen.NUI.HorizontalAlignmentType CellHorizontalAlignment
882 return (HorizontalAlignmentType)GetValue(CellHorizontalAlignmentProperty);
886 SetValue(CellHorizontalAlignmentProperty, value);
887 NotifyPropertyChanged();
892 /// The vertical alignment of this child inside the cells, if not set, the default value is 'top'.
895 /// This property is for <see cref="TableView"/> class. Please use the property for the child position of <see cref="TableView"/>.
897 /// <since_tizen> 3 </since_tizen>
898 public Tizen.NUI.VerticalAlignmentType CellVerticalAlignment
902 return (VerticalAlignmentType)GetValue(CellVerticalAlignmentProperty);
906 SetValue(CellVerticalAlignmentProperty, value);
907 NotifyPropertyChanged();
912 /// The left focusable view.<br />
913 /// This will return null if not set.<br />
914 /// This will also return null if the specified left focusable view is not on a window.<br />
916 /// <since_tizen> 3 </since_tizen>
917 public View LeftFocusableView
919 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
922 return (View)GetValue(LeftFocusableViewProperty);
926 SetValue(LeftFocusableViewProperty, value);
927 NotifyPropertyChanged();
932 /// The right focusable view.<br />
933 /// This will return null if not set.<br />
934 /// This will also return null if the specified right focusable view is not on a window.<br />
936 /// <since_tizen> 3 </since_tizen>
937 public View RightFocusableView
939 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
942 return (View)GetValue(RightFocusableViewProperty);
946 SetValue(RightFocusableViewProperty, value);
947 NotifyPropertyChanged();
952 /// The up focusable view.<br />
953 /// This will return null if not set.<br />
954 /// This will also return null if the specified up focusable view is not on a window.<br />
956 /// <since_tizen> 3 </since_tizen>
957 public View UpFocusableView
959 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
962 return (View)GetValue(UpFocusableViewProperty);
966 SetValue(UpFocusableViewProperty, value);
967 NotifyPropertyChanged();
972 /// The down focusable view.<br />
973 /// This will return null if not set.<br />
974 /// This will also return null if the specified down focusable view is not on a window.<br />
976 /// <since_tizen> 3 </since_tizen>
977 public View DownFocusableView
979 // As native side will be only storing IDs so need a logic to convert View to ID and vice-versa.
982 return (View)GetValue(DownFocusableViewProperty);
986 SetValue(DownFocusableViewProperty, value);
987 NotifyPropertyChanged();
992 /// Whether the view should be focusable by keyboard navigation.
994 /// <since_tizen> 3 </since_tizen>
995 public bool Focusable
999 SetValue(FocusableProperty, value);
1000 NotifyPropertyChanged();
1004 return (bool)GetValue(FocusableProperty);
1009 /// Retrieves the position of the view.<br />
1010 /// The coordinates are relative to the view's parent.<br />
1012 /// <since_tizen> 3 </since_tizen>
1013 public Position CurrentPosition
1017 return GetCurrentPosition();
1022 /// Sets the size of a view for the width and the height.<br />
1023 /// Geometry can be scaled to fit within this area.<br />
1024 /// This does not interfere with the view's scale factor.<br />
1025 /// The views default depth is the minimum of width and height.<br />
1028 /// This NUI object (Size2D) typed property can be configured by multiple cascade setting. <br />
1029 /// For example, this code ( view.Size2D.Width = 100; view.Size2D.Height = 100; ) is equivalent to this ( view.Size2D = new Size2D(100, 100); ). <br />
1031 /// <since_tizen> 3 </since_tizen>
1032 public Size2D Size2D
1036 Size2D temp = (Size2D)GetValue(Size2DProperty);
1037 int width = temp.Width;
1038 int height = temp.Height;
1040 if (this.Layout == null)
1042 if (width < 0) { width = 0; }
1043 if (height < 0) { height = 0; }
1046 return new Size2D(OnSize2DChanged, width, height);
1050 SetValue(Size2DProperty, value);
1052 NotifyPropertyChanged();
1057 /// Retrieves the size of the view.<br />
1058 /// The coordinates are relative to the view's parent.<br />
1060 /// <since_tizen> 3 </since_tizen>
1061 public Size2D CurrentSize
1065 return GetCurrentSize();
1070 /// Retrieves and sets the view's opacity.<br />
1072 /// <since_tizen> 3 </since_tizen>
1073 public float Opacity
1077 return (float)GetValue(OpacityProperty);
1081 SetValue(OpacityProperty, value);
1082 NotifyPropertyChanged();
1087 /// Sets the position of the view for X and Y.<br />
1088 /// By default, sets the position vector between the parent origin and the pivot point (default).<br />
1089 /// If the position inheritance is disabled, sets the world position.<br />
1092 /// This NUI object (Position2D) typed property can be configured by multiple cascade setting. <br />
1093 /// For example, this code ( view.Position2D.X = 100; view.Position2D.Y = 100; ) is equivalent to this ( view.Position2D = new Position2D(100, 100); ). <br />
1095 /// <since_tizen> 3 </since_tizen>
1096 public Position2D Position2D
1100 Position2D temp = (Position2D)GetValue(Position2DProperty);
1101 return new Position2D(OnPosition2DChanged, temp.X, temp.Y);
1105 SetValue(Position2DProperty, value);
1106 NotifyPropertyChanged();
1111 /// Retrieves the screen position of the view.<br />
1113 /// <since_tizen> 3 </since_tizen>
1114 public Vector2 ScreenPosition
1118 Vector2 temp = new Vector2(0.0f, 0.0f);
1119 var pValue = GetProperty(View.Property.ScreenPosition);
1127 /// Determines whether the pivot point should be used to determine the position of the view.
1128 /// This is false by default.
1130 /// <remarks>If false, then the top-left of the view is used for the position.
1131 /// Setting this to false will allow scaling or rotation around the pivot point without affecting the view's position.
1133 /// <since_tizen> 3 </since_tizen>
1134 public bool PositionUsesPivotPoint
1138 return (bool)GetValue(PositionUsesPivotPointProperty);
1142 SetValue(PositionUsesPivotPointProperty, value);
1143 NotifyPropertyChanged();
1148 /// Deprecated in API5; Will be removed in API8. Please use PositionUsesPivotPoint instead!
1150 /// <since_tizen> 3 </since_tizen>
1151 [Obsolete("Deprecated in API5; Will be removed in API8. Please use PositionUsesPivotPoint instead! " +
1153 "View view = new View(); " +
1154 "view.PivotPoint = PivotPoint.Center; " +
1155 "view.PositionUsesPivotPoint = true;" +
1156 " Deprecated in API5: Will be removed in API8")]
1157 [EditorBrowsable(EditorBrowsableState.Never)]
1158 public bool PositionUsesAnchorPoint
1163 var pValue = GetProperty(View.Property.PositionUsesAnchorPoint);
1164 pValue.Get(out temp);
1170 var temp = new Tizen.NUI.PropertyValue(value);
1171 SetProperty(View.Property.PositionUsesAnchorPoint, temp);
1173 NotifyPropertyChanged();
1178 /// Queries whether the view is connected to the stage.<br />
1179 /// When a view is connected, it will be directly or indirectly parented to the root view.<br />
1181 /// <since_tizen> 3 </since_tizen>
1182 public bool IsOnWindow
1191 /// Gets the depth in the hierarchy for the view.
1193 /// <since_tizen> 3 </since_tizen>
1194 public int HierarchyDepth
1198 return GetHierarchyDepth();
1203 /// Sets the sibling order of the view so the depth position can be defined within the same parent.
1206 /// Note the initial value is 0. SiblingOrder should be bigger than 0 or equal to 0.
1207 /// Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove, and LowerBelow will override the sibling order.
1208 /// The values set by this property will likely change.
1210 /// <since_tizen> 3 </since_tizen>
1211 public int SiblingOrder
1215 return (int)GetValue(SiblingOrderProperty);
1219 SetValue(SiblingOrderProperty, value);
1221 LayoutGroup layout = Layout as LayoutGroup;
1222 layout?.ChangeLayoutSiblingOrder(value);
1224 NotifyPropertyChanged();
1229 /// Returns the natural size of the view.
1232 /// Deriving classes stipulate the natural size and by default a view has a zero natural size.
1234 /// <since_tizen> 5 </since_tizen>
1235 public Vector3 NaturalSize
1239 Vector3 ret = new Vector3(Interop.Actor.GetNaturalSize(SwigCPtr), true);
1240 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
1246 /// Returns the natural size (Size2D) of the view.
1249 /// Deriving classes stipulate the natural size and by default a view has a zero natural size.
1251 /// <since_tizen> 4 </since_tizen>
1252 public Size2D NaturalSize2D
1256 Vector3 temp = new Vector3(Interop.Actor.GetNaturalSize(SwigCPtr), true);
1257 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
1259 Size2D sz = new Size2D((int)temp.Width, (int)temp.Height);
1266 /// Gets or sets the origin of a view within its parent's area.<br />
1267 /// 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 />
1268 /// The default parent-origin is ParentOrigin.TopLeft (0.0, 0.0, 0.5).<br />
1269 /// A view's position is the distance between this origin and the view's anchor-point.<br />
1271 /// <pre>The view has been initialized.</pre>
1272 /// <since_tizen> 3 </since_tizen>
1273 public Position ParentOrigin
1277 Position tmp = (Position)GetValue(ParentOriginProperty);
1278 return new Position(OnParentOriginChanged, tmp.X, tmp.Y, tmp.Z);
1282 SetValue(ParentOriginProperty, value);
1283 NotifyPropertyChanged();
1288 /// Gets or sets the anchor-point of a view.<br />
1289 /// 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 />
1290 /// The default pivot point is PivotPoint.Center (0.5, 0.5, 0.5).<br />
1291 /// A view position is the distance between its parent-origin and this anchor-point.<br />
1292 /// A view's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.<br />
1293 /// <pre>The view has been initialized.</pre>
1296 /// The property cascade chaining set is possible. For example, this (view.PivotPoint.X = 0.1f;) is possible.
1298 /// <since_tizen> 3 </since_tizen>
1299 public Position PivotPoint
1303 Position tmp = (Position)GetValue(PivotPointProperty);
1304 return new Position(OnPivotPointChanged, tmp.X, tmp.Y, tmp.Z);
1308 SetValue(PivotPointProperty, value);
1309 NotifyPropertyChanged();
1314 /// Gets or sets the size width of the view.
1318 /// Animatable - This property can be animated using <c>Animation</c> class.
1321 /// <since_tizen> 3 </since_tizen>
1322 public float SizeWidth
1326 return (float)GetValue(SizeWidthProperty);
1330 SetValue(SizeWidthProperty, value);
1331 NotifyPropertyChanged();
1336 /// Gets or sets the size height of the view.
1340 /// Animatable - This property can be animated using <c>Animation</c> class.
1343 /// <since_tizen> 3 </since_tizen>
1344 public float SizeHeight
1348 return (float)GetValue(SizeHeightProperty);
1352 SetValue(SizeHeightProperty, value);
1353 NotifyPropertyChanged();
1358 /// Gets or sets the position of the view.<br />
1359 /// By default, sets the position vector between the parent origin and pivot point (default).<br />
1360 /// If the position inheritance is disabled, sets the world position.<br />
1364 /// Animatable - This property can be animated using <c>Animation</c> class.
1366 /// The property cascade chaining set is possible. For example, this (view.Position.X = 1.0f;) is possible.
1368 /// <since_tizen> 3 </since_tizen>
1369 public Position Position
1373 Position tmp = (Position)GetValue(PositionProperty);
1374 return new Position(OnPositionChanged, tmp.X, tmp.Y, tmp.Z);
1378 SetValue(PositionProperty, value);
1379 NotifyPropertyChanged();
1384 /// Gets or sets the position X of the view.
1388 /// Animatable - This property can be animated using <c>Animation</c> class.
1391 /// <since_tizen> 3 </since_tizen>
1392 public float PositionX
1396 return (float)GetValue(PositionXProperty);
1400 SetValue(PositionXProperty, value);
1401 NotifyPropertyChanged();
1406 /// Gets or sets the position Y of the view.
1410 /// Animatable - This property can be animated using <c>Animation</c> class.
1413 /// <since_tizen> 3 </since_tizen>
1414 public float PositionY
1418 return (float)GetValue(PositionYProperty);
1422 SetValue(PositionYProperty, value);
1423 NotifyPropertyChanged();
1428 /// Gets or sets the position Z of the view.
1432 /// Animatable - This property can be animated using <c>Animation</c> class.
1435 /// <since_tizen> 3 </since_tizen>
1436 public float PositionZ
1440 return (float)GetValue(PositionZProperty);
1444 SetValue(PositionZProperty, value);
1445 NotifyPropertyChanged();
1450 /// Gets or sets the world position of the view.
1452 /// <since_tizen> 3 </since_tizen>
1453 public Vector3 WorldPosition
1457 Vector3 temp = new Vector3(0.0f, 0.0f, 0.0f);
1458 var pValue = GetProperty(View.Property.WorldPosition);
1466 /// Gets or sets the orientation of the view.<br />
1467 /// The view's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.<br />
1471 /// This is an asynchronous method.
1474 /// Animatable - This property can be animated using <c>Animation</c> class.
1477 /// <since_tizen> 3 </since_tizen>
1478 public Rotation Orientation
1482 return (Rotation)GetValue(OrientationProperty);
1486 SetValue(OrientationProperty, value);
1487 NotifyPropertyChanged();
1492 /// Gets or sets the world orientation of the view.<br />
1494 /// <since_tizen> 3 </since_tizen>
1495 public Rotation WorldOrientation
1499 Rotation temp = new Rotation();
1500 var pValue = GetProperty(View.Property.WorldOrientation);
1508 /// Gets or sets the scale factor applied to the view.<br />
1512 /// Animatable - This property can be animated using <c>Animation</c> class.
1514 /// The property cascade chaining set is possible. For example, this (view.Scale.X = 0.1f;) is possible.
1516 /// <since_tizen> 3 </since_tizen>
1517 public Vector3 Scale
1521 Vector3 temp = (Vector3)GetValue(ScaleProperty);
1522 return new Vector3(OnScaleChanged, temp.X, temp.Y, temp.Z);
1526 SetValue(ScaleProperty, value);
1527 NotifyPropertyChanged();
1532 /// Gets or sets the scale X factor applied to the view.
1536 /// Animatable - This property can be animated using <c>Animation</c> class.
1539 /// <since_tizen> 3 </since_tizen>
1544 return (float)GetValue(ScaleXProperty);
1548 SetValue(ScaleXProperty, value);
1549 NotifyPropertyChanged();
1554 /// Gets or sets the scale Y factor applied to the view.
1558 /// Animatable - This property can be animated using <c>Animation</c> class.
1561 /// <since_tizen> 3 </since_tizen>
1566 return (float)GetValue(ScaleYProperty);
1570 SetValue(ScaleYProperty, value);
1571 NotifyPropertyChanged();
1576 /// Gets or sets the scale Z factor applied to the view.
1580 /// Animatable - This property can be animated using <c>Animation</c> class.
1583 /// <since_tizen> 3 </since_tizen>
1588 return (float)GetValue(ScaleZProperty);
1592 SetValue(ScaleZProperty, value);
1593 NotifyPropertyChanged();
1598 /// Gets the world scale of the view.
1600 /// <since_tizen> 3 </since_tizen>
1601 public Vector3 WorldScale
1605 Vector3 temp = new Vector3(0.0f, 0.0f, 0.0f);
1606 var pValue = GetProperty(View.Property.WorldScale);
1614 /// Retrieves the visibility flag of the view.
1618 /// If the view is not visible, then the view and its children will not be rendered.
1619 /// 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.
1622 /// Animatable - This property can be animated using <c>Animation</c> class.
1625 /// <since_tizen> 3 </since_tizen>
1626 public bool Visibility
1631 var pValue = GetProperty(View.Property.VISIBLE);
1632 pValue.Get(out temp);
1639 /// Gets the view's world color.
1641 /// <since_tizen> 3 </since_tizen>
1642 public Vector4 WorldColor
1646 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
1647 var pValue = GetProperty(View.Property.WorldColor);
1655 /// Gets or sets the view's name.
1657 /// <since_tizen> 3 </since_tizen>
1662 return (string)GetValue(NameProperty);
1666 SetValue(NameProperty, value);
1667 NotifyPropertyChanged();
1672 /// Get the number of children held by the view.
1674 /// <since_tizen> 3 </since_tizen>
1675 public new uint ChildCount
1679 return Convert.ToUInt32(Children.Count);
1684 /// Gets the view's ID.
1687 /// <since_tizen> 3 </since_tizen>
1697 /// Gets or sets the status of whether the view should emit touch or hover signals.
1699 /// <since_tizen> 3 </since_tizen>
1700 public bool Sensitive
1704 return (bool)GetValue(SensitiveProperty);
1708 SetValue(SensitiveProperty, value);
1709 NotifyPropertyChanged();
1714 /// 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.
1716 /// <since_tizen> 3 </since_tizen>
1717 public bool LeaveRequired
1721 return (bool)GetValue(LeaveRequiredProperty);
1725 SetValue(LeaveRequiredProperty, value);
1726 NotifyPropertyChanged();
1731 /// Gets or sets the status of whether a child view inherits it's parent's orientation.
1733 /// <since_tizen> 3 </since_tizen>
1734 public bool InheritOrientation
1738 return (bool)GetValue(InheritOrientationProperty);
1742 SetValue(InheritOrientationProperty, value);
1743 NotifyPropertyChanged();
1748 /// Gets or sets the status of whether a child view inherits it's parent's scale.
1750 /// <since_tizen> 3 </since_tizen>
1751 public bool InheritScale
1755 return (bool)GetValue(InheritScaleProperty);
1759 SetValue(InheritScaleProperty, value);
1760 NotifyPropertyChanged();
1765 /// Gets or sets the status of how the view and its children should be drawn.<br />
1766 /// Not all views are renderable, but DrawMode can be inherited from any view.<br />
1767 /// 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 />
1768 /// If DrawMode.Overlay2D is used, the view and its children will be drawn as a 2D overlay.<br />
1769 /// Overlay views are drawn in a separate pass, after all non-overlay views within the layer.<br />
1770 /// For overlay views, the drawing order is with respect to tree levels of views, and depth-testing will not be used.<br />
1772 /// <since_tizen> 3 </since_tizen>
1773 public DrawModeType DrawMode
1777 return (DrawModeType)GetValue(DrawModeProperty);
1781 SetValue(DrawModeProperty, value);
1782 NotifyPropertyChanged();
1787 /// Gets or sets the relative to parent size factor of the view.<br />
1788 /// This factor is only used when ResizePolicyType is set to either: ResizePolicyType.SizeRelativeToParent or ResizePolicyType.SizeFixedOffsetFromParent.<br />
1789 /// This view's size is set to the view's size multiplied by or added to this factor, depending on ResizePolicyType.<br />
1792 /// The property cascade chaining set is possible. For example, this (view.DecorationBoundingBox.X = 0.1f;) is possible.
1794 /// <since_tizen> 3 </since_tizen>
1795 public Vector3 SizeModeFactor
1799 Vector3 temp = (Vector3)GetValue(SizeModeFactorProperty);
1800 return new Vector3(OnSizeModeFactorChanged, temp.X, temp.Y, temp.Z);
1804 SetValue(SizeModeFactorProperty, value);
1805 NotifyPropertyChanged();
1810 /// Gets or sets the width resize policy to be used.
1812 /// <since_tizen> 3 </since_tizen>
1813 public ResizePolicyType WidthResizePolicy
1817 return (ResizePolicyType)GetValue(WidthResizePolicyProperty);
1821 SetValue(WidthResizePolicyProperty, value);
1822 NotifyPropertyChanged();
1827 /// Gets or sets the height resize policy to be used.
1829 /// <since_tizen> 3 </since_tizen>
1830 public ResizePolicyType HeightResizePolicy
1834 return (ResizePolicyType)GetValue(HeightResizePolicyProperty);
1838 SetValue(HeightResizePolicyProperty, value);
1839 NotifyPropertyChanged();
1844 /// Gets or sets the policy to use when setting size with size negotiation.<br />
1845 /// Defaults to SizeScalePolicyType.UseSizeSet.<br />
1847 /// <since_tizen> 3 </since_tizen>
1848 public SizeScalePolicyType SizeScalePolicy
1852 return (SizeScalePolicyType)GetValue(SizeScalePolicyProperty);
1856 SetValue(SizeScalePolicyProperty, value);
1857 NotifyPropertyChanged();
1862 /// Gets or sets the status of whether the width size is dependent on the height size.
1864 /// <since_tizen> 3 </since_tizen>
1865 public bool WidthForHeight
1869 return (bool)GetValue(WidthForHeightProperty);
1873 SetValue(WidthForHeightProperty, value);
1874 NotifyPropertyChanged();
1879 /// Gets or sets the status of whether the height size is dependent on the width size.
1881 /// <since_tizen> 3 </since_tizen>
1882 public bool HeightForWidth
1886 return (bool)GetValue(HeightForWidthProperty);
1890 SetValue(HeightForWidthProperty, value);
1891 NotifyPropertyChanged();
1896 /// Gets or sets the padding for use in layout.
1899 /// The property cascade chaining set is possible. For example, this (view.Padding.X = 0.1f;) is possible.
1901 /// <since_tizen> 5 </since_tizen>
1902 public Extents Padding
1906 // If View has a Layout then padding in stored in the base Layout class
1909 return Layout.Padding;
1913 Extents temp = (Extents)GetValue(PaddingProperty);
1914 return new Extents(OnPaddingChanged, temp.Start, temp.End, temp.Top, temp.Bottom);
1916 // Two return points to prevent creating a zeroed Extent native object before assignment
1920 Extents padding = value;
1923 // Layout set so store Padding in LayoutItem instead of in View.
1924 // If View stores the Padding value then Legacy Size Negotiation will overwrite
1925 // the position and sizes measure in the Layouting.
1926 Layout.Padding = value;
1927 // If Layout is a LayoutItem then it could be a View that handles it's own padding.
1928 // Let the View keeps it's padding. Still store Padding in Layout to reduce code paths.
1929 if (typeof(LayoutGroup).IsAssignableFrom(Layout.GetType())) // If a Layout container of some kind.
1931 padding = new Extents(0, 0, 0, 0); // Reset value stored in View.
1935 SetValue(PaddingProperty, padding);
1936 NotifyPropertyChanged();
1941 /// Gets or sets the minimum size the view can be assigned in size negotiation.
1943 /// <exception cref="ArgumentNullException"> Thrown when value is null. </exception>
1945 /// The property cascade chaining set is possible. For example, this (view.MinimumSize.Width = 1;) is possible.
1947 /// <since_tizen> 3 </since_tizen>
1948 public Size2D MinimumSize
1952 Size2D tmp = (Size2D)GetValue(MinimumSizeProperty);
1953 return new Size2D(OnMinimumSizeChanged, tmp.Width, tmp.Height);
1959 throw new ArgumentNullException(nameof(value));
1963 // Note: it only works if minimum size is >= than natural size.
1964 // To force the size it should be done through the width&height spec or Size2D.
1965 layout.MinimumWidth = new Tizen.NUI.LayoutLength(value.Width);
1966 layout.MinimumHeight = new Tizen.NUI.LayoutLength(value.Height);
1967 layout.RequestLayout();
1969 SetValue(MinimumSizeProperty, value);
1970 NotifyPropertyChanged();
1975 /// Gets or sets the maximum size the view can be assigned in size negotiation.
1978 /// The property cascade chaining set is possible. For example, this (view.MaximumSize.Width = 1;) is possible.
1980 /// <since_tizen> 3 </since_tizen>
1981 public Size2D MaximumSize
1985 Size2D tmp = (Size2D)GetValue(MaximumSizeProperty);
1986 return new Size2D(OnMaximumSizeChanged, tmp.Width, tmp.Height);
1990 // We don't have Layout.Maximum(Width|Height) so we cannot apply it to layout.
1991 // MATCH_PARENT spec + parent container size can be used to limit
1994 layout.RequestLayout();
1996 SetValue(MaximumSizeProperty, value);
1997 NotifyPropertyChanged();
2002 /// Gets or sets whether a child view inherits it's parent's position.<br />
2003 /// Default is to inherit.<br />
2004 /// 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 />
2006 /// <since_tizen> 3 </since_tizen>
2007 public bool InheritPosition
2011 return (bool)GetValue(InheritPositionProperty);
2015 SetValue(InheritPositionProperty, value);
2016 NotifyPropertyChanged();
2021 /// Gets or sets the clipping behavior (mode) of it's children.
2023 /// <since_tizen> 3 </since_tizen>
2024 public ClippingModeType ClippingMode
2028 return (ClippingModeType)GetValue(ClippingModeProperty);
2032 SetValue(ClippingModeProperty, value);
2033 NotifyPropertyChanged();
2038 /// Gets the number of renderers held by the view.
2040 /// <since_tizen> 3 </since_tizen>
2041 public uint RendererCount
2045 return GetRendererCount();
2050 /// Deprecated in API5; Will be removed in API8. Please use PivotPoint instead!
2053 /// The property cascade chaining set is possible. For example, this (view.AnchorPoint.X = 0.1f;) is possible.
2055 /// <since_tizen> 3 </since_tizen>
2056 [Obsolete("Deprecated in API5; Will be removed in API8. Please use PivotPoint instead! " +
2058 "View view = new View(); " +
2059 "view.PivotPoint = PivotPoint.Center; " +
2060 "view.PositionUsesPivotPoint = true;")]
2061 [EditorBrowsable(EditorBrowsableState.Never)]
2062 public Position AnchorPoint
2066 Position temp = new Position(0.0f, 0.0f, 0.0f);
2067 var pValue = GetProperty(View.Property.AnchorPoint);
2070 Position ret = new Position(OnAnchorPointChanged, temp.X, temp.Y, temp.Z);
2076 var temp = new Tizen.NUI.PropertyValue(value);
2077 SetProperty(View.Property.AnchorPoint, temp);
2079 NotifyPropertyChanged();
2084 /// Sets the size of a view for the width, the height and the depth.<br />
2085 /// Geometry can be scaled to fit within this area.<br />
2086 /// This does not interfere with the view's scale factor.<br />
2087 /// The views default depth is the minimum of width and height.<br />
2091 /// Animatable - This property can be animated using <c>Animation</c> class.
2093 /// The property cascade chaining set is possible. For example, this (view.Size.Width = 1.0f;) is possible.
2095 /// <since_tizen> 5 </since_tizen>
2100 Size tmp = (Size)GetValue(SizeProperty);
2101 return new Size(OnSizeChanged, tmp.Width, tmp.Height, tmp.Depth);
2105 SetValue(SizeProperty, value);
2106 NotifyPropertyChanged();
2111 /// Deprecated in API5; Will be removed in API8. Please use 'Container GetParent() for derived class' instead!
2113 /// <since_tizen> 3 </since_tizen>
2114 [Obsolete("Deprecated in API5; Will be removed in API8. Please use 'Container GetParent() for derived class' instead! " +
2116 "Container parent = view.GetParent(); " +
2117 "View view = parent as View;")]
2118 [EditorBrowsable(EditorBrowsableState.Never)]
2119 public new View Parent
2124 IntPtr cPtr = Interop.Actor.GetParent(SwigCPtr);
2125 HandleRef CPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
2126 BaseHandle basehandle = Registry.GetManagedBaseHandleFromNativePtr(CPtr.Handle);
2128 if (basehandle is Layer layer)
2130 ret = new View(Layer.getCPtr(layer).Handle, false);
2131 NUILog.Error("This Parent property is deprecated, should do not be used");
2135 ret = basehandle as View;
2138 Interop.BaseHandle.DeleteBaseHandle(CPtr);
2139 CPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
2141 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
2147 /// Gets/Sets whether inherit parent's the layout Direction.
2149 /// <since_tizen> 4 </since_tizen>
2150 public bool InheritLayoutDirection
2154 return (bool)GetValue(InheritLayoutDirectionProperty);
2158 SetValue(InheritLayoutDirectionProperty, value);
2159 NotifyPropertyChanged();
2164 /// Gets/Sets the layout Direction.
2166 /// <since_tizen> 4 </since_tizen>
2167 public ViewLayoutDirectionType LayoutDirection
2171 return (ViewLayoutDirectionType)GetValue(LayoutDirectionProperty);
2175 SetValue(LayoutDirectionProperty, value);
2176 NotifyPropertyChanged();
2177 layout?.RequestLayout();
2182 /// Gets or sets the Margin for use in layout.
2185 /// Margin property is supported by Layout algorithms and containers.
2186 /// Please Set Layout if you want to use Margin property.
2187 /// The property cascade chaining set is possible. For example, this (view.Margin.X = 0.1f;) is possible.
2189 /// <since_tizen> 4 </since_tizen>
2190 public Extents Margin
2194 // If View has a Layout then margin is stored in Layout.
2197 return Layout.Margin;
2201 // If Layout not set then return margin stored in View.
2202 Extents temp = (Extents)GetValue(MarginProperty);
2203 return new Extents(OnMarginChanged, temp.Start, temp.End, temp.Top, temp.Bottom);
2205 // Two return points to prevent creating a zeroed Extent native object before assignment
2211 // Layout set so store Margin in LayoutItem instead of View.
2212 // If View stores the Margin too then the Legacy Size Negotiation will
2213 // overwrite the position and size values measured in the Layouting.
2214 Layout.Margin = value;
2215 SetValue(MarginProperty, new Extents(0, 0, 0, 0));
2216 layout?.RequestLayout();
2220 SetValue(MarginProperty, value);
2222 NotifyPropertyChanged();
2223 layout?.RequestLayout();
2228 /// The required policy for this dimension, <see cref="LayoutParamPolicies"/> values or exact value.
2232 /// // matchParentView matches its size to its parent size.
2233 /// matchParentView.WidthSpecification = LayoutParamPolicies.MatchParent;
2234 /// matchParentView.HeightSpecification = LayoutParamPolicies.MatchParent;
2236 /// // wrapContentView wraps its children with their desired size.
2237 /// wrapContentView.WidthSpecification = LayoutParamPolicies.WrapContent;
2238 /// wrapContentView.HeightSpecification = LayoutParamPolicies.WrapContent;
2240 /// // exactSizeView shows itself with an exact size.
2241 /// exactSizeView.WidthSpecification = 100;
2242 /// exactSizeView.HeightSpecification = 100;
2245 /// <since_tizen> 6 </since_tizen>
2246 public int WidthSpecification
2254 if (value == widthPolicy)
2257 widthPolicy = value;
2258 if (widthPolicy >= 0)
2260 if (heightPolicy >= 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 /// The required policy for this dimension, <see cref="LayoutParamPolicies"/> values or exact value.
2275 /// // matchParentView matches its size to its parent size.
2276 /// matchParentView.WidthSpecification = LayoutParamPolicies.MatchParent;
2277 /// matchParentView.HeightSpecification = LayoutParamPolicies.MatchParent;
2279 /// // wrapContentView wraps its children with their desired size.
2280 /// wrapContentView.WidthSpecification = LayoutParamPolicies.WrapContent;
2281 /// wrapContentView.HeightSpecification = LayoutParamPolicies.WrapContent;
2283 /// // exactSizeView shows itself with an exact size.
2284 /// exactSizeView.WidthSpecification = 100;
2285 /// exactSizeView.HeightSpecification = 100;
2288 /// <since_tizen> 6 </since_tizen>
2289 public int HeightSpecification
2293 return heightPolicy;
2297 if (value == heightPolicy)
2300 heightPolicy = value;
2301 if (heightPolicy >= 0)
2303 if (widthPolicy >= 0) // Policy an exact value
2305 // Create Size2D only both _widthPolicy and _heightPolicy are set.
2306 Size2D = new Size2D(widthPolicy, heightPolicy);
2309 layout?.RequestLayout();
2314 /// Gets the List of transitions for this View.
2316 /// <since_tizen> 6 </since_tizen>
2317 public Dictionary<TransitionCondition, TransitionList> LayoutTransitions
2321 if (layoutTransitions == null)
2323 layoutTransitions = new Dictionary<TransitionCondition, TransitionList>();
2325 return layoutTransitions;
2330 /// Sets a layout transitions for this View.
2332 /// <exception cref="ArgumentNullException"> Thrown when value is null. </exception>
2334 /// Use LayoutTransitions to receive a collection of LayoutTransitions set on the View.
2336 /// <since_tizen> 6 </since_tizen>
2337 public LayoutTransition LayoutTransition
2341 return layoutTransition;
2347 throw new global::System.ArgumentNullException(nameof(value));
2349 if (layoutTransitions == null)
2351 layoutTransitions = new Dictionary<TransitionCondition, TransitionList>();
2354 LayoutTransitionsHelper.AddTransitionForCondition(layoutTransitions, value.Condition, value, true);
2356 AttachTransitionsToChildren(value);
2358 layoutTransition = value;
2363 /// Deprecated in API5; Will be removed in API8. Please use Padding instead.
2366 /// The property cascade chaining set is possible. For example, this (view.DecorationBoundingBox.X = 0.1f;) is possible.
2368 /// <since_tizen> 4 </since_tizen>
2369 [Obsolete("Deprecated in API5; Will be removed in API8. Please use Padding instead.")]
2370 [EditorBrowsable(EditorBrowsableState.Never)]
2371 public Extents PaddingEX
2375 Extents temp = new Extents(0, 0, 0, 0);
2376 var pValue = GetProperty(View.Property.PADDING);
2379 Extents ret = new Extents(OnPaddingEXChanged, temp.Start, temp.End, temp.Top, temp.Bottom);
2385 var temp = new Tizen.NUI.PropertyValue(value);
2386 SetProperty(View.Property.PADDING, temp);
2388 NotifyPropertyChanged();
2389 layout?.RequestLayout();
2394 /// The Color of View. This is an RGBA value.
2398 /// Animatable - This property can be animated using <c>Animation</c> class.
2400 /// The property cascade chaining set is possible. For example, this (view.Color.X = 0.1f;) is possible.
2402 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
2403 [EditorBrowsable(EditorBrowsableState.Never)]
2408 Color temp = (Color)GetValue(ColorProperty);
2409 return new Color(OnColorChanged, temp.R, temp.G, temp.B, temp.A);
2413 SetValue(ColorProperty, value);
2414 NotifyPropertyChanged();
2419 /// Set the layout on this View. Replaces any existing Layout.
2422 /// If this Layout is set as null explicitly, it means this View itself and it's child Views will not use Layout anymore.
2424 /// <since_tizen> 6 </since_tizen>
2425 public LayoutItem Layout
2433 // Do nothing if layout provided is already set on this View.
2434 if (value == layout)
2439 LayoutingDisabled = false;
2442 // If new layout being set already has a owner then that owner receives a replacement default layout.
2443 // First check if the layout to be set already has a owner.
2444 if (value?.Owner != null)
2446 // Previous owner of the layout gets a default layout as a replacement.
2447 value.Owner.Layout = new AbsoluteLayout();
2449 // Copy Margin and Padding to replacement LayoutGroup.
2450 if (value.Owner.Layout != null)
2452 value.Owner.Layout.Margin = value.Margin;
2453 value.Owner.Layout.Padding = value.Padding;
2457 // Copy Margin and Padding to new layout being set or restore padding and margin back to
2458 // View if no replacement. Previously margin and padding values would have been moved from
2459 // the View to the layout.
2460 if (layout != null) // Existing layout
2464 // Existing layout being replaced so copy over margin and padding values.
2465 value.Margin = layout.Margin;
2466 value.Padding = layout.Padding;
2470 // Layout not being replaced so restore margin and padding to View.
2471 SetValue(MarginProperty, layout.Margin);
2472 SetValue(PaddingProperty, layout.Padding);
2473 NotifyPropertyChanged();
2478 // First Layout to be added to the View hence copy
2480 // Do not try to set Margins or Padding on a null Layout (when a layout is being removed from a View)
2483 Extents margin = Margin;
2484 Extents padding = Padding;
2485 if (margin.Top != 0 || margin.Bottom != 0 || margin.Start != 0 || margin.End != 0)
2487 // If View already has a margin set then store it in Layout instead.
2488 value.Margin = margin;
2489 SetValue(MarginProperty, new Extents(0, 0, 0, 0));
2490 NotifyPropertyChanged();
2493 if (padding.Top != 0 || padding.Bottom != 0 || padding.Start != 0 || padding.End != 0)
2495 // If View already has a padding set then store it in Layout instead.
2496 value.Padding = padding;
2498 // If Layout is a LayoutItem then it could be a View that handles it's own padding.
2499 // Let the View keeps it's padding. Still store Padding in Layout to reduce code paths.
2500 if (typeof(LayoutGroup).IsAssignableFrom(value.GetType()))
2502 SetValue(PaddingProperty, new Extents(0, 0, 0, 0));
2503 NotifyPropertyChanged();
2509 // Remove existing layout from it's parent layout group.
2512 value.SetPositionByLayout = !excludeLayouting;
2514 // Set layout to this view
2520 /// The weight of the View, used to share available space in a layout with siblings.
2522 /// <since_tizen> 6 </since_tizen>
2532 layout?.RequestLayout();
2537 /// Whether to load the BackgroundImage synchronously.
2538 /// If not specified, the default is false, i.e. the BackgroundImage is loaded asynchronously.
2539 /// Note: For Normal Quad images only.
2541 /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API.
2542 [EditorBrowsable(EditorBrowsableState.Never)]
2543 public bool BackgroundImageSynchronosLoading
2547 return backgroundImageSynchronosLoading;
2551 backgroundImageSynchronosLoading = value;
2553 string bgUrl = null;
2554 var pValue = Background.Find(ImageVisualProperty.URL);
2555 pValue?.Get(out bgUrl);
2558 if (!string.IsNullOrEmpty(bgUrl))
2560 PropertyMap bgMap = this.Background;
2561 var temp = new PropertyValue(backgroundImageSynchronosLoading);
2562 bgMap.Add("synchronousLoading", temp);
2569 /// This will be public opened in tizen_6.0 after ACR done. Before ACR, need to be hidden as inhouse API.
2570 [EditorBrowsable(EditorBrowsableState.Never)]
2571 public Vector2 UpdateSizeHint
2575 return (Vector2)GetValue(UpdateSizeHintProperty);
2579 SetValue(UpdateSizeHintProperty, value);
2580 NotifyPropertyChanged();
2585 /// Enable/Disable ControlState propagation for children.
2586 /// It is false by default.
2587 /// If the View needs to share ControlState with descendants, please set it true.
2588 /// Please note that, changing the value will also changes children's EnableControlStatePropagation value recursively.
2590 [EditorBrowsable(EditorBrowsableState.Never)]
2591 public bool EnableControlStatePropagation
2593 get => controlStatePropagation;
2596 controlStatePropagation = value;
2598 foreach (View child in Children)
2600 child.EnableControlStatePropagation = value;
2606 /// By default, it is false in View, true in Control.
2607 /// Note that if the value is true, the View will be a touch receptor.
2609 [EditorBrowsable(EditorBrowsableState.Never)]
2610 public bool EnableControlState
2614 return (bool)GetValue(EnableControlStateProperty);
2618 SetValue(EnableControlStateProperty, value);
2623 /// Whether the actor grab all touches even if touch leaves its boundary.
2625 /// <returns>true, if it grab all touch after start</returns>
2626 [EditorBrowsable(EditorBrowsableState.Never)]
2627 public bool GrabTouchAfterLeave
2632 var pValue = GetProperty(View.Property.CaptureAllTouchAfterStart);
2633 pValue.Get(out temp);
2639 var temp = new Tizen.NUI.PropertyValue(value);
2640 SetProperty(View.Property.CaptureAllTouchAfterStart, temp);
2642 NotifyPropertyChanged();
2647 /// Determines which blend equation will be used to render renderers of this actor.
2649 /// <returns>blend equation enum currently assigned</returns>
2650 /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API.
2651 [EditorBrowsable(EditorBrowsableState.Never)]
2652 public BlendEquationType BlendEquation
2657 var pValue = GetProperty(View.Property.BlendEquation);
2658 pValue.Get(out temp);
2660 return (BlendEquationType)temp;
2664 var temp = new Tizen.NUI.PropertyValue((int)value);
2665 SetProperty(View.Property.BlendEquation, temp);
2667 NotifyPropertyChanged();
2672 /// If the value is true, the View will change its style as the theme changes.
2673 /// It is false by default, but turned to true when setting StyleName (by setting property or using specified constructor).
2675 /// <since_tizen> 9 </since_tizen>
2676 public bool ThemeChangeSensitive
2678 get => (bool)GetValue(ThemeChangeSensitiveProperty);
2679 set => SetValue(ThemeChangeSensitiveProperty, value);
2683 /// Create Style, it is abstract function and must be override.
2685 [EditorBrowsable(EditorBrowsableState.Never)]
2686 protected virtual ViewStyle CreateViewStyle()
2688 return new ViewStyle();
2692 /// Called after the View's ControlStates changed.
2694 /// <param name="controlStateChangedInfo">The information including state changed variables.</param>
2695 [EditorBrowsable(EditorBrowsableState.Never)]
2696 protected virtual void OnControlStateChanged(ControlStateChangedEventArgs controlStateChangedInfo)
2702 [EditorBrowsable(EditorBrowsableState.Never)]
2703 protected virtual void OnThemeChanged(object sender, ThemeChangedEventArgs e)
2709 /// Apply style instance to the view.
2710 /// Basically it sets the bindable property to the value of the bindable property with same name in the style.
2712 /// <since_tizen> 9 </since_tizen>
2713 public virtual void ApplyStyle(ViewStyle viewStyle)
2715 if (viewStyle == null || this.viewStyle == viewStyle) return;
2717 this.viewStyle = viewStyle;
2719 if (viewStyle.DirtyProperties == null || viewStyle.DirtyProperties.Count == 0)
2725 BindableProperty.GetBindablePropertysOfType(GetType(), out var bindablePropertyOfView);
2727 if (bindablePropertyOfView == null)
2732 var dirtyStyleProperties = new BindableProperty[viewStyle.DirtyProperties.Count];
2733 viewStyle.DirtyProperties.CopyTo(dirtyStyleProperties);
2735 foreach (var sourceProperty in dirtyStyleProperties)
2737 var sourceValue = viewStyle.GetValue(sourceProperty);
2739 if (sourceValue == null)
2744 bindablePropertyOfView.TryGetValue(sourceProperty.PropertyName, out var destinationProperty);
2746 if (destinationProperty != null)
2748 SetValue(destinationProperty, sourceValue);
2754 /// Get whether the View is culled or not.
2755 /// True means that the View is out of the view frustum.
2758 /// Hidden-API (Inhouse-API).
2760 [EditorBrowsable(EditorBrowsableState.Never)]
2766 var pValue = GetProperty(View.Property.Culled);
2767 pValue.Get(out temp);
2774 /// Set or Get TransitionOptions for the page transition.
2775 /// This property is used to define how this view will be transitioned during Page switching.
2777 /// <since_tizen> 9 </since_tizen>
2778 public TransitionOptions TransitionOptions
2782 transitionOptions = value;
2786 return transitionOptions;