Gambas Documentation - /dev/api/name/gb.raise

/dev/api/name/gb.raise

# GB.Raise

int GB.Raise ( void *object , int id , int nparam , ... )

This functions raises an event.

- object is the object that raises the event.

- id is the event index that identifies the event, as got with the `GB_EVENT` macro.

- nparam is the number of arguments sent to the event handler.

After the nparam argument, you must pass the event handler arguments in order.

You must pass first the type of the argument, by using a /wiki/api/cat/datatype, and then the value of the argument. Then you repeat this process for each argument. See /wiki/api/cat/call for more information.

The function returns `TRUE` to indicate that the event has been canceled by the event handler.

### Examples

    // Here is how the QT component sends a keyboard event.

    drop = GB.Raise(control, event_id, 3,
             GB_T_STRING, TO_UTF8(kevent->text()), 0,
             GB_T_INTEGER, kevent->key(),
             GB_T_INTEGER, kevent->state());

### See also

- /wiki/api/cat/event