Class Naviframe

The Naviframe is a widget to stand for the navigation frame. It's a views manager for applications. Inherits Widget.

Inheritance

Object

EvasObject

AccessibleObject

Widget

Naviframe

Implements

IAccessibleObject

Inherited Members

Widget.UpdatePartContents(EvasObject, String)

Widget.Focused

Widget.Unfocused

Widget.IsEnabled

Widget.Style

Widget.IsFocused

Widget.IsFocusAllowed

Widget.Text

Widget.BackgroundColor

Widget.Opacity

Widget.AllowTreeFocus

Widget.IsMirroredMode

Widget.IsAutoMirroredMode

Widget.SetFocus(Boolean)

Widget.AllowFocus(Boolean)

Widget.FocusNext(FocusDirection)

Widget.SetNextFocusObject(EvasObject, FocusDirection)

Widget.SetPartContent(String, EvasObject)

Widget.SetPartContent(String, EvasObject, Boolean)

Widget.SetContent(EvasObject)

Widget.SetContent(EvasObject, Boolean)

Widget.SetPartText(String, String)

Widget.GetPartText(String)

Widget.SetPartColor(String, Color)

Widget.GetPartColor(String)

Widget.SetPartOpacity(String, Int32)

Widget.GetPartOpacity(String)

Widget.SignalEmit(String, String)

Widget.OnRealized()

AccessibleObject.IAccessibleObject.ReadingInfoType

AccessibleObject.IAccessibleObject.Role

AccessibleObject.IAccessibleObject.CanHighlight

AccessibleObject.IAccessibleObject.TranslationDomain

AccessibleObject.IAccessibleObject.Name

AccessibleObject.IAccessibleObject.Description

AccessibleObject.IAccessibleObject.NameProvider

AccessibleObject.IAccessibleObject.DescriptionProvider

AccessibleObject.IAccessibleObject.AppendRelation(IAccessibleRelation)

AccessibleObject.IAccessibleObject.RemoveRelation(IAccessibleRelation)

AccessibleObject.Highlight()

AccessibleObject.Unhighlight()

EvasObject.Handle

EvasObject.Parent

EvasObject.RealHandle

EvasObject.Deleted

EvasObject.KeyUp

EvasObject.KeyDown

EvasObject.BackButtonPressed

EvasObject.MoreButtonPressed

EvasObject.Moved

EvasObject.Resized

EvasObject.Shown

EvasObject.Hidden

EvasObject.RenderPost

EvasObject.IsRealized

EvasObject.EvasCanvas

EvasObject.AutomationId

EvasObject.ClassName

EvasObject.WeightX

EvasObject.WeightY

EvasObject.AlignmentX

EvasObject.AlignmentY

EvasObject.MinimumWidth

EvasObject.MinimumHeight

EvasObject.IsVisible

EvasObject.Geometry

EvasObject.Color

EvasObject.IsMapEnabled

EvasObject.EvasMap

EvasObject.RepeatEvents

EvasObject.PropagateEvents

EvasObject.PassEvents

EvasObject.TooltipStyle

EvasObject.TooltipOrientation

EvasObject.TooltipWindowMode

EvasObject.TooltipContentDelegate

EvasObject.TooltipMoveFreezeCount

EvasObject.AllEventsFrozen

EvasObject.Layer

EvasObject.RenderOperation

EvasObject.SetClip(EvasObject)

EvasObject.SetAlignment(Double, Double)

EvasObject.SetWeight(Double, Double)

EvasObject.SetTooltipText(String)

EvasObject.UnsetTooltip()

EvasObject.PushTooltipMoveFreeze()

EvasObject.PopTooltipMoveFreeze()

EvasObject.HideTooltip()

EvasObject.ShowTooltip()

EvasObject.Show()

EvasObject.Hide()

EvasObject.Resize(Int32, Int32)

EvasObject.Move(Int32, Int32)

EvasObject.Lower()

EvasObject.KeyGrab(String, Boolean)

EvasObject.KeyUngrab(String)

EvasObject.MarkChanged()

EvasObject.Calculate()

EvasObject.SetSizeHintAspect(AspectControl, Int32, Int32)

EvasObject.GetSizeHintAspect(AspectControl, Int32, Int32)

EvasObject.StackBelow(EvasObject)

EvasObject.StackAbove(EvasObject)

EvasObject.RaiseTop()

EvasObject.GetTextBlockGeometryByLineNumber(Int32, Int32, Int32, Int32, Int32)

EvasObject.OnInvalidate()

EvasObject.OnInstantiated()

EvasObject.OnUnrealize()

EvasObject.Realize(EvasObject)

EvasObject.Unrealize()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: ElmSharp

Assembly: ElmSharp.dll

Syntax

public class Naviframe : Widget, IAccessibleObject

Constructors

Naviframe(EvasObject)

Creates and initializes a new instance of the Naviframe class.

Declaration

public Naviframe(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	The parent is a given container which will be attached by Naviframe as a child. It's EvasObject type.

API Version

preview

Properties

DefaultBackButtonEnabled

Sets or gets whether the default back button is enabled.

Declaration

public bool DefaultBackButtonEnabled { get; set; }

Property Value

Type	Description
Boolean

API Version

preview

NavigationStack

Gets the list of the navi item.

Declaration

public IReadOnlyList<NaviItem> NavigationStack { get; }

Property Value

Type	Description
IReadOnlyList<NaviItem>

API Version

preview

PreserveContentOnPop

Sets or gets the preserve content objects when items are popped.

Declaration

public bool PreserveContentOnPop { get; set; }

Property Value

Type	Description
Boolean

API Version

preview

Methods

CreateHandle(EvasObject)

Creates a widget handle.

Declaration

protected override IntPtr CreateHandle(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	Parent EvasObject.

Returns

Type	Description
IntPtr	Handle IntPtr.

Overrides

EvasObject.CreateHandle(EvasObject)

API Version

preview

InsertAfter(NaviItem, EvasObject)

Inserts a new item into the naviframe after the item. The title is "" and the style is null.

Declaration

public NaviItem InsertAfter(NaviItem after, EvasObject content)

Parameters

Type	Name	Description
NaviItem	after	The item for which a new item is inserted after.
EvasObject	content	The main content object. The name of the content part is "elm.swallow.content".

Returns

Type	Description
NaviItem	The created item, or null upon failure.

API Version

preview

InsertAfter(NaviItem, EvasObject, String)

Inserts a new item into the naviframe after the item. The style is null.

Declaration

public NaviItem InsertAfter(NaviItem after, EvasObject content, string title)

Parameters

Type	Name	Description
NaviItem	after	The item which a new item is inserted after.
EvasObject	content	The main content object. The name of the content part is "elm.swallow.content".
String	title	The current item title. Null would be default.

Returns

Type	Description
NaviItem	The created item, or null upon failure.

API Version

preview

InsertAfter(NaviItem, EvasObject, String, String)

Inserts a new item into the naviframe after the item.

Declaration

public NaviItem InsertAfter(NaviItem after, EvasObject content, string title, string style)

Parameters

Type	Name	Description
NaviItem	after	The item for which a new item is inserted after.
EvasObject	content	The main content object. The name of the content part is "elm.swallow.content".
String	title	The current item title. Null would be default.
String	style	The current item style name. Null would be default.

Returns

Type	Description
NaviItem	The created item, or null upon failure.

API Version

preview

InsertBefore(NaviItem, EvasObject)

Inserts a new item into the naviframe before the item. The title is "" and the style is null.

Declaration

public NaviItem InsertBefore(NaviItem before, EvasObject content)

Parameters

Type	Name	Description
NaviItem	before	The item for which a new item is inserted before.
EvasObject	content	The main content object. The name of the content part is "elm.swallow.content".

Returns

Type	Description
NaviItem	The created item, or null upon failure.

API Version

preview

InsertBefore(NaviItem, EvasObject, String)

Inserts a new item into the naviframe before the item. The style is null.

Declaration

public NaviItem InsertBefore(NaviItem before, EvasObject content, string title)

Parameters

Type	Name	Description
NaviItem	before	The item for which a new item is inserted before.
EvasObject	content	The main content object. The name of the content part is "elm.swallow.content".
String	title	The current item title. Null would be default.

Returns

Type	Description
NaviItem	The created item, or null upon failure.

API Version

preview

InsertBefore(NaviItem, EvasObject, String, String)

Inserts a new item into the naviframe before the item.

Declaration

public NaviItem InsertBefore(NaviItem before, EvasObject content, string title, string style)

Parameters

Type	Name	Description
NaviItem	before	The item for which a new item is inserted before.
EvasObject	content	The main content object. The name of the content part is "elm.swallow.content".
String	title	The current item title. Null would be default.
String	style	The current item style name. Null would be default.

Returns

Type	Description
NaviItem	The created item, or null upon failure.

API Version

preview

Pop()

Pops an item that is on top of the stack.

Declaration

public void Pop()

API Version

preview

Push(EvasObject)

Pushes a new item to the top of the naviframe stack and shows it. The title and style are null.

Declaration

public NaviItem Push(EvasObject content)

Parameters

Type	Name	Description
EvasObject	content	The main content object. The name of the content part is "elm.swallow.content".

Returns

Type	Description
NaviItem	The created item, or null upon failure.

API Version

preview

Push(EvasObject, String)

Pushes a new item to the top of the naviframe stack and shows it. The style is null.

Declaration

public NaviItem Push(EvasObject content, string title)

Parameters

Type	Name	Description
EvasObject	content	The main content object. The name of the content part is "elm.swallow.content".
String	title	The current item title. Null would be default.

Returns

Type	Description
NaviItem

API Version

preview

Push(EvasObject, String, String)

Pushes a new item to the top of the naviframe stack and shows it.

Declaration

public NaviItem Push(EvasObject content, string title, string style)

Parameters

Type	Name	Description
EvasObject	content	The main content object. The name of the content part is "elm.swallow.content".
String	title	The current item title. Null would be default.
String	style	The current item style name. Null would be default.

Returns

Type	Description
NaviItem	The created item, or null upon failure.

API Version

preview

Events

AnimationFinished

AnimationFinished will be triggered when the animation is finished.

Declaration

public event EventHandler AnimationFinished

Event Type

Type	Description
EventHandler

API Version

preview

Popped

Popped will be triggered when the NaviItem is removed.

Declaration

public event EventHandler<NaviframeEventArgs> Popped

Event Type

Type	Description
EventHandler<NaviframeEventArgs>

Remarks

It is always called when the NaviItem is removed. (even if removed by NaviItem.Delete()) This event will be invoked in progress of the Pop/Delete operation. After calling the Popped event, the Pop/Delete method will be returned.

API Version

preview

Implements

IAccessibleObject

Extension Methods

RotaryEventExtensions.AddRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.RemoveRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.Activate(EvasObject)

RotaryEventExtensions.Deactivate(EvasObject)