TagList Class Reference

Inherits org::mauikit::controls::ListBrowser, and org::mauikit::controls::ListBrowser.

Properties
alias	list
string	placeholderText
bool	showDeleteIcon
bool	showPlaceHolder

Signals
void	tagClicked (int index)
void	tagRemoved (int index)

Detailed Description

The flickable element for listing horizontally the tag buttons in the TagsBar control.

This control is a graphical representation and consumes the TagsList model.

Warning

This control only exists as an implementation detail of TagsBar, and it is exposed to access its own properties.

Definition at line 11 of file TagList.qml.

Property Documentation

list

TagsList TagList::list

read

An alias to the tags model and controller.

Remarks

This property is read-only

This is exposed to fine tune all the listing properties of the tags.

Definition at line 29 of file TagList.qml.

placeholderText

string TagList::placeholderText

read

Text to be displayed in the bar when the list is empty.

Definition at line 23 of file TagList.qml.

showDeleteIcon

bool TagList::showDeleteIcon

read

Whether the tag elements should have a clos/dismiss button.

When this button is made visible and is clicked the tagRemoved signal is triggered.

See also

tagRemoved

Definition at line 40 of file TagList.qml.

showPlaceHolder

bool TagList::showPlaceHolder

read

Whether to display the placeholder text.

By default this is set to true

Definition at line 34 of file TagList.qml.

Member Function Documentation

tagClicked

void TagList::tagClicked ( int index )

signal

Emitted when a tag button has been clicked.

Parameters

index

the index position of the tag element in the list

tagRemoved

void TagList::tagRemoved ( int index )

signal

Emitted when the close/dismiss button in the tag button is clicked.

See also

showDeleteIcon

Parameters

index

the index position of the tag element in the list

---

The documentation for this class was generated from the following file:

• TagList.qml