KStandardGuiItem Namespace
Provides a set of standardized KGuiItems. More...
| Header: | #include <KStandardGuiItem> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS WidgetsAddons)target_link_libraries(mytarget PRIVATE KF6::WidgetsAddons) |
Types
| enum | BidiMode { UseRTL, IgnoreRTL } |
| enum | StandardItem { Ok, Cancel, Discard, Save, DontSave, …, CloseDocument } |
Functions
| KGuiItem | add() |
| KGuiItem | adminMode() |
| KGuiItem | apply() |
| void | assign(QPushButton *button, KStandardGuiItem::StandardItem item) |
| KGuiItem | back(KStandardGuiItem::BidiMode useBidi = IgnoreRTL) |
| QPair<KGuiItem, KGuiItem> | backAndForward() |
| KGuiItem | cancel() |
| KGuiItem | clear() |
| KGuiItem | close() |
(since 4.3) KGuiItem | closeDocument() |
(since 4.3) KGuiItem | closeWindow() |
| KGuiItem | configure() |
| KGuiItem | cont() |
| KGuiItem | defaults() |
| KGuiItem | del() |
| KGuiItem | discard() |
| KGuiItem | dontSave() |
| KGuiItem | find() |
| KGuiItem | forward(KStandardGuiItem::BidiMode useBidi = IgnoreRTL) |
| KGuiItem | guiItem(KStandardGuiItem::StandardItem id) |
| KGuiItem | help() |
| KGuiItem | insert() |
| KGuiItem | ok() |
| KGuiItem | open() |
| KGuiItem | overwrite() |
| KGuiItem | print() |
| KGuiItem | properties() |
| KGuiItem | quit() |
| KGuiItem | remove() |
| KGuiItem | reset() |
| KGuiItem | save() |
| KGuiItem | saveAs() |
| QString | standardItem(KStandardGuiItem::StandardItem id) |
| KGuiItem | stop() |
| KGuiItem | test() |
Detailed Description
The various methods return standardized KGuiItem's conforming to the KDE UI Standards. Use them instead of creating your own.
Type Documentation
enum KStandardGuiItem::BidiMode
The back and forward items by default use the RTL settings for Hebrew and Arab countries. If you want those actions to ignore the RTL value and force 'Western' behavior instead, use the IgnoreRTL value instead.
| Constant | Value |
|---|---|
KStandardGuiItem::UseRTL | 0 |
KStandardGuiItem::IgnoreRTL | 1 |
enum KStandardGuiItem::StandardItem
| Constant | Value |
|---|---|
KStandardGuiItem::Ok | 1 |
KStandardGuiItem::Cancel | 2 |
KStandardGuiItem::Discard | 3 |
KStandardGuiItem::Save | 4 |
KStandardGuiItem::DontSave | 5 |
KStandardGuiItem::SaveAs | 6 |
KStandardGuiItem::Apply | 7 |
KStandardGuiItem::Clear | 8 |
KStandardGuiItem::Help | 9 |
KStandardGuiItem::Defaults | 10 |
KStandardGuiItem::Close | 11 |
KStandardGuiItem::Back | 12 |
KStandardGuiItem::Forward | 13 |
KStandardGuiItem::Print | 14 |
KStandardGuiItem::Continue | 15 |
KStandardGuiItem::Open | 16 |
KStandardGuiItem::Quit | 17 |
KStandardGuiItem::AdminMode | 18 |
KStandardGuiItem::Reset | 19 |
KStandardGuiItem::Delete | 20 |
KStandardGuiItem::Insert | 21 |
KStandardGuiItem::Configure | 22 |
KStandardGuiItem::Find | 23 |
KStandardGuiItem::Stop | 24 |
KStandardGuiItem::Add | 25 |
KStandardGuiItem::Remove | 26 |
KStandardGuiItem::Test | 27 |
KStandardGuiItem::Properties | 28 |
KStandardGuiItem::Overwrite | 29 |
KStandardGuiItem::CloseWindow | 30 |
KStandardGuiItem::CloseDocument | 31 |
Function Documentation
KGuiItem KStandardGuiItem::add()
Returns the 'Add' gui item.
KGuiItem KStandardGuiItem::adminMode()
Returns a KGuiItem suiting for cases where code or functionality runs under root privileges. Used in conjunction with KConfig Modules.
KGuiItem KStandardGuiItem::apply()
Returns the 'Apply' gui item.
void KStandardGuiItem::assign(QPushButton *button, KStandardGuiItem::StandardItem item)
KGuiItem KStandardGuiItem::back(KStandardGuiItem::BidiMode useBidi = IgnoreRTL)
Returns the 'Back' gui item, like Konqueror's back button. This GUI item can optionally honor the user's setting for BiDi, so the icon for right-to-left languages (Hebrew and Arab) has the arrow pointing in the opposite direction. By default the arrow points in the Western 'back' direction (i.e. to the left). This is because usually you only want the Bidi aware GUI item if you also want the 'forward' item. Those two are available in the separate backAndForward() method.
QPair<KGuiItem, KGuiItem> KStandardGuiItem::backAndForward()
Return both a back and a forward gui item. This function always returns items that are aware of the Right-to-Left setting for Arab and Hebrew locales. If you have a reason for wanting the 'Western' back/forward buttons, please use the back() and forward() items instead.
KGuiItem KStandardGuiItem::cancel()
Returns the 'Cancel' gui item.
KGuiItem KStandardGuiItem::clear()
Returns the 'Clear' gui item.
KGuiItem KStandardGuiItem::close()
Returns the 'Close' gui item.
[since 4.3] KGuiItem KStandardGuiItem::closeDocument()
Returns the 'CloseDocument' gui item.
This function was introduced in 4.3.
[since 4.3] KGuiItem KStandardGuiItem::closeWindow()
Returns the 'CloseWindow' gui item.
This function was introduced in 4.3.
KGuiItem KStandardGuiItem::configure()
Returns the 'Configure' gui item.
KGuiItem KStandardGuiItem::cont()
Returns the 'Continue' gui item. The short name is due to 'continue' being a reserved word in the C++ language.
KGuiItem KStandardGuiItem::defaults()
Returns the 'Defaults' gui item.
KGuiItem KStandardGuiItem::del()
Returns the 'Delete' gui item. The short name is due to 'delete' being a reserved word in the C++ language.
KGuiItem KStandardGuiItem::discard()
Returns the 'Discard' gui item.
KGuiItem KStandardGuiItem::dontSave()
Returns the 'DontSave' gui item.
KGuiItem KStandardGuiItem::find()
Returns the 'Find' gui item.
KGuiItem KStandardGuiItem::forward(KStandardGuiItem::BidiMode useBidi = IgnoreRTL)
Returns the 'Forward' gui item, like Konqueror's forward button. This GUI item can optionally honor the user's setting for BiDi, so the icon for right-to-left languages (Hebrew and Arab) has the arrow pointing in the opposite direction. By default the arrow points in the Western 'forward' direction (i.e. to the right). This is because usually you only want the Bidi aware GUI item if you also want the 'back' item. Those two are available in the separate backAndForward() method.
KGuiItem KStandardGuiItem::guiItem(KStandardGuiItem::StandardItem id)
Returns the gui item for the given identifier id.
id the identifier to search for
KGuiItem KStandardGuiItem::help()
Returns the 'Help' gui item.
KGuiItem KStandardGuiItem::insert()
Returns the 'Insert' gui item.
KGuiItem KStandardGuiItem::ok()
Returns the 'Ok' gui item.
KGuiItem KStandardGuiItem::open()
Returns the 'Open' gui item.
KGuiItem KStandardGuiItem::overwrite()
Returns the 'Overwrite' gui item.
KGuiItem KStandardGuiItem::print()
Returns the 'Print' gui item.
KGuiItem KStandardGuiItem::properties()
Returns the 'Properties' gui item.
KGuiItem KStandardGuiItem::quit()
Returns the 'Quit' gui item.
KGuiItem KStandardGuiItem::remove()
Returns the 'Remove' gui item.
KGuiItem KStandardGuiItem::reset()
Returns the 'Reset' gui item.
KGuiItem KStandardGuiItem::save()
Returns the 'Save' gui item.
KGuiItem KStandardGuiItem::saveAs()
Returns the 'SaveAs' gui item.
QString KStandardGuiItem::standardItem(KStandardGuiItem::StandardItem id)
Returns the name of the gui item for the given identifier id.
id the identifier to search for
KGuiItem KStandardGuiItem::stop()
Returns the 'Stop' gui item.
KGuiItem KStandardGuiItem::test()
Returns the 'Test' gui item.