Class MultiButtonEntry

Definition

Namespace:

ElmSharp

Assembly:

ElmSharp.dll

It inherits Layout. The MultiButtonEntry is a widget, that lets a user enter text and each chunk of the text managed as a set of buttons. Each text button is inserted by pressing the "return" key. If there is no space in the current row, a new button is added to the next row. When a text button is pressed, it will become focused. Backspace removes the focus. When the multi-button entry loses focus, items longer than one line are shrunk to one line. The typical use case of multi-button entry is composing emails/messages to a group of addresses, each of which is an item that can be clicked for further actions.

[Obsolete("This has been deprecated in API12")]
public class MultiButtonEntry : Layout, IAccessibleObject

Inheritance

object

EvasObject

AccessibleObject

Widget

Container

Layout

MultiButtonEntry

Implements

IAccessibleObject

Constructors

MultiButtonEntry(EvasObject)

Creates and initializes a new instance of the MultiButtonEntry class.

Declaration

[Obsolete("This has been deprecated in API12")]
public MultiButtonEntry(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	The parent is a given container, which will be attached by the MultiButtonEntry as a child. It's EvasObject type.

Properties

Entry

Gets the entry object int the MultiButtonEntry.

Declaration

[Obsolete("This has been deprecated in API12")]
public Entry Entry { get; }

Property Value

Type	Description
Entry

FirstItem

Gets the first item in the MultiButtonEntry.

Declaration

[Obsolete("This has been deprecated in API12")]
public MultiButtonEntryItem FirstItem { get; }

Property Value

Type	Description
MultiButtonEntryItem

IsEditable

Gets or sets whether the MultiButtonEntry is editable or not.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool IsEditable { get; set; }

Property Value

Type	Description
bool

IsExpanded

Gets or sets the MultiButtonEntry to expanded state. If true, expanded state. If false, single line state.

Declaration

[Obsolete("This has been deprecated in API12")]
public bool IsExpanded { get; set; }

Property Value

Type	Description
bool

LastItem

Gets the last item in the MultiButtonEntry.

Declaration

[Obsolete("This has been deprecated in API12")]
public MultiButtonEntryItem LastItem { get; }

Property Value

Type	Description
MultiButtonEntryItem

SelectedItem

Gets the selected item in the MultiButtonEntry.

Declaration

[Obsolete("This has been deprecated in API12")]
public MultiButtonEntryItem SelectedItem { get; }

Property Value

Type	Description
MultiButtonEntryItem

Methods

Append(string)

Appends a new item to the multibuttonentry.

Declaration

[Obsolete("This has been deprecated in API12")]
public MultiButtonEntryItem Append(string label)

Parameters

Type	Name	Description
string	label	The label of the new item.

Returns

Type	Description
MultiButtonEntryItem	A MultiButtonEntryItem to the item added.

AppendFilter(Func<string, bool>)

Appends an item filter function for the text inserted in the multibuttonentry.

Declaration

[Obsolete("This has been deprecated in API12")]
public void AppendFilter(Func<string, bool> func)

Parameters

Type	Name	Description
System.Func<T, TResult><string, bool>	func	The function to use as item filter.

Clear()

Removes all items in the MultiButtonEntry.

Declaration

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

CreateHandle(EvasObject)

Creates a widget handle.

Declaration

[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

Layout.CreateHandle(EvasObject)

InsertAfter(MultiButtonEntryItem, string)

Adds a new item to the MultiButtonEntry after the indicated object.

Declaration

[Obsolete("This has been deprecated in API12")]
public MultiButtonEntryItem InsertAfter(MultiButtonEntryItem after, string label)

Parameters

Type	Name	Description
MultiButtonEntryItem	after	The item after which to add it.
string	label	The label of new item.

Returns

Type	Description
MultiButtonEntryItem	A MultiButtonEntryItem to the item added.

InsertBefore(MultiButtonEntryItem, string)

Adds a new item to the MultiButtonEntry before the indicated object reference.

Declaration

[Obsolete("This has been deprecated in API12")]
public MultiButtonEntryItem InsertBefore(MultiButtonEntryItem before, string label)

Parameters

Type	Name	Description
MultiButtonEntryItem	before	The item before which to add it.
string	label	The label of new item.

Returns

Type	Description
MultiButtonEntryItem	A MultiButtonEntryItem to the item added.

Prepend(string)

Prepends a new item to the MultiButtonEntry.

Declaration

[Obsolete("This has been deprecated in API12")]
public MultiButtonEntryItem Prepend(string label)

Parameters

Type	Name	Description
string	label	The label of the new item.

Returns

Type	Description
MultiButtonEntryItem	A MultiButtonEntryItem to the item added.

PrependFilter(Func<string, bool>)

Prepends a filter function for the text inserted in the MultiButtonEntry.

Declaration

[Obsolete("This has been deprecated in API12")]
public void PrependFilter(Func<string, bool> func)

Parameters

Type	Name	Description
System.Func<T, TResult><string, bool>	func	The function to use as text filter.

RemoveFilter(Func<string, bool>)

Removes a filter from the list.

Declaration

[Obsolete("This has been deprecated in API12")]
public void RemoveFilter(Func<string, bool> func)

Parameters

Type	Name	Description
System.Func<T, TResult><string, bool>	func	The filter function to remove.

SetFormatCallback(Func<int, string>)

Sets a function to format the string that will be used to display the hidden items counter. If func is NULL, the default format will be used, which is "+ 'the hidden items counter'".

Declaration

[Obsolete("This has been deprecated in API12")]
public void SetFormatCallback(Func<int, string> func)

Parameters

Type	Name	Description
System.Func<T, TResult><int, string>	func	The function to return string to show.

Events

Clicked

Clicked is raised when a MultiButtonEntry is clicked.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler Clicked

Event Type

Type	Description
System.EventHandler

Contracted

Contracted is raised when a MultiButtonEntry is contracted.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler Contracted

Event Type

Type	Description
System.EventHandler

Expanded

Expanded is raised when a MultiButtonEntry is expanded.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler Expanded

Event Type

Type	Description
System.EventHandler

ExpandedStateChanged

ExpandedStateChanged is raised when shrink mode state of MultiButtonEntry is changed.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler ExpandedStateChanged

Event Type

Type	Description
System.EventHandler

ItemAdded

ItemAdded is raised when a new MultiButtonEntry item is added.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler<MultiButtonEntryItemEventArgs> ItemAdded

Event Type

Type	Description
System.EventHandler<TEventArgs><MultiButtonEntryItemEventArgs>

ItemClicked

ItemClicked is raised when an item is clicked by user interaction.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler<MultiButtonEntryItemEventArgs> ItemClicked

Event Type

Type	Description
System.EventHandler<TEventArgs><MultiButtonEntryItemEventArgs>

ItemDeleted

ItemDeleted is raised when a MultiButtonEntry item is deleted.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler<MultiButtonEntryItemEventArgs> ItemDeleted

Event Type

Type	Description
System.EventHandler<TEventArgs><MultiButtonEntryItemEventArgs>

ItemLongPressed

ItemLongPressed is raised when MultiButtonEntry item is pressed for a long time.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler<MultiButtonEntryItemEventArgs> ItemLongPressed

Event Type

Type	Description
System.EventHandler<TEventArgs><MultiButtonEntryItemEventArgs>

ItemSelected

ItemSelected is raised when an item is selected by API, user interaction, and etc. This is also raised when a user presses backspace, while the cursor is on the first field of the entry.

Declaration

[Obsolete("This has been deprecated in API12")]
public event EventHandler<MultiButtonEntryItemEventArgs> ItemSelected

Event Type

Type	Description
System.EventHandler<TEventArgs><MultiButtonEntryItemEventArgs>

Implements

IAccessibleObject

Extension Methods

RotaryEventExtensions.Activate(EvasObject)

RotaryEventExtensions.AddRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.Deactivate(EvasObject)

RotaryEventExtensions.RemoveRotaryEventHandler(EvasObject, RotaryEventHandler)