albert Namespace Reference

Albert core interface namespace. More...

Namespaces
namespace	detail
	Albert private namespace.
namespace	util
	Albert utility namespace.

Classes
class	Action
	Action used by result items (Item). More...
class	Extension
	Abstract extension class. More...
class	ExtensionRegistry
	The common extension pool. More...
class	FallbackHandler
	Abstract fallback provider. 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
	Asynchronous plugin loader turning a physical plugin into a logical PluginInstance. More...
class	PluginMetadata
	Common plugin metadata. 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	TriggerQueryHandler
	Abstract trigger query handler. More...
class	UrlHandler
	Albert scheme URL handler interface. More...

Functions
void	show (const QString &input_text={})
	Shows the frontend.
void	showSettings (QString plugin_id={})
	Creates and/or shows the settings window.
void	restart ()
	Restarts the application.
void	quit ()
	Quits the application.
const std::filesystem::path &	configLocation ()
	Returns the application config location.
const std::filesystem::path &	cacheLocation ()
	Returns the application cache location.
const 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 central ExtensionRegistry.

Detailed Description

Albert core interface namespace.

Function Documentation

cacheLocation()

const std::filesystem::path & albert::cacheLocation

(

)

Returns the application cache location.

This function is thread-safe.

configLocation()

const std::filesystem::path & albert::configLocation

(

)

Returns the application config location.

This function is thread-safe.

dataLocation()

const std::filesystem::path & albert::dataLocation

(

)

Returns the application data location.

This function is thread-safe.

extensionRegistry()

const ExtensionRegistry & albert::extensionRegistry

(

)

Returns a const reference to the central ExtensionRegistry.

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

quit()

void albert::quit

(

)

Quits the application.

This function is thread-safe.

restart()

void albert::restart

(

)

Restarts the application.

This function is thread-safe.

settings()

std::unique_ptr< QSettings > albert::settings

(

)

Returns a QSettings object for configuration storage.

This function is thread-safe.

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 = {}

)

Creates and/or shows the settings window.

If specified the settings of the plugin with the id plugin_id are shown.

state()

std::unique_ptr< QSettings > albert::state

(

)

Returns a QSettings object for state storage.

This function is thread-safe.