KStandardGuiItem

KStandardGuiItem Namespace Reference

Enumerations

enum  BidiMode { UseRTL = 0 , IgnoreRTL }
 
enum  StandardItem {
  Ok = 1 , Cancel , 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 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 ()
 

Detailed Description

Provides a set of standardized KGuiItems.

The various methods return standardized KGuiItem's conforming to the KDE UI Standards. Use them instead of creating your own.

Author
Holger Freyther freyt.nosp@m.her@.nosp@m.kde.o.nosp@m.rg

Enumeration Type Documentation

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

Definition at line 35 of file kstandardguiitem.h.

◆ StandardItem

enum KStandardGuiItem::StandardItem

Definition at line 37 of file kstandardguiitem.h.

Function Documentation

◆ add()

KGuiItem KStandardGuiItem::add ( )

Returns the 'Add' gui item.

Definition at line 338 of file kstandardguiitem.cpp.

◆ adminMode()

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

◆ apply()

KGuiItem KStandardGuiItem::apply ( )

Returns the 'Apply' gui item.

Definition at line 189 of file kstandardguiitem.cpp.

◆ assign()

void KStandardGuiItem::assign ( QPushButton * button,
StandardItem item )

Definition at line 363 of file kstandardguiitem.cpp.

◆ back()

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

◆ backAndForward()

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

◆ cancel()

KGuiItem KStandardGuiItem::cancel ( )

Returns the 'Cancel' gui item.

Definition at line 155 of file kstandardguiitem.cpp.

◆ clear()

KGuiItem KStandardGuiItem::clear ( )

Returns the 'Clear' gui item.

Definition at line 212 of file kstandardguiitem.cpp.

◆ close()

KGuiItem KStandardGuiItem::close ( )

Returns the 'Close' gui item.

Definition at line 227 of file kstandardguiitem.cpp.

◆ closeDocument()

KGuiItem KStandardGuiItem::closeDocument ( )

Returns the 'CloseDocument' gui item.

Since
4.3

Definition at line 241 of file kstandardguiitem.cpp.

◆ closeWindow()

KGuiItem KStandardGuiItem::closeWindow ( )

Returns the 'CloseWindow' gui item.

Since
4.3

Definition at line 234 of file kstandardguiitem.cpp.

◆ configure()

KGuiItem KStandardGuiItem::configure ( )

Returns the 'Configure' gui item.

Definition at line 323 of file kstandardguiitem.cpp.

◆ cont()

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

◆ defaults()

KGuiItem KStandardGuiItem::defaults ( )

Returns the 'Defaults' gui item.

Definition at line 248 of file kstandardguiitem.cpp.

◆ del()

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

◆ discard()

KGuiItem KStandardGuiItem::discard ( )

Returns the 'Discard' gui item.

Definition at line 160 of file kstandardguiitem.cpp.

◆ dontSave()

KGuiItem KStandardGuiItem::dontSave ( )

Returns the 'DontSave' gui item.

Definition at line 177 of file kstandardguiitem.cpp.

◆ find()

KGuiItem KStandardGuiItem::find ( )

Returns the 'Find' gui item.

Definition at line 328 of file kstandardguiitem.cpp.

◆ forward()

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

◆ guiItem()

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.

◆ help()

KGuiItem KStandardGuiItem::help ( )

Returns the 'Help' gui item.

Definition at line 220 of file kstandardguiitem.cpp.

◆ insert()

KGuiItem KStandardGuiItem::insert ( )

Returns the 'Insert' gui item.

Definition at line 318 of file kstandardguiitem.cpp.

◆ ok()

KGuiItem KStandardGuiItem::ok ( )

Returns the 'Ok' gui item.

Definition at line 150 of file kstandardguiitem.cpp.

◆ open()

KGuiItem KStandardGuiItem::open ( )

Returns the 'Open' gui item.

Definition at line 297 of file kstandardguiitem.cpp.

◆ overwrite()

KGuiItem KStandardGuiItem::overwrite ( )

Returns the 'Overwrite' gui item.

Definition at line 358 of file kstandardguiitem.cpp.

◆ print()

KGuiItem KStandardGuiItem::print ( )

Returns the 'Print' gui item.

Definition at line 274 of file kstandardguiitem.cpp.

◆ properties()

KGuiItem KStandardGuiItem::properties ( )

Returns the 'Properties' gui item.

Definition at line 353 of file kstandardguiitem.cpp.

◆ quit()

KGuiItem KStandardGuiItem::quit ( )

Returns the 'Quit' gui item.

Definition at line 304 of file kstandardguiitem.cpp.

◆ remove()

KGuiItem KStandardGuiItem::remove ( )

Returns the 'Remove' gui item.

Definition at line 343 of file kstandardguiitem.cpp.

◆ reset()

KGuiItem KStandardGuiItem::reset ( )

Returns the 'Reset' gui item.

Definition at line 311 of file kstandardguiitem.cpp.

◆ save()

KGuiItem KStandardGuiItem::save ( )

Returns the 'Save' gui item.

Definition at line 170 of file kstandardguiitem.cpp.

◆ saveAs()

KGuiItem KStandardGuiItem::saveAs ( )

Returns the 'SaveAs' gui item.

Definition at line 182 of file kstandardguiitem.cpp.

◆ standardItem()

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

◆ stop()

KGuiItem KStandardGuiItem::stop ( )

Returns the 'Stop' gui item.

Definition at line 333 of file kstandardguiitem.cpp.

◆ test()

KGuiItem KStandardGuiItem::test ( )

Returns the 'Test' gui item.

Definition at line 348 of file kstandardguiitem.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:51:04 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.