albert::detail::Frontend Class Reference

#include <albert/frontend.h>

Inheritance diagram for albert::detail::Frontend:

Detailed Description

The interface for albert frontends.

Signals
void	inputChanged (QString)
void	visibleChanged (bool)

Public Member Functions
virtual bool	isVisible () const =0
	Visibility of the frontend.
virtual void	setVisible (bool visible)=0
	Set the visibility state of the frontend.
virtual QString	input () const =0
	Input line text.
virtual void	setInput (const QString &)=0
	Input line text setter.
virtual unsigned long long	winId () const =0
	The native window id. Used to apply platform quirks.
virtual QWidget *	createFrontendConfigWidget ()=0
	The config widget show in the window settings tab.
virtual void	setQuery (Query *query)=0
	The query setter.
Public Member Functions inherited from albert::PluginInstance
virtual QWidget *	buildConfigWidget ()
	The widget used to configure the plugin in the settings.
virtual std::vector< albert::Extension * >	extensions ()
	The extensions provided by this plugin.
const PluginLoader &	loader () const
	The PluginLoader of this instance.
std::filesystem::path	cacheLocation () const
	The recommended cache location.
std::filesystem::path	configLocation () const
	The recommended config location.
std::filesystem::path	dataLocation () const
	The recommended data location.
std::vector< std::filesystem::path >	dataLocations () const
	The existing data locations of this plugin.
std::unique_ptr< QSettings >	settings () const
	Persistent plugin settings.
std::unique_ptr< QSettings >	state () const
	Persistent plugin state.
void	readKeychain (const QString &key, std::function< void(const QString &)> onSuccess, std::function< void(const QString &)> onError) const
	Reads the keychain value for key asynchronously.
void	writeKeychain (const QString &key, const QString &value, std::function< void()> onSuccess, std::function< void(const QString &)> onError) const
	Sets the keychain value of key to value asynchronously.

Protected Member Functions
	~Frontend () override
Protected Member Functions inherited from albert::PluginInstance
	PluginInstance ()
virtual	~PluginInstance ()

Constructor & Destructor Documentation

~Frontend()

albert::detail::Frontend::~Frontend ( )

overrideprotected

Member Function Documentation

createFrontendConfigWidget()

virtual QWidget * albert::detail::Frontend::createFrontendConfigWidget ( )

pure virtual

The config widget show in the window settings tab.

input()

virtual QString albert::detail::Frontend::input ( ) const

pure virtual

Input line text.

inputChanged

void albert::detail::Frontend::inputChanged ( QString  )

signal

isVisible()

virtual bool albert::detail::Frontend::isVisible ( ) const

pure virtual

Visibility of the frontend.

setInput()

virtual void albert::detail::Frontend::setInput ( const QString &  )

pure virtual

Input line text setter.

setQuery()

virtual void albert::detail::Frontend::setQuery ( Query *  query )

pure virtual

The query setter.

setVisible()

virtual void albert::detail::Frontend::setVisible ( bool  visible )

pure virtual

Set the visibility state of the frontend.

visibleChanged

void albert::detail::Frontend::visibleChanged ( bool  )

signal

winId()

virtual unsigned long long albert::detail::Frontend::winId ( ) const

pure virtual

The native window id. Used to apply platform quirks.

---

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

• workspace/albert/include/albert/frontend.h