org.kde.koala
Class KStdGuiItem

java.lang.Object
  extended by org.kde.koala.KStdGuiItem
All Implemented Interfaces:
org.kde.qt.QtSupport

public class KStdGuiItem
extends java.lang.Object
implements org.kde.qt.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

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
  KStdGuiItem()
           
protected KStdGuiItem(java.lang.Class dummy)
           
 
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()
           
static KGuiItem back(int useBidi)
          Return a GUI item for a 'back' action, like Konqueror's back button.
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()
           
static KGuiItem forward(int useBidi)
          Return a GUI item for a 'forward' action, like Konqueror's forward button.
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 java.lang.String stdItem(int ui_enum)
           
static KGuiItem stop()
          Returns a "stop" item.
static KGuiItem test()
          Returns a "test" item.
static KGuiItem yes()
           
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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.

See Also:
Constant Field Values

IgnoreRTL

public static final int IgnoreRTL
See Also:
Constant Field Values

Ok

public static final int Ok
See Also:
Constant Field Values

Cancel

public static final int Cancel
See Also:
Constant Field Values

Yes

public static final int Yes
See Also:
Constant Field Values

No

public static final int No
See Also:
Constant Field Values

Discard

public static final int Discard
See Also:
Constant Field Values

Save

public static final int Save
See Also:
Constant Field Values

DontSave

public static final int DontSave
See Also:
Constant Field Values

SaveAs

public static final int SaveAs
See Also:
Constant Field Values

Apply

public static final int Apply
See Also:
Constant Field Values

Clear

public static final int Clear
See Also:
Constant Field Values

Help

public static final int Help
See Also:
Constant Field Values

Defaults

public static final int Defaults
See Also:
Constant Field Values

Close

public static final int Close
See Also:
Constant Field Values

Back

public static final int Back
See Also:
Constant Field Values

Forward

public static final int Forward
See Also:
Constant Field Values

Print

public static final int Print
See Also:
Constant Field Values

Continue

public static final int Continue
See Also:
Constant Field Values

Open

public static final int Open
See Also:
Constant Field Values

Quit

public static final int Quit
See Also:
Constant Field Values

AdminMode

public static final int AdminMode
See Also:
Constant Field Values

Reset

public static final int Reset
See Also:
Constant Field Values

Delete

public static final int Delete
See Also:
Constant Field Values

Insert

public static final int Insert
See Also:
Constant Field Values

Configure

public static final int Configure
See Also:
Constant Field Values

Find

public static final int Find
See Also:
Constant Field Values

Stop

public static final int Stop
See Also:
Constant Field Values

Add

public static final int Add
See Also:
Constant Field Values

Remove

public static final int Remove
See Also:
Constant Field Values

Test

public static final int Test
See Also:
Constant Field Values

Properties

public static final int Properties
See Also:
Constant Field Values

Overwrite

public static final int Overwrite
See Also:
Constant Field Values
Constructor Detail

KStdGuiItem

protected KStdGuiItem(java.lang.Class dummy)

KStdGuiItem

public KStdGuiItem()
Method Detail

guiItem

public static KGuiItem guiItem(int ui_enum)

stdItem

public static java.lang.String stdItem(int ui_enum)

ok

public static KGuiItem ok()

cancel

public static KGuiItem cancel()

yes

public static KGuiItem yes()

no

public static KGuiItem no()

insert

public static KGuiItem insert()

discard

public static KGuiItem discard()

save

public static KGuiItem save()

help

public static KGuiItem help()

dontSave

public static KGuiItem dontSave()

saveAs

public static KGuiItem saveAs()

apply

public static KGuiItem apply()

clear

public static KGuiItem clear()

defaults

public static KGuiItem defaults()

close

public static KGuiItem close()

print

public static KGuiItem print()

properties

public static KGuiItem properties()

reset

public static KGuiItem reset()

overwrite

public static KGuiItem overwrite()

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.


cont

public static KGuiItem cont()
Returns a "continue" item. The short name is due to "continue" being a reserved word in the C++ language.


del

public static KGuiItem del()
Returns a "delete" item. The short name is due to "delete" being a reserved word in the C++ language.


open

public static KGuiItem open()

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.


back

public static KGuiItem back()

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.


forward

public static KGuiItem forward()

configure

public static KGuiItem configure()
Returns a "configure" item.


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.


find

public static KGuiItem find()
Returns a "find" item.


stop

public static KGuiItem stop()
Returns a "stop" item.


add

public static KGuiItem add()
Returns a "add" item.


remove

public static KGuiItem remove()
Returns a "remove" item.


test

public static KGuiItem test()
Returns a "test" item.


finalize

protected void finalize()
                 throws java.lang.InternalError
Deletes the wrapped C++ instance

Overrides:
finalize in class java.lang.Object
Throws:
java.lang.InternalError

dispose

public void dispose()
Delete the wrapped C++ instance ahead of finalize()


isDisposed

public boolean isDisposed()
Has the wrapped C++ instance been deleted?