Class Toolbar

View Source

Definition

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

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


                
C#

                

                    
Copy

                    

                

            
public class Toolbar : Widget, IAccessibleObject
Inheritance
Object
EvasObject
AccessibleObject
Widget
Toolbar
Implements
IAccessibleObject

Constructors

View Source

Toolbar(EvasObject)

Creates and initializes a new instance of the Toolbar class.

Declaration

                
C#

                

                    
Copy

                    

                

            
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

View Source

FirstItem

Gets the first ToolbarItemItem of the toolbar.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarItem FirstItem { get; }
Property Value
Type Description
ToolbarItem
API Level: preview
View Source

Homogeneous

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool Homogeneous { get; set; }
Property Value
Type Description
Boolean
Remarks

True for homogeneous, False for no homogeneous.

API Level: preview
View Source

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

                
C#

                

                    
Copy

                    

                

            
public ToolbarIconLookupOrder IconLookupOrder { get; set; }
Property Value
Type Description
ToolbarIconLookupOrder
API Level: preview
View Source

IconSize

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

Declaration

                
C#

                

                    
Copy

                    

                

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

ItemAlignment

Sets or gets the alignment of the items.

Declaration

                
C#

                

                    
Copy

                    

                

            
public double ItemAlignment { get; set; }
Property Value
Type Description
System.Double
Remarks

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

API Level: preview
View Source

ItemsCount

Gets the number of items in a Toolbar widget.

Declaration

                
C#

                

                    
Copy

                    

                

            
public int ItemsCount { get; }
Property Value
Type Description
System.Int32
API Level: preview
View Source

LastItem

Gets the last ToolbarItemItem of the toolbar.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarItem LastItem { get; }
Property Value
Type Description
ToolbarItem
API Level: preview
View Source

SelectedItem

Gets the selected ToolbarItemItem of the toolbar.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarItem SelectedItem { get; }
Property Value
Type Description
ToolbarItem
API Level: preview
View Source

SelectionMode

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarSelectionMode SelectionMode { get; set; }
Property Value
Type Description
ToolbarSelectionMode
API Level: preview
View Source

ShrinkMode

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarShrinkMode ShrinkMode { get; set; }
Property Value
Type Description
ToolbarShrinkMode
API Level: preview
View Source

TransverseExpansion

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

Declaration

                
C#

                

                    
Copy

                    

                

            
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

View Source

Append(String)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarItem Append(string label)
Parameters
Type Name Description
System.String label

The label of the item.
Returns
Type Description
ToolbarItem

The new ToolbarItem which is appended to the toolbar.
See Also
API Level: preview
View Source

Append(String, String)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarItem Append(string label, string icon)
Parameters
Type Name Description
System.String label

The label of the item.
System.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
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

FindItemByLabel(String)

Finds the item with that label in the toolbar.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarItem FindItemByLabel(string label)
Parameters
Type Name Description
System.String label

The label of the item.
Returns
Type Description
ToolbarItem

The ToolbarItem into the toolbar.
API Level: preview
View Source

InsertAfter(ToolbarItem, String, String)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarItem InsertAfter(ToolbarItem after, string label, string icon)
Parameters
Type Name Description
ToolbarItem after

The toolbar item to insert after.
System.String label

The label of the item.
System.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
View Source

InsertBefore(ToolbarItem, String)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarItem InsertBefore(ToolbarItem before, string label)
Parameters
Type Name Description
ToolbarItem before

The toolbar item to insert before.
System.String label

The label of the item.
Returns
Type Description
ToolbarItem

The new ToolbarItem which is inserted into the toolbar.
See Also
API Level: preview
View Source

InsertBefore(ToolbarItem, String, String)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarItem InsertBefore(ToolbarItem before, string label, string icon)
Parameters
Type Name Description
ToolbarItem before

The toolbar item to insert before.
System.String label

The label of the item.
System.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
API Level: preview
View Source

Prepend(String)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarItem Prepend(string label)
Parameters
Type Name Description
System.String label

The label of the item.
Returns
Type Description
ToolbarItem

The new ToolbarItem which is prepended to the toolbar.
See Also
API Level: preview
View Source

Prepend(String, String)

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public ToolbarItem Prepend(string label, string icon)
Parameters
Type Name Description
System.String label

The label of the item.
System.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
API Level: preview

Events

View Source

Selected

Selected will be triggered when toolbar has been selected.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<ToolbarItemEventArgs> Selected
Event Type
Type Description
System.EventHandler<ToolbarItemEventArgs>
API Level: preview

Implements

Extension Methods