Class GenListItem

Definition

Namespace:

ElmSharp

Assembly:

ElmSharp.dll

It inherits GenItem. A instance to the genlist item is added. It contains the Update() method to update a genlist item which is given.

public class GenListItem : GenItem

Inheritance

object

ItemObject

GenItem

GenListItem

Properties

ExpandedItemDepth

Gets the depth of the expanded item.

Declaration

public int ExpandedItemDepth { get; }

Property Value

Type	Description
int

Index

Gets the index of the item. It is only valid, once displayed.

Declaration

public int Index { get; }

Property Value

Type	Description
int

IsExpanded

Gets or sets whether a given genlist item is expanded.

Declaration

public bool IsExpanded { get; set; }

Property Value

Type	Description
bool

IsSelected

Gets or sets whether a given genlist item is selected.

Declaration

public override bool IsSelected { get; set; }

Property Value

Type	Description
bool

Overrides

GenItem.IsSelected

IsTooltipWindowMode

Gets or sets the disable size restrictions on an object's tooltip.

Declaration

public bool IsTooltipWindowMode { get; set; }

Property Value

Type	Description
bool

Next

Gets the next item in a genlist widget's internal list of items.

Declaration

public GenListItem Next { get; }

Property Value

Type	Description
GenListItem

See Also

Previous

Previous

Gets the previous item in a genlist widget's internal list of items.

Declaration

public GenListItem Previous { get; }

Property Value

Type	Description
GenListItem

See Also

Next

SelectionMode

Gets or sets the genlist item's select mode.

Declaration

public override GenItemSelectionMode SelectionMode { get; set; }

Property Value

Type	Description
GenItemSelectionMode

Overrides

GenItem.SelectionMode

TooltipStyle

Gets or sets the style of the given genlist item's tooltip.

Declaration

public override string TooltipStyle { get; set; }

Property Value

Type	Description
string

Overrides

GenItem.TooltipStyle

Methods

ClearSubitems()

Remove all the subitems (children) of the given item.

Declaration

public void ClearSubitems()

Remarks

This removes the items that are the children (and their descendants) of the given item.

DemoteItem()

Demotes an item to the end of the list.

Declaration

public void DemoteItem()

SetTooltipText(string)

Sets the text to be shown in the genlist item.

Declaration

public override void SetTooltipText(string tooltip)

Parameters

Type	Name	Description
string	tooltip	The text to set in the content.

Overrides

GenItem.SetTooltipText(string)

UnsetTooltip()

Unsets the tooltip from the item.

Declaration

public override void UnsetTooltip()

Overrides

GenItem.UnsetTooltip()

Update()

Updates the content of an item. This updates an item by calling all GenItemClass again to get the content, text, and states. Use this when the original item data has changed and the changes are desired to reflect. To update the already realized items, use UpdateRealizedItems().

Declaration

public override void Update()

Overrides

GenItem.Update()

See Also

UpdateRealizedItems()

UpdateField(string, GenListItemFieldType)

Updates the part of an item. This updates an item's part by calling the item's fetching functions again to get the contents, texts, and states. Use this when the original item data has changed and the changes are desired to be reflected. To update an item's all property, use UpdateRealizedItems().

Declaration

public void UpdateField(string part, GenListItemFieldType type)

Parameters

Type	Name	Description
string	part	The part could be "elm.text", "elm.swalllow.icon", "elm.swallow.end", "elm.swallow.content", and so on. It is also used for globbing to match '*', '?', and '.'. It can be used for updating multi-fields.
GenListItemFieldType	type	The type of the item's part type.

See Also

UpdateRealizedItems()

UpdateItemClass(GenItemClass, object)

Updates the item class of the item. This sets another class of the item, changing the way that it is displayed. After changing the item class, Update() is called on the item.

Declaration

public void UpdateItemClass(GenItemClass itemClass, object data)

Parameters

Type	Name	Description
GenItemClass	itemClass	The item class for the item.
object	data	The data for the item.

UpdateTooltipDelegate()

Sets the content to be shown in the tooltip item.

Declaration

protected override void UpdateTooltipDelegate()

Overrides

GenItem.UpdateTooltipDelegate()

Extension Methods

ItemObjectExtension.ClearHighlight(ItemObject)

ItemObjectExtension.GrabHighlight(ItemObject)