Classes
class	Action
	Action used by result items (Item). More...

class	BackgroundExecutor
	Provides a lean interface for recurring indexing tasks. More...

class	Dependency
	Base class for StrongDependency and WeakDependency. More...

class	Extension
	Abstract extension class. More...

class	ExtensionPlugin
	Convenience base class for extension plugins. More...

class	ExtensionRegistry
	The common extension pool. More...

class	FallbackHandler
	Abstract fallback provider. More...

class	Frontend
	The interface for albert frontends. More...

class	GlobalQueryHandler
	Abstract global query handler. More...

class	IndexItem
	An item utlized by ItemIndex. More...

class	IndexQueryHandler
	Index query handler class. More...

class	InputHistory
	Input history class. More...

class	Item
	Result items displayed in the query results list. More...

class	Match
	Augmented match score. More...

class	MatchConfig
	Configuration for string matching. More...

class	Matcher
	Configurable string matcher. More...

class	Notification
	The notification class. More...

class	PluginInstance
	Abstract plugin instance class. More...

class	PluginLoader
	Plugin loader interface class. More...

class	PluginMetaData
	Common plugin metadata of plugins. More...

class	PluginProvider
	Plugin provider interface class. More...

class	Query
	Common query object. More...

class	RankItem
	An Item with a score. More...

class	ResultItem

class	StandardItem
	General purpose value type Item implememtation. More...

class	StrongDependency
	Convenience holder class for plugin hard dependencies. More...

class	TelemetryProvider

class	TriggerQueryHandler
	Abstract trigger query handler. More...

class	WeakDependency
	Convenience holder class for plugin soft dependencies. More...

Functions
void	show (const QString &input_text={})
	Show the frontend.

void	restart ()
	Restart the application.

void	quit ()
	Quit the application.

QNetworkAccessManager &	network ()
	The threadlocal, global QNetworkAccessManager.

void	showSettings (QString plugin_id={})
	Open/Show the settings window (of plugin).

std::filesystem::path	configLocation ()
	The app config location.

std::filesystem::path	cacheLocation ()
	The app cache location.

std::filesystem::path	dataLocation ()
	The app data location.

std::unique_ptr< QSettings >	settings ()
	Persistent app settings storage.

std::unique_ptr< QSettings >	state ()
	The persistent app state storage.

void	openWebsite ()
	Open the albert website in default browser.

void	openUrl (const QString &url)
	Open the specified url in default browser.

void	open (const QUrl &url)
	Open URL with default handler.

void	open (const QString &path)
	Open file with default handler.

void	open (const std::string &path)
	Open file with default handler.

void	setClipboardText (const QString &text)
	Set the system clipboard.

bool	havePasteSupport ()
	Check paste support of the platform.

void	setClipboardTextAndPaste (const QString &text)
	Set the system clipboard and paste the content to the front-most window.

long long	runDetachedProcess (const QStringList &commandline, const QString &working_dir={})
	Run a detached process.

const ExtensionRegistry &	extensionRegistry ()
	The extension registry.

void	tryCreateDirectory (const std::filesystem::path &path)
	Create a directory if it does not exist yet.

QPixmap	pixmapFromUrl (const QString &url, const QSize &requestedSize)
	URL based icon factory.

QPixmap	pixmapFromUrls (const QStringList &urls, const QSize &requestedSize)
	URL list based icon factory.

QIcon	iconFromUrl (const QString &url)
	URL based icon factory.

QIcon	iconFromUrls (const QStringList &urls)
	URL list based icon factory.

QPixmap	genericPixmap (int size, const QColor &bgcolor={}, const QColor &fgcolor=Qt::black, const QString &text={}, float scalar=1.)
	Generic pixmap factory.

QIcon	genericIcon (int size, const QColor &bgcolor={}, const QColor &fgcolor=Qt::black, const QString &text={}, float scalar=1.)
	Generic icon factory.

QIcon	fileIcon (const QString &path)
	Create an icon for a file using QFileIconProvider.

const QRegularExpression	default_separator_regex ("([\\s\\\\/\\-\\[\\](){}#!?<>\"'=+*.:,;_]+)")

Function Documentation

◆ cacheLocation()

std::filesystem::path albert::cacheLocation ( )

The app cache location.

The path to the directory where cache files should be stored.

Returns: The app cache location.

◆ configLocation()

std::filesystem::path albert::configLocation ( )

The app config location.

The path to the directory where configuration files should be stored.

Returns: The app config location.

◆ dataLocation()

std::filesystem::path albert::dataLocation ( )

The app data location.

The path to the directory where data files should be stored.

Returns: The app data location.

◆ default_separator_regex()

const QRegularExpression albert::default_separator_regex ( "([\\s\\\\/\\-\\[\\](){}#!?<>\"'=+*.:,;_]+)" )

◆ extensionRegistry()

const ExtensionRegistry & albert::extensionRegistry ( )

The extension registry.

Utilze to look up extensions or watch for changes. Const because registering plugins via this registry is not allowed. Use PluginInstance::extensions().

See also WeakDependency and StrongDependency.

Since: 0.27

Returns: A const reference to the extension registry.

◆ fileIcon()

QIcon albert::fileIcon ( const QString & path )

Create an icon for a file using QFileIconProvider.

Parameters

path	The path to the file.

Returns: The file icon.

◆ genericIcon()

QIcon albert::genericIcon	(	int	size,
		const QColor &	bgcolor = `{}`,
		const QColor &	fgcolor = `Qt::black`,
		const QString &	text = `{}`,
		float	scalar = `1.`
	)

Generic icon factory.

Supports drawing a background circle with some text on it.

Parameters

bgcolor	The background color. Default: none.
fgcolor	The text color. Default: black.
text	The text to display. Default: empty.
scalar	Scalar for the default font size which is the pixmap height. Default: 1.

Returns: The generic pixmap.

◆ genericPixmap()

QPixmap albert::genericPixmap	(	int	size,
		const QColor &	bgcolor = `{}`,
		const QColor &	fgcolor = `Qt::black`,
		const QString &	text = `{}`,
		float	scalar = `1.`
	)

Generic pixmap factory.

Supports drawing a background circle with some text on it.

Parameters

bgcolor	The background color. Default: none.
fgcolor	The text color. Default: black.
text	The text to display. Default: empty.
scalar	Scalar for the default font size which is the pixmap height. Default: 1.

Returns: The generic icon.

◆ havePasteSupport()

bool albert::havePasteSupport ( )

Check paste support of the platform.

Returns: True if requirements for setClipboardTextAndPaste(…) are met.

Since: 0.24

◆ iconFromUrl()

QIcon albert::iconFromUrl ( const QString & url )

URL based icon factory.

Parameters

url	The icon URL.

Returns: The icon, if available, null icon otherwise.

◆ iconFromUrls()

QIcon albert::iconFromUrls ( const QStringList & urls )

URL list based icon factory.

See iconFromUrl(const QString &url).

Parameters

urls	The icon URLs.

Returns: The first icon available in the urls list. Null icon otherwise.

◆ network()

QNetworkAccessManager & albert::network ( )

The threadlocal, global QNetworkAccessManager.

Returns: A reference to the QNetworkAccessManager object.

◆ open() [1/3]

void albert::open ( const QString & path )

Open file with default handler.

Parameters

path	The path the file to open.

◆ open() [2/3]

void albert::open ( const QUrl & url )

Open URL with default handler.

Parameters

url	The url to open.

◆ open() [3/3]

void albert::open ( const std::string & path )

Open file with default handler.

Convenience overlaod that works well with filesystem::path.

Parameters

path	The path the file to open.

◆ openUrl()

void albert::openUrl ( const QString & url )

Open the specified url in default browser.

Parameters

url	The url to open

◆ openWebsite()

void albert::openWebsite ( )

Open the albert website in default browser.

◆ pixmapFromUrl()

QPixmap albert::pixmapFromUrl	(	const QString &	url,
		const QSize &	requestedSize
	)

URL based icon factory.

Supported URL schemes:

<path> or
file:<path> Use the file at path as icon.
:<path> or
qrc:<path> Use the file at path in the resource collection as icon.
qfip:<path> Uses fileIcon(const QString &path)
qsp:<pixmap enumerator> Get an icon from QStyle::StandardPixmap enum.
xdg:<icon name> Uses xdgIconLookup(const QString &name);
gen:<> Uses genericPixmapFactory. See also QColor::fromString.

Examples

/absolute/path/to/a/local/image/file.png
file:/absolute/path/to/a/local/image/file.png
:path-to-a-qresource-file
qrc:path-to-a-qresource-file
qfip:/path/to/any/file/for/example/a.pdf
qsp:SP_TrashIcon
xdg:some-themed-icon-name
gen:?background=blue&foreground=red&text=Hi&fontscalar=0.5

Parameters

url	The icon URL.
requestedSize	The size the pixmap should have if possible.

Returns: The pixmap, if available, null pixmap otherwise. The size can be smaller than requestedSize, but is never larger.

◆ pixmapFromUrls()

QPixmap albert::pixmapFromUrls	(	const QStringList &	urls,
		const QSize &	requestedSize
	)

URL list based icon factory.

See pixmapFromUrl(const QString &url, QSize *size, const QSize &requestedSize).

Parameters

urls	The icon URLs.
requestedSize	The size the pixmap should have if possible.

Returns: The first pixmap available in the urls list. Null pixmap otherwise.

◆ quit()

void albert::quit ( )

Quit the application.

◆ restart()

void albert::restart ( )

Restart the application.

◆ runDetachedProcess()

long long albert::runDetachedProcess	(	const QStringList &	commandline,
		const QString &	working_dir = `{}`
	)

Run a detached process.

Parameters

commandline	The command line to run
working_dir	The working directory

Returns: The process id

◆ setClipboardText()

void albert::setClipboardText ( const QString & text )

Set the system clipboard.

Parameters

text	The text to set

◆ setClipboardTextAndPaste()

void albert::setClipboardTextAndPaste ( const QString & text )

Set the system clipboard and paste the content to the front-most window.

Check albert::havePasteSupport before using this function.

Parameters

text	The text to set and paste

◆ settings()

std::unique_ptr< QSettings > albert::settings ( )

Persistent app settings storage.

Returns: Preconfigured QSettings object for configuration storage.

◆ show()

void albert::show ( const QString & input_text = {} )

Show the frontend.

If input_text is not null the input is set.

◆ showSettings()

void albert::showSettings ( QString plugin_id = {} )

Open/Show the settings window (of plugin).

Parameters

plugin_id Id of the plugin whose settings should be displayed.

◆ state()

std::unique_ptr< QSettings > albert::state ( )

The persistent app state storage.

Returns: Preconfigured QSettings object for state storage.

◆ tryCreateDirectory()

void albert::tryCreateDirectory ( const std::filesystem::path & path )

Create a directory if it does not exist yet.

This is a utility function for use with the *Location functions.

Parameters

path	The path to the directory to create.

Returns: The existing directory.

Exceptions

std::runtime_error if the directory could not be created.

Since: 0.27

Classes

Functions

Function Documentation

◆ cacheLocation()

◆ configLocation()

◆ dataLocation()

◆ default_separator_regex()

◆ extensionRegistry()

◆ fileIcon()

◆ genericIcon()

◆ genericPixmap()

◆ havePasteSupport()

◆ iconFromUrl()

◆ iconFromUrls()

◆ network()

◆ open() [1/3]

◆ open() [2/3]

◆ open() [3/3]

◆ openUrl()

◆ openWebsite()

◆ pixmapFromUrl()

◆ pixmapFromUrls()

◆ quit()

◆ restart()

◆ runDetachedProcess()

◆ setClipboardText()

◆ setClipboardTextAndPaste()

◆ settings()

◆ show()

◆ showSettings()

◆ state()

◆ tryCreateDirectory()