albert Namespace Reference

Namespaces
namespace	plugin

Classes
class	Action
	Action used by items. More...
class	BackgroundExecutor
	Provides a lean interface for recurring indexing tasks. More...
class	Extension
	The extension interface class. More...
class	ExtensionRegistry
	The common extension pool. More...
class	ExtensionWatcher
	Non-QObject extension registry observer. More...
class	FallbackHandler
	Fallback providing extension. More...
class	Frontend
	The interface for albert frontends. More...
class	GlobalQueryHandler
	Global search query handler class. More...
class	IconProvider
	Generic pixmap provider. More...
class	IndexItem
	The eligible for the internal index of IndexQueryHandler. More...
class	IndexQueryHandler
	Index query handler class. More...
class	InputHistory
	Input history class. More...
class	Item
	Items displayed in the query results list. More...
class	Notification
	A system tray notification. More...
class	PluginInstance
	Abstract plugin instance class. More...
class	PluginLoader
	Abstract plugin loader class. More...
class	PluginMetaData
	Common plugin metadata of all plugins. More...
class	PluginProvider
	Abstract plugin provider extension class. More...
class	Query
	Interface class for queries used by frontends. More...
class	RankItem
	Scored item Used to rank item results of mutliple handlers. More...
class	StandardItem
	General purpose value type Item implememtation. More...
class	TriggerQueryHandler
	Triggered query handler class. More...

Functions
ALBERT_EXPORT QNetworkAccessManager *	networkManager ()
	The global QNetworkAccessManager. More...
ALBERT_EXPORT void	show (const QString &text=QString())
	Show the main window. More...
ALBERT_EXPORT void	hide ()
	Hide the main window. More...
ALBERT_EXPORT void	toggle ()
	Toggle visibility of main window. More...
ALBERT_EXPORT void	showSettings (QString plugin_id={})
	Open/Show the settings window (of plugin). More...
ALBERT_EXPORT void	restart ()
	Restart the app. More...
ALBERT_EXPORT void	quit ()
	Quit the app. More...
ALBERT_EXPORT QString	configLocation ()
	The app config location. More...
ALBERT_EXPORT QString	cacheLocation ()
	The app cache location. More...
ALBERT_EXPORT QString	dataLocation ()
	The app data location. More...
ALBERT_EXPORT std::unique_ptr< QSettings >	settings ()
	Persistent app settings. @reentrant. More...
ALBERT_EXPORT std::unique_ptr< QSettings >	state ()
	The persistent app state. @reentrant. More...
ALBERT_EXPORT void	openWebsite ()
	Open the albert website in default browser. More...
ALBERT_EXPORT void	openUrl (const QUrl &url)
	Open the specified url in default browser. More...
ALBERT_EXPORT void	openUrl (const QString &url)
	Open the specified url in default browser. More...
ALBERT_EXPORT void	openIssueTracker ()
	Open the albert issue tracker in default browser. More...
ALBERT_EXPORT void	setClipboardText (const QString &text)
	Set the system clipboard. More...
ALBERT_EXPORT void	setClipboardTextAndPaste (const QString &text)
	Set the system clipboard and paste the content to the front-most window. More...
ALBERT_EXPORT long long	runDetachedProcess (const QStringList &commandline, const QString &working_dir={})
	Run a detached process. More...
ALBERT_EXPORT void	runTerminal (const QString &script={}, const QString &working_dir={}, bool close_on_exit=false)
	Run a script in the user defined terminal. More...

Function Documentation

cacheLocation()

ALBERT_EXPORT QString albert::cacheLocation

(

)

The app cache location.

configLocation()

ALBERT_EXPORT QString albert::configLocation

(

)

The app config location.

dataLocation()

ALBERT_EXPORT QString albert::dataLocation

(

)

The app data location.

hide()

ALBERT_EXPORT void albert::hide

(

)

Hide the main window.

networkManager()

ALBERT_EXPORT QNetworkAccessManager * albert::networkManager

(

)

The global QNetworkAccessManager.

openIssueTracker()

ALBERT_EXPORT void albert::openIssueTracker

(

)

Open the albert issue tracker in default browser.

openUrl() [1/2]

ALBERT_EXPORT void albert::openUrl

(

const QString &

url

)

Open the specified url in default browser.

openUrl() [2/2]

ALBERT_EXPORT void albert::openUrl

(

const QUrl &

url

)

Open the specified url in default browser.

openWebsite()

ALBERT_EXPORT void albert::openWebsite

(

)

Open the albert website in default browser.

quit()

ALBERT_EXPORT void albert::quit

(

)

Quit the app.

restart()

ALBERT_EXPORT void albert::restart

(

)

Restart the app.

runDetachedProcess()

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

Run a detached process.

runTerminal()

ALBERT_EXPORT void albert::runTerminal	(	const QString &	script = {},
		const QString &	working_dir = {},
		bool	close_on_exit = false
	)

Run a script in the user defined terminal.

setClipboardText()

ALBERT_EXPORT void albert::setClipboardText

(

const QString &

text

)

Set the system clipboard.

setClipboardTextAndPaste()

ALBERT_EXPORT void albert::setClipboardTextAndPaste

(

const QString &

text

)

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

settings()

ALBERT_EXPORT std::unique_ptr< QSettings > albert::settings

(

)

Persistent app settings. @reentrant.

show()

ALBERT_EXPORT void albert::show

(

const QString &

text = QString()

)

Show the main window.

showSettings()

ALBERT_EXPORT 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()

ALBERT_EXPORT std::unique_ptr< QSettings > albert::state

(

)

The persistent app state. @reentrant.

toggle()

ALBERT_EXPORT void albert::toggle

(

)

Toggle visibility of main window.