albert::detail::InputHistory Class Reference

#include <albert/inputhistory.h>

Inherits QObject.

Detailed Description

Input history class.

Stores input strings and provides a search iterator.

Public Member Functions
	InputHistory (const QString &path={})
	~InputHistory () override
Q_INVOKABLE void	add (const QString &str)
	Adds text to history search.
Q_INVOKABLE QString	next (const QString &pattern=QString{})
	Gets next history item matching the pattern.
Q_INVOKABLE QString	prev (const QString &pattern=QString{})
	Gets previous history item matching the pattern.
Q_INVOKABLE void	resetIterator ()
	Resets history search.
Q_INVOKABLE void	clear ()
	Clears the history.
Q_INVOKABLE uint	limit () const
	Returns the maximum amount of history entries.
Q_INVOKABLE void	setLimit (uint)
	Sets the maximum amount of history entries.

Constructor & Destructor Documentation

InputHistory()

albert::detail::InputHistory::InputHistory

(

const QString &

path = {}

)

~InputHistory()

albert::detail::InputHistory::~InputHistory ( )

override

Member Function Documentation

add()

Q_INVOKABLE void albert::detail::InputHistory::add

(

const QString &

str

)

Adds text to history search.

Skips empty strings and drops duplicates.

Parameters

str	The string to add.

clear()

Q_INVOKABLE void albert::detail::InputHistory::clear

(

)

Clears the history.

limit()

Q_INVOKABLE uint albert::detail::InputHistory::limit

(

)

const

Returns the maximum amount of history entries.

next()

Q_INVOKABLE QString albert::detail::InputHistory::next

(

const QString &

pattern = QString{}

)

Gets next history item matching the pattern.

Parameters

pattern

A pattern used to filter the history items.

Returns

The next history item matching the pattern or empty string.

prev()

Q_INVOKABLE QString albert::detail::InputHistory::prev

(

const QString &

pattern = QString{}

)

Gets previous history item matching the pattern.

Parameters

pattern

A pattern used to filter the history items.

Returns

The previous history item matching the pattern or empty string.

resetIterator()

Q_INVOKABLE void albert::detail::InputHistory::resetIterator

(

)

Resets history search.

setLimit()

Q_INVOKABLE void albert::detail::InputHistory::setLimit

(

uint

)

Sets the maximum amount of history entries.

---

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

• workspace/albert/include/albert/inputhistory.h