Class Toolbar

Definition

Namespace:

ElmSharp

Assembly:

ElmSharp.dll

API Level:

preview

The Toolbar is a widget that displays a list of items inside a box.

public class Toolbar : Widget, IAccessibleObject

Inheritance

Object

EvasObject

AccessibleObject

Widget

Toolbar

Implements

IAccessibleObject

Constructors

Toolbar(EvasObject)

Creates and initializes a new instance of the Toolbar class.

Declaration

public Toolbar(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	A EvasObject to which the new Table instance will be attached.

API Level: preview

Properties

FirstItem

Gets the first ToolbarItemItem of the toolbar.

Declaration

public ToolbarItem FirstItem { get; }

Property Value

Type	Description
ToolbarItem

API Level: preview

Homogeneous

Sets or gets whether the layout of this toolbar is homogeneous.

Declaration

public bool Homogeneous { get; set; }

Property Value

Type	Description
Boolean

Remarks

True for homogeneous, False for no homogeneous.

API Level: preview

IconLookupOrder

Sets or gets the icon lookup order, for toolbar items' icons. The default lookup order is ToolbarIocnLookupOrder.ThemeFreedesktop. Icons added before calling this function will not be affected.

Declaration

public ToolbarIconLookupOrder IconLookupOrder { get; set; }

Property Value

Type	Description
ToolbarIconLookupOrder

API Level: preview

IconSize

Sets or gets the icon size of a given toolbar widget. Default value is 32 pixels, to be used by toolbar items.

Declaration

public int IconSize { get; set; }

Property Value

Type	Description
Int32

API Level: preview

ItemAlignment

Sets or gets the alignment of the items.

Declaration

public double ItemAlignment { get; set; }

Property Value

Type	Description
Double

Remarks

The toolbar items alignment, a float between 0.0 and 1.0.

API Level: preview

ItemsCount

Gets the number of items in a Toolbar widget.

Declaration

public int ItemsCount { get; }

Property Value

Type	Description
Int32

API Level: preview

LastItem

Gets the last ToolbarItemItem of the toolbar.

Declaration

public ToolbarItem LastItem { get; }

Property Value

Type	Description
ToolbarItem

API Level: preview

SelectedItem

Gets the selected ToolbarItemItem of the toolbar.

Declaration

public ToolbarItem SelectedItem { get; }

Property Value

Type	Description
ToolbarItem

API Level: preview

SelectionMode

Sets or gets the slection mode of a given Toolbar widget.

Declaration

public ToolbarSelectionMode SelectionMode { get; set; }

Property Value

Type	Description
ToolbarSelectionMode

API Level: preview

ShrinkMode

Sets or gets the shrink mode of a given Toolbar widget.

Declaration

public ToolbarShrinkMode ShrinkMode { get; set; }

Property Value

Type	Description
ToolbarShrinkMode

API Level: preview

TransverseExpansion

Sets or gets the item's transverse expansion of a given Toolbar widget.

Declaration

public bool TransverseExpansion { get; set; }

Property Value

Type	Description
Boolean

Remarks

The transverse expansion of the item, true for on and false for off. By default it's false.

API Level: preview

Methods

Append(String)

Appends the ToolbarItem, which just contains label to the toolbar.

Declaration

public ToolbarItem Append(string label)

Parameters

Type	Name	Description
String	label	The label of the item.

Returns

Type	Description
ToolbarItem	The new ToolbarItem which is appended to the toolbar.

See Also

Append(String, String)

Prepend(String)

API Level: preview

Append(String, String)

Appends the ToolbarItem, which contains label and icon to the toolbar.

Declaration

public ToolbarItem Append(string label, string icon)

Parameters

Type	Name	Description
String	label	The label of the item.
String	icon	A string with the icon name or the absolute path of an image file.

Returns

Type	Description
ToolbarItem	The new ToolbarItem which is appended to the toolbar.

See Also

Append(String)

Prepend(String)

Prepend(String, String)

API Level: preview

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 Level: preview

FindItemByLabel(String)

Finds the item with that label in the toolbar.

Declaration

public ToolbarItem FindItemByLabel(string label)

Parameters

Type	Name	Description
String	label	The label of the item.

Returns

Type	Description
ToolbarItem	The ToolbarItem into the toolbar.

API Level: preview

InsertAfter(ToolbarItem, String, String)

Inserts a new item which contains label and icon into the toolbar object after item after.

Declaration

public ToolbarItem InsertAfter(ToolbarItem after, string label, string icon)

Parameters

Type	Name	Description
ToolbarItem	after	The toolbar item to insert after.
String	label	The label of the item.
String	icon	A string with the icon name or the absolute path of an image file.

Returns

Type	Description
ToolbarItem	The new ToolbarItem which is inserted into the toolbar.

API Level: preview

InsertBefore(ToolbarItem, String)

Inserts a new item which just contains label into the toolbar object before item before.

Declaration

public ToolbarItem InsertBefore(ToolbarItem before, string label)

Parameters

Type	Name	Description
ToolbarItem	before	The toolbar item to insert before.
String	label	The label of the item.

Returns

Type	Description
ToolbarItem	The new ToolbarItem which is inserted into the toolbar.

See Also

InsertBefore(ToolbarItem, String, String)

API Level: preview

InsertBefore(ToolbarItem, String, String)

Inserts a new item which contains label and icon into the toolbar object before item before.

Declaration

public ToolbarItem InsertBefore(ToolbarItem before, string label, string icon)

Parameters

Type	Name	Description
ToolbarItem	before	The toolbar item to insert before.
String	label	The label of the item.
String	icon	A string with the icon name or the absolute path of an image file.

Returns

Type	Description
ToolbarItem	The new ToolbarItem which is inserted into the toolbar.

See Also

InsertBefore(ToolbarItem, String)

API Level: preview

Prepend(String)

Prepends the ToolbarItem, which just contains label to the toolbar.

Declaration

public ToolbarItem Prepend(string label)

Parameters

Type	Name	Description
String	label	The label of the item.

Returns

Type	Description
ToolbarItem	The new ToolbarItem which is prepended to the toolbar.

See Also

Append(String)

Append(String, String)

Prepend(String, String)

API Level: preview

Prepend(String, String)

Prepends the ToolbarItem, which contains label and icon to the toolbar.

Declaration

public ToolbarItem Prepend(string label, string icon)

Parameters

Type	Name	Description
String	label	The label of the item.
String	icon	A string with the icon name or the absolute path of an image file.

Returns

Type	Description
ToolbarItem	The new ToolbarItem which is prepended to the toolbar.

See Also

Append(String)

Append(String, String)

Prepend(String)

API Level: preview

Events

Selected

Selected will be triggered when toolbar has been selected.

Declaration

public event EventHandler<ToolbarItemEventArgs> Selected

Event Type

Type	Description
EventHandler<ToolbarItemEventArgs>

API Level: preview

Implements

IAccessibleObject

Extension Methods

RotaryEventExtensions.AddRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.RemoveRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.Activate(EvasObject)

RotaryEventExtensions.Deactivate(EvasObject)