reference/albert_8h_source.html

// SPDX-FileCopyrightText: 2024 Manuel Schneider

// SPDX-License-Identifier: MIT


#pragma once

#include <QString>

#include <filesystem>

#include <albert/export.h>

class NotificationPrivate;

class QNetworkAccessManager;

class QSettings;

class QUrl;


namespace albert::util {}


namespace albert::detail {}


namespace albert

{

class ExtensionRegistry;


ALBERT_EXPORT void show(const QString &input_text = {});


ALBERT_EXPORT void showSettings(QString plugin_id = {});


ALBERT_EXPORT void restart();


ALBERT_EXPORT void quit();


ALBERT_EXPORT const std::filesystem::path &configLocation();


ALBERT_EXPORT const std::filesystem::path &cacheLocation();


ALBERT_EXPORT const std::filesystem::path &dataLocation();


ALBERT_EXPORT std::unique_ptr<QSettings> settings();


ALBERT_EXPORT std::unique_ptr<QSettings> state();


ALBERT_EXPORT const ExtensionRegistry &extensionRegistry();


} // namespace albert

albert::ExtensionRegistry
The common extension pool.
Definition extensionregistry.h:23

albert::detail
Albert private namespace.
Definition albert.h:17

albert::util
Albert utility namespace.
Definition albert.h:14

albert
Albert core interface namespace.
Definition albert.h:14

albert::settings
std::unique_ptr< QSettings > settings()
Returns a QSettings object for configuration storage.

albert::cacheLocation
const std::filesystem::path & cacheLocation()
Returns the application cache location.

albert::state
std::unique_ptr< QSettings > state()
Returns a QSettings object for state storage.

albert::show
void show(const QString &input_text={})
Shows the frontend.

albert::dataLocation
const std::filesystem::path & dataLocation()
Returns the application data location.

albert::restart
void restart()
Restarts the application.

albert::configLocation
const std::filesystem::path & configLocation()
Returns the application config location.

albert::showSettings
void showSettings(QString plugin_id={})
Creates and/or shows the settings window.

albert::quit
void quit()
Quits the application.

albert::extensionRegistry
const ExtensionRegistry & extensionRegistry()
Returns a const reference to the central ExtensionRegistry.