Class Index

Definition

Namespace:
ElmSharp
Assembly:
ElmSharp.dll
API Level:
preview

The Index widget gives you an index for fast access to whichever group of the other UI items one might have. Inherits Layout.

C#
Copy
public class Index : Layout, IAccessibleObject
Inheritance
Implements

Constructors

View Source

Index(EvasObject)

Creates and initializes a new instance of the Index class.

Declaration
C#
Copy
public Index(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

The parent is a given container, which will be attached by Index as a child. It's EvasObject type.

API Level: preview

Properties

View Source

AutoHide

Sets or gets whether the auto hiding feature is enabled or not for a given index widget.

Declaration
C#
Copy
public bool AutoHide { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

Delay

Sets a delay change time for the index object. The delay time is 0.2 seconds by default.

Declaration
C#
Copy
public double Delay { get; set; }
Property Value
Type Description
System.Double
API Level: preview
View Source

IndicatorVisible

Sets or gets a value of the indicator's disabled status.

Declaration
C#
Copy
public bool IndicatorVisible { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

IsHorizontal

Sets or gets a value whether the horizontal mode is enabled or not.

Declaration
C#
Copy
public bool IsHorizontal { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

Level

Gets or sets the items level for a given index widget.

Declaration
C#
Copy
public int Level { get; set; }
Property Value
Type Description
System.Int32
API Level: preview
View Source

OmitEnabled

Sets or gets whether the omit feature is enabled or not for a given index widget.

Declaration
C#
Copy
public bool OmitEnabled { get; set; }
Property Value
Type Description
System.Boolean
API Level: preview
View Source

Priority

Controls the standard_priority group of the index. Priority group will be shown as many items as it can, and other group will be shown for one character only.

Declaration
C#
Copy
public int Priority { get; set; }
Property Value
Type Description
System.Int32
API Level: preview
View Source

SelectedItem

Gets the last selected item for a given index widget.

Declaration
C#
Copy
public IndexItem SelectedItem { get; }
Property Value
Type Description
IndexItem
API Level: preview

Methods

View Source

Append(String)

Appends a new item on a given index widget.

Declaration
C#
Copy
public IndexItem Append(string label)
Parameters
Type Name Description
System.String label

The label for which the item should be indexed.

Returns
Type Description
IndexItem

An object to the IndexItem if added, or null on errors.

API Level: preview
View Source

Clear()

Removes all the items from a given index widget.

Declaration
C#
Copy
public void Clear()
API Level: preview
View Source

CreateHandle(EvasObject)

Creates a widget handle.

Declaration
C#
Copy
protected override IntPtr CreateHandle(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

Parent EvasObject.

Returns
Type Description
System.IntPtr

Handle IntPtr.

Overrides
API Level: preview
View Source

InsertAfter(String, IndexItem)

Inserts a new item into the index object after the item after.

Declaration
C#
Copy
public IndexItem InsertAfter(string label, IndexItem after)
Parameters
Type Name Description
System.String label

The label for which the item should be indexed.

IndexItem after

The index item to insert after.

Returns
Type Description
IndexItem

An object to the IndexItem if added, or null on errors.

API Level: preview
View Source

InsertBefore(String, IndexItem)

Inserts a new item into the index object before the item before.

Declaration
C#
Copy
public IndexItem InsertBefore(string label, IndexItem before)
Parameters
Type Name Description
System.String label

The label for which the item should be indexed.

IndexItem before

The index item to insert after.

Returns
Type Description
IndexItem

An object to the IndexItem if added, or null on errors.

API Level: preview
View Source

Prepend(String)

Prepends a new item on a given index widget.

Declaration
C#
Copy
public IndexItem Prepend(string label)
Parameters
Type Name Description
System.String label

The label for which the item should be indexed.

Returns
Type Description
IndexItem

A handle to the item if added, or null on errors.

API Level: preview
View Source

Update(Int32)

Flushes the changes made to the index items so that they work correctly.

Declaration
C#
Copy
public void Update(int level)
Parameters
Type Name Description
System.Int32 level

The index level (one of 0 or 1) where the changes were made.

API Level: preview

Events

View Source

Changed

Changed will be triggered when the selected index item is changed.

Declaration
C#
Copy
public event EventHandler Changed
Event Type
Type Description
System.EventHandler
API Level: preview

Implements

Extension Methods