albert Namespace Reference

Namespaces
namespace	experimental
namespace	util

Classes
class	Action
	Action used by result items (Item). 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	Item
	Result items displayed in the query results list. 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	StrongDependency
	Convenience holder class for plugin hard dependencies. More...
class	TelemetryProvider
class	TriggerQueryHandler
	Abstract trigger query handler. More...
class	UrlHandler
class	WeakDependency
	Convenience holder class for plugin soft dependencies. More...

Functions
void	show (const QString &input_text={})
	Shows the frontend. If input_text is not null the input is set.
void	restart ()
	Restarts the application.
void	quit ()
	Quits the application.
void	showSettings (QString plugin_id={})
	Opens/Shows the settings window (of plugin_id).
std::filesystem::path	configLocation ()
	Returns the application config location.
std::filesystem::path	cacheLocation ()
	Returns the application cache location.
std::filesystem::path	dataLocation ()
	Returns the application data location.
std::unique_ptr< QSettings >	settings ()
	Returns a QSettings object for configuration storage.
std::unique_ptr< QSettings >	state ()
	Returns a QSettings object for state storage.
const ExtensionRegistry &	extensionRegistry ()
	Returns a const reference to the extension registry.

Function Documentation

cacheLocation()

std::filesystem::path albert::cacheLocation

(

)

Returns the application cache location.

configLocation()

std::filesystem::path albert::configLocation

(

)

Returns the application config location.

dataLocation()

std::filesystem::path albert::dataLocation

(

)

Returns the application data location.

extensionRegistry()

const ExtensionRegistry & albert::extensionRegistry

(

)

Returns a const reference to the extension registry.

Registering plugins via this registry is not allowed. Use PluginInstance::extensions(). See also WeakDependency and StrongDependency.

quit()

void albert::quit

(

)

Quits the application.

restart()

void albert::restart

(

)

Restarts the application.

settings()

std::unique_ptr< QSettings > albert::settings

(

)

Returns a QSettings object for configuration storage.

show()

void albert::show

(

const QString &

input_text = {}

)

Shows the frontend. If input_text is not null the input is set.

showSettings()

void albert::showSettings

(

QString

plugin_id = {}

)

Opens/Shows the settings window (of plugin_id).

state()

std::unique_ptr< QSettings > albert::state

(

)

Returns a QSettings object for state storage.