The "event" Package

These routines are meant to provide a general pupose event dispatching mechanism for communicating programmes.

Library: karma
Link With: -lkarma
Note:

  • THIS PACKAGE IS WORK IN PROGRESS. THE INTERFACE MAY CHANGE IN THE NEXT RELEASE, POSSIBLY WITHOUT NOTICE.

    Functions

    event_initialiseInitialise the package.
    event_dispatchDispatch an event.
    event_register_event_funcRegister event callback.
    event_set_maskSet the event mask
    event_waitWait for an event.

    Prototype Functions

    event_PROTO_event_funcGeneric event callback.

    Tables

    event_MASKSList of event bitmasks


    Functions


    EXPERIMENTAL FUNCTION: subject to change without notice

    void event_initialise ()

    Initialise the package.

    Parameters:

    Returns: Nothing.
    Multithreading Level: Unsafe


    EXPERIMENTAL FUNCTION: subject to change without notice

    void event_dispatch (KEvent event)

    Dispatch an event.

    Parameters:

    Returns: Nothing.
    Multithreading Level: Unsafe


    EXPERIMENTAL FUNCTION: subject to change without notice

    KCallbackFunc event_register_event_func (flag (*func) (), void *f_info)

    Register event callback.

    Parameters:

    Returns: A handle to a KCallbackFunc object.
    Multithreading Level: Unsafe


    EXPERIMENTAL FUNCTION: subject to change without notice

    flag event_set_mask (unsigned long mask, long num_events, Connection connection)

    Set the event mask

    Parameters:

    Returns: TRUE on success, else FALSE.
    Multithreading Level: Unsafe


    EXPERIMENTAL FUNCTION: subject to change without notice

    flag event_wait (unsigned long mask, Connection connection, KEvent *event)

    Wait for an event.

    Parameters:

    Returns: TRUE on success, else FALSE.
    Multithreading Level: Unsafe


    Prototype Functions


    flag event_PROTO_event_func (KEvent event, Connection connection,void **f_info)

    Generic event callback.

    Parameters:

    Returns: TRUE if the event was consumed, else FALSE indicating that the event is still to be processed.
    Multithreading Level: Unsafe


    Tables


    event_MASKS

    Value Meaning
    K_EVENT_MASK_MOUSE_CLICK Mouse button click down
    K_EVENT_MASK_MOUSE_RELEASE Mouse button release
    K_EVENT_MASK_MOUSE_DRAG Mouse move while button down
    K_EVENT_MASK_POINTER_MOVE Mouse move
    K_EVENT_MASK_KEYPRESS Keyboard press
    K_EVENT_MASK_POINTER_WARP Mouse warp


    Back to Karma Home Page
    Contact: Richard Gooch
    Web Development: Ariel Internet Services