KIconDialog Class
An icon selection dialog. More...
| Header: | #include <KIconDialog> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS IconWidgets)target_link_libraries(mytarget PRIVATE KF6::IconWidgets) |
| Inherits: | QDialog |
Public Functions
| KIconDialog(QWidget *parent = nullptr) | |
| int | iconSize() const |
| QString | openDialog() |
| void | setCustomLocation(const QString &location) |
| void | setIconSize(int size) |
(since 5.89) void | setSelectedIcon(const QString &iconName) |
| void | setStrictIconSize(bool policy) |
| void | setup(KIconLoader::Group group, KIconLoader::Context context = KIconLoader::Application, bool strictIconSize = false, int iconSize = 0, bool user = false, bool lockUser = false, bool lockCustomDir = false) |
| void | showDialog() |
| bool | strictIconSize() const |
Signals
| void | newIconName(const QString &iconName) |
Static Public Members
| QString | getIcon(KIconLoader::Group group = KIconLoader::Desktop, KIconLoader::Context context = KIconLoader::Application, bool strictIconSize = false, int iconSize = 0, bool user = false, QWidget *parent = nullptr, const QString &title = QString()) |
Detailed Description
Dialog for interactive selection of icons. Use the function getIcon() to let the user select an icon.
Member Function Documentation
[explicit] KIconDialog::KIconDialog(QWidget *parent = nullptr)
Constructs an icon selection dialog using the global icon loader.
parent The parent widget.
[static] QString KIconDialog::getIcon(KIconLoader::Group group = KIconLoader::Desktop, KIconLoader::Context context = KIconLoader::Application, bool strictIconSize = false, int iconSize = 0, bool user = false, QWidget *parent = nullptr, const QString &title = QString())
Pops up the dialog an lets the user select an icon.
group The icon group this icon is intended for. Providing the group shows the icons in the dialog with the same appearance as when used outside the dialog.
context The initial icon context. Initially, the icons having this context are shown in the dialog. The user can change this.
strictIconSize When true, only icons of the specified group's size are shown, otherwise icon not available in the desired group's size will also be selectable.
iconSize the size of the icons – the default of the icon group if set to 0
user Begin with the "user icons" instead of "system icons".
parent The parent widget of the dialog.
title The title to use for the dialog.
Returns The name of the icon, suitable for loading with KIconLoader.
int KIconDialog::iconSize() const
Returns the icon size set via setIconSize() or 0, if the default icon size will be used.
See also setIconSize().
[signal] void KIconDialog::newIconName(const QString &iconName)
QString KIconDialog::openDialog()
exec()utes this modal dialog and returns the name of the selected icon, or QString() if the dialog was aborted. Returns the name of the icon, suitable for loading with KIconLoader.
See also getIcon.
void KIconDialog::setCustomLocation(const QString &location)
Sets the location of the custom icon directory. Only local directory paths are allowed.
void KIconDialog::setIconSize(int size)
Sets the size of the icons to be shown / selected.
See also KIconLoader::StdSizes and iconSize.
[since 5.89] void KIconDialog::setSelectedIcon(const QString &iconName)
Sets the icon that is initially selected in the dialog.
Note: Changing this after the dialog has been shown has no effect.
Note: If the given icon cannot be found in the current context, no icon will be selected.
iconName The name of the icon to select
This function was introduced in 5.89.
void KIconDialog::setStrictIconSize(bool policy)
Sets a strict icon size policy for allowed icons.
policy When true, only icons of the specified group's size in getIcon() are shown.
When false, icons not available at the desired group's size will also be selectable.
See also strictIconSize().
void KIconDialog::setup(KIconLoader::Group group, KIconLoader::Context context = KIconLoader::Application, bool strictIconSize = false, int iconSize = 0, bool user = false, bool lockUser = false, bool lockCustomDir = false)
Allows you to set the same parameters as in the class method getIcon(), as well as two additional parameters to lock the choice between system and user directories and to lock the custom icon directory itself.
void KIconDialog::showDialog()
show()s this dialog and emits a newIconName(const QString&) signal when successful. QString() will be emitted if the dialog was aborted.
bool KIconDialog::strictIconSize() const
Returns true if a strict icon size policy is set.
See also setStrictIconSize().