 |
Albert
|
|
Albert
|
Classes | |
| class | Action |
| Action used by result items (Item). More... | |
| class | App |
| The public app instance interface. More... | |
| class | AsyncGeneratorQueryHandler |
| Coroutine-based asynchronous generator query handler. More... | |
| class | BackgroundExecutor |
| Convenience class for recurring indexing tasks. More... | |
| class | Dependency |
| class | Download |
| Downloads a file from the given URL to the given path. More... | |
| class | Extension |
| Abstract extension class. More... | |
| class | ExtensionPlugin |
| Extension plugin base class. More... | |
| class | ExtensionRegistry |
| The common extension pool. More... | |
| class | FallbackHandler |
| Abstract fallback item provider. More... | |
| class | GeneratorQueryHandler |
| Coroutine-based synchronous generator query handler. More... | |
| class | GlobalQueryHandler |
| Query handler participating in the global search. More... | |
| class | Icon |
| Abstract icon engine. More... | |
| class | IndexItem |
| An item utlized by ItemIndex. More... | |
| class | IndexQueryHandler |
| Index-based global query handler. More... | |
| class | Item |
| Result items displayed in the query results list. More... | |
| struct | ItemKey |
| class | Match |
| Augmented match score. More... | |
| class | MatchConfig |
| Configuration for string matching. More... | |
| class | Matcher |
| Configurable string matcher. More... | |
| class | Notification |
| The notification class. More... | |
| class | OAuth2 |
| Provides OAuth2 authentication with support for the Authorization Code Flow with PKCE and refresh tokens. More... | |
| class | OAuthConfigWidget |
| Ready to use OAuth login widget. More... | |
| class | PluginInstance |
| Abstract plugin instance class. More... | |
| class | PluginLoader |
| Asynchronous plugin loader. More... | |
| class | PluginMetadata |
| Common plugin metadata. More... | |
| class | PluginProvider |
| Plugin provider interface class. More... | |
| class | QueryContext |
| Query interface. More... | |
| class | QueryExecution |
| Abstract asynchronous query execution interface. More... | |
| class | QueryHandler |
| Base query handler interface for triggered queries. More... | |
| class | QueryResult |
| Result item associating an item with an extension. More... | |
| class | QueryResults |
| Query results container. More... | |
| class | RankedQueryHandler |
| Usage-ranked query handler. More... | |
| class | RankItem |
| An Item with a score. More... | |
| class | StandardItem |
| General purpose Item implementation. More... | |
| class | StrongDependency |
| Convenience holder class for hard plugin dependencies. More... | |
| class | UrlHandler |
| Albert scheme URL handler interface. More... | |
| class | UsageScoring |
| Modifies match scores according to user usage history and preferences. More... | |
| class | WeakDependency |
| Convenience holder class for soft plugin dependencies. More... | |
Concepts | |
| concept | ItemPtr |
| A shared pointer to an Item or subclass thereof. | |
| concept | ItemRange |
| A range of ItemPtr. | |
Typedefs | |
| using | AsyncItemGenerator = QCoro::AsyncGenerator< std::vector< std::shared_ptr< albert::Item > > > |
| using | ItemGenerator = QCoro::Generator< std::vector< std::shared_ptr< albert::Item > > > |
Functions | |
| QIcon | qIcon (std::unique_ptr< albert::Icon > icon) |
| Returns a QIcon using icon as icon engine. | |
| std::unique_ptr< Icon > | iconFromUrl (const QString &url) |
| Returns a built-in icon for the given url. | |
| std::unique_ptr< Icon > | iconFromUrls (const QStringList &urls) |
| Returns a built-in icon for the given urls. | |
| QNetworkAccessManager & | network () |
| Returns a global, threadlocal QNetworkAccessManager. | |
| QNetworkReply * | await (QNetworkReply *reply) |
| Blocks until reply is finished. | |
| QString | percentEncoded (const QString &string) |
| Returns string percent encoded. | |
| QString | percentDecoded (const QString &string) |
| Returns string percent decoded. | |
Image icon | |
| std::unique_ptr< Icon > | makeImageIcon (const QString &path) |
| Returns an icon from an image file at path. | |
| std::unique_ptr< Icon > | makeImageIcon (const std::filesystem::path &path) |
| Returns an icon from an image file at path. | |
File type icon | |
| std::unique_ptr< Icon > | makeFileTypeIcon (const QString &path) |
| Returns an icon representing the file type of the file at path. | |
| std::unique_ptr< Icon > | makeFileTypeIcon (const std::filesystem::path &path) |
| Returns an icon representing the file type of the file at path. | |
Theme icon (XDG) | |
| std::unique_ptr< Icon > | makeThemeIcon (const QString &icon_name) |
| Returns an icon from the current icon theme with the given icon_name. | |
Grapheme icon | |
| const QBrush & | graphemeIconDefaultColor () |
| Returns the default color (black). | |
| double | graphemeIconDefaultScalar () |
| Returns the default scaling factor (1.0). | |
| std::unique_ptr< Icon > | makeGraphemeIcon (const QString &grapheme, double scalar=graphemeIconDefaultScalar(), const QBrush &color=graphemeIconDefaultColor()) |
| Returns an icon rendering the given grapheme, scaled by scalar and colored with color. | |
Rect icon | |
| const QBrush & | rectIconDefaultColor () |
| Returns the default color (black). | |
| const QBrush & | rectIconDefaultBorderColor () |
| Returns the default border color (black). | |
| double | rectIconDefaultRadius () |
| Returns the default border radius (1.0). | |
| int | rectIconDefaultBorderWidth () |
| Returns the default border width (0). | |
| std::unique_ptr< Icon > | makeRectIcon (const QBrush &color=rectIconDefaultColor(), double radius=rectIconDefaultRadius(), int border_width=rectIconDefaultBorderWidth(), const QBrush &border_color=rectIconDefaultBorderColor()) |
| Returns a simple rectangular icon with the given color, radius, border_width and border_color. | |
Iconified icon | |
| const QBrush & | iconifiedIconDefaultColor () |
| Returns the default background color (a top down gradient from white to some darker white). | |
| double | iconifiedIconDefaultBorderRadius () |
| Returns the default relative radius 1.0. | |
| int | iconifiedIconDefaultBorderWidth () |
| Returns the default border width (1). | |
| const QBrush & | iconifiedIconDefaultBorderColor () |
| Returns the default border color (a gradient slightly darker than the default background). | |
| std::unique_ptr< Icon > | makeIconifiedIcon (std::unique_ptr< Icon > src, const QBrush &color=iconifiedIconDefaultColor(), double border_radius=iconifiedIconDefaultBorderRadius(), int border_width=iconifiedIconDefaultBorderWidth(), const QBrush &border_color=iconifiedIconDefaultBorderColor()) |
| Returns an iconified src. | |
Composed icon | |
| double | composedIconDefaultSize () |
| Returns the default relative size 0.7. | |
| double | composedIconDefaultPos1 () |
| Returns the default relative position 0.0 of the first item. | |
| double | composedIconDefaultPos2 () |
| Returns the default relative position 1.0 of the second item. | |
| std::unique_ptr< Icon > | makeComposedIcon (std::unique_ptr< Icon > src1, std::unique_ptr< Icon > src2, double size1=composedIconDefaultSize(), double size2=composedIconDefaultSize(), double x1=composedIconDefaultPos1(), double y1=composedIconDefaultPos1(), double x2=composedIconDefaultPos2(), double y2=composedIconDefaultPos2()) |
| Returns a composed icon of src1 and src2. | |
Message boxes | |
| bool | question (const QString &text, QWidget *parent=nullptr) |
| Shows a question message box with Yes and No buttons. | |
| void | information (const QString &text, QWidget *parent=nullptr) |
| Shows an information message box with a single Ok button. | |
| void | warning (const QString &text, QWidget *parent=nullptr) |
| Shows a warning message box with a single Ok button. | |
| void | critical (const QString &text, QWidget *parent=nullptr) |
| Shows a critical message box with a single Ok button. | |
System utility | |
| void | openUrl (const QString &url) |
| Opens url with the default handler for the scheme. | |
| void | open (const QUrl &url) |
| Opens url with the default handler for the scheme. | |
| void | open (const QString &path) |
| Opens a file at path with the associated default application. | |
| void | open (const std::filesystem::path &path) |
| Opens a file at path with the associated default application. | |
| void | setClipboardText (const QString &text) |
| Sets the system clipboard to text. | |
| bool | havePasteSupport () |
Returns the true if the platform supports pasting, else false. | |
| void | setClipboardTextAndPaste (const QString &text) |
| Sets the system clipboard to text and pastes text to the front-most window. | |
| long long | runDetachedProcess (const QStringList &commandline) |
| Starts the commandline in a new process, and detaches from it. | |
| long long | runDetachedProcess (const QStringList &commandline, const QString &working_dir) |
| Starts the commandline in a new process, and detaches from it. | |
| QString | toQString (const std::filesystem::path &path) |
| Returns a QString representation of path. | |
Property editor bindings | |
| template<typename T , typename GET , typename SET > | |
| void | bindWidget (QCheckBox *checkbox, T *object, GET get, SET set) |
Binds a property of type bool of object to checkbox. | |
| template<typename T , typename GET , typename SET , typename SIG > | |
| void | bindWidget (QCheckBox *checkbox, T *object, GET get, SET set, SIG sig) |
Binds a property of type bool of object to checkbox. | |
| template<typename T , typename GET , typename SET > | |
| void | bindWidget (QLineEdit *lineedit, T *object, GET get, SET set) |
Binds a property of type QString of object to lineedit. | |
| template<typename T , typename GET , typename SET , typename SIG > | |
| void | bindWidget (QLineEdit *lineedit, T *object, GET get, SET set, SIG sig) |
Binds a property of type QString of object to lineedit. | |
| template<typename T , typename GET , typename SET > | |
| void | bindWidget (QSpinBox *spinbox, T *object, GET get, SET set) |
Binds a property of type int of object to spinbox. | |
| template<typename T , typename GET , typename SET , typename SIG > | |
| void | bindWidget (QSpinBox *spinbox, T *object, GET get, SET set, SIG sig) |
Binds a property of type int of object to spinbox. | |
| template<typename T , typename GET , typename SET > | |
| void | bindWidget (QDoubleSpinBox *spinbox, T *object, GET get, SET set) |
Binds a property of type double of object to spinbox. | |
| template<typename T , typename GET , typename SET , typename SIG > | |
| void | bindWidget (QDoubleSpinBox *spinbox, T *object, GET get, SET set, SIG sig) |
Binds a property of type double of object to spinbox. | |
Standard icon (QStyle standard pixmap) | |
| enum | StandardIconType |
| This enum describes the available standard icons. More... | |
| std::unique_ptr< Icon > | makeStandardIcon (StandardIconType type) |
| Returns a standard icon for the given type. | |
| using albert::AsyncItemGenerator = typedef QCoro::AsyncGenerator<std::vector<std::shared_ptr<albert::Item> >> |
| using albert::ItemGenerator = typedef QCoro::Generator<std::vector<std::shared_ptr<albert::Item> >> |
1.9.8