Provides a set of standardized KGuiItems. More...

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)
builddir build BUILD kdelibs kdeui util kstandardguiitem cpp 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.

Author:: Holger Freyther <freyther@kde.org>

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

Enumerator:

UseRTL
IgnoreRTL

Definition at line 46 of file kstandardguiitem.h.

enum KStandardGuiItem::StandardItem

Enumerator:

Ok
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

Definition at line 48 of file kstandardguiitem.h.

Function Documentation

KGuiItem KStandardGuiItem::add ( )

Returns the 'Add' gui item.

Definition at line 285 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 162 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::apply ( )

Returns the 'Apply' gui item.

Definition at line 153 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 207 of file kstandardguiitem.cpp.

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

KGuiItem KStandardGuiItem::cancel ( )

Returns the 'Cancel' gui item.

Definition at line 114 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::clear ( )

Returns the 'Clear' gui item.

Definition at line 170 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::close ( )

Returns the 'Close' gui item.

Definition at line 183 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::closeDocument ( )

Returns the 'CloseDocument' gui item.

Since:: 4.3

Definition at line 195 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::closeWindow ( )

Returns the 'CloseWindow' gui item.

Since:: 4.3

Definition at line 189 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::configure ( )

Returns the 'Configure' gui item.

Definition at line 270 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 235 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::defaults ( )

Returns the 'Defaults' gui item.

Definition at line 201 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 241 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::discard ( )

Returns the 'Discard' gui item.

Definition at line 129 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::dontSave ( )

Returns the 'DontSave' gui item.

Definition at line 141 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::find ( )

Returns the 'Find' gui item.

Definition at line 275 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 215 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 30 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::help ( )

Returns the 'Help' gui item.

Definition at line 177 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::insert ( )

Returns the 'Insert' gui item.

Toggle insert/overwrite (with visual feedback, e.g.

Definition at line 265 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::no ( )

Returns the 'No' gui item.

Definition at line 124 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::ok ( )

Returns the 'Ok' gui item.

Definition at line 108 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::open ( )

Returns the 'Open' gui item.

Definition at line 247 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::overwrite ( )

Returns the 'Overwrite' gui item.

Definition at line 305 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::print ( )

Returns the 'Print' gui item.

Definition at line 228 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::properties ( )

Returns the 'Properties' gui item.

Definition at line 300 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::quit ( )

Returns the 'Quit' gui item.

Definition at line 253 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::remove ( )

Returns the 'Remove' gui item.

Definition at line 290 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::reset ( )

Returns the 'Reset' gui item.

Definition at line 259 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::save ( )

Returns the 'Save' gui item.

Definition at line 136 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::saveAs ( )

Returns the 'SaveAs' gui item.

Definition at line 147 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 70 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::stop ( )

Returns the 'Stop' gui item.

Definition at line 280 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::test ( )

Returns the 'Test' gui item.

Definition at line 295 of file kstandardguiitem.cpp.

KGuiItem KStandardGuiItem::yes ( )

Returns the 'Yes' gui item.

Definition at line 119 of file kstandardguiitem.cpp.

KDEUI

KStandardGuiItem Namespace Reference

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation

KDEUI

kdelibs