DESIGN (xvwidgets) library
LIBRARY NAME
xvwidgets - (no short description specified)
DESCRIPTION
The xvwidgets library (libxvw.a) is the lowest level library of GUI and
Visualization services; the other five libraries all depend on routines
available in xvwidgets. This library supports the use of alternate
widget sets by providing an application programming interface that forms an
abstraction from the particular widget
set used. It also contains a number of routines that are front ends to the
X Toolkit, which should be called by the application instead of the X Toolkit
calls, in order to ensure that an application will support all three widget
sets. Consistent use of the xvwidgets library ensures that X
Windows-based Khoros applications will have a standard of functionality and
a familiar method of operation regardless of the widget set being used, and
regardless of whether a particular object is instantiated as a widget or a
gadget.
LIST OF LIBRARY FUNCTIONS
- xvw_add_action
- add an action handler to an object
- xvw_remove_action
- remove an action handler from an object
- xvw_destroy_actions
- destroy all action handlers currently installed on an object
- xvw_vset_attributes
- set attributes on an object (variable argument list)
- xvw_vget_attributes
- get attributes from an object (variable argument list)
- xvw_set_attributes
- set attributes on an object (variable argument list)
- xvw_get_attributes
- get attributes from an object (variable argument list)
- xvw_format_attribute
- formatted set attribute (variable argument list)
- xvw_init_attributes
- initialize the attributes to be associated with a object class
- xvw_define_attributes
- add user defined attributes
- xvw_define_constraints
- add user defined constraint attributes
- xvw_busy
- set an object to be busy or not busy
- xvw_insert_callback
- insert a callback to a GUI object
- xvw_add_callback
- add a callback to a GUI object
- xvw_remove_callback
- remove a callback from a GUI object
- xvw_call_callback
- call a callback for a GUI object
- xvw_destroy_callbacks
- destroy all callbacks associated with a GUI object
- xvw_insert_event
- insert an event handler for an object
- xvw_add_event
- add an event handler to an object
- xvw_remove_event
- remove an event handler from an object
- xvw_destroy_events
- destroy all event handlers currently installed on an object
- xvw_getextent_rectangle
- returns the rectangular extent of an object
- xvw_getextent_circle
- returns the circular extent of an object
- xvw_getextent_ellipse
- returns the elliptical extent of an object
- xvw_getextent_line
- returns the linear extent of an object
- xvw_getextent_polyline
- returns the polylne extent of an object
- xvw_getextent_freehand
- returns the freehand draw extent of an object
- xvw_add_detectfid
- add (fid) input handler to an object
- xvw_remove_detectfid
- remove (fid) input handler from an object
- xvw_destroy_detectfids
- destroy all (fid) input handlers currently installed on an object
- xvw_add_detectfile
- add a (file) detect handler to an object
- xvw_call_detectfile
- call a (file) detect handler for an object
- xvw_remove_detectfile
- remove a (file) detect handler from an object
- xvw_destroy_detectfiles
- destroy all file detect handlers currently installed on an object
- xvw_widget
- get the widget (or gadget) associated with an object
- xvw_window
- get the window associated with an object
- xvw_rootwindow
- get the root window associated with an object
- xvw_toplevel
- get the toplevel object of an object
- xvw_visual
- get the visual associated with an object
- xvw_colormap
- get the colormap associated with a object
- xvw_name
- get the name of the object
- xvw_class
- get the class of the object
- xvw_object
- get the object associated with a particular widget
- xvw_create
- create a new object
- xvw_recreate
- re-create an object
- xvw_reparent
- re-parent an object
- xvw_duplicate
- duplicate an object
- xvw_parent
- get the parent of an object
- xvw_destroy
- destroy an object
- xvw_place
- place an object on the screen
- xvw_unmap
- unmap an object
- xvw_map
- map an object
- xvw_unmanage
- unmanage an object
- xvw_manage
- manage an object
- xvw_raise
- raise an object
- xvw_lower
- lower an object
- xvw_realize
- realize an object
- xvw_unrealize
- un-realize an object
- xvw_sensitive
- sensitize or de-sensitize an object
- xvw_refresh
- refreshes an object
- xvw_geometry
- get the geometry of an object
- xvw_children
- get the children of an object
- xvw_numchildren
- get the number of children of an object
- xvw_translate_coords
- translates the coordinates of an object to those of the root window
- xvw_font
- return the font being used by a object
- xvw_fontname
- return the font name being used by an object
- xvw_sort
- sort a list of objects
- xvw_check_realized
- see if an object is realized
- xvw_check_sensitive
- see if an object is sensitive
- xvw_check_mapped
- see if an object is mapped
- xvw_check_visible
- see if an object is visible
- xvw_check_managed
- see if an object is managed
- xvw_check_menuactive
- see if an object's internal menuform is displayed
- xvw_check_menuexist
- check if an object has an internal menuform
- xvw_check_toplevel
- see if object specified is a toplevel, or see if a toplevel exists
- xvw_check_localhost
- see if the object is on the local display
- xvw_check_subclass
- check the subclass of an object
- xvw_initialize
- initialize the xvwidgets library
- xvw_display
- returns the display associated with a object
- xvw_appcontext
- return the application context associated with a object
- xvw_screen
- return the screen associated with a object
- xvw_screennum
- return the screen number associated with an object
- xvw_activate_menu
- pop up the internal menuform for an object.
- xvw_inactivate_menu
- pop down the internal menuform for an object.
- xvw_activated_menu
- see if the internal menuform for an object is currently mapped
- xvw_create_application_shell
- create an application shell object
- xvw_create_transient_shell
- create a transient shell object
- xvw_create_popup_shell
- create a popup shell object
- xvw_add_timeout
- add a timeout to an object
- xvw_remove_timeout
- removes a timeout from an object
- xvw_destroy_timeouts
- destroy all timeouts currently installed on an object
- xvw_allocate_color
- returns the pixel given the color name
- xvw_copy_colormap
- copies existing colormap into a new one
- xvw_cache_pixmap
- caches a pixmap for a library
- xvw_locate_pixmap
- locates a cached pixmap definition for a library
- xvw_set_attribute
- set a single attribute on an object
- xvw_get_attribute
- get a single attribute of an object
- xvw_define_attribute
- define a single attribute for a widget class
- xvw_define_constraint
- define a single constraint attribute for a widget class
- xvw_getextent
- get a rectangular extent
ADDITIONAL INFORMATION
LOCATION OF SOURCE FILES
$DESIGN/objects/library/xvwidgets/src
LOCATION OF PUBLIC INCLUDE FILE
$DESIGN/include/xvwidgets/xvwidgets.h
YOU MUST INCLUDE
#include <design.h>
SEE ALSO
See also the documentation on the xvobjects and xvisual libraries.
SEE MANUAL
The xvwidgets library is documented in Chapter 2, "The xvwidgets Library"
of Programming Services Manual, Volume III.
COPYRIGHT
Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.