KStandardGuiItem

KStandardGuiItem Namespace Reference

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 ()
 
void assign (QPushButton *button, StandardItem item)
 
KGuiItem back (BidiMode useBidi=IgnoreRTL)
 
QPair< KGuiItem, KGuiItembackAndForward ()
 
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 KWIDGETSADDONS_EXPORT methods returns standardized KGuiItem's conforming to the KDE UI Standards. Use them instead of creating your own.

Author
Holger Freyther freyt[email protected][email protected][email protected]kde.o[email protected]rg

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.

Definition at line 35 of file kstandardguiitem.h.

Function Documentation

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::add ( )

Returns the 'Add' gui item.

Definition at line 356 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT 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 219 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::apply ( )

Returns the 'Apply' gui item.

Definition at line 207 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT 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 273 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT 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.

Definition at line 287 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::cancel ( )

Returns the 'Cancel' gui item.

Definition at line 163 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::clear ( )

Returns the 'Clear' gui item.

Definition at line 230 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::close ( )

Returns the 'Close' gui item.

Definition at line 245 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::closeDocument ( )

Returns the 'CloseDocument' gui item.

Since
4.3

Definition at line 259 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::closeWindow ( )

Returns the 'CloseWindow' gui item.

Since
4.3

Definition at line 252 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::configure ( )

Returns the 'Configure' gui item.

Definition at line 341 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT 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 301 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::defaults ( )

Returns the 'Defaults' gui item.

Definition at line 266 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT 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 308 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::discard ( )

Returns the 'Discard' gui item.

Definition at line 178 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::dontSave ( )

Returns the 'DontSave' gui item.

Definition at line 195 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::find ( )

Returns the 'Find' gui item.

Definition at line 346 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT 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 279 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::guiItem ( StandardItem  id)

Returns the gui item for the given identifier id.

Parameters
idthe identifier to search for

Definition at line 14 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::help ( )

Returns the 'Help' gui item.

Definition at line 238 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::insert ( )

Returns the 'Insert' gui item.

Definition at line 336 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::no ( )

Returns the 'No' gui item.

Definition at line 173 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::ok ( )

Returns the 'Ok' gui item.

Definition at line 158 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::open ( )

Returns the 'Open' gui item.

Definition at line 315 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::overwrite ( )

Returns the 'Overwrite' gui item.

Definition at line 376 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::print ( )

Returns the 'Print' gui item.

Definition at line 292 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::properties ( )

Returns the 'Properties' gui item.

Definition at line 371 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::quit ( )

Returns the 'Quit' gui item.

Definition at line 322 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::remove ( )

Returns the 'Remove' gui item.

Definition at line 361 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::reset ( )

Returns the 'Reset' gui item.

Definition at line 329 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::save ( )

Returns the 'Save' gui item.

Definition at line 188 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::saveAs ( )

Returns the 'SaveAs' gui item.

Definition at line 200 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT QString KStandardGuiItem::standardItem ( StandardItem  id)

Returns the name of the gui item for the given identifier id.

Parameters
idthe identifier to search for

Definition at line 88 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::stop ( )

Returns the 'Stop' gui item.

Definition at line 351 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::test ( )

Returns the 'Test' gui item.

Definition at line 366 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::yes ( )

Returns the 'Yes' gui item.

Definition at line 168 of file kstandardguiitem.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Jul 26 2021 22:44:37 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.