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 intAdd
static intAdminMode
static intApply
static intBack
static intCancel
static intClear
static intClose
static intConfigure
static intContinue
static intDefaults
static intDelete
static intDiscard
static intDontSave
static intFind
static intForward
static intHelp
static intIgnoreRTL
static intInsert
static intNo
static intOk
static intOpen
static intOverwrite
static intPrint
static intProperties
static intQuit
static intRemove
static intReset
static intSave
static intSaveAs
static intStop
static intTest
static intUseRTL
The back and forward items by default use the RTL settings for Hebrew and Arab countries.
static intYes
Constructor Summary
protected KStdGuiItem(Class dummy)
KStdGuiItem()
Method Summary
static KGuiItemadd()
Returns a "add" item.
static KGuiItemadminMode()
Returns a KGuiItem suiting for cases where code or functionality runs under root privileges.
static KGuiItemapply()
static KGuiItemback(int useBidi)
Return a GUI item for a 'back' action, like Konqueror's back button.
static KGuiItemback()
static KGuiItemcancel()
static KGuiItemclear()
static KGuiItemclose()
static KGuiItemconfigure()
Returns a "configure" item.
static KGuiItemcont()
Returns a "continue" item.
static KGuiItemdefaults()
static KGuiItemdel()
Returns a "delete" item.
static KGuiItemdiscard()
voiddispose()
Delete the wrapped C++ instance ahead of finalize()
static KGuiItemdontSave()
protected voidfinalize()
Deletes the wrapped C++ instance
static KGuiItemfind()
Returns a "find" item.
static KGuiItemforward(int useBidi)
Return a GUI item for a 'forward' action, like Konqueror's forward button.
static KGuiItemforward()
static KGuiItemguiItem(int ui_enum)
static KGuiItemhelp()
static KGuiIteminsert()
booleanisDisposed()
Has the wrapped C++ instance been deleted?
static KGuiItemno()
static KGuiItemok()
static KGuiItemopen()
static KGuiItemoverwrite()
static KGuiItemprint()
static KGuiItemproperties()
static KGuiItemquit()
Return both a back and a forward item.
static KGuiItemremove()
Returns a "remove" item.
static KGuiItemreset()
static KGuiItemsave()
static KGuiItemsaveAs()
static StringstdItem(int ui_enum)
static KGuiItemstop()
Returns a "stop" item.
static KGuiItemtest()
Returns a "test" item.
static KGuiItemyes()

Field Detail

Add

public static final int Add

AdminMode

public static final int AdminMode

Apply

public static final int Apply

Back

public static final int Back

Cancel

public static final int Cancel

Clear

public static final int Clear

Close

public static final int Close

Configure

public static final int Configure

Continue

public static final int Continue

Defaults

public static final int Defaults

Delete

public static final int Delete

Discard

public static final int Discard

DontSave

public static final int DontSave

Find

public static final int Find

Forward

public static final int Forward

Help

public static final int Help

IgnoreRTL

public static final int IgnoreRTL

Insert

public static final int Insert

No

public static final int No

Ok

public static final int Ok

Open

public static final int Open

Overwrite

public static final int Overwrite

Print

public static final int Print

Properties

public static final int Properties

Quit

public static final int Quit

Remove

public static final int Remove

Reset

public static final int Reset

Save

public static final int Save

SaveAs

public static final int SaveAs

Stop

public static final int Stop

Test

public static final int Test

UseRTL

public static final int UseRTL
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.

reset

public static KGuiItem reset()

save

public static KGuiItem save()

saveAs

public static KGuiItem saveAs()

stdItem

public static String stdItem(int ui_enum)

stop

public static KGuiItem stop()
Returns a "stop" 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()