org.gnu.gtk

Class Gtk


public class Gtk
extends java.lang.Object

This class is a catch-all for methods in GTK that are not associated with a GTK object.

Method Summary

static boolean
eventsPending()
Checks if any events are pending.
static boolean
getFalse()
Analogical to getTrue().
static boolean
getTrue()
All this function does is to return TRUE.
static void
init(String[] args)
This method should be called before using any java-gnome objects.
static void
initCheck(String[] args)
This method does the same work as init(String[]) with only a single change: It does not terminate the program if the GUI can't be initialized.
static boolean
isGtkThread()
Returns true if the current thread is the Gtk thread
static void
main()
Runs the main event loop.
static boolean
mainIteration()
Runs a single iteration of the main loop.
static boolean
mainIterationDo(boolean blocking)
Runs a single iteration of the mainloop.
static void
mainQuit()
Quit the main event loop.
void
propagateEvent(Widget widget, Event event)
Sends an event to a widget, propagating the event to parent widgets if the event remains unhandled.
static void
removeKeySnoopMethod()
Removes current the key snooper method.
static void
setKeySnoopMethod(KeySnoopMethod method)
Installs a key snooper method, which will get called on all key events before delivering them normally.

Method Details

eventsPending

public static boolean eventsPending()
Checks if any events are pending. This can be used to update the GUI and invoke timeouts etc. while doing some time intensive computation.
Returns:
true if any events are pending.

getFalse

public static boolean getFalse()
Analogical to getTrue(). This function does nothing but always return FALSE.

getTrue

public static boolean getTrue()
All this function does is to return TRUE. This can be useful for example if you want to inhibit the deletion of a window. Of course you should not do this as the user expects a reaction from clicking the close icon of the window.

init

public static void init(String[] args)
This method should be called before using any java-gnome objects. It initialized everything needed to use the native libraries. This method will terminate you program if it is unable to initialize the native libraries.
Parameters:
args - The command line arguments passed to the application.

initCheck

public static void initCheck(String[] args)
            throws GtkInitException
This method does the same work as init(String[]) with only a single change: It does not terminate the program if the GUI can't be initialized. Instead it throws a GtkInitException.
Parameters:
args - The command line arguments passed to the application.
Since:
2.8.2

isGtkThread

public static boolean isGtkThread()
Returns true if the current thread is the Gtk thread

main

public static void main()
Runs the main event loop.

mainIteration

public static boolean mainIteration()
Runs a single iteration of the main loop. If no events are waiting to be processed GTK will block until the next event is noticed.

mainIterationDo

public static boolean mainIterationDo(boolean blocking)
Runs a single iteration of the mainloop. If no events are available either return or block dependent on the value of blocking.
Parameters:
blocking - TRUE if you want GTK+ to block if no events are pending.
Returns:
TRUE if mainQuit() has been called for the innermost mainloop.

mainQuit

public static void mainQuit()
Quit the main event loop.

propagateEvent

public void propagateEvent(Widget widget,
                           Event event)
Sends an event to a widget, propagating the event to parent widgets if the event remains unhandled. NOTE: You most likely don't want to use this function. Synthesizing events is rarely needed. Consider asking on the mailing list for better ways to achieve your goals.
Parameters:
widget - A Widget.
event - An Event.

removeKeySnoopMethod

public static void removeKeySnoopMethod()
Removes current the key snooper method.

setKeySnoopMethod

public static void setKeySnoopMethod(KeySnoopMethod method)
Installs a key snooper method, which will get called on all key events before delivering them normally. This can be used to implement custom key event handling.