Albert
|
#include <albert/item.h>
Result items displayed in the query results list.
Classes | |
class | Observer |
Interface class for item observers. More... | |
Public Member Functions | |
virtual | ~Item () |
virtual QString | id () const =0 |
Returns the item identifier. | |
virtual QString | text () const =0 |
Returns the item text. | |
virtual QString | subtext () const =0 |
Returns the item subtext. | |
virtual QStringList | iconUrls () const =0 |
Returns the items icon urls. | |
virtual QString | inputActionText () const |
Returns the input action text. | |
virtual std::vector< Action > | actions () const |
Returns the item actions. | |
virtual void | addObserver (Observer *observer) |
Start notifying observer about any changes. | |
virtual void | removeObserver (Observer *observer) |
Stop notifying observer about any changes. | |
|
virtual |
|
virtual |
Returns the item actions.
These are the actions a users can run. The base implementation returns an empty vector.
Reimplemented in albert::util::StandardItem.
|
virtual |
Start notifying observer about any changes.
Reimplemented in albert::detail::DynamicItem.
|
pure virtual |
Returns the items icon urls.
Used to get the item icon using the icon provider functions.
Implemented in albert::util::StandardItem.
|
pure virtual |
Returns the item identifier.
Has to be unique per extension. This function is involved in several time critical operartion such as indexing and sorting. It is therefore recommended to return a string that is as short as possible as fast as possible.
Implemented in albert::util::StandardItem.
|
virtual |
Returns the input action text.
Used as input text replacement (usually by pressing Tab). The base implementation returns text().
Reimplemented in albert::util::StandardItem.
|
virtual |
Stop notifying observer about any changes.
Reimplemented in albert::detail::DynamicItem.
|
pure virtual |
Returns the item subtext.
Secondary descriptive text displayed in a list item.
Implemented in albert::util::StandardItem.
|
pure virtual |
Returns the item text.
Primary text displayed emphasized in a list item. This string is used in scoring. It is therefore recommended to return as fast as possible. The text length is used as divisor for scoring, hence the string must not be empty, otherwise you get undefined behavior. For performance reasons text length is not checked.
Implemented in albert::util::StandardItem.