org.kde.koala

Class KStdGuiItem

public class KStdGuiItem extends Object implements QtSupport

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

Author: Holger Freyther

UNKNOWN: Provides a set of standardized KGuiItems.

Field Summary
static int	Add
static int	AdminMode
static int	Apply
static int	Back
static int	Cancel
static int	Clear
static int	Close
static int	Configure
static int	Continue
static int	Defaults
static int	Delete
static int	Discard
static int	DontSave
static int	Find
static int	Forward
static int	Help
static int	IgnoreRTL
static int	Insert
static int	No
static int	Ok
static int	Open
static int	Overwrite
static int	Print
static int	Properties
static int	Quit
static int	Remove
static int	Reset
static int	Save
static int	SaveAs
static int	Stop
static int	Test
static int	UseRTL The back and forward items by default use the RTL settings for Hebrew and Arab countries.
static int	Yes

Constructor Summary
protected	KStdGuiItem(Class dummy)
	KStdGuiItem()

Method Summary
static KGuiItem	add() Returns a "add" item.
static KGuiItem	adminMode() Returns a KGuiItem suiting for cases where code or functionality runs under root privileges.
static KGuiItem	apply()
static KGuiItem	back(int useBidi) Return a GUI item for a 'back' action, like Konqueror's back button.
static KGuiItem	back()
static KGuiItem	cancel()
static KGuiItem	clear()
static KGuiItem	close()
static KGuiItem	configure() Returns a "configure" item.
static KGuiItem	cont() Returns a "continue" item.
static KGuiItem	defaults()
static KGuiItem	del() Returns a "delete" item.
static KGuiItem	discard()
void	dispose() Delete the wrapped C++ instance ahead of finalize()
static KGuiItem	dontSave()
protected void	finalize() Deletes the wrapped C++ instance
static KGuiItem	find() Returns a "find" item.
static KGuiItem	forward(int useBidi) Return a GUI item for a 'forward' action, like Konqueror's forward button.
static KGuiItem	forward()
static KGuiItem	guiItem(int ui_enum)
static KGuiItem	help()
static KGuiItem	insert()
boolean	isDisposed() Has the wrapped C++ instance been deleted?
static KGuiItem	no()
static KGuiItem	ok()
static KGuiItem	open()
static KGuiItem	overwrite()
static KGuiItem	print()
static KGuiItem	properties()
static KGuiItem	quit() Return both a back and a forward item.
static KGuiItem	remove() Returns a "remove" item.
static KGuiItem	reset()
static KGuiItem	save()
static KGuiItem	saveAs()
static String	stdItem(int ui_enum)
static KGuiItem	stop() Returns a "stop" item.
static KGuiItem	test() Returns a "test" item.
static KGuiItem	yes()

Field Detail

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.

UNKNOWN: The back and forward items by default use the RTL settings for Hebrew and Arab countries.

Yes

public static final int Yes

Constructor Detail

KStdGuiItem

protected KStdGuiItem(Class dummy)

KStdGuiItem

public KStdGuiItem()

Method Detail

add

public static KGuiItem add()

Returns a "add" item.

UNKNOWN: Returns a "add" item.

adminMode

public static KGuiItem adminMode()

Returns a KGuiItem suiting for cases where code or functionality runs under root privileges. Used in conjunction with KConfig Modules.

UNKNOWN: Returns a KGuiItem suiting for cases where code or functionality runs under root privileges.

apply

public static KGuiItem apply()

back

public static KGuiItem back(int useBidi)

Return a GUI item for a 'back' action, 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.

UNKNOWN: Return a GUI item for a 'back' action, like Konqueror's back button.

back

public static KGuiItem back()

cancel

public static KGuiItem cancel()

clear

public static KGuiItem clear()

close

public static KGuiItem close()

configure

public static KGuiItem configure()

Returns a "configure" item.

UNKNOWN: Returns a "configure" item.

cont

public static KGuiItem cont()

Returns a "continue" item. The short name is due to "continue" being a reserved word in the C++ language.

UNKNOWN: Returns a "continue" item.

defaults

public static KGuiItem defaults()

del

public static KGuiItem del()

Returns a "delete" item. The short name is due to "delete" being a reserved word in the C++ language.

UNKNOWN: Returns a "delete" item.

discard

public static KGuiItem discard()

dispose

public void dispose()

Delete the wrapped C++ instance ahead of finalize()

dontSave

public static KGuiItem dontSave()

finalize

protected void finalize()

Deletes the wrapped C++ instance

find

public static KGuiItem find()

Returns a "find" item.

UNKNOWN: Returns a "find" item.

forward

public static KGuiItem forward(int useBidi)

Return a GUI item for a 'forward' action, 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.

UNKNOWN: Return a GUI item for a 'forward' action, like Konqueror's forward button.

forward

public static KGuiItem forward()

guiItem

public static KGuiItem guiItem(int ui_enum)

help

public static KGuiItem help()

insert

public static KGuiItem insert()

isDisposed

public boolean isDisposed()

Has the wrapped C++ instance been deleted?

no

public static KGuiItem no()

ok

public static KGuiItem ok()

open

public static KGuiItem open()

overwrite

public static KGuiItem overwrite()

UNKNOWN:

print

public static KGuiItem print()

properties

public static KGuiItem properties()

UNKNOWN:

quit

public static KGuiItem quit()

Return both a back and a forward 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.

UNKNOWN: Return both a back and a forward item.

remove

public static KGuiItem remove()

Returns a "remove" item.

UNKNOWN: Returns a "remove" item.

UNKNOWN: Returns a "stop" item.

test

public static KGuiItem test()

Returns a "test" item.

UNKNOWN: Returns a "test" item.

yes

public static KGuiItem yes()