Class Index

View Source

Definition

Namespace:
ElmSharp
Assembly:
ElmSharp.dll

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

                    

                

            
[Obsolete("This has been deprecated in API12")]
public class Index : Layout, IAccessibleObject
Inheritance
object
EvasObject
AccessibleObject
Widget
Container
Layout
Index
Implements
IAccessibleObject

Constructors

View Source

Index(EvasObject)

Creates and initializes a new instance of the Index class.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
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.

Properties

View Source

AutoHide

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

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public bool AutoHide { get; set; }
Property Value
Type Description
bool
View Source

Delay

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

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public double Delay { get; set; }
Property Value
Type Description
double
View Source

IndicatorVisible

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

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public bool IndicatorVisible { get; set; }
Property Value
Type Description
bool
View Source

IsHorizontal

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

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public bool IsHorizontal { get; set; }
Property Value
Type Description
bool
View Source

Level

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

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public int Level { get; set; }
Property Value
Type Description
int
View Source

OmitEnabled

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

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public bool OmitEnabled { get; set; }
Property Value
Type Description
bool
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

                    

                

            
[Obsolete("This has been deprecated in API12")]
public int Priority { get; set; }
Property Value
Type Description
int
View Source

SelectedItem

Gets the last selected item for a given index widget.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public IndexItem SelectedItem { get; }
Property Value
Type Description
IndexItem

Methods

View Source

Append(string)

Appends a new item on a given index widget.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public IndexItem Append(string label)
Parameters
Type Name Description
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.
View Source

Clear()

Removes all the items from a given index widget.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public void Clear()
View Source

CreateHandle(EvasObject)

Creates a widget handle.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
protected override IntPtr CreateHandle(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

Parent EvasObject.
Returns
Type Description
System.IntPtr

Handle IntPtr.
Overrides
View Source

InsertAfter(string, IndexItem)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public IndexItem InsertAfter(string label, IndexItem after)
Parameters
Type Name Description
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.
View Source

InsertBefore(string, IndexItem)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public IndexItem InsertBefore(string label, IndexItem before)
Parameters
Type Name Description
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.
View Source

Prepend(string)

Prepends a new item on a given index widget.

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public IndexItem Prepend(string label)
Parameters
Type Name Description
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.
View Source

Update(int)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public void Update(int level)
Parameters
Type Name Description
int level

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

Events

View Source

Changed

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

Declaration

                
C#

                

                    
Copy

                    

                

            
[Obsolete("This has been deprecated in API12")]
public event EventHandler Changed
Event Type
Type Description
System.EventHandler

Implements

Extension Methods