The "xtmisc" Package

These routines are meant to provide miscellaneuos Xt support. NOTE: THIS PACKAGE IS WORK IN PROGRESS. THE INTERFACE MAY CHANGE IN THE NEXT RELEASE, POSSIBLY WITHOUT NOTICE.

Library: karmaXt
Link With: -lkarmaXt

Functions

xtmisc_event_create_list	Create a periodic event management list under Xt.
xtmisc_set_icon	Create an icon for an application's top level widget.
xtmisc_init_app_initialise	Initialise an application for Xt.
xtmisc_popup_cbk	Pop up a popup widget.
xtmisc_exclusive_popup_cbk	Pop up a popup widget with exclusive grab.
xtmisc_popdown_cbk	Pop down a popup widget.
xtmisc_sensitive_cbk	Make a widget sensitive.
xtmisc_insensitive_cbk	Make a widget insensitive.
xtmisc_toggle_cbk	Default toggle callback.
xtmisc_support_work_funcs	Register support for work functions within an Xt application.

Prototype Functions

xtmisc_PROTO_icon_func

Write an icon pixmap.

Tables

xtmisc_INIT_ATTRIBUTES

List of attributes for xtmisc_init_app_initialise

Functions

KPeriodicEventList xtmisc_event_create_list (XtAppContext app_context, unsigned long interval_us, unsigned long interval_s, void *list_info)

Create a periodic event management list under Xt.

Parameters:

app_context : The application context to use.
interval_us : The microsecond component time between timeouts on this list.
interval_s : The second component time between timeouts on this list.
list_info : An arbitrary pointer passed to event functions on this list.

Returns: A KPeriodicEventList on success, else the process aborts.
Multithreading Level: Unsafe
Note:

The specified interval may be rounded up to the system timer resolution (10ms on many systems).

void xtmisc_set_icon ( Widget top_level, void (*icon_func) (Display *display, Pixmap pixmap, int width, int height) )

Create an icon for an application's top level widget.

Parameters:

top_level : The top level widget.
icon_func : The function to use when writing the icon. The prototype function is xtmisc_PROTO_icon_func.

Returns: Nothing.
Multithreading Level: Unsafe

Widget xtmisc_init_app_initialise (XtAppContext *app_context_return, CONST char* application_class, XrmOptionDescList options, Cardinal num_options, int *argc_in_out, String *argv_in_out, String *fallback_resources, ...)

This routine will initialise an application to use Xt. This routine is similar to the XtVaAppInitialize routine, except that a new colourmap for the application may be created.

Parameters:

app_context_return : As for XtVaAppInitialize.
application_class : As for XtVaAppInitialize.
options : As for XtVaAppInitialize.
num_options : As for XtVaAppInitialize.
argc_in_out : As for XtVaAppInitialize.
argv_in_out : As for XtVaAppInitialize.
fallback_resources : As for XtVaAppInitialize.
... : Two separate lists of optional pairs of attribute-key attribute-value. The first list is processed by this routine and must be terminated with XTMISC_INIT_ATT_END. The second list is processed by XtVaAppInitialize and must be terminated by NULL.

Returns: The application shell.
Multithreading Level: Unsafe

void xtmisc_popup_cbk (Widget w, XtPointer client_data, XtPointer call_data)

This routine will pop up a popup widget. This routine is a convenience routine to be used as a callback.

Parameters:

w : The widget on which the event occurred. This is ignored.
client_data : The callback client data. This must be the popup widget.
call_data : The callback call data. This is ignored.

Returns: Nothing.
Multithreading Level: Unsafe

void xtmisc_exclusive_popup_cbk (Widget w, XtPointer client_data, XtPointer call_data)

This routine will pop up a popup widget. This routine is a convenience routine to be used as a callback. An exclusive grab is performed on the popped up widget.

Parameters:

w : The widget on which the event occurred. This is ignored.
client_data : The callback client data. This must be the popup widget.
call_data : The callback call data. This is ignored.

Returns: Nothing.
Multithreading Level: Unsafe

void xtmisc_popdown_cbk (Widget w, XtPointer client_data, XtPointer call_data)

This routine will pop down a popup widget. This routine is a convenience routine to be used as a callback.

Parameters:

w : The widget on which the event occurred. This is ignored.
client_data : The callback client data. This must be the popup widget.
call_data : The callback call data. This is ignored.

Returns: Nothing.
Multithreading Level: Unsafe

EXPERIMENTAL FUNCTION: subject to change without notice

void xtmisc_sensitive_cbk (Widget w, XtPointer client_data, XtPointer call_data)

This routine will make a widget sensitive. This routine is a convenience routine to be used as a callback.

Parameters:

w : The widget on which the event occurred. This is ignored.
client_data : The callback client data. This must be the widget to set the sensitivity state of.
call_data : The callback call data. This is ignored.

Returns: Nothing.
Multithreading Level: Unsafe

EXPERIMENTAL FUNCTION: subject to change without notice

void xtmisc_insensitive_cbk (Widget w, XtPointer client_data, XtPointer call_data)

This routine will make a widget insensitive. This routine is a convenience routine to be used as a callback.

Parameters:

w : The widget on which the event occurred. This is ignored.
client_data : The callback client data. This must be the widget to set the sensitivity state of.
call_data : The callback call data. This is ignored.

Returns: Nothing.
Multithreading Level: Unsafe

void xtmisc_toggle_cbk (Widget w, XtPointer client_data, XtPointer call_data)

This routine will set a flag. This routine is a convenience routine to be used as a callback.

Parameters:

w : The widget on which the event occurred. This is ignored.
client_data : The callback client data. This must be the pointer to the (flag) type.
call_data : The callback call data. This is the toggle state.

Returns: Nothing.
Multithreading Level: Unsafe

void xtmisc_support_work_funcs (XtAppContext app_context)

This routine will register Xt support for work functions using the w package.

Parameters:

app_context : The Xt application context.

Returns: Nothing. On failure the process aborts.
Multithreading Level: Unsafe

Prototype Functions

void xtmisc_PROTO_icon_func (Display *display, Pixmap pixmap, int width, int height)

Write an icon pixmap.

Parameters:

display : The display pointer.
pixmap : The pixmap to write to.
width : The width of the pixmap.
height : The height of the pixmap.

Returns: Nothing.
Multithreading Level: Unsafe

Tables

xtmisc_INIT_ATTRIBUTES

Name Type Meaning

XTMISC_INIT_ATT_END End of varargs list
XTMISC_INIT_ATT_MIN_CCELLS unsigned int The min. number of colourcells that the application will want to allocate.
XTMISC_INIT_ATT_COMMS_SETUP flag If TRUE, communications setting up is performed
XTMISC_INIT_ATT_CONTROLLED flag * TRUE is written here if an external agent is controlling
XTMISC_INIT_ATT_VERBOSE flag * TRUE is written here if the "-verbose" flag is given by user
XTMISC_INIT_ATT_BECOME_SERVER flag If TRUE, become a server
XTMISC_INIT_ATT_TITLE char * Title string is written here

Back to Karma Home Page

Contact: Richard Gooch
Web Development: Ariel Internet Services

Name	Type	Meaning

XTMISC_INIT_ATT_END		End of varargs list
XTMISC_INIT_ATT_MIN_CCELLS	unsigned int	The min. number of colourcells that the application will want to allocate.
XTMISC_INIT_ATT_COMMS_SETUP	flag	If TRUE, communications setting up is performed
XTMISC_INIT_ATT_CONTROLLED	flag *	TRUE is written here if an external agent is controlling
XTMISC_INIT_ATT_VERBOSE	flag *	TRUE is written here if the "-verbose" flag is given by user
XTMISC_INIT_ATT_BECOME_SERVER	flag	If TRUE, become a server
XTMISC_INIT_ATT_TITLE	char *	Title string is written here