Class Layer
Definition
- Assembly:
- Tizen.NUI.dll
Layers provide a mechanism for overlaying groups of actors on top of each other.
public class Layer : Container, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider
- Inheritance
- Implements
-
System.IDisposable
Constructors
View SourceLayer()
Creates a Layer object.
Declaration
public Layer()
Properties
View SourceBehavior
Layer behavior, type String (Layer.LayerBehavior).
Declaration
public Layer.LayerBehavior Behavior { get; set; }
Property Value
Type | Description |
---|---|
Layer.LayerBehavior |
ChildCount
Get the number of children held by the layer.
Declaration
public uint ChildCount { get; }
Property Value
Type | Description |
---|---|
uint |
Depth
Queries the depth of the layer.
0 is the bottommost layer, higher number is on the top.
Declaration
public uint Depth { get; }
Property Value
Type | Description |
---|---|
uint |
ID
Gets the Layer's ID Readonly
Declaration
public uint ID { get; }
Property Value
Type | Description |
---|---|
uint |
Remarks
Hidden-API
Name
Gets or sets the layer's name.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
Opacity
Retrieves and sets the layer's opacity.
Declaration
public float Opacity { get; set; }
Property Value
Type | Description |
---|---|
float |
Viewport
Sets the viewport (in window coordinates), type rectangle. The contents of the layer will not be visible outside this box, when ViewportEnabled is true.
Declaration
public Rectangle Viewport { get; set; }
Property Value
Type | Description |
---|---|
Rectangle |
Visibility
Retrieves and sets the layer's visibility.
Declaration
public bool Visibility { get; set; }
Property Value
Type | Description |
---|---|
bool |
Methods
View SourceAdd(View)
Adds a child view to this layer.
Declaration
public override void Add(View child)
Parameters
Type | Name | Description |
---|---|---|
View | child |
Overrides
See Also
View SourceDispose(DisposeTypes)
Dispose Explicit or Implicit
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Type | Name | Description |
---|---|---|
DisposeTypes | type |
Overrides
View SourceDownCast(BaseHandle)
Downcasts a handle to layer handle.
Declaration
public static Layer DownCast(BaseHandle handle)
Parameters
Type | Name | Description |
---|---|---|
BaseHandle | handle |
Returns
Type | Description |
---|---|
Layer |
FindChildById(uint)
Search through this layer's hierarchy for a view with the given unique ID.
Declaration
public View FindChildById(uint id)
Parameters
Type | Name | Description |
---|---|---|
uint | id | The id of the child to find |
Returns
Type | Description |
---|---|
View | A handle to the view if found, or an empty handle if not. |
Remarks
The actor itself is also considered in the search.
FindChildByName(string)
Declaration
public View FindChildByName(string viewName)
Parameters
Type | Name | Description |
---|---|---|
string | viewName |
Returns
Type | Description |
---|---|
View |
GetChildAt(uint)
Retrieves a child view by the index.
Declaration
public override View GetChildAt(uint index)
Parameters
Type | Name | Description |
---|---|---|
uint | index | The index of the child to retrieve. |
Returns
Type | Description |
---|---|
View | The view for the given index or empty handle if children not initialized. |
Overrides
View SourceGetChildCount()
Get the child count of the layer.
Declaration
public override uint GetChildCount()
Returns
Type | Description |
---|---|
uint | The child count of the layer. |
Overrides
View SourceGetParent()
Get parent of the layer.
Declaration
public override Container GetParent()
Returns
Type | Description |
---|---|
Container | The view's container |
Overrides
View SourceLower()
Decrements the depth of the layer.
Declaration
public void Lower()
LowerToBottom()
Lowers the layer to the bottom.
Declaration
public void LowerToBottom()
MoveAbove(Layer)
Moves the layer directly above the given layer.
After the call, this layer's depth will be immediately above target.
Declaration
public void MoveAbove(Layer target)
Parameters
Type | Name | Description |
---|---|---|
Layer | target | The layer to get on top of. |
MoveBelow(Layer)
Moves the layer directly below the given layer.
After the call, this layer's depth will be immediately below target.
Declaration
public void MoveBelow(Layer target)
Parameters
Type | Name | Description |
---|---|---|
Layer | target | The layer to get below of. |
Raise()
Increments the depth of the layer.
Declaration
public void Raise()
RaiseToTop()
Raises the layer to the top.
Declaration
public void RaiseToTop()
ReleaseSwigCPtr(HandleRef)
Declaration
protected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
Type | Name | Description |
---|---|---|
Tizen.System.Runtime.InteropServices.HandleRef | swigCPtr |
Overrides
View SourceRemove(View)
Removes a child view from this layer. If the view was not a child of this layer, this is a no-op.
Declaration
public override void Remove(View child)
Parameters
Type | Name | Description |
---|---|---|
View | child |
Overrides
See Also
View SourceSetAnchorPoint(Vector3)
Declaration
public void SetAnchorPoint(Vector3 anchorPoint)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | anchorPoint |
SetHoverConsumed(bool)
Inhouse API. This allows the user to specify whether this layer should consume hover. If set, any layers behind this layer will not be hit-test.
Declaration
public void SetHoverConsumed(bool consume)
Parameters
Type | Name | Description |
---|---|---|
bool | consume | Whether the layer should consume hover |
SetParentOrigin(Vector3)
Declaration
public void SetParentOrigin(Vector3 parentOrigin)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | parentOrigin |
SetResizePolicy(ResizePolicyType, DimensionType)
Declaration
public void SetResizePolicy(ResizePolicyType policy, DimensionType dimension)
Parameters
Type | Name | Description |
---|---|---|
ResizePolicyType | policy | |
DimensionType | dimension |
SetSize(float, float)
Declaration
public void SetSize(float width, float height)
Parameters
Type | Name | Description |
---|---|---|
float | width | |
float | height |
SetTouchConsumed(bool)
Inhouse API. This allows the user to specify whether this layer should consume touch (including gestures). If set, any layers behind this layer will not be hit-test.
Declaration
public void SetTouchConsumed(bool consume)
Parameters
Type | Name | Description |
---|---|---|
bool | consume | Whether the layer should consume touch (including gestures). |
Events
View SourceVisibilityChanged
An event for visibility change which can be used to subscribe or unsubscribe the event handler.
This signal is emitted when the visible property of this or a parent view is changed.
Declaration
public event EventHandler<Layer.VisibilityChangedEventArgs> VisibilityChanged
Event Type
Type | Description |
---|---|
EventHandler<><VisibilityChangedEventArgs> |