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, 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 KWIDGETSADDONS_EXPORT methods returns 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

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.

Definition at line 46 of file kstandardguiitem.h.

Function Documentation

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::add

(

)

Returns the 'Add' gui item.

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

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::apply

(

)

Returns the 'Apply' gui item.

Definition at line 150 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 204 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 220 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::cancel

(

)

Returns the 'Cancel' gui item.

Definition at line 111 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::clear

(

)

Returns the 'Clear' gui item.

Definition at line 167 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::close

(

)

Returns the 'Close' gui item.

Definition at line 180 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::closeDocument

(

)

Returns the 'CloseDocument' gui item.

Since

4.3

Definition at line 192 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::closeWindow

(

)

Returns the 'CloseWindow' gui item.

Since

4.3

Definition at line 186 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::configure

(

)

Returns the 'Configure' gui item.

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

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::defaults

(

)

Returns the 'Defaults' gui item.

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

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::discard

(

)

Returns the 'Discard' gui item.

Definition at line 126 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::dontSave

(

)

Returns the 'DontSave' gui item.

Definition at line 138 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::find

(

)

Returns the 'Find' gui item.

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

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::guiItem

(

StandardItem

id

)

Returns the gui item for the given identifier id.

Parameters

id	the identifier to search for

Definition at line 28 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::help

(

)

Returns the 'Help' gui item.

Definition at line 174 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::insert

(

)

Returns the 'Insert' gui item.

Definition at line 262 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::no

(

)

Returns the 'No' gui item.

Definition at line 121 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::ok

(

)

Returns the 'Ok' gui item.

Definition at line 106 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::open

(

)

Returns the 'Open' gui item.

Definition at line 244 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::overwrite

(

)

Returns the 'Overwrite' gui item.

Definition at line 302 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::print

(

)

Returns the 'Print' gui item.

Definition at line 225 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::properties

(

)

Returns the 'Properties' gui item.

Definition at line 297 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::quit

(

)

Returns the 'Quit' gui item.

Definition at line 250 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::remove

(

)

Returns the 'Remove' gui item.

Definition at line 287 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::reset

(

)

Returns the 'Reset' gui item.

Definition at line 256 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::save

(

)

Returns the 'Save' gui item.

Definition at line 133 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::saveAs

(

)

Returns the 'SaveAs' gui item.

Definition at line 144 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT QString KStandardGuiItem::standardItem

(

StandardItem

id

)

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

Parameters

id	the identifier to search for

Definition at line 68 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::stop

(

)

Returns the 'Stop' gui item.

Definition at line 277 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::test

(

)

Returns the 'Test' gui item.

Definition at line 292 of file kstandardguiitem.cpp.

KWIDGETSADDONS_EXPORT KGuiItem KStandardGuiItem::yes

(

)

Returns the 'Yes' gui item.

Definition at line 116 of file kstandardguiitem.cpp.