Project

General

Profile

Actions

Widget callbacks

A signal will be emitted when an event occurs on a widget.
To run any actions when a signal is emitted, you should define a callback, a function will run these actions.

Here, you can define all callbacks with an one function : _gtkWidgetCB

Its prototype is : fun [ObjGtkWidget u1 u0 I I] ObjGtkWidget

  1. ObjGtkWidget : Scol object : the widget
  2. u1 : the prototype of the callback (see below)
  3. u0 : the user parameter, at your convenience
  4. I : the flag of the callback = which signal is affected ? (see below)
  5. I : the mask : propagate or not the signal to the container ? Two values are availables
    • SCOL_GTK_SIGNAL_MASK_PROPAGATE
    • SCOL_GTK_SIGNAL_MASK_STOP

Warning : the prototype of the callback (u1) is different for each flag !

Flags currently availables :

Any widgets

SCOL_GTK_WIDGET_BUTTONPRESSED

a mouse button has been pressed on a widget.
Prototype : fun [ObjGtkWidget u0 I I I [I I]] u2

table
1. widget ObjGtkWidget a widget
2. userparam u0 a user parameter, at your convenience
3. signal I the type of the signal SCOL_GTK_EVENT_BUTTON_PRESSED (one click),
SCOL_GTK_EVENT_BUTTON_PRESSED2 (double click),
SCOL_GTK_EVENT_BUTTON_PRESSED3 (triple click),
SCOL_GTK_EVENT_BUTTON_RELEASE (button released).
So you can make one function to several definitions
4. button I the mouse button SCOL_GTK_EVENT_BUTTON_1,
SCOL_GTK_EVENT_BUTTON_2,
SCOL_GTK_EVENT_BUTTON_3,
SCOL_GTK_EVENT_BUTTON_4,
SCOL_GTK_EVENT_BUTTON_5,
5. mask I the mask of the modifier keys SCOL_GTK_EVENT_KEY_SHIFT
SCOL_GTK_EVENT_KEY_CONTROL,
SCOL_GTK_EVENT_KEY_ALT,
SCOL_GTK_EVENT_KEY_CAPS (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_HYPER (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_SUPER (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_OTHER (or nothing)
6. position [I I] the position of the click [x y], relative to the widget

Note : sometimes, it is better to use the flag SCOL_GTK_BUTTON_CLICKED. For example, to grab the signal of a mnemonic button, SCOL_GTK_BUTTON_CLICKED should be used (but the callback give less informations).

SCOL_GTK_WIDGET_BUTTONRELEASED

a mouse button has been released on a widget.
Prototype : fun [ObjGtkWidget u0 I I I [I I]] u2

Note : sometimes, it is better to use the flag SCOL_GTK_BUTTON_CLICKED. For example, to grab the signal of a mnemonic button, SCOL_GTK_BUTTON_CLICKED should be used (but the callback give less informations).

See 'SCOL_GTK_WIDGET_BUTTONPRESSED' above.

SCOL_GTK_WIDGET_MOVERESIZE

a window has moved and/or resized.
Prototype : fun [ObjGtkWidget u0 [I I] [I I]] u2

The supplementals parameters are two tuples :
  1. is the new position (x and y, relative at its parents or at the screen)
  2. is the new size (width and height)

SCOL_GTK_WIDGET_DESTROY

when a widget (typically a window or all top level container) is destroyed (all reference are destroyed).
Prototype : fun [ObjGtkWidget u0] u2

SCOL_GTK_WIDGET_ENTERLEAVE

when the pointer (typically a mouse) enter or leave a window (maybe an other object)
Prototype : fun [ObjGtkWidget u0 I I I [I I]] u2

The supplementals arguments are :
table
1. widget ObjGtkWidget a widget (typically a window)
2. userparam u0 a user parameter, at your convenience
3 type I the pointer enters or leaves 0 if enters, 1 if leaves
4 mask I the mask of the modifier keys SCOL_GTK_EVENT_KEY_SHIFT
SCOL_GTK_EVENT_KEY_CONTROL,
SCOL_GTK_EVENT_KEY_ALT,
SCOL_GTK_EVENT_KEY_CAPS (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_HYPER (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_SUPER (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_OTHER (or nothing)
5 focus I the widget has (or not) the focus 1 if is the focus window or an inferior
6 coord [I I] the coordinate of the pointer (x, y)

SCOL_GTK_WIDGET_KEYB_FOCUS

when the keyboard focus enters or leaves a widget.
Prototype : fun [ObjGtkWidget u0 I] u2

The supplemental parameter is :
in : I : 1 if enter, 0 if lost

SCOL_GTK_WIDGET_SHOW

when a widget is shown
Prototype : fun [ObjGtkWidget u0] u2

SCOL_GTK_WIDGET_HIDE

when a widget is hidden
Prototype : fun [ObjGtkWidget u0] u2

SCOL_GTK_WIDGET_KEY

when a key is pressed or released
Prototype : fun [ObjGtkWidget u0 I I I S] u2

table
1. widget ObjGtkWidget a widget
2. userparam u0 a user parameter, at your convenience
3. type I the keyis pressed or released 0 if pressed, 1 if released, nil if not known, error, etc
4. mask I the mask of the modifier keys SCOL_GTK_EVENT_KEY_SHIFT
SCOL_GTK_EVENT_KEY_CONTROL,
SCOL_GTK_EVENT_KEY_ALT,
SCOL_GTK_EVENT_KEY_CAPS (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_HYPER (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_SUPER (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_OTHER (or nothing)
5 keyval I the value of the key
6 keystring S the string (e.g. if keyval = 65, keystring = "A"). But, be careful, if the key is the left shift, keystring should be "SHIFT_L", or, in french, with the key è, keystring = "egrave", ... This last argument is a facility only.

SCOL_GTK_WIDGET_MOTION

when the pointer moves over a widget
Prototype : fun [ObjGtkWidget u0 I [I I] [I I] [S I]] u2

table
1. widget ObjGtkWidget a widget
2. userparam u0 a user parameter, at your convenience
3. mask I the mask of the modifier keys SCOL_GTK_EVENT_KEY_SHIFT
SCOL_GTK_EVENT_KEY_CONTROL,
SCOL_GTK_EVENT_KEY_ALT,
SCOL_GTK_EVENT_KEY_CAPS (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_HYPER (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_SUPER (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_OTHER (or nothing)
4. coord [I I] x and y coordinates
5. coorddevice [I I] x, y translated to the axes of device, or nil if device is the mouse
6. device [S I] the name of the device and the type of the device In Gtk+ 2.x, the string is always "unknown" and the integer is always SCOL_DEVICE_UNKNOWN
SCOL_DEVICE_MOUSE,
SCOL_DEVICE_PEN,
SCOL_DEVICE_ERASER,
SCOL_DEVICE_CURSOR,
SCOL_DEVICE_KEYBOARD,
SCOL_DEVICE_UNKNOWN

SCOL_GTK_WIDGET_SCROLL

when the whell mouse turns and or is pressed

Prototype : fun [ObjGtkWidget u0 I I [I I] [S I]] u2
table
1. widget ObjGtkWidget a widget
2. userparam u0 a user parameter, at your convenience
3. direction I the direction SCOL_GTK_EVENT_SCROLL_UP
SCOL_GTK_EVENT_SCROLL_DOWN
SCOL_GTK_EVENT_SCROLL_LEFT
SCOL_GTK_EVENT_SCROLL_RIGHT
SCOL_GTK_EVENT_SCROLL_UNKNOWN
4. mask I the mask of the modifier keys SCOL_GTK_EVENT_KEY_SHIFT
SCOL_GTK_EVENT_KEY_CONTROL,
SCOL_GTK_EVENT_KEY_ALT,
SCOL_GTK_EVENT_KEY_CAPS (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_HYPER (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_SUPER (can not work : system, window manager, ...)
SCOL_GTK_EVENT_KEY_OTHER (or nothing)
5. coord [I I] x and y coordinates
6. device [S I] the name of the device and the type of the device In Gtk+ 2.x, the string is always "unknown" and the integer is always SCOL_DEVICE_UNKNOWN
SCOL_DEVICE_MOUSE,
SCOL_DEVICE_PEN,
SCOL_DEVICE_ERASER,
SCOL_DEVICE_CURSOR,
SCOL_DEVICE_KEYBOARD,
SCOL_DEVICE_UNKNOWN

SCOL_GTK_WIDGET_VALUE_CHANGED

When the value of several widgets changes. These widgets are the Range widget, Spin widgets, ...

Prototype : fun [ObjGtkWidget u0 F] u2

The supplemental argument is the new value displayed by the widget.

Window only

SCOL_GTK_WINDOW_STATE

when the state of a window changes.

Prototype : fun [ObjGtkWidget u0 I] u2

table
1. widget ObjGtkWidget a widget Warning : widget must be a window (GtkWindow, see _gtkWidgetTypeName)
2. userparam u0 a user parameter, at your convenience
3. state I what flags have changed ? SCOL_WINDOW_NOTSHOWN the window is not shown
SCOL_WINDOW_ICONIFIED the window is minimized
SCOL_WINDOW_MAXIMIZED the window is maximized
SCOL_WINDOW_STICKY the window is sticky
SCOL_WINDOW_FULLSCREEN the window is maximized without decorations
SCOL_WINDOW_ABOVE the window is kept above other windows
SCOL_WINDOW_BELOW the window is kept below other windows
SCOL_WINDOW_STATE_UNKNOWN the state is unknown

Button only

SCOL_GTK_BUTTON_CLICKED

A button has been clicked
Prototype : fun [ObjGtkWidget u0] u2
Warning : widget must be a button (GtkButton, see _gtkWidgetTypeName)

Notebook only

SCOL_GTK_NOTEBOOK_CHANGE

when the user or a function changes the current tab/page.
Prototype : fun [ObjGtkWidget u0 I] u2
The supplemental argument is the index of the new current tab

TextBuffer only

SCOL_GTK_TEXTBUFFER_CHANGED

when the content of a text buffer object change.
Prototype : fun [ObjGtkWidget u0] u2

SCOL_GTK_TEXTBUFFER_MODIFIED

when the text buffer has been modified by the user or by the program. To set/get this state, see _gtkTextBufferIsModified
Prototype : fun [ObjGtkWidget u0] u2

Return Widgets

Updated by iri almost 13 years ago · 26 revisions