KDE API ReferenceKDEUI
Enumerations | |
| enum | BidiMode { UseRTL = 0, IgnoreRTL } |
| enum | StandardItem { Ok =1, Cancel, Yes, No, Discard, Save, DontSave, SaveAs, Apply, Clear, Help, Defaults, Close, Back, Forward, Print, Continue, Open, Quit, AdminMode, Reset, Delete, Insert, Configure, Find, Stop, Add, Remove, Test, Properties, Overwrite, CloseWindow, CloseDocument } |
Functions | |
| KGuiItem | add () |
| KGuiItem | adminMode () |
| KGuiItem | apply () |
| KGuiItem | back (BidiMode useBidi=IgnoreRTL) |
| QPair< KGuiItem, KGuiItem > | backAndForward () |
| KGuiItem | cancel () |
| KGuiItem | clear () |
| KGuiItem | close () |
| KGuiItem | closeDocument () |
| KGuiItem | closeWindow () |
| KGuiItem | configure () |
| KGuiItem | cont () |
| KGuiItem | defaults () |
| KGuiItem | del () |
| KGuiItem | discard () |
| KGuiItem | dontSave () |
| KGuiItem | find () |
| KGuiItem | forward (BidiMode useBidi=IgnoreRTL) |
| KGuiItem | guiItem (StandardItem id) |
| KGuiItem | help () |
| KGuiItem | insert () |
| KGuiItem | no () |
| KGuiItem | ok () |
| KGuiItem | open () |
| KGuiItem | overwrite () |
| KGuiItem | print () |
| KGuiItem | properties () |
| KGuiItem | quit () |
| KGuiItem | remove () |
| KGuiItem | reset () |
| KGuiItem | save () |
| KGuiItem | saveAs () |
| QString | standardItem (StandardItem id) |
| KGuiItem | stop () |
| KGuiItem | test () |
| KGuiItem | yes () |
Detailed Description
Provides a set of standardized KGuiItems.
The various KDEUI_EXPORT methods returns standardized KGuiItem's conforming to the KDE UI Standards. Use them instead of creating your own.
Enumeration Type Documentation
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.
| Enumerator | |
|---|---|
| UseRTL | |
| IgnoreRTL | |
Definition at line 46 of file kstandardguiitem.h.
Definition at line 48 of file kstandardguiitem.h.
Function Documentation
| KGuiItem KStandardGuiItem::add | ( | ) |
Returns the 'Add' gui item.
Definition at line 284 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::adminMode | ( | ) |
Returns a KGuiItem suiting for cases where code or functionality runs under root privileges.
Used in conjunction with KConfig Modules.
Definition at line 161 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::apply | ( | ) |
Returns the 'Apply' gui item.
Definition at line 152 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::back | ( | 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.
Definition at line 206 of file kstandardguiitem.cpp.
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.
Definition at line 222 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::cancel | ( | ) |
Returns the 'Cancel' gui item.
Definition at line 113 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::clear | ( | ) |
Returns the 'Clear' gui item.
Definition at line 169 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::close | ( | ) |
Returns the 'Close' gui item.
Definition at line 182 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::closeDocument | ( | ) |
| KGuiItem KStandardGuiItem::closeWindow | ( | ) |
| KGuiItem KStandardGuiItem::configure | ( | ) |
Returns the 'Configure' gui item.
Definition at line 269 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::cont | ( | ) |
Returns the 'Continue' gui item.
The short name is due to 'continue' being a reserved word in the C++ language.
Definition at line 234 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::defaults | ( | ) |
Returns the 'Defaults' gui item.
Definition at line 200 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::del | ( | ) |
Returns the 'Delete' gui item.
The short name is due to 'delete' being a reserved word in the C++ language.
Definition at line 240 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::discard | ( | ) |
Returns the 'Discard' gui item.
Definition at line 128 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::dontSave | ( | ) |
Returns the 'DontSave' gui item.
Definition at line 140 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::find | ( | ) |
Returns the 'Find' gui item.
Definition at line 274 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::forward | ( | 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.
Definition at line 214 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::guiItem | ( | StandardItem | id | ) |
Returns the gui item for the given identifier.
- Parameters
-
id. id the identifier to search for
Definition at line 29 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::help | ( | ) |
Returns the 'Help' gui item.
Definition at line 176 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::insert | ( | ) |
Returns the 'Insert' gui item.
Toggle insert/overwrite (with visual feedback, e.g.
Definition at line 264 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::no | ( | ) |
Returns the 'No' gui item.
Definition at line 123 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::ok | ( | ) |
Returns the 'Ok' gui item.
Definition at line 107 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::open | ( | ) |
Returns the 'Open' gui item.
Definition at line 246 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::overwrite | ( | ) |
Returns the 'Overwrite' gui item.
Definition at line 304 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::print | ( | ) |
Returns the 'Print' gui item.
Definition at line 227 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::properties | ( | ) |
Returns the 'Properties' gui item.
Definition at line 299 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::quit | ( | ) |
Returns the 'Quit' gui item.
Definition at line 252 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::remove | ( | ) |
Returns the 'Remove' gui item.
Definition at line 289 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::reset | ( | ) |
Returns the 'Reset' gui item.
Definition at line 258 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::save | ( | ) |
Returns the 'Save' gui item.
Definition at line 135 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::saveAs | ( | ) |
Returns the 'SaveAs' gui item.
Definition at line 146 of file kstandardguiitem.cpp.
| QString KStandardGuiItem::standardItem | ( | StandardItem | id | ) |
Returns the name of the gui item for the given identifier.
- Parameters
-
id. id the identifier to search for
Definition at line 69 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::stop | ( | ) |
Returns the 'Stop' gui item.
Definition at line 279 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::test | ( | ) |
Returns the 'Test' gui item.
Definition at line 294 of file kstandardguiitem.cpp.
| KGuiItem KStandardGuiItem::yes | ( | ) |
Returns the 'Yes' gui item.
Definition at line 118 of file kstandardguiitem.cpp.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:24:04 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.
