Albert
Loading...
Searching...
No Matches
albert::InputHistory Class Referencefinal

#include <albert/inputhistory.h>

Inheritance diagram for albert::InputHistory:

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)
 Add text to history search.
 
Q_INVOKABLE QString next (const QString &pattern=QString{})
 Get next history item matching the pattern.
 
Q_INVOKABLE QString prev (const QString &pattern=QString{})
 Get previous history item matching the pattern.
 
Q_INVOKABLE void resetIterator ()
 Reset history search.
 

Constructor & Destructor Documentation

◆ InputHistory()

albert::InputHistory::InputHistory ( const QString &  path = {})

◆ ~InputHistory()

albert::InputHistory::~InputHistory ( )
override

Member Function Documentation

◆ add()

Q_INVOKABLE void albert::InputHistory::add ( const QString &  str)

Add text to history search.

Skips empty strings and drops duplicates.

Parameters
strThe string to add.

◆ next()

Q_INVOKABLE QString albert::InputHistory::next ( const QString &  pattern = QString{})

Get next history item matching the pattern.

Parameters
patternA pattern used to filter the history items.
Returns
The next history item matching the pattern or empty string.

◆ prev()

Q_INVOKABLE QString albert::InputHistory::prev ( const QString &  pattern = QString{})

Get previous history item matching the pattern.

Parameters
patternA pattern used to filter the history items.
Returns
The previous history item matching the pattern or empty string.

◆ resetIterator()

Q_INVOKABLE void albert::InputHistory::resetIterator ( )

Reset history search.


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