|
|
|
ApplicationShell(3) -- The ApplicationShell widget class
|
|
ApplicationShell is used as the main top-level window for an application. An application should have more than one ApplicationShell only if it implements multiple logical applications. |
|
atexit(3) -- register a function to be called at program termination
|
|
atexit() registers the function func to be called, without arguments, at normal program termination. Functions registered by atexit() are called in reverse order of registration. An atexit() call during exit processing is always unsuccessful. The number of registered functions should not exceed ATEXIT_MAX as specified in . When necessary, crt0() or dld.sl() (see crt0(3) and dld.sl(5)) re... |
|
|
audit_intro(3) -- Introduction to the DCE Audit API runtime.
|
|
This introduction gives general information about the DCE Audit Application Programming Interface (API) and an overview of the following parts of the DCE Audit API runtime: + Runtime services + Environment variables + Data types and structures + Permissions required |
|
close_secdef(3) -- security defaults configuration file routines
|
|
open_secdef opens the security configuration file /etc/default/security. This function must be called prior to calling get_secdef_str or get_secdef_int. close_secdef closes the security configuration file. get_secdef_str and get_secdef_int return the value of the specified parameter defined in the security configuration file. See the security(4) manpage. Programs using these routines must be compi... |
|
Composite(3) -- The Composite widget class
|
|
Composite widgets are intended to be containers for other widgets and can have an arbitrary number of children. Their responsibilities (implemented either directly by the widget class or indirectly by Intrinsics functions) include: + Overall management of children from creation to destruction. + Destruction of descendants when the composite widget is destroyed. + Physical arrangement (geometry man... |
|
Constraint(3) -- The Constraint widget class
|
|
Constraint widgets maintain additional state data for each child. For example, client-defined constraints on the child's geometry may be specified. When a constrained composite widget defines constraint resources, all of that widget's children inherit all of those resources as their own. These constraint resources are set and read just the same as any other resources defined for the child. This ... |
|
copydvagent(3) -- manipulate device assignment database entry for a trusted system
|
|
getdvagent, getdvagnam, and copydvagent each return a pointer to an object with the following structure containing the broken-out fields of an entry in the Device Assignment database. Each database entry is returned as a dev_asg structure, declared in the header file: struct dev_field { char *fd_name; /* external name */ char **fd_devs; /* device list */ mask_t fd_type[1]; /* tape, printe... |
|
Core(3) -- The Core widget class
|
|
Core is the Xt Intrinsic base class for windowed widgets. The Object and RectObj classes provide support for windowless widgets. |
|
crt0(3) -- execution startup routines
|
|
The C, aC++, and FORTRAN compilers link in the object file crt0.o for statically-bound programs to provide startup capabilities and environments for program execution. It contains startup code that must be linked using ld to every statically-bound program. In a dynamically linked program (the default method), the crt0.o object file is not used, and all actions normally associated with it are inste... |
|
crt0.o(3) -- execution startup routines
|
|
The C, aC++, and FORTRAN compilers link in the object file crt0.o for statically-bound programs to provide startup capabilities and environments for program execution. It contains startup code that must be linked using ld to every statically-bound program. In a dynamically linked program (the default method), the crt0.o object file is not used, and all actions normally associated with it are inste... |
|
crt0.o_ia(3) -- execution startup routines
|
|
The C, aC++, and FORTRAN compilers link in the object file crt0.o for statically-bound programs to provide startup capabilities and environments for program execution. It contains startup code that must be linked using ld to every statically-bound program. In a dynamically linked program (the default method), the crt0.o object file is not used, and all actions normally associated with it are inste... |
|
crt0.o_pa(3) -- 64-bit ELF uses crt0.o only
|
|
PA-RISC 32-bit SOM The C, Pascal, and FORTRAN compilers link in the object files crt0.o, gcrt0.o, or mcrt0.o to provide startup capabilities and environments for program execution. All are identical except that gcrt0.o and mcrt0.o provide additional functionality for gpro profiling support respectively. The following symbols are defined in these object files: _environ An array of character pointer... |
|
crt0_ia(3) -- execution startup routines
|
|
The C, aC++, and FORTRAN compilers link in the object file crt0.o for statically-bound programs to provide startup capabilities and environments for program execution. It contains startup code that must be linked using ld to every statically-bound program. In a dynamically linked program (the default method), the crt0.o object file is not used, and all actions normally associated with it are inste... |
|
crt0_pa(3) -- execution startup routines; PARISC
|
|
PA-RISC 32-bit SOM The C, Pascal, and FORTRAN compilers link in the object files crt0.o, gcrt0.o, or mcrt0.o to provide startup capabilities and environments for program execution. All are identical except that gcrt0.o and mcrt0.o provide additional functionality for gpro profiling support respectively. The following symbols are defined in these object files: _environ An array of character pointer... |
|
cr_close(3) -- close a crash dump descriptor
|
|
The cr_close() function closes the crash dump descriptor structure pointed to by crash_cb. The crash_cb structure is a crash dump descriptor filled in by a cr_open(3) call. All associated resources (memory and files) are released. |
|
cr_info(3) -- retrieve crash dump information
|
|
The cr_info() function returns a pointer to a cr_info_t structure with information about an open crash dump. cr_info_t The cr_info_t structure contains the following fields. Note that there is no necessary correlation between the placement in this list and the order in the structure, and the structure may contain other, reserved fields. In the future, this structure may change in size and should n... |
|
cr_isaddr(3) -- validate whether physical page number was dumped
|
|
The cr_isaddr() checks to see if the specified page number, pagenum, is present in the open crash dump represented by crash_cb. It sets the Boolean to which avail points to indicate the presence (1) or absence (0) of the page. |
|
cr_open(3) -- open crash dump for reading
|
|
The cr_open() library call opens a crash dump and passes back a crash dump descriptor. The path argument points to a path name naming a crash dump directory or file, and must not exceed PATH_MAX bytes in length. The CRASH * to which crash_cb points is set to a crash dump descriptor, which can then be passed to the other cr_*() functions to access the crash dump. flags is a bitmask of zero or more ... |
|
cr_perror(3) -- print a libcrash error or warning message
|
|
cr_perror() prints to standard error an error or warning message corresponding to error, which should be the return value from an immediately previous call to one of the libcrash calls. The message describes the problem that occurred, explains its implications when appropriate, and gives corrective action where appropriate. If called with a zero error value, indicating success, cr_perror() prints ... |
|
cr_read(3) -- read from crash dump
|
|
The cr_read() function attempts to read the memory area defined by mem_page and num_pages into the buffer pointed to by buf from the crash dump opened using crash_cb. The cr_read() starts at the position in the crash dump associated with the physical memory offset given by mem_page. If the physical memory page mem_page does not exist in the crash dump, cr_read() sets *num_pages to 0 and returns 0.... |
|
cr_set_node(3) -- set node number
|
|
The cr_set_node() function expects the physical node number passed in node_num. The node number will be used by cr_read() and cr_isaddr() to access the node private memory contained on a particular node. This function is only valid for ccnumadir (version 4) dumps. If the old_node_num argument is non-NULL, the address referenced by old_node_num will be set to the previous node number. If old_node_n... |
|
cr_uncompress(3) -- uncompress a file in a crash dump
|
|
The cr_uncompress() ensures that a file, part of a crash dump described by crash_cb, is uncompressed and matches its expected size and checksum (as computed by cksum(1)). This call is most often used to ensure the integrity of module files that are a part of the crash dump; see cr_info(3). pathname is the name of the file to uncompress. Supported compression methods include gzip(1), which appends ... |
|
cr_verify(3) -- verify integrity of crash dump
|
|
cr_verify() uncompresses and verifies the sizes and checksums of every file in the crash dump identified by crash_cb. flags is a bitmask of zero or more of the following flag values: CR_NOCHECKSUM cr_verify() will not attempt to verify checksums of files in the crash dump if this flag is set. Only sizes will be verified. CR_DELAYMSGS cr_verify() will write messages to stderr during time-consuming ... |
|
csa_add_calendar(3) -- add a calendar to the calendar service
|
|
The csa_add_calendar function creates a calendar on the calendar service. If the user does not have sufficient authority to add a calendar to the service, the error CSA_E_NO_AUTHORITY is returned. If the calendar already exists the error CSA_E_CALENDAR_EXISTS is returned. |
|
csa_add_entry(3) -- add an entry to the specified calendar
|
|
The csa_add_entry function adds a new entry to a calendar. The handle for the new entry is returned. Only the owner of the calendar, users with CSA_OWNER_RIGHTS, users with CSA_INSERT_PUBLIC_ENTRIES, user with CSA_INSERT_CONFIDENTIAL_ENTRIES, or users with CSA_INSERT_PRIVATE_ENTRIES access rights can add entries to the calendar. |
|
csa_call_callbacks(3) -- force the invocation of the callback functions associated with the specified callback list(s)
|
|
The csa_call_callbacks function causes the service to call the registered callback functions associationed with the specified callback list(s). The service will process each specified callback list and call the registered callback functions if there have been changes that would trigger the callbacks of that type. The order in which callbacks are invoked is implementation specific. |
|
csa_delete_calendar(3) -- delete a calendar from the calendar service
|
|
The csa_delete_calendar function deletes a calendar on the calendar service. Only the owner of the calendar, or a user with the owner authority, can remove the calendar from the calendar service. |
|
csa_delete_entry(3) -- delete an entry from a calendar
|
|
The csa_delete_entry function will delete an entry in a calendar. The delete_scope indicates the scope of the deletion if the entry has any associated recurring entries. All of the recurring entries can be deleted, only the specified entry can be deleted, or only the recurring entries that follow the specified entry can be deleted. Only the calendar owner, users with CSA_OWNER_RIGHTS, users with C... |
|
csa_free(3) -- free memory allocated by the calendaring service
|
|
The csa_free function frees memory allocated by the calendaring service. After the call, the pointer memory will be invalid and should not be referenced again. When any CSA function allocates and returns a buffer to the application, the application will free that memory with this call when it is finished with the memory. When a CSA function returns a base pointer to a complex structure containing ... |
|
csa_free_time_search(3) -- searches one or more calendars for available free time
|
|
The csa_free_time_search function searches for available free time on one or more calendars and returns a list of free time intervals found. Free time is an interval of time that is not currently scheduled on one or more calendars. The free time search is based on a date and time range and the minimum time duration required of the free time interval. Only the owner of the calendar, users with CSA_... |
|
csa_list_calendars(3) -- list the calendars supported by a calendar service
|
|
The csa_list_calendars function lists all the calendars supported by the specified calendar service. The names of the calendars supported are returned in calendar_names, which is an array of CSA_calendar_users structures with number_names elements. It is implementation specific what authority a calendar user needs to invoke this function. |
|
csa_list_calendar_attributes(3) -- list the names of the calendar attributes associated with a calendar
|
|
The csa_list_calendar_attributes function lists the names of the calendar attributes associated with a calendar. Using the returned calendar attribute name(s), the attribute value(s) may be read using the csa_read_calendar_attributes(3) function. Only the owner of the calendar, users with CSA_OWNER_RIGHTS, or users with CSA_VIEW_CALENDAR_ATTRIBUTES access rights can list the calendar attributes. |
|
csa_list_entries(3) -- list the calendar entries that match all the attribute search criteria
|
|
The csa_list_entries function lists the entry handles for the calendar entries that match all the attribute search criteria. Using the returned entry handles, the entries can have their attributes listed and read, or the entries can updated or deleted. Only the calendar owner, users with CSA_OWNER_RIGHTS, users with CSA_VIEW_PUBLIC_ENTRIES, user with CSA_VIEW_CONFIDENTIAL_ENTRIES, or users with CS... |
|
csa_list_entry_attributes(3) -- list the names of the entry attributes associated with the specified entry
|
|
The csa_list_entry_attributes function lists the names of the entry attributes associated with a calendar entry. Using the returned entry attributes name(s), the attributes value(s) may be read using the csa_read_entry_attributes(3) function. |
|
csa_list_entry_sequence(3) -- lists the recurring calendar entries that are associated with a calendar entry
|
|
The csa_list_entry_sequence function returns an array of the entry handles for the recurring entries associated with a specific calendar entry. The entry handles for the recurring calendar entries are returned in entry_list. A NULL is returned if no recurring entries are associated with this calendar entry. |
|
csa_logoff(3) -- terminate a session with a calendar
|
|
The csa_logoff function allows the calling application to terminate a session with a calendar. |
|
csa_logon(3) -- log on to the calendar service and establish a session with a calendar
|
|
The csa_logon function allows the calling application to logon to the calendar service. If the specified calendar does not exist, then the error CSA_E_CALENDAR_NOT_EXIST is returned. The function returns a Session Handle that the application will use in subsequent CSA calls. |
|
csa_look_up(3) -- Looks up calendar information
|
|
The csa_look_up function looks up calendar addressing information in the directory provided by the CSA calendaring service. It primarily is used to resolves a user's friendly name to a calendar address. Multiple addresses may be returned. An array of calendar user descriptors is allocated and returned containing fully resolved information about each entry. |
|
csa_query_configuration(3) -- Determine information about the installed CSA configuration
|
|
The csa_query_configuration function queries the underlying implementation's configuration, and returns the information requested about it, allocating memory when necessary. The underlying configuration file format is implementation dependent. |
|
csa_read_calendar_attributes(3) -- read and return the calendar attributes values for a calendar
|
|
The csa_read_calendar_attributes function returns an array of attributes structures containing the values of the calendar attributes of the specified calendar. The function will return all of the attributes if number_names argument is zero and attribute_names argument is NULL. Only the owner of the calendar, users with CSA_OWNER_RIGHTS, or users with CSA_VIEW_CALENDAR_ATTRIBUTES access rights can ... |
|
csa_read_entry_attributes(3) -- read and return the calendar entry attribute values for a specified calendar entry
|
|
The csa_read_entry_attributes function returns an array of attribute structures containing the values of the attributes of the specified calendar entry. The function will return all of the attributes if number_names argument is zero and attribute_names argument is NULL. |
|
csa_read_next_reminder(3) -- reads the next reminder of the given type in the specified calendar relative to a given time
|
|
The csa_read_next_reminder function reads the next reminder of the specified type in the specified calendar relative to a given time. More than one type of reminder may be specified. For each reminder type specified, the next reminder of that type after the given time will be returned. The owner of the calendar or users with CSA_OWNER_RIGHTS access right can read the next reminder for a calendar. |
|
csa_register_callback(3) -- register the callback functions to be invoked when the specified type of update occurs in the calendar
|
|
The csa_register_callback function adds the callback procedure to the specified callback list for the session. The service maintains a set of callback lists, logically one list per callback activity type per session. The service reports changes to the state of the service or its calendars by invoking the appropriate callbacks in sequence when the client calls the csa_call_callbacks function or whe... |
|
csa_restore(3) -- restores calendar entries from an archive file
|
|
This optional function is not implemented in the CDE 1.0 Sample Implementation. - 1 - Formatted: January 24, 2005 |
|
csa_save(3) -- saves calendar entries into an archive file
|
|
This optional function is not implemented in the CDE 1.0 Sample Implementation. - 1 - Formatted: January 24, 2005 |
|
csa_unregister_callback(3) -- unregister the specified callback functions
|
|
The csa_unregister_callback function removes the specified callback procedure to the specified callback list. Both the procedure and the client data must match for this function to remove the procedure. Specifying a value of NULL for both callback and client data will cause all callbacks on the specified callback list(s) to be removed. |
|
csa_update_calendar_attributes(3) -- update the calendar attributes values for a calendar
|
|
The csa_update_calendar_attributes function update the values of the calendar attributes of the specified calendar. The existing value of each specified attribute will be replaced by the new value specified in calendar_attributes. New attributes can be added using this function and existing attributes can be effectively deleted by setting the value part of the CSA_attributes structure to NULL. If ... |
|
csa_update_entry_attributes(3) -- update the calendar entry attributes
|
|
The csa_update_entry_attributes function updates the values of the entry attributes of the specified calendar entry. The existing value of each specified attribute will be replaced by the new value specified in entry_attributes. New attributes can be added using this function and existing attributes can be effectively deleted by setting the value part of the entry_attributes structure to NULL. If ... |
|
csa_x_process_updates(3) -- invoke a calendar application's calendar event handler
|
|
The csa_x_process_updates function checks to see if there have been calendar updates that are of interest to the client. If there have been one or more calendar updates, and the client previously registered a callback handler using csa_register_callback(3) for updates of this type, the callback function is called by csa_x_process_updates. The cal argument specifies a calendar session handle. The c... |
|
devnm(3) -- map device ID to file path
|
|
Given a device type, a device ID, and a string in which to return the result, devnm() maps the type and ID to a block or character special file (device file) name by searching /dev. It returns in path the full path name of the first special file encountered with a matching device type and ID. It searches /dev and all its subdirectories recursively in unspecified order. The parameters are: devtype ... |
|
DtActionCallbackProc(3) -- notify application that the status of an application has changed
|
|
The Dt/Action.h header defines the DtActionCallbackProc callback prototype as follows: typedef void (*DtActionCallbackProc)(DtActionInvocationID id, XtPointer client_data, DtActionArg *args, int argCount, DtActionStatus status); If registered when invoking an action with DtActionInvoke(3), a DtActionCallbackProc procedure is called whenever an action has a status update, such as action termination... |
|
DtActionDescription(3) -- obtain the descriptive text for a given action
|
|
The DtActionDescription function looks up and returns the descriptive text associated with the actionName action. The actionName argument is the name of the action. If there are multiple actionName actions, the string returned is the description of the most general. The most general action is the one with the lowest precedence, as described in dtactionfile(4) (``Action Selection''). |
|
DtActionExists(3) -- determine if a string corresponds to an action name
|
|
The DtActionExists function checks whether a given name corresponds to an action name. The name argument is the name of the action. |
|
DtActionIcon(3) -- get the icon information for an action
|
|
The DtActionIcon function gets the icon information for an action. The actionName argument is the name of the action. DtActionIcon returns the name of the icon associated with an actionName action. If the action definition does not explicitly identify an icon name, this function returns the default action icon name, as described in dtactionfile(4) (``Action Selection''). The default action icon ... |
|
DtActionInvoke(3) -- invoke a CDE action
|
|
The DtActionInvoke function provides a way for applications to invoke desktop actions on file or buffer arguments. Applications can register a callback for receiving action-done status and return arguments. The actions and data types databases must be initialized and loaded (using DtInitialize(3) and DtDbLoad(3)) before DtActionInvoke can run successfully. The w argument is a widget that becomes t... |
|
DtActionLabel(3) -- get the localizable label string for an action
|
|
The DtActionLabel function provides access to the localizable label string associated with an action named actionName. The actionName argument is the name of the action. The localizable label string is the string that all components should display to identify the action. If the action definition does not specify a label string, the action name itself is returned. The label string associated with a... |
|
DtAppInitialize(3) -- initialize the Desktop Services library
|
|
These functions perform the one-time initialization in the Desktop Services library. Applications must call either DtInitialize or DtAppInitialize before calling any other Desktop Services library routines. The difference between these two functions is whether app_context is specified. DtInitialize uses the default Intrinsic XtAppContext. The app_context argument is the application context, displa... |
|
DtComboBox(3) -- the ComboBox widget class
|
|
Note: This function has been superseded by the equivalent Motif function XmComboBox. Please refer to the Motif Programmer's Reference for more information. The DtComboBox widget is a combination of a TextField and a List widget that provides a list of valid choices for the TextField. Selecting an item from this list automatically fills in the TextField with that list item. Widget subclassing is n... |
|
DtComboBoxAddItem(3) -- add an item to the ComboBox widget
|
|
Note: This function has been superseded by the equivalent Motif function, XmComboBoxAddItem. Please refer to the Motif Programmer's Reference for more information. The DtComboBoxAddItem function adds the given item to the DtComboBox at the given position. The w argument specifies the DtComboBox widget ID. The item argument specifies the XmString for the new item. The pos argument specifies the po... |
|
DtComboBoxDeletePos(3) -- delete a DtComboBox item
|
|
Note: This function has been superseded by the equivalent Motif function, XmComboBoxDeletePos. Please refer to the Motif Programmer's Reference for more information. The DtComboBoxDeletePos function deletes a specified item from a DtComboBox widget. The w argument specifies the DtComboBox widget ID. The pos argument specifies the position of the item to be deleted. |
|
DtComboBoxSelectItem(3) -- select a DtComboBox item
|
|
Note: This function has been superseded by the equivalent Motif function, XmComboBoxSelectItem. Please refer to the Motif Programmer's Reference for more information. The DtComboBoxSelectItem function selects an item in the XmList of the DtComboBox widget. The w argument specifies the DtComboBox widget ID. The item argument specifies the XmString of the item to be selected. If the item is not fou... |
|
DtComboBoxSetItem(3) -- set an item in the DtComboBox list
|
|
Note: This function has been superseded by the equivalent Motif function, XmComboBoxSetItem. Please refer to the Motif Programmer's Reference for more information. The DtComboBoxSetItem function selects an item in the XmList of the given DtComboBox widget and makes it the first visible item in the list. The w argument specifies the DtComboBox widget ID. The item argument specifies the XmString fo... |
|
DtCreateComboBox(3) -- the ComboBox widget creation function
|
|
Note: This function has been superseded by the equivalent Motif function, XmCreateComboBox. Please refer to the Motif Programmer's Reference for more information. The DtCreateComboBox function creates an instance of a ComboBox widget and returns the associated widget ID. The parent argument specifies the parent widget ID. The name argument specifies the name of the created widget. The arglist arg... |
|
DtCreateEditor(3) -- create a new instance of a DtEditor widget
|
|
The DtEditorCreate function creates an instance of a DtEditor widget and returns the associated widget ID. The parent argument specifies the parent widget ID. The name argument specifies the name of the created widget. The arglist argument specifies the argument list. The argcount argument specifies the number of attribute and value pairs in the argument list ( arglist). For a complete definition ... |
|
DtCreateHelpDialog(3) -- create a general DtHelpDialog widget
|
|
The DtCreateHelpDialog function is a convenience function that creates a DtHelpDialog widget. The parent argument specifies the parent widget ID. The name argument specifies the name of the created widget. The arglist argument specifies the argument list. The argcount argument specifies the number of attribute and value pairs in the argument list (arglist). |
|
DtCreateHelpQuickDialog(3) -- create a DtHelpQuickDialog widget
|
|
The DtCreateHelpQuickDialog function is a convenience function that creates a DtHelpQuickDialog widget. The parent argument specifies the parent widget ID. The name argument specifies the name of the created widget. The arglist argument specifies the argument list. The argcount argument specifies the number of attribute and value pairs in the argument list (arglist). |
|
DtCreateMenuButton(3) -- the MenuButton widget creation function
|
|
The DtCreateMenuButton function creates an instance of a MenuButton widget and returns the associated widget ID. The parent argument specifies the parent widget ID. The name argument specifies the name of the created widget. The arglist argument specifies the argument list. The argcount argument specifies the number of attribute/value pairs in the argument list. |
|
DtCreatePrintSetupBox(3) -- creates an instance of a DtPrintSetupBox widget
|
|
The DtCreatePrintSetupBox function creates an unmanaged instance of a DtPrintSetupBox widget and returns its widget ID. |
|
DtCreatePrintSetupDialog(3) -- creates an instance of a dialog containing a DtPrintSetupBox widget
|
|
DtCreatePrintSetupDialog is a convenience function that creates a DialogShell and an unmanaged DtPrintSetupBox child of the DialogShell. Use XtManageChild to pop up the print set up dialog (passing the DtPrintSetupBox as the widget parameter); use XtUnmanageChild to pop it down. |
|
DtCreateSpinBox(3) -- the SpinBox widget creation function
|
|
Note: This function has been superseded by the equivalent Motif function XmCreateSimpleSpinBox. Please refer to the Motif Programmer's Reference for more information. The DtCreateSpinBox function creates an instance of a SpinBox widget and returns the associated widget ID. The parent argument specifies the parent widget ID. The name argument specifies the name of the created widget. The arglist a... |
|
DtCreateTerm(3) -- create a DtTerm widget
|
|
The DtCreateTerm function creates a terminal emulator widget hierarchy. The parent argument specifies the parent widget ID. The name argument specifies the name of the created widget. The arglist argument specifies the argument list. The argcount argument specifies the number of attribute and value pairs in the argument list (arglist). The DtTerm widget provides the core set of functionality neede... |
|
DtDbLoad(3) -- load actions and data types database
|
|
The DtDbLoad function loads the actions and data types database into the application. When the function returns, the database has been loaded. An environment variable determines the set of directories to be searched. The DtDbLoad function loads all actions and data types defined in files with a .dt suffix located in these directories. The directory search path is based on the value of the DTDATABA... |
|
DtDbReloadNotify(3) -- reload the Dt actions and data typing services database
|
|
The DtDbReloadNotify function registers an application callback function that is called whenever the actions and data types database needs to be reloaded; the conditions that trigger this callback are implementation-dependent. The callback_proc must flush any actions and data type information that the application has cached and then call DtDbLoad(3) to reload the database. The client_data argument... |
|
DtDndCreateSourceIcon(3) -- create a drag source icon
|
|
The DtDndCreateSourceIcon function creates a Motif drag icon, named sourceIcon, based on the characteristics of the pixmap argument. The resulting drag icon is suitable for use with DtDndDragStart(3). The parent argument is the parent of the drag icon. Typically this widget is the drag source. The pixmap argument is the pixmap representation of the data to be dragged. The mask argument is the mask... |
|
DtDndDragStart(3) -- initiate a drag
|
|
The DtDndDragStart and DtDndVaDragStart functions initiate a Motif drag, with drag visuals appropriate to the type of data being dragged, and updates the translation table of the drag context. Either of the functions is called from the application's event handler, which interprets mouse events to determine when a drag should begin. The only difference between DtDndDragStart and DtDndVaDragStart i... |
|
DtDndDropRegister(3) -- specify a drop site
|
|
The DtDndDropRegister and DtDndVaDropRegister functions register a Motif drop site with import targets based on the specified data transfer protocols. DtDndDropRegister may be called to register a widget as a drop site at any time, typically soon after the widget is created. The only difference between DtDndDropRegister and DtDndVaDropRegister is how the argument list is passed. The argument list ... |
|
DtDndDropUnregister(3) -- deactivate a drop site
|
|
The DtDndDropUnregister function removes the widget, dropSite, from the set of drop sites that have been registered with DtDndDropRegister(3) and frees data allocated by a call to DtDndDropRegister(3). The DtDndDropUnregister function is used to unregister a widget when it is no longer a drop site. A widget can be unregistered with DtDndDropUnregister at any time after it has been registered with ... |
|
DtDndVaDragStart(3) -- initiate a drag
|
|
The DtDndDragStart and DtDndVaDragStart functions initiate a Motif drag, with drag visuals appropriate to the type of data being dragged, and updates the translation table of the drag context. Either of the functions is called from the application's event handler, which interprets mouse events to determine when a drag should begin. The only difference between DtDndDragStart and DtDndVaDragStart i... |
|
DtDndVaDropRegister(3) -- specify a drop site
|
|
The DtDndDropRegister and DtDndVaDropRegister functions register a Motif drop site with import targets based on the specified data transfer protocols. DtDndDropRegister may be called to register a widget as a drop site at any time, typically soon after the widget is created. The only difference between DtDndDropRegister and DtDndVaDropRegister is how the argument list is passed. The argument list ... |
|
DtDtsBufferToAttributeList(3) -- get a list of data attributes for a byte stream
|
|
The DtDtsBufferToAttributeList function returns a list of data attributes for a given byte stream. The buffer argument is a pointer to the buffer of the data to be typed. The size argument is the size of the buffer in bytes. The opt_name argument can be used to specify a name to be associated with the buffer. If the opt_name argument is not NULL, it is used as a pseudo file name in typing; otherwi... |
|
DtDtsBufferToAttributeValue(3) -- get a single data attribute value for a byte stream
|
|
The DtDtsBufferToAttributeValue function returns a data attribute value for a given byte stream. The buffer argument is a pointer to the buffer of the data to be typed. The size argument is the size of the buffer in bytes. The attr_name argument is a name of the attribute. The opt_name argument can be used to specify a name to be associated with the buffer. If the opt_name argument is not NULL, it... |
|
DtDtsBufferToDataType(3) -- get the data type for a byte stream
|
|
The DtDtsBufferToDataType function returns the data type name for a given byte stream. The buffer argument is a pointer to the buffer of the data to be typed. The size argument is the size of the buffer in bytes. The opt_name argument can be used to specify a name to be associated with the buffer. If the opt_name argument is not NULL, it is used as a pseudo file name in typing; otherwise, certain ... |
|
DtDtsDataToDataType(3) -- get the data type for a set of data
|
|
The DtDtsDataToDataType function determines the data type of a set of data, based on the information given in the non- NULL pointer arguments to the function. The function gathers any additional information, if it is needed, to compensate for the NULL arguments. For example, if the filepath argument is given, but the stat_buff argument is NULL and a stat_buff value is required to determine the dat... |
|
DtDtsDataTypeIsAction(3) -- determine if the data type is an action
|
|
The DtDtsDataTypeIsAction function determines if the specified data type is an action-a data type that was loaded from the action tables of the actions and data types database. The datatype argument is a pointer to a data type name string. |
|
DtDtsDataTypeNames(3) -- get a list of available data types
|
|
The DtDtsDataTypeNames function returns a list of all available data types that are currently loaded into the data types database. |
|
DtDtsDataTypeToAttributeList(3) -- get a list of attributes for a data type
|
|
The DtDtsDataTypeToAttributeList function returns a list of attributes for a data type. The datatype argument is a pointer to a data type name string. The opt_name argument can be used to specify a name to be associated with the data type. If the opt_name argument is not NULL, it is used as a pseudo file name in typing; otherwise, certain attributes may be returned as NULL because the filename com... |
|
DtDtsDataTypeToAttributeValue(3) -- get an attribute value for a specified data type
|
|
The DtDtsDataTypeToAttributeValue returns an attribute value for the specified data type name. The datatype argument is a pointer to a data type name string. The attr_name argument is a name of the attribute. The opt_name argument can be used to specify a name to be associated with the data type. If the opt_name argument is not NULL, it is used as a pseudo file name in typing; otherwise, certain a... |
|
DtDtsFileToAttributeList(3) -- get a list of attributes for a file
|
|
The DtDtsFileToAttributeList function returns a list of attributes for the specified file. The filepath argument is the pathname of the file. |
|
DtDtsFileToAttributeValue(3) -- get a specified attribute value for a file
|
|
The DtDtsFileToAttributeValue function returns a data attribute value for the specified file. The filepath argument is the pathname of the file. The attr_name argument is a pointer to an attribute name string. |
|
DtDtsFileToDataType(3) -- get a data type for a file
|
|
The function DtDtsFileToDataType returns a data type name for the specified file. The filepath argument is the pathname of the file. |
|
DtDtsFindAttribute(3) -- get a specified list of data types
|
|
The DtDtsFindAttribute function returns the list of data types that have an attribute name that equals the specified value. The attr_name argument is the attribute name. The attr_value argument is the value of an attribute to be matched. |
|
DtDtsFreeAttributeList(3) -- free a list of data attributes
|
|
The DtDtsFreeAttributeList function frees the memory used for an attribute list. The attr_list argument is a list of attribute and value pairs defined by the DtDtsAttribute structure. |
|
DtDtsFreeAttributeValue(3) -- free a data attribute value
|
|
The DtDtsFreeAttributeValue function frees the memory used for an attribute value. The attr_value argument is the value of an attribute. |
|
DtDtsFreeDataType(3) -- free data type pointer memory
|
|
The DtDtsFreeDataType function frees the memory used for a data type name. The datatype argument is a pointer to a data type name string. |
|
DtDtsFreeDataTypeNames(3) -- free a list of data type names
|
|
The DtDtsFreeDataTypeNames function frees the memory used for a list of data type names. The namelist argument is a list of data type names. |
|
DtDtsIsTrue(3) -- return a Boolean value associated with a string
|
|
The DtDtsIsTrue function tests a string for a Boolean value. Any of the following string values, without regard to case, causes a return value of True: true yes on 1 |
|
DtDtsLoadDataTypes(3) -- load and initialize the data types database
|
|
The DtDtsLoadDataTypes function initializes and loads the database fields for the data typing functions. |
|
DtDtsRelease(3) -- free memory associated with the data types database
|
|
The DtDtsRelease function releases the data structures and data associated with the data types database, generally in preparation for a reload. |
|
DtDtsSetDataType(3) -- set the data type of a directory
|
|
The DtDtsSetDataType function sets the data type of a directory. This may be accomplished by adding a file named with a leading dot to the directory. The dirpath argument is a pathname of the directory. The datatype argument is a data type. If the value is already set, DtDtsSetDataType does not change the value unless the override argument is set to True. |
|
DtEditor(3) -- the DtEditor widget class
|
|
The DtEditor widget supports creating and editing text files. It gives applications running in the desktop environment a consistent method for editing text data. The widget consists of: + A scrolled edit window for text + Dialogs for finding and changing text + Optional status line + Spell checking option + Formatting options + Convenience functions for programmatically controlling the widget The ... |
|
DtEditorAppend(3) -- append data to a DtEditor widget
|
|
The DtEditorAppend function appends either a NULL-terminated string, wide character string or sized buffer after the last character in a DtEditor widget. The data is transferred to the DtEditor widget using a DtEditorContentRec, which indicates the type of data being transferred along with the actual data. After the data is appended, the insertion cursor is positioned at the new last character. Th... |
|
DtEditorAppendFromFile(3) -- append data from a file into a DtEditor widget
|
|
DtEditorAppendFromFile function appends data from a file to after the last character in a DtEditor widget. After the data is appended, the insertion cursor is positioned at the new last character. The widget argument specifies the DtEditor widget ID. The fileName argument is the pathname of the file relative to the local system. For a complete definition of the DtEditor widget and its associated r... |
|
DtEditorChange(3) -- change one or all occurrences of a string in a DtEditor widget
|
|
The DtEditorChange function replaces the next occurrence of a string, all occurrences of the string, or the currently selected text in a DtEditor widget with a replacement string. The string to search for and the value to change it to can be the last values entered in the Find/Change dialog (see DtEditorInvokeFindChangeDialog(3)) or passed as arguments to DtEditorChange. The search begins at the i... |
|
DtEditorCheckForUnsavedChanges(3) -- report whether text has been edited
|
|
The DtEditorCheckForUnsavedChanges function reports whether the text contained in the edit window of a DtEditor widget has been modified since the last call to DtEditorGetContents(3) or DtEditorSaveContentsToFile(3), including inserting, deleting or moving text with the keyboard or mouse. For information about retrieving the text without affecting whether DtEditorCheckForUnsavedChanges reports tha... |
|
DtEditorClearSelection(3) -- clear the primary selection in a DtEditor widget
|
|
The DtEditorClearSelection function replaces the primary selection in a DtEditor widget, specified by widget, with blanks (ASCII character 0x20) and newlines. Text can be selected and deselected programmatically with DtEditorSelectAll(3) and DtEditorDeselect(3). The widget argument specifies the DtEditor widget ID. For a complete definition of the DtEditor widget and its associated resources, see ... |
|
DtEditorCopyToClipboard(3) -- copy the primary selection in a DtEditor widget to the clipboard
|
|
The DtEditorCopyToClipboard function copies to the clipboard the currently selected text in the DtEditor widget specified by the widget argument. Text can be selected and deselect programmatically with DtEditorSelectAll(3) and DtEditorDeselect(3). The widget argument specifies the DtEditor widget ID. For a complete definition of the DtEditor widget and its associated resources, see DtEditor(3). |
|
DtEditorCutToClipboard(3) -- copy the primary selection in a DtEditor widget to the clipboard and delete the selected text
|
|
The DtEditorCutToClipboard function copies the primary selected text in the DtEditor widget, specified by the widget, argument to the clipboard and then deletes the primary selected text. Text can be selected and deselected programmatically with DtEditorSelectAll(3) and DtEditorDeselect(3). The widget argument specifies the DtEditor widget ID. For a complete definition of the DtEditor widget and i... |
|
DtEditorDeleteSelection(3) -- delete the primary selection in the DtEditor widget
|
|
The DtEditorDeleteSelection function removes the currently highlighted data in a DtEditor widget. Any data following the deleted data is moved up. Text can be selected and deselect programmatically with DtEditorSelectAll(3) and DtEditorDeselect(3). The widget argument Specifies the DtEditor widget ID. For a complete definition of the DtEditor widget and its associated resources, see DtEditor(3). |
|
DtEditorDeselect(3) -- deselect the current selection in a DtEditor widget
|
|
The DtEditorDeselect function deselects any currently selected text in a DtEditor widget. The entire contents of a DtEditor widget may be selected with DtEditorSelectAll(3). The widget argument specifies the DtEditor widget ID. For a complete definition of the DtEditor widget and its associated resources, see DtEditor(3). |
|
DtEditorDisableRedisplay(3) -- temporarily prevent visual update of a DtEditor widget
|
|
The DtEditorDisableRedisplay function prevents redisplay of a DtEditor widget even though its visual attributes have been modified. The visual appearance of the widget remains unchanged until DtEditorEnableRedisplay(3) is called. This allows an application to make multiple changes to an editor widget without causing intermediate visual updates. The widget argument specifies the DtEditor widget ID.... |
|
DtEditorEnableRedisplay(3) -- force the visual update of a DtEditor widget
|
|
The DtEditorEnableRedisplay function forces a DtEditor widget to update its visual display if any visual attributes have been set or modified since the DtEditorDisableRedisplay(3) function was called for the specified widget. Any subsequent changes that affect the widget's visual appearance will cause the widget to update its display. These functions allow an application to make multiple changes ... |
|
DtEditorFind(3) -- search for the next occurrence of a string in a DtEditor widget
|
|
The DtEditorFind function searches for the next occurrence (relative to the insertion cursor) of a string. The string is either the last find string value specified in the Find/Change dialog (see DtEditorInvokeFindChangeDialog(3)) or is passed in as an argument. The widget argument specifies the DtEditor widget ID. The find argument specifies the string to search for. If find is NULL, DtEditorFind... |
|
DtEditorFormat(3) -- format all or part of the contents of a DtEditor widget
|
|
The DtEditorFormat function formats all or part of the contents of the DtEditor widget according to the current text format settings in the Format Settings dialog. These options specify which margins and alignments (left aligned, right aligned, justified or centered) are used. Optionally, alternative settings can be passed as an argument to DtEditorFormat in a data structure. This function formats... |
|
DtEditorGetContents(3) -- retrieve the contents of a DtEditor widget
|
|
The DtEditorGetContents function retrieves the entire contents of a DtEditor widget as a string, wide character string or sized buffer of data. The data is transferred from the DtEditor widget using a DtEditorContentRec, which indicates the type of data being transferred along with the actual data. If desired, any soft line feeds (word wraps) can be replaced with s. The DtEditor widget tr... |
|
DtEditorGetInsertionPosition(3) -- retrieve the position of the insert cursor in a DtEditor widget
|
|
The DtEditorGetInsertionPosition function accesses the current position of the insertion cursor in the DtEditor widget. The position is an integer number of characters from the beginning of the widget's text buffer. The first character position is zero. The position of the insertion cursor can be set with DtEditorSetInsertionPosition(3). The widget argument specifies the DtEditor widget ID. For a... |
|
DtEditorGetLastPosition(3) -- retrieve the position of the last character in a DtEditor widget
|
|
The DtEditorGetLastPosition function accesses the last text position in the DtEditor widget. The position is an integer number of characters from the beginning of the widget's buffer. Any text added to the end of the buffer is added after this position. The first character position is zero. The last character position is equal to the number of characters contained in the widget. The widget argume... |
|
DtEditorGetMessageTextFieldID(3) -- retrieve the widget ID of the message text field in the DtEditor status line
|
|
The DtEditorGetMessageTextFieldID function returns the widget ID of the Motif Text Field located in the status area of a DtEditor widget. By setting the XmNvalue or XmNvalueWcs resource of this widget, an application can display feedback messages for the user. If the application does not use the message field, the message field can be unmanaged by calling XtUnmanageWidget(3) with this widget ID. T... |
|
DtEditorGetSizeHints(3) -- retrieve sizing information from a DtEditor widget
|
|
The DtEditorGetSizeHints function retrieves the current sizing information from a DtEditor widget, allowing the application to compute appropriate size hints for the window manager. The widget argument specifies the DtEditor widget ID. The pHints argument is a pointer to an XSizeHints structure into which the current sizing information is placed. The fields in this structure do not have to contain... |
|
DtEditorGoToLine(3) -- move the insert cursor for a DtEditor widget to a specified line
|
|
The DtEditorGoToLine function moves the insert cursor for the DtEditor widget to the beginning of the line specified by the lineNumber argument. The cursor can be moved to the last line by specifying DtEDITOR_LAST_LINE as the line number. If the line is not currently on-screen, the contents for the DtEditor widget are scrolled to display the new insertion position. The lineNumber argument is the n... |
|
DtEditorInsert(3) -- insert data into a DtEditor widget
|
|
The DtEditorInsert function inserts either a string, wide character string or sized buffer at the insertion cursor position in a DtEditor widget. The data is transferred to the DtEditor widget using a DtEditorContentRec, which indicates the type of data being transferred along with the actual data. After the data is appended, the insertion cursor is positioned after the last character inserted. Th... |
|
DtEditorInsertFromFile(3) -- insert data from a file into a DtEditor widget
|
|
The DtEditorInsertFromFile function inserts data from a file to the insertion cursor position in a DtEditor widget. After the data is inserted, the insertion cursor is positioned after the last character inserted. The widget argument specifies the DtEditor widget ID. The fileName argument is the pathname of the file relative to the local system. For a complete definition of the DtEditor widget and... |
|
DtEditorInvokeFindChangeDialog(3) -- display the DtEditor widget dialog for searching and replacing text
|
|
The DtEditorInvokeFindChangeDialog function displays the Find/Change dialog for the DtEditor widget. This dialog enables a user to search for, and optionally replace, a string in the text for the DtEditor widget. It also allows the user to specify a replacement string, which can be substituted for either the next occurrence of the search string or all occurrences. The Find/Change dialog remains di... |
|
DtEditorInvokeFormatDialog(3) -- display the DtEditor widget dialog for choosing formatting options
|
|
The DtEditorInvokeFormatDialog function displays the Format Settings dialog of the DtEditor widget. This dialog enables a user to set the text formatting options: margins and text alignments (left aligned, right aligned, justified or centered). The dialog also provides the capability to format either the paragraph containing the insertion cursor or the entire contents of the DtEditor widget. The F... |
|
DtEditorInvokeSpellDialog(3) -- display the DtEditor widget dialog for checking text for spelling errors
|
|
The DtEditorInvokeSpellDialog function displays the Spell dialog for the DtEditor widget. This dialog displays the list of unrecognized or misspelled words from the widget's text. Users can search for and replace misspelled words with the Spell dialog. The list of misspelled words is automatically generated by filtering the text for the DtEditor widget through the filter specified by the DtNspell... |
|
DtEditorPasteFromClipboard(3) -- insert the clipboard selection into a DtEditor widget
|
|
The DtEditorPasteFromClipboard function inserts the clipboard selection before the insertion cursor of the DtEditor widget. If the insertion cursor is inside the current selection, the clipboard selection replaces the selected text. Text can be cut or copied to the clipboard with DtEditorCutToClipboard(3) and DtEditorCopyToClipboard(3). Text can be selected and deselected programmatically with DtE... |
|
DtEditorReplace(3) -- replace a portion of the contents of a DtEditor widget
|
|
The DtEditorReplace function replaces part of the contents of a DtEditor widget with a string, a wide character string or sized buffer. The data is transferred to the DtEditor widget using a DtEditorContentRec, which indicates the type of data being transferred along with the actual data. All data following the start position and up to, but not including, the end position is replaced. If the start... |
|
DtEditorReplaceFromFile(3) -- replace a portion of the contents of a DtEditor widget with the contents of a file
|
|
The DtEditorReplaceFromFile function replaces part of the contents of a DtEditor widget with the contents of a file. All data following the start position and up to, but not including, the end position is replaced. If the start position and the end position are equal, the data is inserted after the end position. The character positions begin at zero and are numbered sequentially from the beginning... |
|
DtEditorReset(3) -- reset a DtEditor widget to its default state
|
|
The DtEditorReset function deletes the contents of a DtEditor widget, resets the undo edit function, clears the last string searched for plus the last replacement string. The widget argument specifies the DtEditor widget ID. For a complete definition of the DtEditor widget and its associated resources, see DtEditor(3). |
|
DtEditorSaveContentsToFile(3) -- save the contents of a DtEditor widget to a file
|
|
The DtEditorSaveContentsToFile function saves the entire contents of the DtEditor widget to a file, optionally replacing soft line feeds (word wraps) with s. If the file does not exist and the directory has the correct write permissions, the file is created. If the file exists and the overwriteIfExists argument is set to True, the contents of the file are overwritten. If the file or its d... |
|
DtEditorSelectAll(3) -- select all text in a DtEditor widget
|
|
The DtEditorSelectAll function selects all text in a DtEditor widget. Any current selection can be programmatically deselected with DtEditorDeselect(3). The widget argument specifies the DtEditor widget ID. For a complete definition of the DtEditor widget and its associated resources, see DtEditor(3). |
|
DtEditorSetContents(3) -- place data into a DtEditor widget
|
|
The DtEditorSetContents function places a NULL-terminated string, wide character string or sized buffer into a DtEditor widget. Any data currently in the DtEditor widget is lost. The data is transferred to the DtEditor widget using a DtEditorContentRec, which indicates the type of data being transferred along with the actual data. After the data is placed into the DtEditor widget, the insertion cu... |
|
DtEditorSetContentsFromFile(3) -- load data from a file into a DtEditor widget
|
|
The DtEditorSetContentsFromFile function loads the contents of a file into a DtEditor widget. Any data currently in the DtEditor widget is lost. After the data is loaded, the insertion cursor is positioned at the first character. The widget argument specifies the DtEditor widget ID. The fileName argument is the pathname of the file relative to the local system. For a complete definition of the DtE... |
|
DtEditorSetInsertionPosition(3) -- set the position of the insert cursor in a DtEditor widget
|
|
The DtEditorSetInsertionPosition function sets the insertion cursor position of the DtEditor widget. The current position of the insertion cursor can be retrieved with DtEditorGetInsertionPosition(3). The last text position of the DtEditor widget can be retrieved with DtEditorGetLastPosition(3). The widget argument specifies the DtEditor widget ID. The position argument specifies the position of t... |
|
DtEditorTraverseToEditor(3) -- set keyboard traversal to the edit window of a DtEditor widget
|
|
The DtEditorTraverseToEditor function causes the Motif keyboard traversal to be set to the edit window of a DtEditor widget. The widget argument specifies the DtEditor widget ID. For a complete definition of the DtEditor widget and its associated resources, see DtEditor(3). |
|
DtEditorUndoEdit(3) -- undo the last edit made to the text in a DtEditor widget
|
|
The DtEditorUndoEdit function undoes the last change (deletion or insertion) made to the text in a DtEditor widget. A change consists of either a set of consecutive insertions, or a set of consecutive deletions followed by up to one set of consecutive insertions. An insertion is consecutive if there have been no intervening deletions, and it is continuing forward from the same point. A deletion is... |
|
DtHelpDialog(3) -- DtHelpDialog widget class
|
|
The DtHelpDialog widget provides users with functionality for viewing and navigating structured online information (CDE help volumes). This functionality includes text and graphics rendering, embedded hypertext links and various navigation methods to move through online help information. The widget supports rendering of CDE help volumes, system manual pages, text files and character string values.... |
|
DtHelpQuickDialog(3) -- DtHelpQuickDialog widget class
|
|
The DtHelpQuickDialog widget provides users with a constrained set of functionality for viewing and and navigating structured online information (CDE help volumes). This functionality includes text and graphics rendering, embedded hypertext links and limited navigation methods to move through online help information. The widget supports rendering of CDE help volume, system manual pages, text files... |
|
DtHelpQuickDialogGetChild(3) -- get child of DtHelpQuickDialog widget
|
|
The DtHelpQuickDialogGetChild function accesses a component within a DtHelpQuickDialog widget. The widget argument specifies the DtHelpQuickDialog widget instance. The child argument specifies which DtHelpQuickDialog widget child the widget ID is for. The following are valid values for the child argument: |
|
DtHelpReturnSelectedWidgetId(3) -- select a widget or gadget
|
|
The DtHelpReturnSelectedWidgetId function provides an interface for users to select a component within an application. This function grabs the pointer and returns the widget within which a button press occurs. Pressing the escape key (ESC) aborts this function. The parent argument specifies the widget ID to use as the basis of the interaction, usually a top level shell. The cursor argument specifi... |
|
DtHelpSetCatalogName(3) -- assign the name of the message catalog to use for help services
|
|
The DtHelpSetCatalogName function provides an interface for applications to set the name of the message catalog file that the help services library uses at runtime. This message catalog contains all strings, messages and button labels used in the help widgets that can be localized. The catFile argument specifies the name of the message catalog file that the help services library accesses at runtim... |
|
DtInfoShowTopic(3) -- provide the user access to a local information corpus at a specific location
|
|
By invoking DtInfoShowTopic, a client application requests that dtinfo display a particular section of data, or topic. DtInfoShowTopic sends a ToolTalk message to any active dtinfo process that can access the requested information in the current locale. The browser is started if it is not already running. This corresponds to invoking the dtinfo command with the -sect option from the command line. ... |
|
DtInitialize(3) -- initialize the Desktop Services library
|
|
These functions perform the one-time initialization in the Desktop Services library. Applications must call either DtInitialize or DtAppInitialize before calling any other Desktop Services library routines. The difference between these two functions is whether app_context is specified. DtInitialize uses the default Intrinsic XtAppContext. The app_context argument is the application context, displa... |
|
DtMenuButton(3) -- the MenuButton widget class
|
|
The DtMenuButton widget is a command widget that complements the menu cascading functionality of an XmCascadeButton widget. As a complement to the XmCascadeButton widget, DtMenuButton can only be instantiated outside a MenuPane; the application must use XmCascadeButton widget inside a MenuPane. The DtMenuButton widget belongs to a subclass of the XmLabel class. Visually, the DtMenuButton widget co... |
|
DtMmdbBookCaseFreeInfo(3) -- frees space used by bookcase information structure
|
|
The DtMmdbBookCaseFreeInfo function frees the space used by the specified bookcase information structure. |
|
DtMmdbBookCaseGetInfo(3) -- obtains information about a bookcase
|
|
The DtMmdbBookCaseGetInfo function returns a structure containing information about the specified bookcase. |
|
DtMmdbBookGetLicense(3) -- obtains a book's license term
|
|
The DtMmdbBookGetLicense function returns the license term of the specified book object. Do not use the free function on the returned pointer. Table lookup is involved when the identifier is specified by either the primary_oid or sequence_num field. |
|
DtMmdbBookGetLongTitle(3) -- obtains the long title of a book
|
|
The DtMmdbBookGetLongTitle function returns the long title of the specified book object. Do not use the free function on the returned pointer. Table lookup is involved when the identifier is specified by either the primary_oid or sequence_num field. |
|
DtMmdbBookGetSeqNum(3) -- obtains the sequence number of a book
|
|
The DtMmdbBookGetSeqNum function returns the sequence number of the specified book object. Table lookup is involved when the identifier is specified by the primary_oid field. |
|
DtMmdbBookGetShortTitle(3) -- obtains the short title of a book
|
|
The DtMmdbBookGetShortTitle function returns the short title of the specified book object. Do not use the free function on the returned pointer. Table lookup is involved when the identifier is specified by either the primary_oid or sequence_num field. |
|
DtMmdbBookGetTabList(3) -- obtains the list of tab sections in a book
|
|
The DtMmdbBookGetTabList function returns the list of tab sections for the specified book object. It returns the list in a NULL-terminated array. Use the DtMmdbFreeHandleList function to release the memory when the array is no longer needed. Table lookup is involved when the identifier is specified by either the primary_oid or sequence_num field. |
|
DtMmdbBookGetTocObjectId(3) -- obtains the locator of a book's TOC section
|
|
The DtMmdbBookGetTocObjectId function returns the object identifier of the specified book's TOC section. Use the DtMmdbFreeHandleList function to release the memory when the object identifier is no longer needed. Table lookup is involved when the identifier is specified by either the primary_oid or sequence_num field. |
|
DtMmdbCloseInfoLib(3) -- closes an infolib
|
|
The DtMmdbCloseInfoLib function desclares that the specified infolib is no longer needed by the application. |
|
DtMmdbDlpGetNextSectionId(3) -- obtains the object identifier of the next section
|
|
The DtMmdbDlpGetNextSectionId function returns the object identifier of the next section. You can use this function to traverse the TOC hierarchy in a depth-first fashion. Use the DtMmdbFreeHandleList function to release the memory when the object identifier is no longer needed. Table lookup is involved. |
|
DtMmdbDlpGetPrevSectionId(3) -- obtains the object identifier of the previous section
|
|
The DtMmdbDlpGetPrevSectionId function returns the object identifier of the previous section. You can use this function to traverse the TOC hierarchy in a depth-first fashion. Use the DtMmdbFreeHandleList function to release the memory when the object identifier is no longer needed. Table lookup is involved. |
|
DtMmdbFreeGraphicInfo(3) -- frees memory used by a graphics info structure
|
|
The DtMmdbFreeGraphicInfo function frees all memory used by a DtMmdbGraphicInfo structure. |
|
DtMmdbFreeHandle(3) -- frees memory used by a DtMmdbHandle
|
|
The DtMmdbFreeHandle function frees all memory used by a DtMmdbHandle. |
|
DtMmdbFreeHandleList(3) -- frees memory used by a DtMmdbHandle array
|
|
The DtMmdbFreeHandleList frees all memory used by a DtMmdbHandle array, including all contained DtMmdbHandle structures. |
|
DtMmdbGetBookCaseByIndex(3) -- obtains a descriptor for a bookcase based on an infolib index
|
|
The DtMmdbGetBookCaseByIndex function makes the database engine ready to provide access service for a bookcase. It allows you to access all bookcases in an infolib without knowing their names. |
|
DtMmdbGetBookCaseByLoc(3) -- obtains a descriptor for a bookcase based on a hypertext link target
|
|
The DtMmdbGetBookCaseByLoc function makes the database engine ready to provide access service for a bookcase. It allows you to access a bookcase by using a hypertext link target in the bookcase. |
|
DtMmdbGetBookCaseByLocs(3) -- obtains descriptors for a set of bookcases based on hypertext link targets
|
|
The DtMmdbGetBookCaseByLocs function makes the database engine ready to provide access service for a set of bookcases. It allows you to access multiple bookcases by specifying hypertext link targets that occur within the bookcases. Use the free function to release the array of bookcase descriptors when it is no longer needed. |
|
DtMmdbGetBookCaseByName(3) -- obtains a descriptor for a bookcase based on the bookcase name
|
|
The DtMmdbGetBookCaseByName function makes the database engine ready to provide access service for a bookcase. It allows you to access a bookcase by supplying its name. |
|
DtMmdbGraphicGetData(3) -- obtains the data for a graphic object
|
|
The DtMmdbGraphicGetData function returns the data for a graphic object. Do not use the free function on the returned pointer. Table lookup is involved because the graphic identifier is specified by the locator_ptr field. |
|
DtMmdbGraphicGetInfo(3) -- obtains information about a graphic object
|
|
The DtMmdbGraphicGetInfo function returns a structure containing the information about a graphic object. Use the DtMmdbFreeGraphicInfo function to release the memory when the structure is no longer needed. Table lookup is involved because the graphic identifier is specified by the locator_ptr field. |
|
DtMmdbInfoLibFreeInfo(3) -- frees space occupied by an infolib information structure
|
|
The DtMmdbInfoLibFreeInfo function releases the space used by an infolib information structure. |
|
DtMmdbInfoLibGetInfo(3) -- obtains information about an infolib
|
|
The DtMmdbInfoLibGetInfo function returns a structure containing information about a specified infolib. |
|
DtMmdbInit(3) -- initializes the DtInfo database engine
|
|
The DtMmdbInit function makes the DtInfo database engine ready to provide access service. When the function returns, the database has been initialized. |
|
DtMmdbLocatorGetSectionLoc(3) -- obtains the locator of a section
|
|
The DtMmdbLocatorGetSectionLoc function returns the locator of the section that contains the specified component. Do not use the free function on the returned pointer. Table lookup is involved because the component identifier is specified by the locator_ptr field. |
|
DtMmdbLocatorGetSectionObjectId(3) -- obtains the object identifier of a section
|
|
The DtMmdbLocatorGetSectionObjectId function returns the object identifier of the specified section. Use the DtMmdbFreeHandle function to release the identifier when it is no longer needed. Table lookup is involved because the section identifier is specified by the locator_ptr field. |
|
DtMmdbOpenInfoLib(3) -- opens an infolib for service
|
|
The DtMmdbOpenInfoLib function opens an infolib for user access and returns the descriptor for the infolib. It makes the database engine ready to provide service for an infolib. To obtain information about an infolib, use the DtMmdbInfoLibGetInfo function. |
|
DtMmdbQuit(3) -- shuts down the DtInfo database engine
|
|
The DtMmdbQuit function frees all memory used by the database engine and instructs it to stop service. After the call, the database engine can no longer provide services. |
|
DtMmdbSectionGetBookId(3) -- obtains the object identifier of a book
|
|
The DtMmdbSectionGetBookId function returns the object identifier of the book that contains the specified section. Use the DtMmdbFreeHandle function to release the identifier when it is no longer needed. Table lookup is involved if the section identifier is specified by the locator_ptr field. |
|
DtMmdbSectionGetData(3) -- obtains the data for a section
|
|
The DtMmdbSectionGetData function returns the data for the specified section. Do not use the free function on the returned pointer. Table lookup is involved if the section identifier is specified by the locator_ptr field. |
|
DtMmdbSectionGetDataSize(3) -- obtains the size of a section's data
|
|
The DtMmdbSectionGetDataSize function returns the number of bytes in the specified section's data. Table lookup is involved if the section identifier is specified by the locator_ptr field. |
|
DtMmdbSectionGetLoc(3) -- obtains a section's locator
|
|
The DtMmdbSectionGetLoc function returns the logical identifier for the specified section. Do not use the free function on the returned pointer. No table lookup is involved. The space used by the returned locator pointer is likely to be reused by the database engine when any of the API functions are invoked again. You must make a copy of the content if you want to retain it across multiple API cal... |
|
DtMmdbSectionGetLongTitle(3) -- obtains the long title for a section
|
|
The DtMmdbSectionGetLongTitle function returns the long title for the specified section. Do not use the free function on the returned pointer. Table lookup is involved if the section identifier is specified by the locator_ptr field. |
|
DtMmdbSectionGetShortTitle(3) -- obtains the short title for a section
|
|
The DtMmdbSectionGetShortTitle function returns the short title for the specified section. Do not use the free function on the returned pointer. Table lookup is involved if the section identifier is specified by the locator_ptr field. |
|
DtMmdbSectionGetStyleSheetId(3) -- obtains the object identifier of a section's stylesheet
|
|
The DtMmdbSectionGetStyleSheetId function returns the object identifier for the specified section's stylesheet. Use the DtMmdbFreeHandle function to free the handle when it is no longer needed. Table lookup is involved if the section identifier is specified by the locator_ptr field. |
|
DtMmdbSectionGetTocLoc(3) -- obtains the locator for a book's TOC section
|
|
The DtMmdbSectionGetTocLoc function returns the locator of the TOC section of the book that contains the specified section. Table lookup is involved if the section identifier is specified by the locator_ptr field. |
|
DtMmdbStylesheetGetData(3) -- obtains the data for a stylesheet object
|
|
The DtMmdbStylesheetGetData function returns the data for the stylesheet used by the specified section. Do not use the free function on the returned pointer. Table lookup is involved if the section identifier is specified by the locator_ptr field. |
|
DtMmdbStylesheetGetName(3) -- obtains the name of a stylesheet
|
|
The DtMmdbStylesheetGetName function returns the name of the specified stylesheet object. Do not use the free function on the returned pointer. |
|
DtMmdbTocGetChildIds(3) -- obtains a list of object identifiers for child sections
|
|
The DtMmdbTocGetChildIds function returns an array of the object identifiers for the child sections belonging to the specified section. Use the DtmmdbFreeHandleList to release the array when it is no longer needed. |
|
DtMmdbTocGetNumOfChildren(3) -- obtains the number of child sections
|
|
The DtMmdbTocGetNumOfChildren function returns the number of child sections for the specified section. |
|
DtMmdbTocGetParentId(3) -- obtains the object identifier of the parent section
|
|
The DtMmdbTocGetParentId function returns the object identifier of the section that is parent to the specified section. Use the DtMmdbFreeHandle to release the identifier when it is no longer needed. |
|
DtMrmInitialize(3) -- registers the Dt Widget with the Mrm library and initializes it
|
|
DtMrmInitialize first calls MrmInitialize, and then, using MrmRegisterClass, registers the following Dt widgets: + DtMenuButton + DtTerm + DtHelpDialog, DtHelpQuickDialog + DtEditor + DtPrintSetupBox, DtPrintSetupDialog (Refer to the individual widgets for the exact class pointer names, resources, etc.) DtMrmInitialize is part of the DtMrm run time library. It is necessary to link with libMrm to u... |
|
DtMsgLogMessage(3) -- logs a message
|
|
The DtMsgLogMessage function logs the given arguments in one message. The format of the message is specified by format and thus is controlled by the application. The format of each logged entry is: *** ( ): : PID : *** [ ] The value of depends on the value of msg_type. Its value is: |
|
DtMsgLogOpenFile(3) -- opens a log file
|
|
The DtMsgLogOpenFile function calls fopen to open a log file with type open mode. If fopen opens a log file successfully and returns a nonNULL filename_return, DtMsgLogOpenFile calls malloc to allocate space for filename_return. DtMsgLogOpenFile then copies the log file name to filename_return. The caller must use the free function to release the space allocated for filename_return, if it is not N... |
|
DtMsgLogSetHandler(3) -- installs an alternate message logging handler
|
|
The DtMsgLogSetHandler function installs an alternate message logging handler that will be invoked when DtMsgLogMessage is called. If handler is NULL, the default handler is installed. DtMsgLogSetHandler is optional and should be used only to override the default message logging handler. If the handler function wants to log a message, it must use the format and file specified in DtMsgLogMessage(3)... |
|
DtPrintCopySetupData(3) -- copies one DtPrintSetupData structure to another
|
|
The DtPrintCopySetupData function copies the DtPrintSetupData structure pointed to by source to the DtPrintSetupData structure pointed to by target. Elements in target are updated only if different than the corresponding elements in source. For elements that point to allocated memory, DtPrintCopySetupData allocates new memory for those elements updated in target. Existing elements in target are fr... |
|
DtPrintFillSetupData(3) -- obtains X printer connection information
|
|
The DtPrintFillSetupData function obtains an X printer connection in order to initiate an X printing job in situations other than direct interaction with a DtPrintSetupBox. Examples of such situations include a "quick print" button on a toolbar and "GUI-less" printing. This X printer connection information can be obtained from an existing DtPrintSetupBox widget instance, or if a DtPrintSetupBo... |
|
DtPrintFreeSetupData(3) -- frees the memory pointed to by DtPrintSetupData structure elements
|
|
The DtPrintFreeSetupData function calls XtFree to deallocate memory pointed to by elements of the DtPrintSetupData structure indicated by target. The DtPrintSetupData structure pointed to by target is not altered by this function. For a description of the DtPrintSetupData structure, see DtPrintSetupBox(3). |
|
DtPrintResetConnection(3) -- resets the print display connection managed by a DtPrintSetupBox
|
|
The DtPrintResetConnection function is a convenience function provided by the DtPrintSetupBox widget that allows applications to direct the widget to stop managing the X print server connection. A mode parameter is included in order to direct the widget to close the print connection by calling XpDestroyPrintContext and XCloseDisplay or to simply relinquish control of the connection without closing... |
|
DtPrintSetupBox(3) -- application print setup widget
|
|
DtPrintSetupBox is a widget that is typically the initial window used to set various options prior to printing from an application. This widget is designed primarily for use by applications that utilize the X Print Service. However, it can also be used by applications employing other printing methods. DtPrintSetupBox is organized based on generic print options and application specific print option... |
|
DtPrintSetupProc(3) -- Type definition for DtPrintSetupBox procedure resources.
|
|
DtPrintSetupProc is the type definition used for DtPrintSetupBox procedure resources. Each procedure is passed the widget ID of the DtPrintSetupBox via wid, and a structure containing information needed to perform the particular operation via print_data. If a procedure needs to update the DtPrintSetupBox, it should do so by setting resources as indicated by the procedure resource description. The ... |
|
DtSaverGetWindows(3) -- get the list of windows for drawing by a screen saver application
|
|
The DtSaverGetWindows function returns a list of windows on which a screen saver application should draw when invoked by CDE. The display argument is the X display. The window argument is the address of a pointer to receive the pointer to a list of windows. The count argument is the address of an integer to receive the number of elements in the list of windows returned in window. |
|
DtSearchAddMessage(3) -- Access and manipulate messages on the DtSearch MessageList
|
|
The DtSearch online search engine may assemble detailed user messages to explain various errors and failures. These messages are designed to provide a user with enough information to correct the error. Often more than one message is assembled onto the MessageList as the result of a single API call. The calling code may also append messages to the MessageList prior to display to the user. All messa... |
|
DtSearchExit(3) -- Perform orderly shutdown of search engine
|
|
DtSearchExit is an internal exit call for the online API. It may be called by any API module when a fatal error or aborting signal is detected. It performs an orderly shutdown of the search engine including graceful database closure, communications disconnect, release of system resources, restoration of environment, etc., as necessary. It will call a user exit function if one was installed by DtSe... |
|
DtSearchFreeMessages(3) -- Access and manipulate messages on the DtSearch MessageList
|
|
The DtSearch online search engine may assemble detailed user messages to explain various errors and failures. These messages are designed to provide a user with enough information to correct the error. Often more than one message is assembled onto the MessageList as the result of a single API call. The calling code may also append messages to the MessageList prior to display to the user. All messa... |
|
DtSearchFreeResults(3) -- Free storage allocated for DtSearch results lists
|
|
The DtFreeSearchResults function frees the results list pointed to by list which was originally returned from DtSearchQuery, and sets the list pointer to NULL. |
|
DtSearchGetKeytypes(3) -- Access the Keytypes array for a DtSearch database
|
|
The DtSearchGetKeytypes function returns a pointer to the keytypes array of the specified database. The caller may modify the is_selected member of any DtSrKeytype but should not alter any other member values. This function may be called anytime after DtSearchInit. |
|
DtSearchGetMaxResults(3) -- Obtain the DtSearch maximum results value
|
|
The results list returned from DtSearchQuery will be truncated to a maximum number of items after search completion and statistical ranking. DtSearchGetMaxResults returns the current maximum results setting. The function can be called any time after DtSearchInit. |
|
DtSearchGetMessages(3) -- Access and manipulate messages on the DtSearch MessageList
|
|
The DtSearch online search engine may assemble detailed user messages to explain various errors and failures. These messages are designed to provide a user with enough information to correct the error. Often more than one message is assembled onto the MessageList as the result of a single API call. The calling code may also append messages to the MessageList prior to display to the user. All messa... |
|
DtSearchHasMessages(3) -- Access and manipulate messages on the DtSearch MessageList
|
|
The DtSearch online search engine may assemble detailed user messages to explain various errors and failures. These messages are designed to provide a user with enough information to correct the error. Often more than one message is assembled onto the MessageList as the result of a single API call. The calling code may also append messages to the MessageList prior to display to the user. All messa... |
|
DtSearchHighlight(3) -- Generate DtSrHitwords table for highlighting DtSearch document
|
|
The DtSearchHighlight function generates an array of offsets and lengths (DtSrHitword) of parsed linguistic terms (stems) in the passed document cleartext to enable a browser to highlight the words in the text as appropriate for its user interface. |
|
DtSearchInit(3) -- Initialize the DtSearch online API for subsequent calls
|
|
DtSearchInit opens databases and other files and initializes the search engine API for subsequent requests. It must be the first online DtSearch function called. DtSearchInit may be called only once, although DtSrReinit may be called at any time after DtSearchInit. If this function fails, the caller should display the MessageList returned and exit; no subsequent requests will be possible. |
|
DtSearchMergeResults(3) -- Merge two DtSearch results lists into one
|
|
DtSearchMergeResults merges the srclist results list into the targlist list using proximity for sort order, and sets the srclist source list pointer to NULL. This function is used to merge results from separate database searches for presentation to the user as a single results list. It presumes both lists are initially sorted by ascending proximity. It does nothing if source list is empty and retu... |
|
DtSearchQuery(3) -- Perform a DtSearch database search for a specified query
|
|
DtSearchQuery is the DtSearch API search function. DtSearchQuery is passed a query string and some search options, performs the requested search, and if successful returns a linked list of DtSrResult structures representing the documents satisfying the search. The results list contains information about the documents that can be used for subsequent retrievals, as well as information suitable for d... |
|
DtSearchReinit(3) -- Reinitialize the DtSearch online API
|
|
DtSearchReinit closes and reopens databases and other files as necessary, and reinitializes the search engine API. It is typically used after either databases or the ocf file have been externally changed to force the search engine to reinitialize itself, and to acquire the new database names if any. It can also be used after any function returns DtSrREINIT to acquire the new database names. |
|
DtSearchRetrieve(3) -- Return clear text of documents from DtSearch databases
|
|
DtSearchRetrieve retrieves the uncompressed document text of a specified DtSearch document listed in the DtSrResult list from a previous call to DtSearchQuery. It will be successful only in an AusText type database where the documents are stored directly in a database repository. |
|
DtSearchSetMaxResults(3) -- Set the DtSearch maximum results value
|
|
The results list returned from DtSearchQuery will be truncated to a maximum number of items after search completion and statistical ranking. DtSearchSetMaxResults changes the maximum results setting to max. If DtSearchSetMaxResults is never called, the maximum number of DtSrResult items returned will default to 20. The function can be called any time after DtSearchInit(). |
|
DtSearchSortResults(3) -- Sort DtSearch results lists
|
|
DtSearchSortResults sorts lists returned from DtSearchQuery. Note that results lists are already presorted by proximity by DtSearchQuery. |
|
DtSearchValidDateString(3) -- Validate and convert a user date string
|
|
DtSearchValidDateString validates a DtSearch date string, as might have been entered by a user in a free form text field, and converts it into a valid DtSrObjdate. Since an invalid date string format returns a distinctive DtSrObjdate, this function may also be used as a boolean test for string validity. |
|
DtSessionRestorePath(3) -- get a pathname for the application's state information file
|
|
The DtSessionRestorePath function returns a pathname to an application's state information. The widget argument is the application's top level widget. The restorePath argument is the address of the character string to receive the pathname of the application's state information file. The restoreFile argument is the filename of the file containing the application state information. This is the fi... |
|
DtSessionSavePath(3) -- get a pathname for saving application state information
|
|
The DtSessionSavePath function returns the pathname to be used by an application for saving its state information. The information is later used by the application to restore its state. The widget argument is the application's top level widget. The savePath argument is the address of the character string to receive the pathname of the state information file to be used by the application for stori... |
|
DtSpinBox(3) -- the SpinBox widget class
|
|
Note: This widget has been superseded by the equivalent Motif widget XmSimpleSpinBox. Please refer to the Motif Programmer's Reference for more information. The DtSpinBox widget is a user interface control to increment and decrement an arbitrary TextField. For example, it can be used to cycle through the months of the year or days of the month. Widget subclassing is not supported for the DtSpinBo... |
|
DtSpinBoxAddItem(3) -- add an item to the DtSpinBox
|
|
Note: This function has been superseded by the equivalent Motif function XmSimpleSpinBoxAddItem. Please refer to the Motif Programmer's Reference for more information. The DtSpinBoxAddItem function adds the given item to the DtSpinBox at the given position. The w argument specifies the widget ID. The item argument specifies the XmString for the new item. The pos argument specifies the position of... |
|
DtSpinBoxDeletePos(3) -- delete a DtSpinBox item
|
|
Note: This function has been superseded by the equivalent Motif function XmSimpleSpinBoxDeletePos. Please refer to the Motif Programmer's Reference for more information. The DtSpinBoxDeletePos function deletes a specified item from a DtSpinBox widget. The w argument specifies the widget ID. The pos argument specifies the position of the item to be deleted. A value of 1 means the first item in the... |
|
DtSpinBoxSetItem(3) -- set an item in the DtSpinBox list
|
|
Note: This function has been superseded by the equivalent Motif function XmSimpleSpinBoxSetItem. Please refer to the Motif Programmer's Reference for more information. The DtSpinBoxSetItem function selects an item in the list of the given DtSpinBox widget and makes it the current value. The w argument specifies the widget ID. The item argument specifies the XmString for the item to be set in the ... |
|
DtSrAPI(3) -- Describes overview, constants, and structures for DtSearch online API
|
|
The DtSearch API provides programmatic access to the DtSearch search and retrieval engine. The API functions are located in the library libDtSr, and are directly linked into user written search programs. Search and retrieval of DtSearch databases is available through three essential API functions: |
|
DtTerm(3) -- DtTerm widget class
|
|
The DtTerm widget provides the core set of functionality needed to emulate an ANSI X3.64-1979 - and ISO 6429:1992(E)-style terminal, such as the DEC VT220. This functionality includes text rendering, scrolling, margin and tab support, escape sequence parsing and the low-level OS-specific interface required to allocate and configure a pty or STREAMS pseudo-terminal device and write the system's ut... |
|
DtTermDisplaySend(3) -- send data to a DtTerm widget's display
|
|
The DtTermDisplaySend function sends data to a DtTerm widget's display. The widget argument specifies the DtTerm widget ID. The buffer argument specifies the string (single- or multi-byte depending on the locale) to be sent to the display. The string may contain NULL bytes. The length argument specifies the length of buffer in bytes. The DtTermDisplaySend function allows the program to write text... |
|
DtTermInitialize(3) -- prevent accelerators from being installed on a DtTerm widget
|
|
The DtTermInitialize function prevents the XmBulletinBoard(3) widget from installing accelerators on DtTerm widgets. It enables DtTerm widgets to receive certain key events, such as Return and Escape, normally not passed by Motif to XmPrimitive(3) widgets. |
|
DtTermSubprocReap(3) -- allow a DtTerm widget to clean up after subprocess termination
|
|
The DtTermSubprocReap function allows DtTerm widgets to function correctly in applications that have installed a SIGCHLD signal handler. The pid argument specifies the process ID of the child process wait(2) returns. The stat_loc argument specifies the termination information wait(2) returns. |
|
DtTermSubprocSend(3) -- send data to a DtTerm widget's subprocess
|
|
The DtTermSubprocSend function sends data to a DtTerm widget's child process. The widget argument specifies the DtTerm widget ID. The buffer argument specifies the string (single- or multi-byte depending on the locale) to be sent to the display. The string may contain NULL bytes. The length argument specifies the length of buffer in bytes. The DtTermSubprocSend function allows the program to send... |
|
DtWsmAddCurrentWorkspaceCallback(3) -- add a callback to be called when the current workspace changes
|
|
The DtWsmAddCurrentWorkspaceCallback function registers an application function to be called when the CDE workspace manager, dtwm(1), switches to a new workspace. The workspace manager sends the new current workspace name to the DtWsmWsChangeProc callback. The widget argument is a realized widget. The ws_change argument is the procedure to be called when the workspace changes. The client_data argu... |
|
DtWsmAddWorkspace(3) -- add a workspace
|
|
The DtWsmAddWorkspace() function works with the CDE workspace manager, dtwm(1), and adds a new workspace. Applications can use this function to implement an interface to the workspace manager. If the DtWsmAddWorkspace() function is not successful, the most likely reason for failure is that the CDE workspace manager, dtwm(1), is not running. DtWsmAddWorkspace() sends a message to the CDE workspace ... |
|
DtWsmAddWorkspaceFunctions(3) -- add workspace functions for a window
|
|
The DtWsmAddWorkspaceFunctions function enables workspace functions for a window. When workspace functions are enabled, the default window menu for the window displayed by the CDE workspace manager, dtwm(1), shows entries that allow the window to occupy a different set of workspaces, occupy all workspaces, or be removed from the current workspace. The display argument is the X display. The window ... |
|
DtWsmAddWorkspaceModifiedCallback(3) -- add a callback to be called when any workspace is changed
|
|
The DtWsmAddWorkspaceModifiedCallback function works with the CDE workspace manager, dtwm(1), and registers a function to be called when a workspace is added, deleted or modified. The widget argument is a realized widget. The ws_change argument is the procedure to be called when a workspace is modified. The client_data argument points to arbitrary client data to be passed back to ws_change. The he... |
|
DtWsmChangeBackdrop(3) -- set current workspace's backdrop
|
|
The DtWsmChangeBackdrop function works with the CDE workspace manager, dtwm(1), and changes the current workspace's backdrop. Applications can use this function to implement an interface to the workspace manager. If the DtWsmChangeBackdrop function is not successful, the most likely reason for failure is that the CDE workspace manager, dtwm(1), is not running. DtWsmChangeBackdrop sends a message ... |
|
DtWsmDeleteWorkspace(3) -- delete a specific workspace
|
|
The DtWsmDeleteWorkspace() function works with the CDE workspace manager, dtwm(1), and deletes a specific workspace. Applications can use this function to implement an interface to the workspace manager. If the DtWsmDeleteWorkspace() function is not successful, the most likely reason for failure is that the CDE workspace manager, dtwm(1), is not running. The DtWsmDeleteWorkspace() function require... |
|
DtWsmFreeWorkspaceInfo(3) -- free workspace information
|
|
The DtWsmFreeWorkspaceInfo function frees workspace information. The pWsInfo argument points to the workspace information the DtWsmGetWorkspaceInfo(3) function returns. |
|
DtWsmGetCurrentBackdropWindow(3) -- get the backdrop window for the current workspace
|
|
The DtWsmGetCurrentBackdropWindow function works with the CDE workspace manager, dtwm(1), and returns the window used as the backdrop for the current workspace. The display argument is the X display. The root argument is the root window of the screen of interest. |
|
DtWsmGetCurrentWorkspace(3) -- get the current workspace
|
|
The DtWsmGetCurrentWorkspace function works with the CDE workspace manager, dtwm(1), and returns the name of the current workspace (converted to an X atom). The display argument is the X display. The root argument is the root window of the screen of interest. The paWorkspace argument is the address of an atom to receive the current workspace identifier. |
|
DtWsmGetWorkspaceInfo(3) -- get detailed workspace information
|
|
The DtWsmGetWorkspaceInfo function works with the CDE workspace manager, dtwm(1), and returns detailed information on a specific workspace. The display argument is the X display. The root argument is the root window of the screen of interest. The aWorkspace argument is the workspace name (converted to an X atom). The *ppWsInfo argument is the address of a variable to receive the returned pointer t... |
|
DtWsmGetWorkspaceList(3) -- get the names of the currently defined workspaces
|
|
The DtWsmGetWorkspaceList function works with the CDE workspace manager, dtwm(1). and returns a list of the names (converted into X atoms) of the currently defined workspaces. The display argument is the X display. The root argument is the root window of the screen of interest. The *ppaWorkspaces argument is the address of a pointer to receive the returned pointer to the workspacelist. The pNumWor... |
|
DtWsmGetWorkspacesOccupied(3) -- get the workspaces in which a window resides
|
|
The DtWsmGetWorkspacesOccupied function works with the CDE workspace manager, dtwm(1), and returns the list of workspaces in which this window resides. Each element of the list is the name of a workspace (converted to an X atom). The display argument is the X display. The window argument is the window of interest. The *ppaWorkspaces argument is the address of a pointer to receive the pointer to a ... |
|
DtWsmOccupyAllWorkspaces(3) -- put a window into all workspaces
|
|
The DtWsmOccupyAllWorkspaces function works with the CDE workspace manager, dtwm(1), and puts a window into all currently defined workspaces and also into newly created workspaces. The display argument is the X display. The window argument is the window to occupy all workspaces. Calling the DtWsmSetWorkspacesOccupied function overrides the effect of the DtWsmOccupyAllWorkspaces function. |
|
DtWsmRemoveWorkspaceCallback(3) -- remove a workspace callback
|
|
The DtWsmRemoveWorkspaceCallback function works with the CDE workspace manager, dtwm(1), and removes a callback called when the current workspace changes or when a workspace is modified. The context argument is the context the DtWsmAddCurrentWorkspaceCallback(3) function or the DtWsmAddWorkspaceModifiedCallback(3) function returns when the application registers the callback. |
|
DtWsmRemoveWorkspaceFunctions(3) -- remove a window's workspace functions
|
|
The DtWsmRemoveWorkspaceFunctions function removes a window's workspace functions. When DtWsmRemoveWorkspaceFunctions removes workspace functions, the window menu for the window the CDE workspace manager, dtwm(1), displays does not have the entries that allow the window to occupy a different set of workspaces, occupy all workspaces, or be removed from the current workspace. The display argument i... |
|
DtWsmSetCurrentWorkspace(3) -- set the current workspace
|
|
The DtWsmSetCurrentWorkspace function works with the CDE workspace manager, dtwm(1), and sets the current workspace. Applications can use this function to switch from the current workspace to another workspace. The widget argument is a realized widget on the screen of interest. The aWorkspace argument is the name (in X atom form) of the workspace to be made current. |
|
DtWsmSetWorkspacesOccupied(3) -- set the workspaces in which a window resides
|
|
The DtWsmSetWorkspacesOccupied function works with the CDE workspace manager, dtwm(1), and puts a window into a set of workspaces. The display argument is the X display. The window argument is the window to be put into this set of workspaces. The paWorkspaces argument points to a list of workspace names (converted to X atoms); the CDE workspace manager, dtwm(1), places the window into these worksp... |
|
DtWsmSetWorkspaceTitle(3) -- set workspace title
|
|
The DtWsmSetWorkspaceTitle() function works with the CDE workspace manager, dtwm(1), and changes a specific workspace's title. Applications can use this function to implement an interface to the workspace manager. If the DtWsmSetWorkspaceTitle() function is not successful, the most likely reason for failure is that the CDE workspace manager, dtwm(1), is not running. The DtWsmSetWorkspaceTitle() f... |
|
enddvagent(3) -- manipulate device assignment database entry for a trusted system
|
|
getdvagent, getdvagnam, and copydvagent each return a pointer to an object with the following structure containing the broken-out fields of an entry in the Device Assignment database. Each database entry is returned as a dev_asg structure, declared in the header file: struct dev_field { char *fd_name; /* external name */ char **fd_devs; /* device list */ mask_t fd_type[1]; /* tape, printe... |
|
endprdfent(3) -- manipulate system default database entry for a trusted system
|
|
getprdfent and getprdfnam each returns a pointer to an object with the following structure containing the broken-out fields of a line in the system default database. Each line in the database contains a pr_default structure, declared in the header file: struct system_default_fields { time_t fd_inactivity_timeout ; char fd_boot_authenticate ; } ; struct system_default_flags { unsigned shor... |
|
endprpwent(3) -- manipulate protected password database entries (for trusted systems only).
|
|
getprpwent, getprpwuid, getprpwaid, and getprpwnam each returns a pointer to a pr_passwd structure containing the broken-out fields of a line in the protected password database. Each line in the database contains a pr_passwd structure, declared in the header file: struct pr_field { /* Identity: */ char fd_name[9]; /* uses 8 character maximum(and NULL) from utmp */ uid_t fd_uid; /* uid ass... |
|
endprtcent(3) -- manipulate terminal control database entry for a trusted system
|
|
getprtcent and getprtcnam each returns a pointer to an object with the following structure containing the broken-out fields of an entry in the terminal control database. Each entry in the database contains a pr_term structure, declared in the header file: struct t_field { char fd_devname[14]; /* Terminal (or host) name */ uid_t fd_uid; /* uid of last successful login */ time_t fd_slogin; ... |
|
frt0.o(3) -- 64-bit ELF uses crt0.o only
|
|
PA-RISC 32-bit SOM The C, Pascal, and FORTRAN compilers link in the object files crt0.o, gcrt0.o, or mcrt0.o to provide startup capabilities and environments for program execution. All are identical except that gcrt0.o and mcrt0.o provide additional functionality for gpro profiling support respectively. The following symbols are defined in these object files: _environ An array of character pointer... |
|
frt0.o_pa(3) -- 64-bit ELF uses crt0.o only
|
|
PA-RISC 32-bit SOM The C, Pascal, and FORTRAN compilers link in the object files crt0.o, gcrt0.o, or mcrt0.o to provide startup capabilities and environments for program execution. All are identical except that gcrt0.o and mcrt0.o provide additional functionality for gpro profiling support respectively. The following symbols are defined in these object files: _environ An array of character pointer... |
|
gcrt0.o(3) -- execution startup routines; PARISC
|
|
PA-RISC 32-bit SOM The C, Pascal, and FORTRAN compilers link in the object files crt0.o, gcrt0.o, or mcrt0.o to provide startup capabilities and environments for program execution. All are identical except that gcrt0.o and mcrt0.o provide additional functionality for gpro profiling support respectively. The following symbols are defined in these object files: _environ An array of character pointer... |
|
gcrt0.o_pa(3) -- 64-bit ELF uses crt0.o only
|
|
PA-RISC 32-bit SOM The C, Pascal, and FORTRAN compilers link in the object files crt0.o, gcrt0.o, or mcrt0.o to provide startup capabilities and environments for program execution. All are identical except that gcrt0.o and mcrt0.o provide additional functionality for gpro profiling support respectively. The following symbols are defined in these object files: _environ An array of character pointer... |
|
getdvagent(3) -- manipulate device assignment database entry for a trusted system
|
|
getdvagent, getdvagnam, and copydvagent each return a pointer to an object with the following structure containing the broken-out fields of an entry in the Device Assignment database. Each database entry is returned as a dev_asg structure, declared in the header file: struct dev_field { char *fd_name; /* external name */ char **fd_devs; /* device list */ mask_t fd_type[1]; /* tape, printe... |
|
getdvagnam(3) -- manipulate device assignment database entry for a trusted system
|
|
getdvagent, getdvagnam, and copydvagent each return a pointer to an object with the following structure containing the broken-out fields of an entry in the Device Assignment database. Each database entry is returned as a dev_asg structure, declared in the header file: struct dev_field { char *fd_name; /* external name */ char **fd_devs; /* device list */ mask_t fd_type[1]; /* tape, printe... |
|
getprdfent(3) -- manipulate system default database entry for a trusted system
|
|
getprdfent and getprdfnam each returns a pointer to an object with the following structure containing the broken-out fields of a line in the system default database. Each line in the database contains a pr_default structure, declared in the header file: struct system_default_fields { time_t fd_inactivity_timeout ; char fd_boot_authenticate ; } ; struct system_default_flags { unsigned shor... |
|
getprdfnam(3) -- manipulate system default database entry for a trusted system
|
|
getprdfent and getprdfnam each returns a pointer to an object with the following structure containing the broken-out fields of a line in the system default database. Each line in the database contains a pr_default structure, declared in the header file: struct system_default_fields { time_t fd_inactivity_timeout ; char fd_boot_authenticate ; } ; struct system_default_flags { unsigned shor... |
|
getprpwaid(3) -- manipulate protected password database entries (for trusted systems only).
|
|
getprpwent, getprpwuid, getprpwaid, and getprpwnam each returns a pointer to a pr_passwd structure containing the broken-out fields of a line in the protected password database. Each line in the database contains a pr_passwd structure, declared in the header file: struct pr_field { /* Identity: */ char fd_name[9]; /* uses 8 character maximum(and NULL) from utmp */ uid_t fd_uid; /* uid ass... |
|
getprpwent(3) -- manipulate protected password database entries (for trusted systems only).
|
|
getprpwent, getprpwuid, getprpwaid, and getprpwnam each returns a pointer to a pr_passwd structure containing the broken-out fields of a line in the protected password database. Each line in the database contains a pr_passwd structure, declared in the header file: struct pr_field { /* Identity: */ char fd_name[9]; /* uses 8 character maximum(and NULL) from utmp */ uid_t fd_uid; /* uid ass... |
|
getprpwnam(3) -- manipulate protected password database entries (for trusted systems only).
|
|
getprpwent, getprpwuid, getprpwaid, and getprpwnam each returns a pointer to a pr_passwd structure containing the broken-out fields of a line in the protected password database. Each line in the database contains a pr_passwd structure, declared in the header file: struct pr_field { /* Identity: */ char fd_name[9]; /* uses 8 character maximum(and NULL) from utmp */ uid_t fd_uid; /* uid ass... |
|
getprpwuid(3) -- manipulate protected password database entries (for trusted systems only).
|
|
getprpwent, getprpwuid, getprpwaid, and getprpwnam each returns a pointer to a pr_passwd structure containing the broken-out fields of a line in the protected password database. Each line in the database contains a pr_passwd structure, declared in the header file: struct pr_field { /* Identity: */ char fd_name[9]; /* uses 8 character maximum(and NULL) from utmp */ uid_t fd_uid; /* uid ass... |
|
getprtcent(3) -- manipulate terminal control database entry for a trusted system
|
|
getprtcent and getprtcnam each returns a pointer to an object with the following structure containing the broken-out fields of an entry in the terminal control database. Each entry in the database contains a pr_term structure, declared in the header file: struct t_field { char fd_devname[14]; /* Terminal (or host) name */ uid_t fd_uid; /* uid of last successful login */ time_t fd_slogin; ... |
|
getprtcnam(3) -- manipulate terminal control database entry for a trusted system
|
|
getprtcent and getprtcnam each returns a pointer to an object with the following structure containing the broken-out fields of an entry in the terminal control database. Each entry in the database contains a pr_term structure, declared in the header file: struct t_field { char fd_devname[14]; /* Terminal (or host) name */ uid_t fd_uid; /* uid of last successful login */ time_t fd_slogin; ... |
|
getresgid(3) -- get real, effective and saved user or group IDs
|
|
getresuid and getresgid return the real, effective, and saved user or group ID's of the current process. |
|
getresuid(3) -- get real, effective and saved user or group IDs
|
|
getresuid and getresgid return the real, effective, and saved user or group ID's of the current process. |
|
get_secdef_int(3) -- security defaults configuration file routines
|
|
open_secdef opens the security configuration file /etc/default/security. This function must be called prior to calling get_secdef_str or get_secdef_int. close_secdef closes the security configuration file. get_secdef_str and get_secdef_int return the value of the specified parameter defined in the security configuration file. See the security(4) manpage. Programs using these routines must be compi... |
|
get_secdef_str(3) -- security defaults configuration file routines
|
|
open_secdef opens the security configuration file /etc/default/security. This function must be called prior to calling get_secdef_str or get_secdef_int. close_secdef closes the security configuration file. get_secdef_str and get_secdef_int return the value of the specified parameter defined in the security configuration file. See the security(4) manpage. Programs using these routines must be compi... |
|
gfrt0.o(3) -- 64-bit ELF uses crt0.o only
|
|
PA-RISC 32-bit SOM The C, Pascal, and FORTRAN compilers link in the object files crt0.o, gcrt0.o, or mcrt0.o to provide startup capabilities and environments for program execution. All are identical except that gcrt0.o and mcrt0.o provide additional functionality for gpro profiling support respectively. The following symbols are defined in these object files: _environ An array of character pointer... |
|
gfrt0.o_pa(3) -- 64-bit ELF uses crt0.o only
|
|
PA-RISC 32-bit SOM The C, Pascal, and FORTRAN compilers link in the object files crt0.o, gcrt0.o, or mcrt0.o to provide startup capabilities and environments for program execution. All are identical except that gcrt0.o and mcrt0.o provide additional functionality for gpro profiling support respectively. The following symbols are defined in these object files: _environ An array of character pointer... |
|
gss_accept_sec_context(3) -- establish a security context between the application and a context acceptor
|
|
The gss_accept_sec_context() routine is the second step in establishing a security context between the context initiator and a context acceptor. In the first step, the context initiator calls the gss_init_sec_context() routine. The gss_init_sec_context() routine generates a token for the security context and passes it to the context initiator. The context initiator sends the token to the context a... |
|
gss_acquire_cred(3) -- allow an application to acquire a handle for an existing, named credential
|
|
The gss_acquire_cred() routine allows an application to obtain a handle for a pre-existing credential by name. The credentials could be either an ACCEPT, INITIATE, or BOTH. The application then passes the credential handle to either the gss_init_sec_context() or the gss_accept_sec_context() routine. If desired_name is GSS_C_NO_NAME, the call is interpreted as a request for a credential handle that... |
|
gss_add_cred(3) -- adds a credential-element to a credential
|
|
The gss_add_cred() routine adds a credential-element to a credential. The credential-element is identified by the name of the principal to which it refers. If desired_name is GSS_C_NO_NAME, the call is interpreted as a request to add a credential element that will invoke default behavior when passed to gss_init_sec_context() or gss_accept_sec_context(). This routine can be used to either compose a... |
|
gss_add_oid_set_member(3) -- add an Object Identifier (OID) to an OID set
|
|
The gss_add_oid_set_member() routine adds a new Object Identifier to an Object Identifier set. If an OID set does not exist, you can create a new, empty OID set with the gss_create_empty_oid_set() routine. |
|
gss_canonicalize_name(3) -- convert an internal name to an internal mechanism name (MN) representation of an opaque internal name
|
|
The gss_canonicalize_name() routine generate a canonical mechanism name (MN) from an arbitrary internal name. The mechanism name is the name that would be returned to a context acceptor on successful authentication of a context where the initiator used the input_name in a successful call to gss_acquire_cred(), specifying an Object Identifier (OID) set containing mech_type as its only member, follo... |
|
gss_compare_name(3) -- allow an application to compare two internal names to determine whether they are equivalent
|
|
The gss_compare_name() routine lets an application compare two internal names to determine whether they are the same. This routine does not resolve the names to see if they refer to the same object. It simply compares the input names for equivalence. If either name presented to gss_compare_name() denotes an anonymous principal, the routines should indicate that the two names do not refer to the sa... |
|
gss_context_time(3) -- check the number of seconds the context will remain valid
|
|
The gss_context_time() routine checks the number of seconds for which the context will remain valid. |
|
gss_create_empty_oid_set(3) -- create a new, empty OID set, to which members can be added
|
|
The gss_create_empty_oid_set() routine creates a new, empty OID set to which the context initiator can add members. Use the gss_add_oid_set_member() routine to add members to the OID set. These routines are intended to be used to construct sets of mechanism object identifiers, for input to gss_acquire_cred() routine. |
|
gss_delete_sec_context(3) -- delete a security context
|
|
The gss_delete_sec_context() routine deletes a security context. It also deletes the local data structures associated with the security context. When it deletes the context, the routine can generate a token. The application passes the token to the context acceptor. The context acceptor then passes the token to the gss_process_context_token() routine, telling it to delete the context and all associ... |
|
gss_display_name(3) -- provide textual representation of an opaque internal name to an application
|
|
The gss_display_name() routine provides an application with the text form of an opaque internal name. The application can use the text to display the name but not to print it. |
|
gss_display_status(3) -- provide an application with the textual representation of a GSSAPI status code that can be displayed to a user
|
|
The gss_display_status() routine provides the context initiator with a textual representation of a status code so that the application can display the message to a user or log the message. Because some status values can indicate more than one error, the routine enables the calling application to process status codes with multiple messages. The message_context parameter indicates which error messag... |
|
gss_duplicate_name(3) -- allow an application to create an exact duplicate of the existing internal name
|
|
The gss_duplicate_name() routine create an exact duplicate of the existing internal name src_name. The new dest_name will be independent of src_name. |
|
gss_export_name(3) -- convert a mechanism name (MN) to a form suitable for direct comparison
|
|
The gss_export_name() converts a mechanism name (MN) to export form. |
|
gss_export_sec_context(3) -- transfer a security context to another process on a single machine
|
|
The gss_export_sec_context() deactivates the security context for the calling process and creates an interprocess token which, when passed to gss_import_sec_context() in another process, will re-activate the context in the second process. Only a single instantiation of a given context may be active at any one time; a subsequent attempt by a context exporter to access the exported security context ... |
|
gss_get_mic(3) -- calculate a cryptographic message integrity code (MIC) for a message and return in a token
|
|
The gss_get_mic() routine generates a cryptographic message integrity code (MIC) for the supplied message and places the MIC in a token for transfer to the peer application. The qop_req parameter allows a choice between several cryptographic algorithms, if supported by the chosen mechanism. |
|
gss_import_name(3) -- convert a printable name to an internal form
|
|
The gss_import_name() routine converts a printable name to an internal form. |
|
gss_import_sec_context(3) -- transfer a security context to another process on a single machine
|
|
The gss_import_sec_context() routine lets a process to import a security context established by another process. A given interprocess token may be imported only once. |
|
gss_indicate_mechs(3) -- allow an application to determine which underlying security mechanisms are available
|
|
The gss_indicate_mechs() routine enables an application to determine which underlying security mechanisms are available. |
|
gss_init_sec_context(3) -- establish a security context between the context initiator and a context acceptor
|
|
The gss_init_sec_context() routine is the first step in the establishment of a security context between the context initiator and the context acceptor. To ensure the portability of the application, use its default credential by supplying GSS_C_NO_CREDENTIAL to the claimant_cred_handle parameter. Specify an explicit credential when the application needs an additional credential; for example, to use... |
|
gss_inquire_context(3) -- obtain information about a security context
|
|
The gss_inquire_context() routine provides information about the security context to the calling application. The calling application must first have called the gss_acquire_cred() routine for a handle for the credential. |
|
gss_inquire_cred(3) -- provide the calling application information about a credential
|
|
The gss_inquire_cred() routine provides information about a credential to the calling application. The calling application must first have called the gss_acquire_cred() routine for a handle for the credential. |
|
gss_inquire_cred_by_mech(3) -- provide the calling application permechanism information about a credential
|
|
The gss_inquire_cred_by_mech() routine provides per-mechanism information about a credential. |
|
gss_inquire_mechs_for_name(3) -- list the mechanisms that support the
|
|
The gss_inquire_mechs_for_name() routine returns the set of mechanisms supported by the GSS-API implementation that may be able to process the specified name. |
|
gss_inquire_names_for_mech(3) -- list the name-types supported by the specified mechanism
|
|
The gss_inquire_names_for_mech() routine returns the set of nametypes supported by the specified mechanism. |
|
gss_process_context_token(3) -- process a context to the security service
|
|
The gss_process_context_token() routine passes tokens generated by the gss_delete_security_context() routine to the security service. Usually, tokens are associated with either the context establishment or with per-message security services. If the tokens are associated with the context establishment, they are passed to the gss_init_sec_context() or gss_accept_sec_context() routine. If the tokens ... |
|
gss_release_buffer(3) -- free storage associated with a buffer
|
|
The gss_release_buffer() routine deletes the buffer by freeing the storage associated with it. |
|
gss_release_cred(3) -- mark a credential for deletion
|
|
The gss_release_cred() routine informs the GSSAPI that a credential is no longer required and marks it for deletion. |
|
gss_release_name(3) -- free storage associated with an internal name allocated by a GSSAPI routine
|
|
The gss_release_name() routine deletes the internal name by freeing the storage associated with that internal name. |
|
gss_release_oid_set(3) -- free storage associated with a gss_OID_set object
|
|
The gss_release_oid_set() routine frees storage that is associated with the gss_OID_set parameter and was allocated by a GSSAPI routine. |
|
gss_test_oid_set_member(3) -- check an OID set for a specified OID
|
|
The gss_test_oid_set_member() routine checks an OID set to see if the specified OID is a member of the set. To add a member to an OID set, use the gss_add_oid_set_member() routine. The gss_test_oid_set_member() routine uses the value of the actual_mechs output parameter from the gss_acquire_cred() routine to get the list of OIDs. It checks this list to see if any of the OIDs are members of the OID... |
|
gss_unwrap(3) -- verify a message with attached message integrity code (MIC) and decrypt message content if necessary
|
|
The gss_unwrap() routine converts a protected message to a usable form and verifies the embedded message integrity code (MIC). The conf_state parameter indicates whether the message was encrypted. The qop_state parameter indicates the quality of protection that was used to provide the confidentiality and integrity services. |
|
gss_verify_mic(3) -- check a cryptographic message integrity code (MIC) against a message to verify its integrity
|
|
The gss_verify_mic() routine verifies that a cryptographic MIC, contained in the token_buffer parameter, fits the supplied message. The application receiving the message can use the qop_state parameter to check the strength of protection. |
|
gss_wrap(3) -- attach a message integrity code (MIC) to a message, and optionally encrypt the message content
|
|
The gss_wrap() routine attaches a cryptographic message integrity code (MIC) and optionally encrypts the input_message. The output_message contains both the MIC and the message. Although the qop_req parameter enables a choice between several qualities of protection, if you specify an unsupported protection, the gss_wrap() routine returns a status of GSS_S_FAILURE. |
|
gss_wrap_size_limit(3) -- determine a token-size limit for gss_wrap on a context
|
|
The gss_wrap_size_limit() routine allows an application to determine the maximum message size that, if presented to gss_wrap() with the same conf_req_flag and qop_req parameters, will result in an output token containing no more than the req_output_size bytes. This call is intended for use by applications that communicate over protocols that impose a maximum message size. It enables the applicatio... |
|
hosts_access(3) -- access control library
|
|
The routines described here are a part of the libwrap.a library. They implement a rule-based access control language with optional shell commands that are executed when a rule fires. request_init() initializes a structure with information about a client request. request_set() updates an already initialized request structure. Both functions take a variable-length list of key-value pairs and return ... |
|
hosts_ctl(3) -- access control library
|
|
The routines described here are a part of the libwrap.a library. They implement a rule-based access control language with optional shell commands that are executed when a rule fires. request_init() initializes a structure with information about a client request. request_set() updates an already initialized request structure. Both functions take a variable-length list of key-value pairs and return ... |
|
libcom_err(3) -- Kerberos client libraries (libkrb5, libk5crypto, libcom_err)
|
|
Kerberos is a network authentication protocol developed at MIT. This is now an IETF standard RFC 1510, the Kerberos Network Authentication Service (V5). The shared libraries, libkrb5.so/libkrb5.sl, libcom_err.so/libcom_err.sl and libk5crypto.so/libk5crypto.sl support authentication, integrity and confidentiality services as per the Kerberos V5 specification. Kerberos performs authentication as a t... |
|
libcom_err.sl(3) -- Kerberos client libraries (libkrb5, libk5crypto, libcom_err)
|
|
Kerberos is a network authentication protocol developed at MIT. This is now an IETF standard RFC 1510, the Kerberos Network Authentication Service (V5). The shared libraries, libkrb5.so/libkrb5.sl, libcom_err.so/libcom_err.sl and libk5crypto.so/libk5crypto.sl support authentication, integrity and confidentiality services as per the Kerberos V5 specification. Kerberos performs authentication as a t... |
|
libcom_err.so(3) -- Kerberos client libraries (libkrb5, libk5crypto, libcom_err)
|
|
Kerberos is a network authentication protocol developed at MIT. This is now an IETF standard RFC 1510, the Kerberos Network Authentication Service (V5). The shared libraries, libkrb5.so/libkrb5.sl, libcom_err.so/libcom_err.sl and libk5crypto.so/libk5crypto.sl support authentication, integrity and confidentiality services as per the Kerberos V5 specification. Kerberos performs authentication as a t... |
|
libk5crypto(3) -- Kerberos client libraries (libkrb5, libk5crypto, libcom_err)
|
|
Kerberos is a network authentication protocol developed at MIT. This is now an IETF standard RFC 1510, the Kerberos Network Authentication Service (V5). The shared libraries, libkrb5.so/libkrb5.sl, libcom_err.so/libcom_err.sl and libk5crypto.so/libk5crypto.sl support authentication, integrity and confidentiality services as per the Kerberos V5 specification. Kerberos performs authentication as a t... |
|
libk5crypto.sl(3) -- Kerberos client libraries (libkrb5, libk5crypto, libcom_err)
|
|
Kerberos is a network authentication protocol developed at MIT. This is now an IETF standard RFC 1510, the Kerberos Network Authentication Service (V5). The shared libraries, libkrb5.so/libkrb5.sl, libcom_err.so/libcom_err.sl and libk5crypto.so/libk5crypto.sl support authentication, integrity and confidentiality services as per the Kerberos V5 specification. Kerberos performs authentication as a t... |
|
libk5crypto.so(3) -- Kerberos client libraries (libkrb5, libk5crypto, libcom_err)
|
|
Kerberos is a network authentication protocol developed at MIT. This is now an IETF standard RFC 1510, the Kerberos Network Authentication Service (V5). The shared libraries, libkrb5.so/libkrb5.sl, libcom_err.so/libcom_err.sl and libk5crypto.so/libk5crypto.sl support authentication, integrity and confidentiality services as per the Kerberos V5 specification. Kerberos performs authentication as a t... |
|
libkrb5(3) -- Kerberos client libraries (libkrb5, libk5crypto, libcom_err)
|
|
Kerberos is a network authentication protocol developed at MIT. This is now an IETF standard RFC 1510, the Kerberos Network Authentication Service (V5). The shared libraries, libkrb5.so/libkrb5.sl, libcom_err.so/libcom_err.sl and libk5crypto.so/libk5crypto.sl support authentication, integrity and confidentiality services as per the Kerberos V5 specification. Kerberos performs authentication as a t... |
|
libkrb5.sl(3) -- Kerberos client libraries (libkrb5, libk5crypto, libcom_err)
|
|
Kerberos is a network authentication protocol developed at MIT. This is now an IETF standard RFC 1510, the Kerberos Network Authentication Service (V5). The shared libraries, libkrb5.so/libkrb5.sl, libcom_err.so/libcom_err.sl and libk5crypto.so/libk5crypto.sl support authentication, integrity and confidentiality services as per the Kerberos V5 specification. Kerberos performs authentication as a t... |
|
libkrb5.so(3) -- Kerberos client libraries (libkrb5, libk5crypto, libcom_err)
|
|
Kerberos is a network authentication protocol developed at MIT. This is now an IETF standard RFC 1510, the Kerberos Network Authentication Service (V5). The shared libraries, libkrb5.so/libkrb5.sl, libcom_err.so/libcom_err.sl and libk5crypto.so/libk5crypto.sl support authentication, integrity and confidentiality services as per the Kerberos V5 specification. Kerberos performs authentication as a t... |
|
mcrt0.o(3) -- execution startup routines; PARISC
|
|
PA-RISC 32-bit SOM The C, Pascal, and FORTRAN compilers link in the object files crt0.o, gcrt0.o, or mcrt0.o to provide startup capabilities and environments for program execution. All are identical except that gcrt0.o and mcrt0.o provide additional functionality for gpro profiling support respectively. The following symbols are defined in these object files: _environ An array of character pointer... |
|
mcrt0.o_pa(3) -- 64-bit ELF uses crt0.o only
|
|
PA-RISC 32-bit SOM The C, Pascal, and FORTRAN compilers link in the object files crt0.o, gcrt0.o, or mcrt0.o to provide startup capabilities and environments for program execution. All are identical except that gcrt0.o and mcrt0.o provide additional functionality for gpro profiling support respectively. The following symbols are defined in these object files: _environ An array of character pointer... |
|
mfrt0.o(3) -- 64-bit ELF uses crt0.o only
|
|
PA-RISC 32-bit SOM The C, Pascal, and FORTRAN compilers link in the object files crt0.o, gcrt0.o, or mcrt0.o to provide startup capabilities and environments for program execution. All are identical except that gcrt0.o and mcrt0.o provide additional functionality for gpro profiling support respectively. The following symbols are defined in these object files: _environ An array of character pointer... |
|
mfrt0.o_pa(3) -- 64-bit ELF uses crt0.o only
|
|
PA-RISC 32-bit SOM The C, Pascal, and FORTRAN compilers link in the object files crt0.o, gcrt0.o, or mcrt0.o to provide startup capabilities and environments for program execution. All are identical except that gcrt0.o and mcrt0.o provide additional functionality for gpro profiling support respectively. The following symbols are defined in these object files: _environ An array of character pointer... |
|
MrmCloseHierarchy(3) -- Closes a UID hierarchy
|
|
The MrmCloseHierarchy function closes a UID hierarchy previously opened by MrmOpenHierarchyPerDisplay. All files associated with the hierarchy are closed by the Motif Resource Manager (MRM) and all associated memory is returned. hierarchy_id Specifies the ID of a previously opened UID hierarchy. The hierarchy_id was returned in a previous call to MrmOpenHierarchyPerDisplay. |
|
MrmFetchBitmapLiteral(3) -- Fetches a bitmap literal from a hierarchy
|
|
The MrmFetchBitmapLiteral function fetches a bitmap literal from an MRM hierarchy, and converts the bitmap literal to an X pixmap of depth 1. The function returns this pixmap and its width and height. hierarchy_id Specifies the ID of the UID hierarchy that contains the specified icon literal. The value of hierarchy_id was returned in a previous call to MrmOpenHierarchyPerDisplay. index Specifies t... |
|
MrmFetchColorLiteral(3) -- Fetches a named color literal from a UID file
|
|
The MrmFetchColorLiteral function fetches a named color literal from a UID file, and converts the color literal to a pixel color value. hierarchy_id Specifies the ID of the UID hierarchy that contains the specified literal. The value of hierarchy_id was returned in a previous call to MrmOpenHierarchyPerDisplay. index Specifies the UIL name of the color literal to fetch. You must define this name i... |
|
MrmFetchIconLiteral(3) -- Fetches an icon literal from a hierarchy
|
|
The MrmFetchIconLiteral function fetches an icon literal from an MRM hierarchy and converts the icon literal to an X pixmap. hierarchy_id Specifies the ID of the UID hierarchy that contains the specified icon literal. The hierarchy_id was returned in a previous call to MrmOpenHierarchyPerDisplay. index Specifies the UIL name of the icon literal to fetch. screen Specifies the screen used for the pi... |
|
MrmFetchLiteral(3) -- Fetches a literal from a UID file
|
|
The MrmFetchLiteral function reads and returns the value and type of a literal (named value) that is stored as a public resource in a single UID file. This function returns a pointer to the value of the literal. For example, an integer is always returned as a pointer to an integer, and a string is always returned as a pointer to a string. Applications should not use MrmFetchLiteral for fetching ic... |
|
MrmFetchSetValues(3) -- Fetches the values to be set from literals stored in UID files
|
|
The MrmFetchSetValues function is similar to XtSetValues, except that the values to be set are defined by the UIL named values that are stored in the UID hierarchy. MrmFetchSetValues fetches the values to be set from literals stored in UID files. hierarchy_id Specifies the ID of the UID hierarchy that contains the specified literal. The value of hierarchy_id was returned in a previous call to MrmO... |
|
MrmFetchWidget(3) -- Fetches and creates an indexed (UIL named) application widget and its children
|
|
The MrmFetchWidget function fetches and creates an indexed application widget and its children. The indexed application widget is any widget that is named in UIL. In fetch operations, the fetched widget's subtree is also fetched and created. This widget must not appear as the child of a widget within its own subtree. MrmFetchWidget does not execute XtManageChild for the newly created widget. All ... |
|
MrmFetchWidgetOverride(3) -- Fetches any indexed (UIL named) application widget. It overrides the arguments specified for this application
|
|
The MrmFetchWidgetOverride function is the extended version of MrmFetchWidget. It is identical to MrmFetchWidget, except that it allows the caller to override the widget's name and any arguments that MrmFetchWidget would otherwise retrieve from the UID file or one of the defaulting mechanisms. That is, the override argument list is not limited to those arguments in the UID file. The override argu... |
|
MrmInitialize(3) -- Prepares an application to use MRM widget-fetching facilities
|
|
The MrmInitialize function must be called to prepare an application to use MRM widget-fetching facilities. You must call this function prior to fetching a widget. However, it is good programming practice to call MrmInitialize prior to performing any MRM operations. MrmInitialize initializes the internal data structures that MRM needs to successfully perform type conversion on arguments and to succ... |
|
MrmOpenHierarchy(3) -- Allocates a hierarchy ID and opens all the UID files in the hierarchy
|
|
This routine is obsolete and exists for compatibility with previous releases. It is replaced by MrmOpenHierarchyPerDisplay. MrmOpenHierarchy is identical to MrmOpenHierarchyPerDisplay except that MrmOpenHierarchy does not take a display argument. num_files Specifies the number of files in the name list. file_names_list Specifies an array of character strings that identify the UID files. ancillary_... |
|
MrmOpenHierarchyFromBuffer(3) -- Allocates a hierarchy ID and opens a buffer containing a memory image of a UID file
|
|
MrmOpenHierarchyFromBuffer allows you to specify a buffer containing information from UID files that MRM searches in subsequent fetch operations. This function also allocates a hierarchy ID and initializes the optimized search lists in the hierarchy. buffer Specifies a stream of bytes containing information from UID files hierarchy_id Returns the search hierarchy ID. The search hierarchy ID identi... |
|
MrmOpenHierarchyPerDisplay(3) -- Allocates a hierarchy ID and opens all the UID files in the hierarchy
|
|
MrmOpenHierarchyPerDisplay allows you to specify the list of UID files that MRM searches in subsequent fetch operations. All subsequent fetch operations return the first occurrence of the named item encountered while traversing the UID hierarchy from the first list element (UID file specification) to the last list element. This function also allocates a hierarchy ID and opens all the UID files in ... |
|
MrmRegisterClass(3) -- Saves the information needed for MRM to access the
|
|
The MrmRegisterClass function allows MRM to access user-defined widget classes. This function registers the necessary information for MRM to create widgets of this class. You must call MrmRegisterClass prior to fetching any user-defined class widget. MrmRegisterClass saves the information needed to access the widget creation function and to do type conversion of argument lists by using the informa... |
|
MrmRegisterNames(3) -- Registers the values associated with the names referenced in UIL (for example, UIL callback function names or
|
|
The MrmRegisterNames function registers a vector of names and associated values for access in MRM. The values can be callback functions, pointers to user-defined data, or any other values. The information provided is used to resolve symbolic references occurring in UID files to their run-time values. For callbacks, this information provides the procedure address required by the Motif Toolkit. For ... |
|
MrmRegisterNamesInHierarchy(3) -- Registers the values associated with the names referenced in UIL within a single hierarchy (for example, UIL c
|
|
The MrmRegisterNamesInHierarchy function registers a vector of names and associated values for access in MRM. The values can be callback functions, pointers to user-defined data, or any other values. The information provided is used to resolve symbolic references occurring in UID files to their run-time values. For callbacks, this information provides the procedure address required by the Motif To... |
|
Object(3) -- The Object widget class
|
|
Object is never instantiated. Its sole purpose is as a supporting superclass for other widget classes. |
|
open_secdef(3) -- security defaults configuration file routines
|
|
open_secdef opens the security configuration file /etc/default/security. This function must be called prior to calling get_secdef_str or get_secdef_int. close_secdef closes the security configuration file. get_secdef_str and get_secdef_int return the value of the specified parameter defined in the security configuration file. See the security(4) manpage. Programs using these routines must be compi... |
|
OverrideShell(3) -- The OverrideShell widget class
|
|
OverrideShell is used for shell windows that completely bypass the window manager, for example, PopupMenu shells. |
|
pam(3) -- Pluggable Authentication Module
|
|
PAM gives system administrators the flexibility of choosing any authentication service available on the system to perform authentication. The framework also allows new authentication service modules to be plugged in and made available without modifying the applications. The PAM framework, libpam, consists of an interface library and multiple authentication service modules. The PAM interface librar... |
|
pam_acct_mgmt(3) -- perform PAM account validation procedures
|
|
The function pam_acct_mgmt() is called to determine if the current user's account is valid. This includes checking for password and account expiration, as well as verifying access hour restrictions and terminal access restrictions for trusted mode. This function is typically called after the user has been authenticated with pam_authenticate(3). The pamh argument is an authentication handle obtain... |
|
pam_authenticate(3) -- perform authentication within the PAM framework
|
|
pam_authenticate() is called to authenticate the current user. The user is usually required to enter a password or similar authentication token depending upon the authentication service configured within the system. In the case of smart card authentication this token would be a PIN (Personal Identification Number). The user in question should have been specified by a prior call to pam_start() or p... |
|
pam_chauthtok(3) -- perform password related functions within the PAM framework
|
|
pam_chauthtok() is called to change the authentication token associated with a particular user referenced by the authentication handle, pamh. The following flag may be passed in to pam_chauthtok(): |
|
pam_close_session(3) -- perform PAM session creation and termination operations
|
|
pam_open_session() is called after a user has been successfully authenticated (refer to pam_authenticate(3) and pam_acct_mgmt(3)) and is used to notify the session modules that a new session has been initiated. All programs that use the pam(3) library should invoke pam_open_session() when beginning a new session. Upon termination of this activity, pam_close_session() should be invoked to inform pa... |
|
pam_end(3) -- authentication transaction routines for PAM
|
|
pam_start() is called to initiate an authentication transaction. pam_start() takes as arguments the name of the current service, service, the name of the user to be authenticated, user, the address of the conversation structure, pam_conv, and the address of a variable to be assigned the authentication handle, pamh. Upon successful completion, pamh will refer to a PAM handle for use with subsequent... |
|
pam_get_data(3) -- PAM routines to maintain module specific state
|
|
pam_set_data() and pam_get_data() allow PAM service modules to access and update module specific information as needed. These functions should not be used by applications. pam_set_data() stores module specific data within the PAM handle, pamh. The module_data_name argument uniquely identifies the data, and the data argument represents the actual data. module_data_name should be unique across all s... |
|
pam_get_item(3) -- authentication information routines for PAM
|
|
pam_get_item() and pam_set_item() allow applications and PAM service modules to access and update PAM information as needed. The information is specified by item_type, and can be one of the following: PAM_SERVICE The service name. PAM_USER The user name. PAM_AUTHTOK The user authentication token. PAM_OLDAUTHTOK The old user authentication token. PAM_TTY The tty name. PAM_RHOST The remote host name... |
|
pam_get_user(3) -- PAM routine to retrieve user name.
|
|
pam_get_user() is used by PAM service modules to retrieve the current user name from the PAM handle. If the user name has not been set, via pam_start() or pam_set_item(), then the PAM conversation function will be used to prompt the user for the user name with the string "prompt". If prompt is NULL, then pam_get_item() is called and the value of PAM_USER_PROMPT is used for prompting. If the valu... |
|
pam_open_session(3) -- perform PAM session creation and termination operations
|
|
pam_open_session() is called after a user has been successfully authenticated (refer to pam_authenticate(3) and pam_acct_mgmt(3)) and is used to notify the session modules that a new session has been initiated. All programs that use the pam(3) library should invoke pam_open_session() when beginning a new session. Upon termination of this activity, pam_close_session() should be invoked to inform pa... |
|
pam_setcred(3) -- modify/delete user credentials for an authentication service
|
|
pam_setcred() is used to establish, modify, or delete user credentials. pam_setcred() is typically called after the user has been authenticated and after a session has been opened (refer to pam_authenticate(3), pam_acct_mgmt(3), and pam_open_session(3)). The user is specified by a prior call to pam_start() or pam_set_item(), and is referenced by the authentication handle, pamh. The following flags... |
|
pam_set_data(3) -- PAM routines to maintain module specific state
|
|
pam_set_data() and pam_get_data() allow PAM service modules to access and update module specific information as needed. These functions should not be used by applications. pam_set_data() stores module specific data within the PAM handle, pamh. The module_data_name argument uniquely identifies the data, and the data argument represents the actual data. module_data_name should be unique across all s... |
|
pam_set_item(3) -- authentication information routines for PAM
|
|
pam_get_item() and pam_set_item() allow applications and PAM service modules to access and update PAM information as needed. The information is specified by item_type, and can be one of the following: PAM_SERVICE The service name. PAM_USER The user name. PAM_AUTHTOK The user authentication token. PAM_OLDAUTHTOK The old user authentication token. PAM_TTY The tty name. PAM_RHOST The remote host name... |
|
pam_sm(3) -- PAM Service Module APIs
|
|
PAM gives system administrators the flexibility of choosing any authentication service available on the system to perform authentication. The framework also allows new authentication service modules to be plugged in and made available without modifying the applications. The PAM framework, libpam, consists of an interface library and multiple authentication service modules. The PAM interface librar... |
|
pam_sm_acct_mgmt(3) -- Service provider implementation for pam_acct_mgmt
|
|
In response to a call to pam_acct_mgmt(3), the PAM framework calls pam_sm_acct_mgmt() from the modules listed in the pam.conf(4) file. The account management provider supplies the back-end functionality for this interface function. The applications should not call this API directly. The function, pam_sm_acct_mgmt(), determines whether the current user's account and password are valid. This includ... |
|
pam_sm_authenticate(3) -- Service provider implementation for pam_authenticate
|
|
In response to a call to pam_authenticate(3), the PAM framework calls pam_sm_authenticate() from the modules listed in the pam.conf(4) file. The authentication provider supplies the back-end functionality for this interface function. The function, pam_sm_authenticate(), is called to verify the identity of the current user. The user is usually required to enter a password or similar authentication ... |
|
pam_sm_chauthtok(3) -- Service provider implementation for pam_chauthtok
|
|
In response to a call to pam_chauthtok() the PAM framework calls pam_sm_chauthtok() from the modules listed in the pam.conf(4) file. The password management provider supplies the back-end functionality for this interface function. pam_sm_chauthtok() changes the authentication token associated with a particular user referenced by the authentication handle, pamh. The following flag may be passed in ... |
|
pam_sm_close_session(3) -- Service provider implementation for pam_open_session and pam_close_session respectively
|
|
In response to a call to pam_open_session() and pam_close_session(), the PAM framework calls pam_sm_open_session() and pam_sm_close_session(), respectively from the modules listed in the pam.conf(4) file. The session management provider supplies the backend functionality for this interface function. pam_sm_open_session() is called to initiate session management. pam_sm_close_session() is invoked w... |
|
pam_sm_open_session(3) -- Service provider implementation for pam_open_session and pam_close_session respectively
|
|
In response to a call to pam_open_session() and pam_close_session(), the PAM framework calls pam_sm_open_session() and pam_sm_close_session(), respectively from the modules listed in the pam.conf(4) file. The session management provider supplies the backend functionality for this interface function. pam_sm_open_session() is called to initiate session management. pam_sm_close_session() is invoked w... |
|
pam_sm_setcred(3) -- Service provider implementation for pam_setcred
|
|
In response to a call to pam_setcred(), the PAM framework calls pam_sm_setcred() from the modules listed in the pam.conf(4) file. The authentication provider supplies the back-end functionality for this interface function. pam_sm_setcred() is called to set the credentials of the current user associated with the authentication handle, pamh. The following flags may be set in the flags field. Note th... |
|
pam_start(3) -- authentication transaction routines for PAM
|
|
pam_start() is called to initiate an authentication transaction. pam_start() takes as arguments the name of the current service, service, the name of the user to be authenticated, user, the address of the conversation structure, pam_conv, and the address of a variable to be assigned the authentication handle, pamh. Upon successful completion, pamh will refer to a PAM handle for use with subsequent... |
|
pam_strerror(3) -- get PAM error message string
|
|
pam_strerror() maps the PAM error number in errnum to a PAM error message string, and returns a pointer to that string. The application should not free or modify the string returned. The pamh argument is the PAM handle obtained by a prior call to pam_start(). If pam_start() returns an error, a NULL PAM handle should be passed. |
|
putdvagnam(3) -- manipulate device assignment database entry for a trusted system
|
|
getdvagent, getdvagnam, and copydvagent each return a pointer to an object with the following structure containing the broken-out fields of an entry in the Device Assignment database. Each database entry is returned as a dev_asg structure, declared in the header file: struct dev_field { char *fd_name; /* external name */ char **fd_devs; /* device list */ mask_t fd_type[1]; /* tape, printe... |
|
putprdfnam(3) -- manipulate system default database entry for a trusted system
|
|
getprdfent and getprdfnam each returns a pointer to an object with the following structure containing the broken-out fields of a line in the system default database. Each line in the database contains a pr_default structure, declared in the header file: struct system_default_fields { time_t fd_inactivity_timeout ; char fd_boot_authenticate ; } ; struct system_default_flags { unsigned shor... |
|
putprpwnam(3) -- manipulate protected password database entries (for trusted systems only).
|
|
getprpwent, getprpwuid, getprpwaid, and getprpwnam each returns a pointer to a pr_passwd structure containing the broken-out fields of a line in the protected password database. Each line in the database contains a pr_passwd structure, declared in the header file: struct pr_field { /* Identity: */ char fd_name[9]; /* uses 8 character maximum(and NULL) from utmp */ uid_t fd_uid; /* uid ass... |
|
putprtcnam(3) -- manipulate terminal control database entry for a trusted system
|
|
getprtcent and getprtcnam each returns a pointer to an object with the following structure containing the broken-out fields of an entry in the terminal control database. Each entry in the database contains a pr_term structure, declared in the header file: struct t_field { char fd_devname[14]; /* Terminal (or host) name */ uid_t fd_uid; /* uid of last successful login */ time_t fd_slogin; ... |
|
RectObj(3) -- The RectObj widget class
|
|
RectObj is never instantiated. Its sole purpose is as a supporting superclass for other widget classes. |
|
request_init(3) -- access control library
|
|
The routines described here are a part of the libwrap.a library. They implement a rule-based access control language with optional shell commands that are executed when a rule fires. request_init() initializes a structure with information about a client request. request_set() updates an already initialized request structure. Both functions take a variable-length list of key-value pairs and return ... |
|
request_set(3) -- access control library
|
|
The routines described here are a part of the libwrap.a library. They implement a rule-based access control language with optional shell commands that are executed when a rule fires. request_init() initializes a structure with information about a client request. request_set() updates an already initialized request structure. Both functions take a variable-length list of key-value pairs and return ... |
|
secdef(3) -- security defaults configuration file routines
|
|
open_secdef opens the security configuration file /etc/default/security. This function must be called prior to calling get_secdef_str or get_secdef_int. close_secdef closes the security configuration file. get_secdef_str and get_secdef_int return the value of the specified parameter defined in the security configuration file. See the security(4) manpage. Programs using these routines must be compi... |
|
setdvagent(3) -- manipulate device assignment database entry for a trusted system
|
|
getdvagent, getdvagnam, and copydvagent each return a pointer to an object with the following structure containing the broken-out fields of an entry in the Device Assignment database. Each database entry is returned as a dev_asg structure, declared in the header file: struct dev_field { char *fd_name; /* external name */ char **fd_devs; /* device list */ mask_t fd_type[1]; /* tape, printe... |
|
setprdfent(3) -- manipulate system default database entry for a trusted system
|
|
getprdfent and getprdfnam each returns a pointer to an object with the following structure containing the broken-out fields of a line in the system default database. Each line in the database contains a pr_default structure, declared in the header file: struct system_default_fields { time_t fd_inactivity_timeout ; char fd_boot_authenticate ; } ; struct system_default_flags { unsigned shor... |
|
setprpwent(3) -- manipulate protected password database entries (for trusted systems only).
|
|
getprpwent, getprpwuid, getprpwaid, and getprpwnam each returns a pointer to a pr_passwd structure containing the broken-out fields of a line in the protected password database. Each line in the database contains a pr_passwd structure, declared in the header file: struct pr_field { /* Identity: */ char fd_name[9]; /* uses 8 character maximum(and NULL) from utmp */ uid_t fd_uid; /* uid ass... |
|
setprtcent(3) -- manipulate terminal control database entry for a trusted system
|
|
getprtcent and getprtcnam each returns a pointer to an object with the following structure containing the broken-out fields of an entry in the terminal control database. Each entry in the database contains a pr_term structure, declared in the header file: struct t_field { char fd_devname[14]; /* Terminal (or host) name */ uid_t fd_uid; /* uid of last successful login */ time_t fd_slogin; ... |
|
Shell(3) -- The Shell widget class
|
|
Shell is a top-level widget (with only one managed child) that encapsulates the interaction with the window manager. At the time the shell's child is managed, the child's width is used for both widgets if the shell is unrealized and no width has been specified for the shell. Otherwise, the shell's width is used for both widgets. The same relations hold for the height of the shell and its child. |
|
TopLevelShell(3) -- The TopLevelShell widget class
|
|
TopLevelShell is used for normal top-level windows such as any additional top-level widgets an application needs. |
|
TransientShell(3) -- The TransientShell widget class
|
|
TransientShell is used for shell windows that can be manipulated by the window manager, but are not allowed to be iconified separately. For example, DialogBoxes make no sense without their associated application. They are iconified by the window manager only if the main application shell is iconified. |
|
ttdt_close(3) -- destroy a ToolTalk communication endpoint
|
|
The ttdt_close function destroys a ToolTalk communication endpoint. If sendStopped is True, the ttdt_close function sends a Stopped notice; otherwise, it sends no notice. If procid is not NULL, ttdt_close calls tt_default_procid_set with a procid argument and then calls tt_close; otherwise, it closes the current default procid. If new_procid is not NULL, ttdt_close calls tt_default_procid_set with... |
|
ttdt_file_event(3) -- use ToolTalk to announce an event about a file
|
|
The ttdt_file_event function is used to create and send a ToolTalk notice announcing an event pertaining to a file. The file is indicated by the pathname argument that was passed to ttdt_file_join(3) when patterns was created. The event argument identifies the event. If event is TTDT_MODIFIED, ttdt_file_event registers in the the_scope argument passed to ttdt_file_join(3) to handle Get_Modified, S... |
|
ttdt_file_join(3) -- register to observe ToolTalk events on a file
|
|
The ttdt_file_join function registers to observe Deleted, Modified, Reverted, Moved, and Saved notices. If join is True, ttdt_file_join calls tt_file_join with a pathname argument. The the_scope argument identifies the scope of the request. If the_scope is TT_SCOPE_NONE, it tries TT_BOTH, and falls back to TT_FILE_IN_SESSION if, for example, the ToolTalk database server is not installed on the fil... |
|
ttdt_file_notice(3) -- create and send a standard ToolTalk notice about a file
|
|
The ttdt_file_notice function is used to create (and optionally send) any of the standard file notices: Created, Deleted, Moved, Reverted, Saved, and Modified. The ttdt_file_notice function creates a notice with the specified op and scope, and sets its file attribute to pathname. The function adds an unset argument of Tt_mode TT_IN and vtype File to the notice, per the Desktop messaging convention... |
|
ttdt_file_quit(3) -- unregister interest in ToolTalk events about a file
|
|
The ttdt_file_quit function is used to unregister interest in the pathname that was passed to ttdt_file_join(3) when patterns was created. The ttdt_file_quit function destroys patterns and sets the default file to NULL. If quit is True, ttdt_file_quit calls tt_file_quit(3) with a pathname argument; otherwise, it returns without quitting. |
|
ttdt_file_request(3) -- create and send a standard ToolTalk request about a file
|
|
The ttdt_file_request function is used to create (and optionally send) any of the standard Desktop file requests such as Get_Modified, Save, and Revert. The ttdt_file_request function creates a request with the specified op and scope, and sets its file attribute to pathname. The function adds an unset argument of Tt_mode TT_IN and vtype File to the request, per the Desktop messaging conventions. I... |
|
ttdt_Get_Modified(3) -- ask if any ToolTalk client has changes pending on a file
|
|
The ttdt_Get_Modified function sends a Get_Modified request in the scope the_scope and waits for the reply. A Get_Modified request asks if any ToolTalk client has changes pending on pathname that it intends to make persistent. The context argument describes the environment to use. If context is not zero, messages created by ttdt_Get_Modified inherit from context all contexts whose slotname begins ... |
|
ttdt_message_accept(3) -- accept a contract to handle a ToolTalk request
|
|
The ttdt_message_accept function registers in the default session for TT_HANDLER-addressed requests: 1. Get_Geometry, Set_Geometry, Get_Iconified, Set_Iconified, Get_Mapped, Set_Mapped, Raise, Lower, Get_XInfo 2. Pause, Resume 3. Quit, Get_Status If the shell argument is not NULL, the ToolTalk service handles messages in (1) transparently; otherwise, it treats them like messages in (3). If shell i... |
|
ttdt_open(3) -- create a ToolTalk communication endpoint
|
|
The ttdt_open function calls tt_open(3) and tt_fd(3). It associates toolname, vendor and version with the created procid, and initializes the new procid's default contexts from the process environment. If sendStarted is True, ttdt_open sends a Started notice. |
|
ttdt_Revert(3) -- request a ToolTalk client to revert a file
|
|
The ttdt_Revert function sends a Revert request in the the_scope argument and waits for the reply. A Revert request asks the handling ToolTalk client to discard any changes pending on pathname. The context argument describes the environment to use. If context is not zero, messages created by ttdt_Revert inherit from context all contexts whose slotname begins with the characters ENV_. The the_scope... |
|
ttdt_Save(3) -- request a ToolTalk client to save a file
|
|
The ttdt_Save function sends a Save request in the the_scope argument and waits for the reply. A Save request asks the handling ToolTalk client to save any changes pending on pathname. The context argument describes the environment to use. If context is not zero, messages created by ttdt_Save inherit from context all contexts whose slotname begins with the characters ENV_. The the_scope argument i... |
|
ttdt_sender_imprint_on(3) -- act like a child of the specified tool
|
|
The ttdt_sender_imprint_on function is used to make the calling tool act equivalently to a child of another specified tool. The calling tool adopts the other tool's X11 display, locale, and current working directory. It also learns the other tool's X11 geometry, so that it may position itself appropriately. If the handler argument is non- NULL, the requests are addressed to that procid using TT_... |
|
ttdt_session_join(3) -- join a ToolTalk session
|
|
The ttdt_session_join function joins the session sessid, registering patterns and default callbacks for many standard Desktop message interfaces. If sessid is NULL, the default session is joined. The ttdt_session_join function registers for the following TT_HANDLER-addressed requests: 1. Get_Environment, Set_Environment, Get_Locale, Set_Locale, Get_Situation, Set_Situation, Signal, Get_Sysinfo 2. ... |
|
ttdt_session_quit(3) -- quit a ToolTalk session
|
|
The ttdt_session_quit function destroys the patterns in sess_pats. If quit is True, it quits the session sessid, or the default session if sessid is NULL. |
|
ttdt_subcontract_manage(3) -- manage an outstanding request
|
|
The ttdt_subcontract_manage function allows a requester to manage the standard Desktop interactions with the tool that is handling the request. The ttdt_subcontract_manage function registers in the default session for TT_HANDLER-addressed requests Get_Geometry and Get_XInfo, and Status notices. If shell is not NULL, the ToolTalk service handles the Get_Geometry and Get_XInfo notices transparently;... |
|
ttmedia_Deposit(3) -- send a Deposit request to checkpoint a document
|
|
The ttmedia_Deposit function is used to perform a checkpoint save on a document that was the subject of a Media Exchange load_contract request such as Edit, Compose, or Open. To carry out a checkpoint save, the editor must send the new document contents back to the sender of load_contract. The ttmedia_Deposit function creates and sends a Deposit request and returns the success or failure of that r... |
|
ttmedia_load(3) -- send a Display, Edit or Compose request
|
|
The ttmedia_load function is used to create and optionally send a Media Exchange request to display, edit or compose a document. The cb argument will be passed clientdata when the reply is received, or when intermediate versions of the document are checkpointed through Deposit requests. The op argument must be one of TTME_DISPLAY, TTME_EDIT or TTME_COMPOSE. The media_type argument names the data f... |
|
ttmedia_load_reply(3) -- reply to a Display, Edit or Compose request
|
|
The ttmedia_load_reply function is used to reply to a Media Exchange request to display, edit or compose a document. The editor working on the request usually calls ttmedia_load_reply when the user has indicated in some way that he or she is finished viewing or modifying the document. If new_contents and new_len are non- NULL and non-zero, respectively, ttmedia_load_reply uses their values to set ... |
|
ttmedia_ptype_declare(3) -- declare the ptype of a Media Exchange media editor
|
|
The ttmedia_ptype_declare function is used to initialize an editor that implements the Media Exchange message interface for a particular media type. The ttmedia_ptype_declare function notifies the ToolTalk service that the cb callback is to be called when the editor is asked to edit a document of the kind supported by ptype. The ttmedia_ptype_declare function installs an implementation-specific op... |
|
tttk_block_while(3) -- block while a counter is greater than zero
|
|
The tttk_block_while function is used to process asynchronous events, such as ToolTalk messages or window system events, while waiting for a condition or timeout. If app2run is not zero, then an event loop is run for that application context, by repeatedly calling XtAppProcessEvent(3) with ms_timeout being effected using XtAppAddTimeOut(3). If app2run is zero, then the file descriptor (as returned... |
|
tttk_message_abandon(3) -- finalize a message properly
|
|
The tttk_message_abandon function is used by an application when it does not understand a message and wants to get rid of it. The tttk_message_abandon function fails or rejects msg if appropriate, and then destroys it. The tttk_message_abandon will reject or fail the message only if msg is a TT_REQUEST in Tt_state TT_SENT. If it has a Tt_address of TT_HANDLER or a tt_message_status of TT_WRN_START... |
|
tttk_message_create(3) -- create a message conforming to the CDE conventions
|
|
The tttk_message_create function creates a message that propagates inherited contexts from one message to another. The tttk_message_create function creates a message and copies onto it all the context slots from context whose slotname begins with the characters ENV_. It gives the created message a Tt_class of the_class and a Tt_scope of the_scope. If handler is not NULL, then tttk_message_create a... |
|
tttk_message_destroy(3) -- destroy a message conforming to the CDE conventions
|
|
The tttk_message_destroy function can be used in place of tt_message_destroy(3). It destroys any patterns that may have been stored on msg by ttdt_message_accept(3) or ttdt_subcontract_manage(3). Then it passes msg to tt_message_destroy(3). |
|
tttk_message_fail(3) -- fail a message
|
|
The tttk_message_fail function sets the status and status string of the TT_REQUEST msg, fails msg, and then destroys msg if destroy is True. |
|
tttk_message_reject(3) -- reject a message
|
|
The tttk_message_reject function sets the status and status string of the TT_REQUEST msg, rejects the msg, and then destroys msg if destroy is True. |
|
tttk_op_string(3) -- map a ToolTalk op code to a string
|
|
The tttk_op_string function returns a string containing the op for opcode. |
|
tttk_string_op(3) -- map a string to a ToolTalk op code
|
|
The tttk_string_op function returns the Tttk_op named by opstring. |
|
tttk_Xt_input_handler(3) -- Process ToolTalk events for Xt clients
|
|
If procid is not NULL, tttk_Xt_input_handler passes it to tt_default_procid_set(3). The tttk_Xt_input_handler function then calls tt_message_receive(3), which retrieves the next message available, if any, for the default procid. If tt_message_receive(3) returns TT_ERR_NOMP, then tttk_Xt_input_handler closes the default procid with ttdt_close(3), and removes the input source *id with XtRemoveInput(... |
|
tt_bcontext_join(3) -- add a byte-array value to the list of values
|
|
The tt_bcontext_join function adds the given byte-array value to the list of values for the named contexts of all patterns. The context is compared to currently registered patterns for the procid. If a pattern has a slot with the specified name, the given byte-array value is added to the list of values for that slot. The slotname argument is the name of the context. The value argument is the value... |
|
tt_bcontext_quit(3) -- remove a byte-array value from the list of values
|
|
The tt_bcontext_quit function removes the given byte-array value from the list of values for the contexts of all patterns. The context is compared to currently registered patterns for the procid. If a pattern has a slot with the specified name, the given byte string value is removed from the list of values for that slot. If there are duplicate values, only one value is removed. The slotname argume... |
|
tt_close(3) -- close the current default procid
|
|
The tt_close function closes the current default procid. |
|
tt_context_join(3) -- add a string value to the list of values
|
|
The tt_context_join function adds the given string value to the list of values for the context of all patterns. The context is compared to currently registered patterns for the procid. If a pattern has a slot with the specified name, the given string value is added to the list of values for that slot. The slotname argument is the name of the context. The value argument is the value to be added. |
|
tt_context_quit(3) -- remove a string value from the list of values
|
|
The tt_context_quit function removes the given string value from the list of values for the contexts of all patterns. The context is compared to currently registered patterns for the procid. If a pattern has a slot with the specified name, tt_context_quit removes the given string value from the list of values for that slot. If there are duplicate values, only one value is removed. The slotname arg... |
|
tt_default_file(3) -- return the current default file
|
|
The tt_default_file function returns the current default file. When the application joins a file, the file becomes the default. |
|
tt_default_file_set(3) -- set the default file to a file
|
|
The tt_default_file_set function sets the default file to the specified file. The docid argument is a pointer to a character string that specifies the file that is to be the default file. |
|
tt_default_procid(3) -- identify the current default process
|
|
The tt_default_procid function retrieves the current default procid for the process. |
|
tt_default_procid_set(3) -- set the current default procid
|
|
The tt_default_procid_set function sets the current default procid. The procid argument is the name of process that is to be the default process. |
|
tt_default_ptype(3) -- retrieve the current default ptype
|
|
The tt_default_ptype function retrieves the current default ptype. When the application declares a ptype, the ptype becomes the default. |
|
tt_default_ptype_set(3) -- set the default ptype
|
|
The tt_default_ptype_set function sets the default ptype. The ptid argument must be the character string that uniquely identifies the process that is to be the default process. |
|
tt_default_session(3) -- retrieve the current default session identifier
|
|
The tt_default_session function retrieves the current default session identifier. |
|
tt_default_session_set(3) -- set the current default session identifier
|
|
The tt_default_session_set function sets the current default session identifier. The ToolTalk service uses the initial user session as the default session and supports one session per procid. The application can make this call before it calls tt_open(3) to specify the session to which it wants to connect. The sessid argument is a pointer to the unique identifier for the session in which the procid... |
|
tt_error(3) -- capture ToolTalk function errors
|
|
The tt_error function is a publicly-known null function. It is called by the ToolTalk library just before it returns from any ToolTalk API call that has a status other than TT_OK. The caller passes the name of the function that is about to return and the function's status code. You can use this function to set a dbx breakpoint to quickly catch and trace back any ToolTalk errors. You can also inte... |
|
tt_error_int(3) -- return an integer error object that encodes the code
|
|
The tt_error_int function returns an integer error object that encodes a Tt_status return value. The ttrc argument is the Tt_status code that is to be encoded. |
|
tt_error_pointer(3) -- return a pointer to an error object that encodes the code
|
|
The tt_error_pointer function returns a pointer to an error object that encodes a Tt_status return value. The ttrc argument is the Tt_status code that is to be encoded. |
|
tt_fd(3) -- return a file descriptor
|
|
The tt_fd function returns a file descriptor. The returned file descriptor alerts the process that a message has arrived for the default procid in the default session. File descriptors are either active or inactive. When the file descriptor becomes active, the process must call tt_message_receive(3) to receive the message. |
|
tt_feature_enabled(3) -- determine if a particular feature has been enabled in this process
|
|
The tt_feature_enabled function queries the ToolTalk service to see if the specified feature has previously been enabled. This allows a library that "wraps around" ToolTalk for sending and receiving messages to determine if multithreaded execution has been enabled by the main program, and to modify its behavior accordingly. |
|
tt_feature_required(3) -- declare a feature to be required by the calling program.
|
|
The tt_feature_required function declares a feature to be required by the calling code. If the feature is available, tt_feature_required enables it. If the feature requires the ToolTalk service to perform some initialization (for example, TT_FEATURE_MULTITHREADED), the initialization is performed in this call. Some features (such as TT_FEATURE_MULTITHREADED) require this call to be made before cal... |
|
tt_file_copy(3) -- copy objects from one file to a new file
|
|
The tt_file_copy function copies all objects that exist on the specified file to a new file. If any objects already exist on newfilepath, they are not overwritten by the copy (that is, they are not removed.) The oldfilepath argument is a pointer to the name of the file whose objects are to be copied. The newfilepath argument is a pointer to the name of the file on which to create the copied object... |
|
tt_file_destroy(3) -- remove objected rooted on a file
|
|
The tt_file_destroy function removes all objects that exist on the files and directories rooted at filepath. The application must call this function when the application unlinks a file or removes a directory. The filepath argument is a pointer to the pathname of the file or directory to be removed. |
|
tt_file_join(3) -- register interest in messages involving a file
|
|
The tt_file_join function informs the ToolTalk service that the process is interested in messages that involve the specified file. The ToolTalk service adds this file value to any currently registered patterns. The named file becomes the default file. When the process joins a file, the ToolTalk service updates the file field of its registered patterns. The tt_file_join call causes the pattern's T... |
|
tt_file_move(3) -- move objects from one file to another
|
|
The tt_file_move function destroys all objects that exist on the files and directories rooted at newfilepath, then moves all objects that exist on oldfilepath to newfilepath. If oldfilepath and newfilepath reside in the same file system, tt_file_move replaces oldfilepath with newfilepath in the path associated with every object in that file system; that is, all the objects in the directory tree ro... |
|
tt_file_netfile(3) -- map between local and canonical pathnames on the local host
|
|
The tt_file_netfile function converts a local pathname to a netfilename, a form that can be passed to other hosts on the network and converted back to a local pathname for the same file with tt_netfile_file(3). The filename argument is a pathname (absolute or relative) that is valid on the local host. Every component of filename must exist, except that the last component need not exist. |
|
tt_file_objects_query(3) -- find all objects in the named file
|
|
The tt_file_objects_query function instructs the ToolTalk service to find all objects in the named file and pass the objids to the filter function. The context pointer and accumulator pointer initially specified are also passed to the filter function. As the ToolTalk service finds each object, it calls the filter function, passing the objid of the object and the two applicationsupplied pointers. T... |
|
tt_file_quit(3) -- register lack of interest in messages that involve a file
|
|
The tt_file_quit function informs the ToolTalk service that the process is no longer interested in messages that involve the specified file. The ToolTalk service removes this file value from any currently registered patterns and sets the default file to NULL. The filepath argument is the name of the file in which the process is no longer interested. |
|
tt_free(3) -- free storage from the ToolTalk API allocation stack
|
|
The tt_free function frees storage from the ToolTalk API allocation stack. The p argument is the address of the storage in the ToolTalk API allocation stack to be freed. |
|
tt_host_file_netfile(3) -- map between local and canonical pathnames on a remote host
|
|
The tt_host_file_netfile function performs a conversion equivalent to that of the tt_file_netfile(3) function, but performs it on a remote host. The filename argument is a pathname (absolute or relative) that is valid on the remote host. Every component of filename must exist, except for the last component. The host argument is a name of a remote host. |
|
tt_host_netfile_file(3) -- map between canonical and local pathnames on a remote host
|
|
The tt_host_netfile_file function performs a conversion equivalent to that of the tt_netfile_file(3) function, but performs it on a remote host. The host argument is the host on which the file resides. The netfilename argument is a copy of a null-terminated string returned by tt_netfile_fileRETURN VALUEÂ Â Â Â RETURN VALUEÂ Â Â Â [Toc]Â Â Â Â |
|
tt_icontext_join(3) -- add an integer value to the list of values
|
|
The tt_icontext_join function adds the given integer value to the list of values for the contexts of all patterns. The context is compared to currently registered patterns for the procid. If a pattern has a slot with the specified name, the given integer value is added to the list of values for that slot. The slotname argument is the name of the context. The value argument is the value to be added... |
|
tt_icontext_quit(3) -- remove an integer value from the list of values
|
|
The tt_icontext_quit function removes the given integer value from the list of values for the contexts of all patterns. The context is compared to currently registered patterns for the procid. If a pattern has a slot with the specified name, the given integer value is removed from the list of values for that slot. If there are duplicate values, only one value is removed. The slotname argument is t... |
|
tt_initial_session(3) -- return the initial session identifier
|
|
The tt_initial_session function returns the initial session identifier of the ttsession(1) with which the current process identifier is associated. The current process identifier is obtained by calling tt_open(3). |
|
tt_int_error(3) -- return the status of an error object
|
|
The tt_int_error function returns the status of an error object. The return_val argument is the integer returned by a ToolTalk function. |
|
tt_is_err(3) -- check status value
|
|
The tt_is_err function checks whether a status value is a warning or an error. The s argument is the Tt_status code to check. |
|
tt_malloc(3) -- allocate storage on the ToolTalk API allocation stack
|
|
The tt_malloc function allocates storage on the ToolTalk API allocation stack. The s argument is the amount of storage to be allocated in bytes. |
|
tt_mark(3) -- mark a storage position in the ToolTalk API allocation stack
|
|
The tt_mark function marks a storage position in the ToolTalk API allocation stack. |
|
tt_message_abstainer(3) -- return offer's nth abstaining procid
|
|
The tt_message_abstainer function returns the procid of the nth abstainer of the specified message. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the abstainer to be returned. The first abstainer is numbered zero. |
|
tt_message_abstainers_count(3) -- return a count of the offer's abstaining procids
|
|
The tt_message_abstainers_count function returns a count of the procids that are recorded in the offer m as having abstained from it. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_accept(3) -- declare that the process has been initialized and can accept messages
|
|
The tt_message_accept function declares that the process has been initialized and can accept messages. The ToolTalk service invokes this function for start messages. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_accepter(3) -- return offer's nth accepting procid
|
|
The tt_message_accepter function returns the procid of the nth accepter of the specified message. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the accepter to be returned. The first accepter is numbered zero. |
|
tt_message_accepters_count(3) -- return a count of the offer's accepting procids
|
|
The tt_message_accepters_count function returns a count of the procids that are recorded in the offer m as having accepted it. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_address(3) -- retrieve the address attribute from a message
|
|
The tt_message_address function retrieves the address attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_address_set(3) -- set the address attribute for a message
|
|
The tt_message_address_set function sets the address attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The a argument specifies which message attributes form the address to which the message will be delivered. The following values are defined: TT_HANDLER The message is addressed to a specific handler that can perform this operation... |
|
tt_message_args_count(3) -- return the number of arguments in the message
|
|
The tt_message_args_count function returns the number of arguments in the message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_arg_add(3) -- add a new argument to a message object
|
|
The tt_message_arg_add function adds a new argument to a message object. The application must add all arguments before the message is sent. To change existing argument values, the application must use only modes TT_OUT or TT_INOUT. Adding arguments when replying to a message produces undefined results. The m argument is the opaque handle for the message involved in this operation. The n argument s... |
|
tt_message_arg_bval(3) -- retrieve the byte-array value of a message argument
|
|
The tt_message_arg_bval function retrieves the byte-array value of the nth message argument. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the argument to be retrieved. The first argument is numbered zero. The value argument is the address of a character pointer to which the ToolTalk service is to point a string that contains the co... |
|
tt_message_arg_bval_set(3) -- set the byte-array value and type of a message argument
|
|
The tt_message_arg_bval_set function sets the byte-array value and the type of the nth message argument. This function also changes the value of an existing nth message argument to a byte string. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the argument to set. The first argument is numbered zero. The value argument is the byte str... |
|
tt_message_arg_ival(3) -- retrieve the integer value of a message argument
|
|
The tt_message_arg_ival function retrieves the integer value of the nth message argument. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the argument to be retrieved. The first argument is numbered zero. The value argument is a pointer to an integer where the ToolTalk service is to store the contents of the argument. |
|
tt_message_arg_ival_set(3) -- add an integer value in a message argument
|
|
The tt_message_arg_ival_set function adds an integer value in the nth message argument. This function also changes the value of an existing nth message argument to an integer. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the argument to be set. The first argument is numbered zero. The value argument is the contents for the message ... |
|
tt_message_arg_mode(3) -- return the mode of a message argument
|
|
The tt_message_arg_mode function returns the mode of the nth message argument. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the argument to be returned. The first argument is numbered zero. |
|
tt_message_arg_type(3) -- retrieve the type of a message argument
|
|
The tt_message_arg_type function retrieves the type of the nth message argument. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the argument to be retrieved. The first argument is numbered zero. |
|
tt_message_arg_val(3) -- return a pointer to the value of a message argument
|
|
The tt_message_arg_val function returns a pointer to the value of the nth message argument. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the argument to be returned. The first argument is numbered zero. |
|
tt_message_arg_val_set(3) -- change the value of a message argument
|
|
The tt_message_arg_val_set function changes the value of the nth message argument. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the argument to be changed. The first argument is numbered zero. The value argument is the contents for the message argument. |
|
tt_message_arg_xval(3) -- retrieve and deserialize the data from a message argument
|
|
The tt_message_arg_xval function retrieves and deserializes the data from a message argument. This function uses an XDR routine that is supplied by the client. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the argument to be returned. The first argument is numbered zero. The xdr_proc argument points to the XDR procedure to be used t... |
|
tt_message_arg_xval_set(3) -- serialize and set data into an existing message argument
|
|
The tt_message_arg_xval_set function serializes and sets data into an existing message argument. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the argument to be changed. The first argument is numbered zero. The xdr_proc argument causes tt_message_arg_xval_set to serialize the data pointed to by value and store it as a byte string v... |
|
tt_message_barg_add(3) -- add an argument to a pattern
|
|
The tt_message_barg_add function adds an argument to a pattern that may have a byte-array value that contains embedded nulls. To change existing argument values, the application must use only modes TT_OUT or TT_INOUT. Adding arguments when replying to a message produces undefined results. The m argument is the opaque handle for the message involved in this operation. The n argument specifies who (... |
|
tt_message_bcontext_set(3) -- set the byte-array value of a message's context
|
|
The tt_message_bcontext_set function sets the byte-array value of a message's context. This function overwrites any previous value associated with slotname. The m argument is the opaque handle for the message involved in this operation. The slotname argument describes the slotname in this message. The value argument is the byte string with the contents for the message argument. The length argumen... |
|
tt_message_callback_add(3) -- register a callback function
|
|
The tt_message_callback_add function registers a callback function to be automatically invoked by tt_message_receive(3) whenever a reply or other state-change to this message is returned. The callback is defined in Tt/tt_c.h - Tttt_c(5). If the callback returns TT_CALLBACK_CONTINUE, other callbacks will be run; if no callback returns TT_CALLBACK_PROCESSED, tt_message_receive returns the message. I... |
|
tt_message_class(3) -- retrieve the class attribute from a message
|
|
The tt_message_class function retrieves the class attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_class_set(3) -- set the class attribute for a message
|
|
The tt_message_class_set function sets the class attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The c argument indicates whether an action is to take place after the message is received. The following values are defined: TT_NOTICE A notice of an event. The sender does not want feedback on this message. TT_REQUEST A request for s... |
|
tt_message_contexts_count(3) -- return the number of contexts in a message
|
|
The tt_message_contexts_count function returns the number of contexts in a message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_context_bval(3) -- retrieve the byte-array value and length of a message's context
|
|
The tt_message_context_bval function retrieves the byte-array value and length of a message's context. If there is no context slot associated with slotname, tt_message_context_bval returns zero in slotname and zero in len. The m argument is the opaque handle for the message involved in this operation. The slotname argument describes the context of this message. The value argument points to the lo... |
|
tt_message_context_ival(3) -- retrieve the integer value of a message's context
|
|
The tt_message_context_ival function retrieves the integer value of a message's context. The m argument is the opaque handle for the message involved in this operation. The slotname argument describes the context of this message. The value argument points to the location to return the value. If there is no context slot associated with slotname, tt_message_context_ival returns a NULL pointer in *v... |
|
tt_message_context_set(3) -- set the character string value of a message's context
|
|
The tt_message_context_set function sets the character string value of a message's context. The m argument is the opaque handle for the message involved in this operation. The slotname argument describes the context of this message. This function overwrites any previous value associated with slotname. The value argument is the character string to be set. |
|
tt_message_context_slotname(3) -- return the name of a message's nth context
|
|
The tt_message_context_slotname function returns the name of a message's nth context. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the context to be retrieved. The first context is numbered zero. |
|
tt_message_context_val(3) -- retrieve the character string of a message's context
|
|
The tt_message_context_val function retrieves the character string of a message's context. The m argument is the opaque handle for the message involved in this operation. The slotname argument describes the context of this message. If there is no context slot associated with slotname, tt_message_context_val returns a NULL pointer. |
|
tt_message_context_xval(3) -- retrieve and deserialize the data from a message's context
|
|
The tt_message_context_xval function retrieves and deserializes the data from a message's context. The m argument is the opaque handle for the message involved in this operation. The slotname argument describes the context of this message. The xdr_proc argument points to the XDR procedure to be used to deserialize the data in the nth argument into newly allocated storage, the address of which wil... |
|
tt_message_create(3) -- create a new message object
|
|
The tt_message_create function creates a new message object. The ToolTalk service returns a message handle that is an opaque pointer to a ToolTalk structure. |
|
tt_message_create_super(3) -- create and re-address a copy of a message
|
|
The tt_message_create_super function creates a copy of the specified message and re-addresses the copy of the message to the parent of the otype contained within the message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_destroy(3) -- destroy a message
|
|
The tt_message_destroy function destroys the message. Destroying a message has no effect on the delivery of a message already sent. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_disposition(3) -- retrieve the disposition attribute from a message
|
|
The tt_message_disposition function retrieves the disposition attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_disposition_set(3) -- set the disposition attribute for a message
|
|
The tt_message_disposition_set function sets the disposition attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The r argument indicates whether an instance of the receiving process is to be started to receive the message immediately, or whether the message is to be queued until the receiving process is started at a later time. The ... |
|
tt_message_fail(3) -- indicate a message cannot be handled
|
|
The tt_message_fail function informs the ToolTalk service that the process cannot handle the request just received. This function also informs the ToolTalk service that the message is not be offered to other processes of the same ptype. The ToolTalk service will send the message back to the sender with state TT_FAILED. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_file(3) -- retrieves the file attribute from a message
|
|
The tt_message_file function retrieves the file attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_file_set(3) -- set the file attribute for a message
|
|
The tt_message_file_set function sets the file attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The file argument is the name of the file involved in this operation. |
|
tt_message_gid(3) -- retrieve the group identifier attribute from a message
|
|
The tt_message_gid function retrieves the group identifier attribute from the specified message. The ToolTalk service automatically sets the group identifier of a message with the group identifier of the process that created the message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_handler(3) -- retrieve the handler attribute from a message
|
|
The tt_message_handler function retrieves the handler attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_handler_ptype(3) -- retrieve the handler ptype attribute from a message
|
|
The tt_message_handler_ptype function retrieves the handler ptype attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_handler_ptype_set(3) -- set the handler ptype attribute for a message
|
|
The tt_message_handler_ptype_set function sets the handler ptype attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The ptid argument is the type of process that is to handle this message. |
|
tt_message_handler_set(3) -- set the handler attribute for a message
|
|
The tt_message_handler_set function sets the handler attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The procid argument is the character value that uniquely identifies the process that is to handle the message. |
|
tt_message_iarg_add(3) -- add a new argument to a message object
|
|
The tt_message_iarg_add function adds a new argument to a message object and sets the value to a given integer. Add all arguments before the message is sent. To change existing argument values, the application must use only modes TT_OUT or TT_INOUT. Adding arguments when replying to a message produces undefined results. The m argument is the opaque handle for the message involved in this operation... |
|
tt_message_icontext_set(3) -- set the integer value of a message's context
|
|
The tt_message_icontext_set function sets the integer value of a message's context. This function overwrites any previous value associated with slotname. The m argument is the opaque handle for the message involved in this operation. The slotname argument describes the context of this message. The value argument is the integer value to be set. |
|
tt_message_id(3) -- retrieve the identifier of a message
|
|
The tt_message_id function retrieves the identifier of the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_object(3) -- retrieve the object attribute from a message
|
|
The tt_message_object function retrieves the object attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_object_set(3) -- set the object attribute for a message
|
|
The tt_message_object_set function sets the object attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The objid argument is the identifier of the specified object. |
|
tt_message_op(3) -- retrieve the operation attribute from a message
|
|
The tt_message_op function retrieves the operation attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_opnum(3) -- retrieve the operation number attribute from a message
|
|
The tt_message_opnum function retrieves the operation number attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_op_set(3) -- set the operation attribute for a message
|
|
The tt_message_op_set function sets the operation attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The opname argument is the operation that the receiving process is to perform. |
|
tt_message_otype(3) -- retrieve the object type attribute from a message
|
|
The tt_message_otype function retrieves the object type attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_otype_set(3) -- set the otype attribute for a message
|
|
The tt_message_otype_set function sets the object type (otype) attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The otype argument is the type of the object involved in this message. |
|
tt_message_pattern(3) -- return the pattern matched by a message
|
|
The tt_message_pattern function returns the pattern that the specified message matched. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_print(3) -- format a message
|
|
The tt_message_print function formats a message in the same way a message is formatted for the ttsession(1) trace and returns a string containing it. The m argument is the message to be formatted. |
|
tt_message_receive(3) -- receive a message
|
|
The tt_message_receive function returns a handle for the next message queued to be delivered to the process and also runs any message or pattern callbacks applicable to the queued message. If the return value of tt_message_status(3) for this message is TT_WRN_START_MESSAGE, the ToolTalk service started the process to deliver the queued message; the process must reply to this message. If the return... |
|
tt_message_reject(3) -- reject a message
|
|
The tt_message_reject function informs the ToolTalk service that the process cannot handle this message. The ToolTalk service will attempt to deliver the message to other handlers. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_rejecter(3) -- return offer's nth rejecting procid
|
|
The tt_message_rejecter function returns the procid of the nth rejecter of the specified message. The m argument is the opaque handle for the message involved in this operation. The n argument is the number of the rejecter to be returned. The first rejecter is numbered zero. |
|
tt_message_rejecters_count(3) -- return a count of the offer's rejecting procids
|
|
The tt_message_rejecters_count function returns a count of the procids that are recorded in the offer m as having rejected it. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_reply(3) -- reply to a message
|
|
The tt_message_reply function informs the ToolTalk service that the process has handled the message and filled in all return values. The ToolTalk service sends the message back to the sending process and fills in the state attribute with TT_HANDLED. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_scope(3) -- retrieve the scope attribute from a message
|
|
The tt_message_scope function retrieves the scope attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_scope_set(3) -- set the scope attribute for a message
|
|
The tt_message_scope_set function sets the scope attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The s argument identifies the set of processes eligible to receive the message. The following values are defined: TT_SESSION All processes joined to the indicated session are eligible. TT_FILE All processes joined to the indicated fil... |
|
tt_message_send(3) -- send a message
|
|
The tt_message_send function sends the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_sender(3) -- retrieve the sender attribute from a message
|
|
The tt_message_sender function retrieves the sender attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_sender_ptype(3) -- retrieve the sender ptype attribute from a message
|
|
The tt_message_sender_ptype function retrieves the sender ptype attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_sender_ptype_set(3) -- set the sender ptype attribute for a message
|
|
The tt_message_sender_ptype_set function sets the sender ptype attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The ptid argument is the type of process that is sending this message. |
|
tt_message_send_on_exit(3) -- set up a message to send upon unexpected exit
|
|
The tt_message_send_on_exit function requests that the ToolTalk service send this message if the process exits unexpectedly. The message is sent to the ToolTalk service, which queues the message internally until either of two events occur: 1. The procid that sent the tt_message_send_on_exit message to the ToolTalk service calls tt_close(3). In this case, the queued message is deleted. 2. The conne... |
|
tt_message_session(3) -- retrieve the session attribute from a message
|
|
The tt_message_session function retrieves the session attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_session_set(3) -- set the session attribute for a message
|
|
The tt_message_session_set function sets the session attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The sessid argument is the identifier of the session in which the process is interested. |
|
tt_message_state(3) -- retrieve the state attribute from a message
|
|
The tt_message_state function retrieves the state attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_status(3) -- retrieve the status attribute from a message
|
|
The tt_message_status function retrieves the status attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_status_set(3) -- set the status attribute for a message
|
|
The tt_message_status_set function sets the status attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. The status argument is the status to be stored in this message. |
|
tt_message_status_string(3) -- retrieve the character string stored with the status attribute for a message
|
|
The tt_message_status_string function retrieves the character string stored with the status attribute for the specified message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_status_string_set(3) -- set a character string with the status attribute for a message
|
|
The tt_message_status_string_set function sets status string of the specified message. The m argument is the opaque handle for the message involved in this operation. The status_str argument is the status string to be stored in this message. |
|
tt_message_uid(3) -- retrieve the user identifier attribute from a message
|
|
The tt_message_uid function retrieves the user identifier attribute from the specified message. The ToolTalk service automatically sets the user identifier of a message with the user identifier of the process that created the message. The m argument is the opaque handle for the message involved in this operation. |
|
tt_message_user(3) -- retrieve the user information associated with a message object
|
|
The tt_message_user function retrieves the user information stored in data cells associated with the specified message object. The user data is part of the message object (that is, the storage buffer in the application); it is not a part of the actual message. The application can, therefore, only retrieve user information that the application placed in the message. The m argument is the opaque han... |
|
tt_message_user_set(3) -- stores user information associated with a message object
|
|
The tt_message_user_set function stores user information in data cells associated with the specified message object. The user data is part of the message object (that is, the storage buffer in the application); it is not part of the actual message. Data stored by the sending process in user data cells is not seen by handlers and observers. The application can use arguments for data that needs to b... |
|
tt_message_xarg_add(3) -- add an argument with an XDR-interpreted value to a message object
|
|
The tt_message_xarg_add function adds an argument with an XDRinterpreted value to a message object. To change existing argument values, the application must use only modes TT_OUT or TT_INOUT. Adding arguments when replying to a message produces undefined results. The m argument is the opaque handle for the message involved in this operation. The n argument specifies who (sender, handler, observers... |
|
tt_message_xcontext_set(3) -- set the XDR-interpreted byte-array value of a message's context
|
|
The tt_message_xcontext_set function sets the XDR-interpreted bytearray value of a message's context. The m argument is the opaque handle for the message involved in this operation. The slotname argument describes the slotname in this message. The value argument is the byte string with the contents for the message argument. The xdr_proc argument points to the XDR procedure to be used to serialize... |
|
tt_netfile_file(3) -- map between canonical and local pathnames on the local host
|
|
The tt_netfile_file function converts a netfilename of the format returned by tt_file_netfile(3) to a pathname that is valid on the local host. If the file is not currently mounted on the local host, tt_netfile_file constructs a pathname of the form: /mountpoint/host/filepath where mountpoint is the mount point pathname in the environment variable DTMOUNTPOINT, or /net if the variable is null or u... |
|
tt_objid_equal(3) -- test whether two objids are equal
|
|
The tt_objid_equal function tests whether two objids are equal. The tt_objid_equal(3) function is recommended rather than strcmp(3) for this purpose because the tt_objid_equal(3) function returns 1 even in the case where one objid is a forwarding pointer for the other. The objid1 argument is the identifier of the first object involved in this operation. The objid2 argument is the identifier of the... |
|
tt_objid_objkey(3) -- return the unique key of an objid
|
|
The tt_objid_objkey function returns the unique key of an objid. The objid argument is the identifier of the object involved in this operation. |
|
tt_onotice_create(3) -- create a notice
|
|
The tt_onotice_create function creates a message. The created message contains the following: Tt_address = TT_OBJECT Tt_class = TT_NOTICE The application can use the returned handle to add arguments and other attributes, and to send the message. The objid argument is the identifier of the specified object. The op argument is the operation to be performed by the receiving process. |
|
tt_open(3) -- return the process identifier for the calling process
|
|
The tt_open function returns the process identifier for the calling process. |
|
tt_orequest_create(3) -- create a request message
|
|
The tt_orequest_create function creates a message. The created message contains the following: Tt_address = TT_OBJECT Tt_class = TT_REQUEST The application can use the returned handle to add arguments and other attributes, and to send the message. The objid argument is the identifier of the specified object. The op argument is the operation to be performed by the receiving process. |
|
tt_otype_base(3) -- return the base otype of an otype
|
|
The tt_otype_base function returns the base otype of the given otype, or NULL if the given otype is not derived. The otype argument is the object type involved in this operation. |
|
tt_otype_derived(3) -- return the ith otype derived from the given otype
|
|
The tt_otype_derived function returns the ith otype derived from the given otype. The otype argument is the object type involved in this operation. The i argument is the zero-based index into the otypes derived from the given otype. |
|
tt_otype_deriveds_count(3) -- return the number of otypes derived from an otype
|
|
The tt_otype_deriveds_count function returns the number of otypes derived from the given otype. The otype argument is the object type involved in this operation. |
|
tt_otype_hsig_args_count(3) -- return the number of arguments of a request signature of an otype
|
|
The tt_otype_hsig_args_count function returns the number of arguments of the sigth request signature of the given otype. The otype argument is the object type involved in this operation. The sig argument is the zero-based index into the request signatures of the specified otype. |
|
tt_otype_hsig_arg_mode(3) -- return the mode of an argument of a request signature of an otype
|
|
The tt_otype_hsig_arg_mode function returns the mode of the argth argument of the sigth request signature of the given otype. The otype argument is the object type involved in this operation. The sig argument is the zero-based index into the request signatures of the specified otype. The arg argument is the zero-based index into the arguments of the specified signature. |
|
tt_otype_hsig_arg_type(3) -- return the data type of an argument of a request signature of an otype
|
|
The tt_otype_hsig_arg_type function returns the data type of the argth argument of the sigth request signature of the given otype. The otype argument is the object type involved in this operation. The sig argument is the zero-based index into the request signatures of the specified otype. The arg argument is the zero-based index into the arguments of the specified signature. |
|
tt_otype_hsig_count(3) -- return the number of request signatures for an otype
|
|
The tt_otype_hsig_count function returns the number of request signatures for the given otype. The otype argument is the object type involved in this operation. |
|
tt_otype_hsig_op(3) -- return the operation name of a request signature of an otype
|
|
The tt_otype_hsig_op function returns the operation name of the sigth request signature of the given otype. The otype argument is the object type involved in this operation. The sig argument is the zero-based index into the request signatures of the given otype. |
|
tt_otype_is_derived(3) -- indicate the otype derivations
|
|
The tt_otype_is_derived function specifies whether the derived otype is derived directly or indirectly from the base otype. The derivedotype argument is the specified derived otype. The baseotype argument is the specified base otype. |
|
tt_otype_opnum_callback_add(3) -- return a callback if two opnums are equal
|
|
The tt_otype_opnum_callback_add function adds a callback that is automatically invoked when a message is delivered because it matched a pattern derived from a signature in the named otype with an opnum equal to the specified one. The callback is defined in Tt/tt_c.h - Tttt_c(5). The otid argument is the identifier of the object type involved in this operation. The opnum argument is the opnum of th... |
|
tt_otype_osig_args_count(3) -- returns the number of arguments of a notice signature of an otype
|
|
The tt_otype_osig_args_count function returns the number of arguments of the sigth notice signature of the given otype. The otype argument is the object type involved in this operation. The sig argument is the zero-based index into the notice signatures of the specified otype. |
|
tt_otype_osig_arg_mode(3) -- return the mode of an argument of a notice signature of an otype
|
|
The tt_otype_osig_arg_mode function returns the mode of the argth argument of the sigth notice signature of the given otype. The otype argument is the object type involved in this operation. The sig argument is the zero-based index into the notice signatures of the specified otype. The arg argument is the zero-based index into the arguments of the specified signature. |
|
tt_otype_osig_arg_type(3) -- return the data type of an argument of a notice signature of an otype
|
|
The tt_otype_osig_arg_type function returns the data type of the argth argument of the sigth notice signature of the given otype. The otype argument is the object type involved in this operation. The sig argument is the zero-based index into the notice signatures of the specified otype. The arg argument is the zero-based index into the arguments of the specified signature. |
|
tt_otype_osig_count(3) -- return the number of notice signatures for an otype
|
|
The tt_otype_osig_count function returns the number of notice signatures for the given otype. The otype argument is the object type involved in this operation. |
|
tt_otype_osig_op(3) -- return the op name of a notice signature of an otype
|
|
The tt_otype_osig_op function returns the op name of the sigth notice signature of the given otype. The otype argument is the object type involved in this operation. The sig argument is the zero-based index into the notice signatures of the given otype. |
|
tt_pattern_address_add(3) -- add a value to the address field for a pattern
|
|
The tt_pattern_address_add function adds a value to the address field for the specified pattern. The p argument is a unique handle for a message pattern. This handle is returned after a tt_pattern_create(3) call has been made. The d argument specifies which pattern attributes form the address that messages will be matched against. The following values are defined: TT_HANDLER The message is address... |
|
tt_pattern_arg_add(3) -- add an argument to a pattern
|
|
The tt_pattern_arg_add function adds an argument to a pattern. The application must add pattern arguments before it registers the pattern with the ToolTalk service. The p argument is the opaque handle for the pattern involved in this operation The n argument specifies who (sender, handler, observers) writes and reads a message argument. The following modes are defined: TT_IN The argument is writte... |
|
tt_pattern_barg_add(3) -- add an argument with a value that contains embedded nulls to a pattern
|
|
The tt_pattern_barg_add function adds an argument with a value that contains embedded nulls to a pattern. The m argument is the opaque handle for the pattern involved in this operation. The n argument specifies who (sender, handler, observers) writes and reads a message argument. The following modes are defined: TT_IN The argument is written by the sender and read by the handler and any observers.... |
|
tt_pattern_bcontext_add(3) -- add a byte-array value to the values in this pattern's named context
|
|
The tt_pattern_bcontext_add function adds a byte-array value to the values in this pattern's named context. The p argument is the opaque handle for the pattern involved in this operation. The slotname argument describes the context for this pattern. The value argument is the byte string with the contents for the message context. The length argument is the length of the value in bytes. |
|
tt_pattern_callback_add(3) -- register a message-matching callback function
|
|
The tt_pattern_callback_add function registers a callback function that will be automatically invoked by tt_message_receive(3) whenever a message matches the pattern. The callback is defined in Tt/tt_c.h - Tttt_c(5). If the callback returns TT_CALLBACK_CONTINUE, other callbacks will be run; if no callback returns TT_CALLBACK_PROCESSED, tt_message_receive(3) returns the message. If the callback ret... |
|
tt_pattern_category(3) -- return the category value of a pattern
|
|
The tt_pattern_category function returns the category value of the specified pattern. The p argument is the opaque handle for a message pattern. |
|
tt_pattern_category_set(3) -- fill in the category field for a pattern
|
|
The tt_pattern_category_set function fills in the category field for the specified pattern. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The c argument indicates whether the receiving process will observe or handle messages. The following values are defined: TT_OBSERVE The receiving process will observe messages. TT_HANDLE T... |
|
tt_pattern_class_add(3) -- add a value to the class information for a pattern
|
|
The tt_pattern_class_add function adds a value to the class information for the specified pattern. If the class is TT_REQUEST, the sending process expects a reply to the message. If the class is TT_NOTICE, the sending process does not expect a reply to the message. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The c argument ... |
|
tt_pattern_context_add(3) -- add a string value to the values of this pattern's context
|
|
The tt_pattern_context_add function adds a string value to the values of this pattern's context. If the value pointer is NULL, a slot is created with the specified name but no value is added. The p argument is the opaque handle for the pattern involved in this operation. The slotname argument describes the context of this pattern. The value argument is the value to be added. |
|
tt_pattern_create(3) -- request a new pattern object
|
|
The tt_pattern_create function requests a new pattern object. After receiving the pattern object, the application fills in the message pattern fields to indicate what type of messages the process wants to receive and then registers the pattern with the ToolTalk service. The application can supply multiple values for each attribute added to a pattern (although some attributes are set and can only h... |
|
tt_pattern_destroy(3) -- destroy a pattern object
|
|
The tt_pattern_destroy function destroys a pattern object. Destroying a pattern object automatically unregisters the pattern with the ToolTalk service. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. |
|
tt_pattern_disposition_add(3) -- add a value to the disposition field for a pattern
|
|
The tt_pattern_disposition_add function adds a value to the disposition field for the specified pattern. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The r argument indicates whether an instance of the receiver is to be started to receive the message immediately, or whether the message is to be queued until the receiving pro... |
|
tt_pattern_file_add(3) -- add a value to the file field of a pattern
|
|
The tt_pattern_file_add function adds a value to the file field of the specified pattern. The application can use this call to set individual files on individual patterns. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The file argument is the name of the file of the specified pattern. |
|
tt_pattern_iarg_add(3) -- add a new integer argument to a pattern
|
|
The tt_pattern_iarg_add function adds a new argument to a pattern and sets the value to a given integer. Add all arguments before the pattern is registered with the ToolTalk service. The m argument is the opaque handle for the pattern involved in this operation. The n argument specifies who (sender, handler, observers) writes and reads a message argument. The following modes are defined: TT_IN The... |
|
tt_pattern_icontext_add(3) -- add an integer value to the values of this pattern's context
|
|
The tt_pattern_icontext_add function adds an integer value to the values of this pattern's context. The p argument is the opaque handle for the pattern involved in this operation. The slotname argument describes the slotname in this pattern. The value argument is the value to be added. |
|
tt_pattern_object_add(3) -- add a value to the object field of a pattern
|
|
The tt_pattern_object_add function adds a value to the object field of the specified pattern. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The objid argument is the identifier for the specified object. Both tt_spec_createRETURN VALUEÂ Â Â Â RETURN VALUEÂ Â Â Â [Toc]Â Â Â Â |
|
tt_pattern_opnum_add(3) -- add an operation number to a pattern
|
|
The tt_pattern_opnum_add function adds an operation number to the specified pattern. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The opnum argument is the operation number to be added. |
|
tt_pattern_op_add(3) -- add a value to the operation field of a pattern
|
|
The tt_pattern_op_add function adds a value to the operation field of the specified pattern. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The opname argument is the name of the operation the process can perform. |
|
tt_pattern_otype_add(3) -- add a value to the object type field for a pattern
|
|
The tt_pattern_otype_add function adds a value to the object type field for the specified pattern. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The otype argument is the name of the object type the application manages. |
|
tt_pattern_print(3) -- format a pattern
|
|
The tt_pattern_print function formats a pattern in the same way a message is formatted for the ttsession(1) trace and returns a string containing it. The p argument is the pattern to be formatted. |
|
tt_pattern_register(3) -- register a pattern with the ToolTalk service
|
|
The tt_pattern_register function registers a pattern with the ToolTalk service. When the process is registered, it will start receiving messages that match the specified pattern. Once a pattern is registered, no further changes can be made in the pattern. When the process joins a session or file, the ToolTalk service updates the file and session field of its registered patterns. The p argument is ... |
|
tt_pattern_scope_add(3) -- add a value to the scope field for a pattern
|
|
The tt_pattern_scope_add function adds a value to the scope field for the specified pattern. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The s argument specifies what processes are eligible to receive the message. The following values are defined: TT_SESSION All processes joined to the indicated session are eligible. TT_FIL... |
|
tt_pattern_sender_add(3) -- add a value to the sender field for a pattern
|
|
The tt_pattern_sender_add function adds a value to the sender field for the specified pattern. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The procid argument is the character value that uniquely identifies the process of interest. |
|
tt_pattern_sender_ptype_add(3) -- add a value to the sending process's ptype field for a pattern
|
|
The tt_pattern_sender_ptype_add function adds a value to the sending process's ptype field for the specified pattern. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The ptid argument is the character string that uniquely identifies the type of process in which the application is interested. |
|
tt_pattern_session_add(3) -- adds a value to the session field for a pattern
|
|
The tt_pattern_session_add function adds a value to the session field for the specified pattern. When the process joins a session, the ToolTalk service updates the session field of its registered patterns. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The sessid argument is the session of interest. |
|
tt_pattern_state_add(3) -- add a value to the state field for a pattern
|
|
The tt_pattern_state_add function adds a value to the state field for the specified pattern. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The s argument indicates the current delivery state of a message. The following values are defined: TT_CREATED The message has been created, but not yet sent. TT_SENT The message has been ... |
|
tt_pattern_unregister(3) -- unregister a pattern from the ToolTalk service
|
|
The tt_pattern_unregister function unregisters the specified pattern from the ToolTalk service. The process will stop receiving messages that match this pattern. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. |
|
tt_pattern_user(3) -- return the value in a user data cell for a pattern object
|
|
The tt_pattern_user function returns the value in the indicated user data cell for the specified pattern object. Every pattern object allows an arbitrary number of user data cells that are each one word in size. The user data cells are identified by integer keys. The tool can use these keys in any manner to associate arbitrary data with a pattern object. The user data is part of the pattern object... |
|
tt_pattern_user_set(3) -- store information in the user data cells of a pattern object
|
|
The tt_pattern_user_set function stores information in the user data cells associated with the specified pattern object. The p argument is a unique handle for a message pattern. This handle is returned after tt_pattern_create(3) is called. The key argument is the specified user data cell. The value for each data cell must be unique for this pattern. The v argument is the data cell, a piece of arbi... |
|
tt_pattern_xarg_add(3) -- add a new argument with an interpreted XDR value to a pattern object
|
|
The tt_pattern_xarg_add function adds a new argument with an interpreted XDR value to a pattern object. The m argument is the opaque handle for the pattern involved in this operation. The n argument specifies who (sender, handler, observers) writes and reads a pattern argument. The following modes are defined: TT_IN The argument is written by the sender and read by the handler and any observers. T... |
|
tt_pattern_xcontext_add(3) -- add an XDR-interpreted byte-array value to this pattern's named context
|
|
The tt_pattern_xcontext_add function adds an XDR-interpreted bytearray value to the values in this pattern's named context. The p argument is the opaque handle for the pattern involved in this operation. The slotname argument describes the context for this pattern. The xdr_proc argument points to the XDR procedure to be used to serialize the data pointed to by value. The value argument is the dat... |
|
tt_pnotice_create(3) -- create a procedure notice
|
|
The tt_pnotice_create function creates a message. The created message contains the following: Tt_address = TT_PROCEDURE Tt_class = TT_NOTICE The application can use the returned handle to add arguments and other attributes, and to send the message. The scope argument determines which processes are eligible to receive the message. The following values are defined: TT_SESSION All processes joined to... |
|
tt_pointer_error(3) -- return the status of a pointer
|
|
The tt_pointer_error function returns the status of the specified pointer. If an opaque pointer (Tt_message or Tt_pattern) or character pointer (char *) is specified, this function returns TT_OK if the pointer is valid or the encoded Tt_status value if the pointer is an error object. The pointer argument is the opaque pointer or character pointer to be checked. |
|
tt_prequest_create(3) -- create a procedure request message
|
|
The tt_prequest_create function creates a message. The created message created contains the following: Tt_address = TT_PROCEDURE Tt_class = TT_REQUEST The application can use the returned handle to add arguments and other attributes, and to send the message. The scope argument determines which processes are eligible to receive the message. The following values are defined: TT_SESSION All processes... |
|
tt_procid_session(3) -- identify the session in which a procid was opened
|
|
The tt_procid_session function returns the identifier of the session in which the specified procid was opened. The return value points to the sessid for the session associated with the procid. When the sessid value is no longer needed, it must be freed with tt_free. |
|
tt_ptr_error(3) -- pointer error macro
|
|
The tt_ptr_error macro expands to tt_pointer_error((void *)(p)). The pointer argument is the opaque pointer or character pointer to be checked. |
|
tt_ptype_declare(3) -- register the process type with the ToolTalk service
|
|
The tt_ptype_declare function registers the process type with the ToolTalk service. The ptid argument is the character string specified in the ptype that uniquely identifies this process. |
|
tt_ptype_exists(3) -- indicate whether a ptype is already installed
|
|
The tt_ptype_exists function returns an indication of whether a ptype is already installed. The ptid argument is the character string specifying the ptype. |
|
tt_ptype_opnum_callback_add(3) -- return a callback if two opnums are equal
|
|
The tt_ptype_opnum_callback_add function returns a callback if the specified opnums are equal. The callback is defined in Tt/tt_c.h - Tttt_c(5). When a message is delivered because it matched a pattern derived from a signature in the named ptype with an opnum equal to the specified one, the given callback is run in the usual ToolTalk way. The ptid argument is the identifier of the ptype involved i... |
|
tt_ptype_undeclare(3) -- undeclare a ptype
|
|
The tt_ptype_undeclare function undeclares the indicated ptype and unregisters the patterns associated with the indicated ptype from the ToolTalk service. The ptid argument is the character string specifying the ptype. |
|
tt_release(3) -- free storage allocated on the ToolTalk API allocation stack
|
|
The tt_release function frees all storage allocated on the ToolTalk API allocation stack since mark was returned by tt_mark(3). The mark argument is an integer that marks the application's storage position in the ToolTalk API allocation stack. |
|
tt_session_bprop(3) -- retrieve the ith value of the named property of a session
|
|
The tt_session_bprop function retrieves the ith value of the named property of the specified session. If there are i values or fewer, both the returned value and the returned length are set to zero. The sessid argument is the session joined. The application can use the sessid value returned when tt_default_session is called. The propname argument is the name of the property from which values are t... |
|
tt_session_bprop_add(3) -- add a new byte-string value to the end of the list of values
|
|
The tt_session_bprop_add function adds a new byte-string value to the end of the list of values for the named property of the specified session. The sessid argument is the name of the session joined. The application can use the sessid value returned when tt_default_session is called. The propname argument is the name of the property to which to add values. The value argument is the value to add to... |
|
tt_session_bprop_set(3) -- replace current values stored under the named property of a session
|
|
The tt_session_bprop_set function replaces any current values stored under the named property of the specified session with the given byte-string value. The sessid argument is the name of the session joined. The application can use the sessid value returned when tt_default_session is called. The propname argument is the name of the property whose value is to be replaced. The value argument is the ... |
|
tt_session_join(3) -- join a session and make it the default
|
|
The tt_session_join function joins the named session and makes it the default session. The sessid argument is the name of the session to join. |
|
tt_session_prop(3) -- return the ith value of a session property
|
|
The tt_session_prop function returns the ith value of the specified session property. The sessid argument is the name of the session joined. The application can use the sessid value returned when tt_default_session is called. The propname argument is the name of the property from which a value is to be retrieved. The name must be less than 64 bytes. The i argument is the number of the item in the ... |
|
tt_session_propname(3) -- returns an element of the list of property names for a session
|
|
The tt_session_propname function returns the nth element of the list of currently defined property names for the specified session. The sessid argument is the name of the session joined. The application can use the sessid value returned when tt_default_session is called. The n argument is the number of the item in the property name list for which a name is to be obtained. The list numbering begins... |
|
tt_session_propnames_count(3) -- return the number of property names for the session
|
|
The tt_session_propnames_count function returns the number of currently defined property names for the session. The sessid argument is the name of the session joined. The application can use the sessid value returned when tt_default_session is called. |
|
tt_session_prop_add(3) -- add a new character-string value to the end of the list of values
|
|
The tt_session_prop_add function adds a new character-string value to the end of the list of values for the property of the specified session. The sessid argument is the name of the session joined. The application can use the sessid value returned when tt_default_session is called. The propname argument is the name of the property to which a value is to be added. The name must be less than 64 byte... |
|
tt_session_prop_count(3) -- return the number of values stored under a property of a session
|
|
The tt_session_prop_count function returns the number of values stored under the named property of the specified session. The sessid argument is the name of the session joined. The application can use the sessid value returned when tt_default_session is called. The propname argument is the name of the property to be examined. |
|
tt_session_prop_set(3) -- replace current values for a property of a
|
|
The tt_session_prop_set function replaces all current values stored under the named property of the specified session with the given character-string value. The sessid argument is the name of the session joined. The application can use the sessid value returned when tt_default_session is called. The propname argument is the name of the property to be examined. The value argument is the new value t... |
|
tt_session_quit(3) -- quit the session
|
|
The tt_session_quit function informs the ToolTalk service that the process is no longer interested in this ToolTalk session. The ToolTalk service stops delivering messages scoped to this session. The sessid argument is the name of the session to quit. |
|
tt_session_types_load(3) -- merge a compiled ToolTalk types file into the running ttsession
|
|
The tt_session_types_load function merges a compiled ToolTalk types file into the running ttsession(1). The session argument is the name of the running session. The filename argument is the name of the compiled ToolTalk types file. |
|
tt_spec_bprop(3) -- retrieve the ith value of a property
|
|
The tt_spec_bprop function retrieves the ith value of the specified property. The objid argument is the identifier of the object involved in this operation. The propname argument is the name of the property whose value is to be retrieved. The name must be less than 64 characters. The i argument is the item of the list for which a value is to be obtained. The list numbering begins with zero. The va... |
|
tt_spec_bprop_add(3) -- add a new byte-string to the end of the list of values
|
|
The tt_spec_bprop_add function adds a new byte-string to the end of the list of values associated with the specified spec property. The objid argument is the identifier of the object involved in this operation. The propname argument is the name of the property to which the byte-string is to be added. The value argument is the byte-string to be added to the property value list. The length argument ... |
|
tt_spec_bprop_set(3) -- replace any current values stored under this spec
|
|
The tt_spec_bprop_set function replaces any current values stored under this spec property with a new byte-string. The objid argument is the identifier of the object involved in this operation. The propname argument is the name of the property which stores the values. The value argument is the byte-string to be added to the property value list. If the value is NULL, the property is removed entirel... |
|
tt_spec_create(3) -- create an in-memory spec for an object
|
|
The tt_spec_create function creates a spec (in memory) for an object. The application can use the objid returned in future calls to manipulate the object. The filepath argument is the name of the file. |
|
tt_spec_destroy(3) -- destroy an object's spec
|
|
The tt_spec_destroy function destroys an object's spec immediately. The objid argument is the identifier of the object involved in this operation. |
|
tt_spec_file(3) -- retrieve the name of the file that contains the object described by the spec
|
|
The tt_spec_file function retrieves the name of the file that contains the object described by the spec. The objid argument is the identifier of the object involved in this operation. |
|
tt_spec_move(3) -- notify the ToolTalk service that an object has moved to a different file
|
|
The tt_spec_move function notifies the ToolTalk service that this object has moved to a different file. The ToolTalk service returns a new objid for the object and leaves a forwarding pointer from the old objid to the new one. If a new objid is not required (for example, because the new and old files are in the same file system), tt_spec_move returns TT_WRN_SAME_OBJID. The objid argument is the id... |
|
tt_spec_prop(3) -- retrieve the ith value of the property associated with an object spec
|
|
The tt_spec_prop function retrieves the ith value of the property associated with this object spec. The objid argument is the identifier of the object involved in this operation. The propname argument is the name of the property associated with the object spec. The i argument is the item of the list whose value is to be retrieved. The list numbering begins with zero. |
|
tt_spec_propname(3) -- return an element of the property name list for an object spec
|
|
The tt_spec_propname function returns the nth element of the property name list for this object spec. The objid argument is the identifier of the object involved in this operation. The n argument is the item of the list whose element is to be returned. The list numbering begins with zero. |
|
tt_spec_propnames_count(3) -- return the number of property names for an object
|
|
The tt_spec_propnames_count function returns the number of property names for this object. The objid argument is the identifier of the object involved in this operation. |
|
tt_spec_prop_add(3) -- add a new item to the end of the list of values
|
|
The tt_spec_prop_add function adds a new item to the end of the list of values associated with this spec property. The objid argument is the identifier of the object involved in this operation. The propname argument is the property to which the item is to be added. The value argument is the new character-string to be added to the property value list. |
|
tt_spec_prop_count(3) -- return the number of values listed in this spec property
|
|
The tt_spec_prop_count function returns the number of values listed in this spec property. The objid argument is the identifier of the object involved in this operation. The propname argument is the name of the property that contains the value to be returned. |
|
tt_spec_prop_set(3) -- replace property values
|
|
The tt_spec_prop_set function replaces any values currently stored under this property of the object spec with a new value. The objid argument is the identifier of the object involved in this operation. The propname argument is the name of the property which stores the values. The value argument is the value to be placed in the property value list. If value is NULL, the property is removed entirel... |
|
tt_spec_type(3) -- return the name of the object type
|
|
The tt_spec_type function returns the name of the object type. The objid argument is the identifier of the object involved in this operation. |
|
tt_spec_type_set(3) -- assign an object type value to an object spec
|
|
The tt_spec_type_set function assigns an object type value to the object spec. The type must be set before the spec is written for the first time and cannot be set thereafter. The objid argument is the identifier of the object involved in this operation. The otid argument is the otype to be assigned to the spec. |
|
tt_spec_write(3) -- write the spec and any associated properties to the ToolTalk database
|
|
The tt_spec_write function writes the spec and any associated properties to the ToolTalk database. The type must be set before the spec is written for the first time. The objid argument is the identifier of the object involved in this operation. |
|
tt_status_message(3) -- provide a message for a problem status code
|
|
The tt_status_message function returns a pointer to a message that describes the problem indicated by this status code. The ttrc argument is the status code received during an operation. |
|
tt_thread_procid(3) -- identify the default process for the currently active thread
|
|
The tt_thread_procid function returns the current default procid for the currently-active thread. If there is no default procid set for the thread, then the process default procid is returned. |
|
tt_thread_procid_set(3) -- set the default procid for the currently active thread
|
|
The tt_thread_procid_set function sets the default procid for the currently active thread. The default procid is an implicit argument to most ToolTalk API calls. |
|
tt_thread_session(3) -- retrieve the default session identifier for the currently active thread
|
|
The tt_thread_session function retrieves the default session identifier for the currently active thread. If there is no default session set for the currently-active thread, then the process default session identifier is returned. A session can have more than one session identifier. This means, for example, that the application cannot compare the result of tt_thread_session with the result of tt_me... |
|
tt_thread_session_set(3) -- set the default session identifier for the current thread
|
|
The tt_thread_session_set function sets the default session identifier for the currently active thread. The ToolTalk service uses the initial user session as the default session and supports one session per procid. The application can make this call before it calls tt_open to specify which session it wants to connect to in the active thread. To change to another opened session, the application mus... |
|
tt_trace_control(3) -- control client-side tracing
|
|
The tt_trace_control function sets or clears an internal flag controlling all client-side tracing. The intent of this is to be called from debugger breakpoints, allowing a programmer to narrow the trace to the suspect area. The value of the onoff argument affects tracing as follows: 0 Tracing is turned off. 1 Tracing is turned on. -1 Tracing is turned on if it was off and vice-versa. |
|
tt_xcontext_join(3) -- add an XDR-interpreted byte-array to the list of values
|
|
The tt_xcontext_join function adds the given XDR-interpreted bytearray value to the list of values for the named contexts of all patterns. The slotname argument describes the slotname in this message. The xdr_proc argument points to the XDR procedure to be used to serialize the data pointed to by value. The value argument is the data to be serialized. |
|
tt_xcontext_quit(3) -- remove an XDR-interpreted byte-array value from the list of values
|
|
The tt_xcontext_quit function removes the given XDR-interpreted bytearray value from the list of values for the contexts of all patterns. The slotname argument describes the slotname in this message. The xdr_proc argument points to the XDR procedure to be used to serialize the data pointed to by value. The value argument is the data to be serialized. |
|
tt_X_session(3) -- return the session associated with an X window system display
|
|
The tt_X_session function returns the session associated with the named X window system display. The application can call tt_X_session before it calls tt_open(3). The xdisplaystring argument is the name of an X display server; for example, somehost:0 or :0. |
|
t_accept(3) -- accept a connect request
|
|
The t_accept() function is issued by a transport user to accept a connect request. fd identifies the local transport endpoint where the connect indication arrived. resfd specifies the local transport endpoint where the connection is to be established. call contains information required by the transport provider to complete the connection. The parameter call points to a t_call structure which conta... |
|
t_alloc(3) -- allocate a library structure
|
|
The t_alloc() function dynamically allocates memory for the various transport function argument structures as specified below. This function will allocate memory for the specified structure and will also allocate memory for buffers referenced by the structure. The structure to allocate is specified by struct_type and must be one of the following: T_BIND struct t_bind T_CALL struct t_call T_OPTMGMT... |
|
t_bind(3) -- bind an address to a transport endpoint
|
|
The t_bind() function associates a protocol address with the transport endpoint specified by fd and activates that transport endpoint. In connection mode, the transport provider may begin enqueuing incoming connect indications or servicing a connection request on the transport endpoint. In connectionless mode, the transport user may send or receive data units through the transport endpoint. The re... |
|
t_close(3) -- close a transport endpoint
|
|
The t_close() function informs the transport provider that the user is finished with the transport endpoint specified by fd, and frees any local library resources associated with the endpoint. t_close() also closes the file descriptor associated with the transport endpoint. t_close() should be called from the T_UNBND state (see t_getstate(3)). However, this function does not check state informatio... |
|
t_connect(3) -- establish a connection with another transport user
|
|
This function enables a transport user to request a connection to the specified destination transport user. This function can only be issued in the T_IDLE state. fd identifies the local transport endpoint where communication will be established. sndcall and rcvcall point to a t_call structure which contains the following members: struct netbuf addr; struct netbuf opt; struct netbuf udata; int sequ... |
|
t_error(3) -- produce error message
|
|
The t_error() function produces a language-dependent message on the standard error output which describes the last error encountered during a call to a transport function. The argument string errmsg is a user-supplied error message that gives context to the error. The error message is written as follows: First if errmsg is not a null pointer and the character pointed to be errmsg is not the null c... |
|
t_free(3) -- free a library structure
|
|
The t_free() function frees memory previously allocated by t_alloc(). This function will free memory for the specified structure and will also free memory for buffers referenced by the structure. The argument ptr points to one of the seven structure types described for t_alloc(). struct_type identifies the type of that structure which must be one of the following: T_BIND struct t_bind T_CALL struc... |
|
t_getinfo(3) -- get protocol-specific service information
|
|
The t_getinfo() function returns the current characteristics of the underlying transport protocol associated with file descriptor fd. The info structure is used to return the same information returned by t_open(). This function enables a transport user to access this information during any phase of communication. This argument points to a t_info structure which contains the following members: t_sc... |
|
t_getprotaddr(3) -- get the protocol address
|
|
The t_getprotaddr() function returns local and remote protocol addresses currently associated with the transport endpoint specified by fd. In boundaddr and peeraddr the user specifies maxlen, which is the maximum size of the address buffer, and buf which points to the buffer where the address is to be placed. On return, the buf field of boundaddr points to the address, if any, currently bound to f... |
|
t_getstate(3) -- get the current state
|
|
The t_getstate() function returns the current state of the provider as seen by the application associated with the transport endpoint specified by fd. |
|
t_listen(3) -- listen for a connect request
|
|
The t_listen() function listens for a connect request from a calling transport user. fd identifies the local transport endpoint where connect indications arrive. On return, call contains information describing the connect indication. The parameter call points to a t_call structure which contains the following members: struct netbuf addr; struct netbuf opt; struct netbuf udata; int sequence; The ty... |
|
t_look(3) -- look at the current event on a transport endpoint
|
|
The t_look() function returns the current event on the transport endpoint specified by fd. This function enables a transport provider to notify a transport user of an asynchronous event when the user is calling functions in synchronous mode. Certain events require immediate notification of the user and are indicated by a specific error, [TLOOK], on the current or next function to be executed. This... |
|
t_open(3) -- establish a transport endpoint
|
|
The t_open() function must be called as the first step in the initialization of a transport endpoint. This function establishes a transport endpoint by opening a file that identifies a particular transport provider and returning a file descriptor that identifies that endpoint. The argument name points to a file name that identifies a transport provider. When using HP XTI to connect to the OSI prot... |
|
t_optmgmt(3) -- manage options for a transport endpoint
|
|
The t_optmgmt() function enables a transport user to retrieve, verify or negotiate protocol options with the transport provider. The argument fd identifies a bound transport endpoint. The req and ret arguments point to a t_optmgmt structure containing the following members: struct netbuf opt; t_scalar_t flags; The opt field identifies protocol options. The flags field is used to specify the action... |
|
t_rcv(3) -- receive data or expedited data sent over a connection
|
|
The t_rcv() function receives either normal or expedited data. fd identifies the local transport endpoint through which data will arrive. buf points to a receive buffer where user data will be placed. nbytes specifies the size of the receive buffer. flags may be set on return from t_rcv() and specifies optional flags as described below. By default, t_rcv() operates in synchronous mode and will wai... |
|
t_rcvconnect(3) -- receive the confirmation from a connect request
|
|
The t_rcvconnect() function enables a calling transport user to determine the status of a previously sent connect request. t_rcvconnect() is also used in conjunction with t_connect() to establish a connection in asynchronous mode. The connection will be established on successful completion of this function. fd identifies the local transport endpoint where communication will be established. call co... |
|
t_rcvdis(3) -- retrieve information from disconnect
|
|
The t_rcvdis() function is used to identify the cause of a disconnect, and to retrieve any user data sent with the disconnect. fd identifies the local transport endpoint where the connection existed. discon points to a t_discon structure containing the following members: struct netbuf udata; int reason; int sequence; The type netbuf structure is defined in the or header file. Th... |
|
t_rcvrel(3) -- acknowledge receipt of an orderly release indication at a transport endpoint
|
|
The t_rcvrel() function is used in connection-oriented mode to acknowledge receipt of an orderly release indication at a transport endpoint. The released endpoint is specified by fd, which is a file descriptor previously returned by the t_open() function. After receipt of this orderly release indication at the transport endpoint specified by fd, the transport user should not try to receive additio... |
|
t_rcvudata(3) -- receive a data unit from remote transport provider user
|
|
The t_rcvudata() function is used in connectionless-mode to receive a data unit from a remote transport provider user. The argument fd identifies the local transport endpoint through which data will be received. unitdata holds information associated with the received data unit. flags is set on return to indicate that the complete data unit was not received. The argument unitdata points to a t_unit... |
|
t_rcvuderr(3) -- receive a unit data error indication
|
|
The t_rcvuderr() function is used in connectionless mode to receive information concerning an error on a previously sent data unit. This function should only be issued following a unit data error indication. It informs the transport user that a data unit with a specific destination address and protocol options produced an error. The argument fd identifies the local transport endpoint through which... |
|
t_snd(3) -- send data or expedited data over a connection
|
|
This function is used to send either normal or expedited data. fd identifies the local transport endpoint over which data should be sent, buf points to the user data, nbytes specifies the number of bytes of user data to be sent, and flags specifies any optional flags described below: T_EXPEDITED if set in flags, the data will be sent as expedited data and will be subject to the interpretations of ... |
|
t_snddis(3) -- send user-initiated disconnect request
|
|
The t_snddis() function is used to initiate an abortive release on an already established connection or to reject a connect request. fd identifies the local transport endpoint of the connection, and call specifies information associated with the abortive release. call points to a t_call structure which contains the following members: struct netbuf addr; struct netbuf opt; struct netbuf udata; int ... |
|
t_sndrel(3) -- initiate an orderly release
|
|
The t_sndrel() function is used in connection-oriented mode to initiate an orderly release at a transport endpoint specified by fd, which is a file descriptor previously returned by the t_open() function. After this orderly release is indicated, the transport user should not try to send more data through that transport endpoint. An attempt to send more data to a released transport endpoint may blo... |
|
t_sndudata(3) -- send a data unit
|
|
The t_sndudata() function is used in connectionless mode to send a data unit to another transport user. The argument fd identifies the local transport endpoint through which data is sent. The argument unitdata points to a type t_unitdata structure used to specify a data unit being sent through the transport endpoint specified by the fd parameter. The t_unitdata structure has the following members:... |
|
t_strerror(3) -- produce an error message string
|
|
The t_strerror() function maps the error number in errnum that corresponds to an XTI error to a language-dependent error message string and returns a pointer to the string. The string pointed to will not be modified by the program, but may be overwritten by a subsequent call to the t_strerror() function. The string is not terminated by a newline character. The language for error message strings wr... |
|
t_sync(3) -- synchronize transport library
|
|
For the transport endpoint specified by fd, the t_sync() function synchronizes the data structures managed by the transport library with information from the underlying transport provider. In doing so, it can convert an uninitialized file descriptor (obtained via open(), dup() or as a result of a fork() and exec()) to an initialized endpoint, assuming that the file descriptor referenced a transpor... |
|
t_unbind(3) -- disable a transport endpoint
|
|
The t_unbind() function disables the transport endpoint specified by fd which was previously bound by t_bind(). On completion of this call, no further data or events destined for this transport endpoint will be accepted by the transport provider. |
|
uc_access(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
Uil(3) -- Invokes the UIL compiler from within an application
|
|
The Uil function provides a callable entry point for the UIL compiler. The Uil callable interface can be used to process a UIL source file and to generate UID files, as well as return a detailed description of the UIL source module in the form of a symbol table (parse tree). command_desc Specifies the uil command line. compile_desc Returns the results of the compilation. message_cb Specifies a cal... |
|
UilDumpSymbolTable(3) -- Dumps the contents of a named UIL symbol table to standard output
|
|
The UilDumpSymbolTable function dumps the contents of a UIL symbol table pointer to standard output. root_ptr Specifies a pointer to the the symbol table root entry. This value can be taken from the parse_tree_root part of the Uil_compile_desc_type data structure returned by Uil. By following the link from the root entry, you can traverse the entire parse tree. Symbol table entries are in the foll... |
|
VendorShell(3) -- The VendorShell widget class
|
|
VendorShell is a Motif widget class used as a supporting superclass for all shell classes that are visible to the window manager and that are not override redirect. It contains resources that describe the MWM-specific look and feel. It also manages the MWM-specific communication needed by all VendorShell subclasses. See the mwm reference page for more information. If an application uses the XmNmwm... |
|
VirtualBindings(3) -- Bindings for virtual mouse and key events
|
|
The Motif reference pages describe key translations in terms of virtual bindings, based on those described in the Motif Style Guide. |
|
WMShell(3) -- The WMShell widget class
|
|
WMShell is a top-level widget that encapsulates the interaction with the window manager. |
|
XmActivateProtocol(3) -- A VendorShell function that activates a protocol
|
|
XmActivateProtocol activates a protocol. It updates the handlers and the property if the shell is realized. It is sometimes useful to allow a protocol's state information (callback lists, and so on) to persist, even though the client may choose to temporarily resign from the interaction. This is supported by allowing a protocol to be in one of two states: active or inactive. If the protocol is ac... |
|
XmActivateWMProtocol(3) -- A VendorShell convenience interface that activates a protocol
|
|
XmActivateWMProtocol is a convenience interface. It calls XmActivateProtocol with the property value set to the atom returned by interning WM_PROTOCOLS. shell Specifies the widget with which the protocol property is associated protocol Specifies the protocol Atom For a complete definition of VendorShell and its associated resources, see VendorShell(3). |
|
XmAddProtocolCallback(3) -- A VendorShell function that adds client callbacks for a protocol
|
|
XmAddProtocolCallback adds client callbacks for a protocol. It checks if the protocol is registered, and if it is not, calls XmAddProtocols. It then adds the callback to the internal list. These callbacks are called when the corresponding client message is received. XmAddWMProtocolCallback is a convenience interface. It calls XmAddProtocolCallback with the property value set to the atom returned b... |
|
XmAddProtocols(3) -- A VendorShell function that adds the protocols to the protocol manager and allocates the internal tables
|
|
XmAddProtocols adds the protocols to the protocol manager and allocates the internal tables. XmAddWMProtocols is a convenience interface. It calls XmAddProtocols with the property value set to the atom returned by interning WM_PROTOCOLS. shell Specifies the widget with which the protocol property is associated property Specifies the protocol property protocols Specifies the protocol Atoms num_prot... |
|
XmAddTabGroup(3) -- A function that adds a manager or a primitive widget to the list of tab groups
|
|
This function is obsolete and its behavior is replaced by setting XmNnavigationType to XmEXCLUSIVE_TAB_GROUP. When the keyboard is used to traverse through a widget hierarchy, primitive or manager widgets are grouped together into what are known as tab groups. Any manager or primitive widget can be a tab group. Within a tab group, move the focus to the next widget in the tab group by using the arr... |
|
XmAddToPostFromList(3) -- a RowColumn function that makes a menu accessible from more than one widget
|
|
XmAddToPostFromList makes a menu accessible from more than one widget. After a menu is once created, this function may be used to make that menu accessible from a second widget. The process may be repeated indefinitely. In other words, where an application would use XmCreatePopupMenu or XmCreatePulldownMenu or their equivalent to create a new menu identical to one that already exists, it can use t... |
|
XmAddWMProtocolCallback(3) -- A VendorShell convenience interface that adds client callbacks for a protocol
|
|
XmAddWMProtocolCallback is a convenience interface. It calls XmAddProtocolCallback with the property value set to the atom returned by interning WM_PROTOCOLS. shell Specifies the widget with which the protocol property is associated protocol Specifies the protocol Atom callback Specifies the procedure to call when a protocol message is received closure Specifies the client data to be passed to the... |
|
XmAddWMProtocols(3) -- A VendorShell convenience interface that adds the protocols to the protocol manager and allocates the internal
|
|
XmAddWMProtocols is a convenience interface. It calls XmAddProtocols with the property value set to the atom returned by interning WM_PROTOCOLS. shell Specifies the widget with which the protocol property is associated protocols Specifies the protocol Atoms num_protocols Specifies the number of elements in protocols For a complete definition of VendorShell and its associated resources, see VendorS... |
|
XmArrowButton(3) -- The ArrowButton widget class
|
|
ArrowButton consists of a directional arrow surrounded by a border shadow. When it is selected, the shadow changes to give the appearance that the ArrowButton has been pressed in. When the ArrowButton is unselected, the shadow reverts to give the appearance that the ArrowButton is released, or out. ArrowButton holds the XmQTactivatable trait. |
|
XmArrowButtonGadget(3) -- The ArrowButtonGadget widget class
|
|
ArrowButtonGadget consists of a directional arrow surrounded by a border shadow. When it is selected, the shadow changes to give the appearance that the ArrowButtonGadget has been pressed in. When it is unselected, the shadow reverts to give the appearance that the button is released, or out. ArrowButtonGadget holds the XmQTactivatable trait. |
|
XmBulletinBoard(3) -- The BulletinBoard widget class
|
|
BulletinBoard is a composite widget that provides simple geometry management for child widgets. It does not force positioning on its children, but can be set to reject geometry requests that result in overlapping children. BulletinBoard is the base widget for most dialog widgets and is also used as a general container widget. Modal and modeless dialogs are implemented as collections of widgets tha... |
|
XmCascadeButton(3) -- The CascadeButton widget class
|
|
CascadeButton links two menu panes or a MenuBar to a menu pane. It is used in menu systems and must have a RowColumn parent with its XmNrowColumnType resource set to XmMENU_BAR, XmMENU_POPUP or XmMENU_PULLDOWN. It is the only widget that can have a Pulldown menu pane attached to it as a submenu. The submenu is displayed when this widget is activated within a MenuBar, a PopupMenu, or a PulldownMenu... |
|
XmCascadeButtonGadget(3) -- The CascadeButtonGadget widget class
|
|
CascadeButtonGadget links two menu panes, a MenuBar to a menu pane, or an OptionMenu to a menu pane. It is used in menu systems and must have a RowColumn parent with its XmNrowColumnType resource set to XmMENU_BAR, XmMENU_POPUP, XmMENU_PULLDOWN, or XmMENU_OPTION. It is the only gadget that can have a Pulldown menu pane attached to it as a submenu. The submenu is displayed when this gadget is activ... |
|
XmCascadeButtonGadgetHighlight(3) -- A CascadeButtonGadget function that sets the highlight state
|
|
XmCascadeButtonGadgetHighlight either draws or erases the shadow highlight around the CascadeButtonGadget. cascadeButtonGadget Specifies the CascadeButtonGadget to be highlighted or unhighlighted highlight Specifies whether to highlight (True) or to unhighlight (False) For a complete definition of CascadeButtonGadget and its associated resources, see XmCascadeButtonGadget(3). |
|
XmCascadeButtonHighlight(3) -- A CascadeButton and CascadeButtonGadget function that sets the highlight state
|
|
XmCascadeButtonHighlight either draws or erases the shadow highlight around the CascadeButton or the CascadeButtonGadget. cascadeButton Specifies the CascadeButton or CascadeButtonGadget to be highlighted or unhighlighted highlight Specifies whether to highlight (True) or to unhighlight (False) For a complete definition of CascadeButton or CascadeButtonGadget and their associated resources, see Xm... |
|
XmChangeColor(3) -- Recalculates all associated colors of a widget
|
|
XmChangeColor handles all color modifications for the specified widget when a new background pixel value is specified. This function recalculates the foreground, select, and shadow colors based on the new background color and sets the corresponding resources for the widget. If a color calculation procedure has been set by a call to XmSetColorCalculation, XmChangeColor uses that procedure to calcul... |
|
XmClipboardCancelCopy(3) -- A clipboard function that cancels a copy to the clipboard
|
|
XmClipboardCancelCopy cancels the copy to clipboard that is in progress and frees up temporary storage. When a copy is to be performed, XmClipboardStartCopy allocates temporary storage for the clipboard data. XmClipboardCopy copies the appropriate data into the the temporary storage. XmClipboardEndCopy copies the data to the clipboard structure and frees up the temporary storage structures. If XmC... |
|
XmClipboardCopy(3) -- A clipboard function that copies a data item to temporary storage for later copying to clipboard
|
|
XmClipboardCopy copies a data item to temporary storage. The data item is moved from temporary storage to the clipboard data structure when a call to XmClipboardEndCopy is made. Additional calls to XmClipboardCopy before a call to XmClipboardEndCopy add additional data item formats to the same data item or append data to an existing format. Formats are described in the Inter-Client Communication C... |
|
XmClipboardCopyByName(3) -- A clipboard function that copies a data item passed by name
|
|
XmClipboardCopyByName copies the actual data for a data item that was previously passed by name to the clipboard. Data is considered to be passed by name when a call to XmClipboardCopy is made with a NULL buffer parameter. Additional calls to this function append new data to the existing data. display Specifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay... |
|
XmClipboardEndCopy(3) -- A clipboard function that completes the copying of data to the clipboard
|
|
XmClipboardEndCopy locks the clipboard from access by other applications, places data in the clipboard data structure, and unlocks the clipboard. Data items copied to the clipboard by XmClipboardCopy are not actually entered in the clipboard data structure until the call to XmClipboardEndCopy. This function also frees up temporary storage that was allocated by XmClipboardStartCopy, which must be c... |
|
XmClipboardEndRetrieve(3) -- A clipboard function that completes retrieval of data from the clipboard
|
|
XmClipboardEndRetrieve suspends copying data incrementally from the clipboard. It tells the clipboard routines that the application is through copying an item from the clipboard. Until this function is called, data items can be retrieved incrementally from the clipboard with XmClipboardRetrieve. The act of copying data is started with the XmClipboardStartRetrieve function. display Specifies a poin... |
|
XmClipboardInquireCount(3) -- A clipboard function that returns the number of data item formats
|
|
XmClipboardInquireCount returns the number of data item formats available for the data item in the clipboard. This function also returns the maximum name-length for all formats in which the data item is stored. display Specifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay or XtDisplay. window Specifies the window ID of a widget that relates the applicati... |
|
XmClipboardInquireFormat(3) -- A clipboard function that returns a specified format name
|
|
XmClipboardInquireFormat returns a specified format name for the data item in the clipboard. If the name must be truncated, the function returns a warning status. display Specifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay or XtDisplay. window Specifies the window ID of a widget that relates the application window to the clipboard. The widget's window... |
|
XmClipboardInquireLength(3) -- A clipboard function that returns the length of the stored data
|
|
XmClipboardInquireLength returns the length of the data stored under a specified format name for the clipboard data item. If no data is found for the specified format, or if there is no item on the clipboard, this function returns a value of 0 (zero) in the length argument. Any format passed by name is assumed to have length passed in a call to XmClipboardCopy, even though the data has not yet bee... |
|
XmClipboardInquirePendingItems(3) -- A clipboard function that returns a list of data ID/private ID pairs
|
|
XmClipboardInquirePendingItems returns a list of data ID/private ID pairs for the specified format name. A data item is considered pending if the application originally passed it by name, the application has not yet copied the data, and the item has not been deleted from the clipboard. The application is responsible for freeing the memory provided by this function to store the list. To free the me... |
|
XmClipboardLock(3) -- A clipboard function that locks the clipboard
|
|
XmClipboardLock locks the clipboard from access by another application until XmClipboardUnlock is called. All clipboard functions lock and unlock the clipboard to prevent simultaneous access. This function allows the application to keep the clipboard data from changing between calls to Inquire and other clipboard functions. The application does not need to lock the clipboard between calls to XmCli... |
|
XmClipboardRegisterFormat(3) -- A clipboard function that registers a new format
|
|
XmClipboardRegisterFormat registers a new format. Each format stored on the clipboard should have a length associated with it; this length must be known to the clipboard routines. Formats are known as targets in the Inter-Client Communication Conventions Manual (ICCCM). All of the formats specified by version 1.1 of the ICCCM conventions are preregistered. Any other format that the application wan... |
|
XmClipboardRetrieve(3) -- A clipboard function that retrieves a data item from the clipboard
|
|
XmClipboardRetrieve retrieves the current data item from clipboard storage. It returns a warning if the clipboard is locked, if there is no data on the clipboard, or if the data needs to be truncated because the buffer length is too short. Between a call to XmClipboardStartRetrieve and a call to XmClipboardEndRetrieve, multiple calls to XmClipboardRetrieve with the same format name result in data ... |
|
XmClipboardStartCopy(3) -- A clipboard function that sets up a storage and data structure
|
|
XmClipboardStartCopy sets up storage and data structures to receive clipboard data. An application calls this function during a cut or copy operation. The data item that these structures receive then becomes the next data item in the clipboard. Copying a large piece of data to the clipboard can take a long time. It is possible that, once the data is copied, no application will ever request that da... |
|
XmClipboardStartRetrieve(3) -- A clipboard function that prepares to retrieve data from the clipboard
|
|
XmClipboardStartRetrieve tells the clipboard routines that the application is ready to start copying an item from the clipboard. The clipboard is locked by this routine and stays locked until XmClipboardEndRetrieve is called. Between a call to XmClipboardStartRetrieve and a call to XmClipboardEndRetrieve, multiple calls to XmClipboardRetrieve with the same format name result in data being incremen... |
|
XmClipboardUndoCopy(3) -- A clipboard function that deletes the last item placed on the clipboard
|
|
XmClipboardUndoCopy deletes the last item placed on the clipboard if the item was placed there by an application with the passed display and window arguments. Any data item deleted from the clipboard by the original call to XmClipboardCopy is restored. If the display or window IDs do not match the last copied item, no action is taken, and this function has no effect. display Specifies a pointer to... |
|
XmClipboardUnlock(3) -- A clipboard function that unlocks the clipboard
|
|
XmClipboardUnlock unlocks the clipboard, enabling it to be accessed by other applications. If multiple calls to XmClipboardLock have occurred, the same number of calls to XmClipboardUnlock is necessary to unlock the clipboard, unless remove_all_locks is set to True. display Specifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay or XtDisplay. window Specif... |
|
XmClipboardWithdrawFormat(3) -- A clipboard function that indicates that the application no longer wants to supply a data item
|
|
XmClipboardWithdrawFormat indicates that the application no longer supplies a data item to the clipboard that the application had previously passed by name. display Specifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay or XtDisplay. window Specifies the window ID of a widget that relates the application window to the clipboard. The widget's window ID ca... |
|
XmComboBox(3) -- The ComboBox widget class
|
|
XmComboBox combines the capabilities of a single-line TextField widget and a List widget. It allows users to perform opoerations like typing and pasting information, and it also provides a list of possible choices that the user can select from to complete the TextField entry field. The list can either be displayed at all times or can be dropped down by the user. When the list portion of the ComboB... |
|
XmComboBoxAddItem(3) -- add an item to the ComboBox widget
|
|
The XmComboBoxAddItem function adds the given item to the XmComboBox at the given position. The w argument specifies the XmComboBox widget ID. The item argument specifies the XmString for the new item. The pos argument specifies the position of the new item. The unique argument specifies if this item should duplicate an identical item or not. |
|
XmComboBoxDeletePos(3) -- Delete a XmComboBox item
|
|
The XmComboBoxDeletePos function deletes a specified item from a XmComboBox widget. The w argument specifies the XmComboBox widget ID. The pos argument specifies the position of the item to be deleted. |
|
XmComboBoxSelectItem(3) -- select a XmComboBox item
|
|
The XmComboBoxSelectItem function selects an item in the XmList of the XmComboBox widget. The w argument specifies the XmComboBox widget ID. The item argument specifies the XmString of the item to be selected. If the item is not found on the list, XmComboBoxSelectItem notifies the user via the XtWarning function. |
|
XmComboBoxSetItem(3) -- set an item in the XmComboBox list
|
|
The XmComboBoxSetItem function selects an item in the XmList of the given XmComboBox widget and makes it the first visible item in the list. The w argument specifies the XmComboBox widget ID. The item argument specifies the XmString for the item to be set in the XmComboBox. If the item is not found on the list, XmComboBoxSetItem notifies the user via the XtWarning function. |
|
XmComboBoxUpdate(3) -- A ComboBox function that resynchronizes data
|
|
XmComboBoxUpdate resynchronizes the internal data structures of a specified ComboBox widget. This function is useful when an application manipulates ComboBox's child widgets, possibly changing data structures. For example, you might want to use the XmComboBoxUpdate function after a ComboBox List child selection has been changed without notification. widget Specifies the ComboBox widget ID. |
|
XmCommand(3) -- The Command widget class
|
|
Command is a special-purpose composite widget for command entry that provides a built-in command-history mechanism. Command includes a command-line text-input field, a command-line prompt, and a commandhistory list region. One additional WorkArea child may be added to the Command after creation. Whenever a command is entered, it is automatically added to the end of the command-history list and mad... |
|
XmCommandAppendValue(3) -- A Command function that appends the passed XmString to the end of the string displayed in the command area of
|
|
XmCommandAppendValue appends the passed XmString to the end of the string displayed in the command area of the Command widget. widget Specifies the Command widget ID command Specifies the passed XmString For a complete definition of Command and its associated resources, see XmCommand(3). |
|
XmCommandError(3) -- A Command function that displays an error message
|
|
XmCommandError displays an error message in the history area of the Command widget. The XmString error is displayed until the next command entered occurs. widget Specifies the Command widget ID error Specifies the passed XmString For a complete definition of Command and its associated resources, see XmCommand(3). |
|
XmCommandGetChild(3) -- A Command function that is used to access a component
|
|
XmCommandGetChild is used to access a component within a Command. The parameters given to the function are the Command widget and a value indicating which component to access. widget Specifies the Command widget ID. child Specifies a component within the Command. The following values are legal for this parameter: + XmDIALOG_COMMAND_TEXT + XmDIALOG_PROMPT_LABEL + XmDIALOG_HISTORY_LIST + XmDIALOG_WO... |
|
XmCommandSetValue(3) -- A Command function that replaces a displayed string
|
|
XmCommandSetValue replaces the string displayed in the command area of the Command widget with the passed XmString. widget Specifies the Command widget ID command Specifies the passed XmString For a complete definition of Command and its associated resources, see XmCommand(3). |
|
XmContainer(3) -- The Container widget class
|
|
Container manages child widgets that have the ContainerItem trait. These child widgets can be viewed in several different layout formats, selected using different selection types and techniques, and directly manipulated by the user. Three different formats or views are supported by the Container. They are specified via the XmNentryViewType resource: + XmLARGE_ICON + XmSMALL_ICON + XmANY_ICON Three... |
|
XmContainerCopy(3) -- Container widget function to copy primary selection to the clipboard
|
|
XmContainerCopy copies the primary selected container items to the clipboard. This routine calls the XmNconvertCallback procedures, possibly multiple times, with the selection member of the XmConvertCallbackStruct set to CLIPBOARD and with the parm member set to XmCOPY. container Specifies the Container widget ID. timestamp Specifies the server time at which to modify the selection value. For a co... |
|
XmContainerCopyLink(3) -- Container widget function to copy links to the clipboard
|
|
XmContainerCopyLink copies links to the primary selected items to the clipboard. This routine calls the XmNconvertCallback procedures, possibly multiple times, with the selection member of the XmConvertCallbackStruct set to CLIPBOARD and with the parm member set to XmLINK. The Container widget itself does not copy any links; XmNconvertCallback procedures are responsible for copying the link to the... |
|
XmContainerCut(3) -- Container widget function to move items to the clipboard
|
|
XmContainerCut cuts the primary selected items to the clipboard. This routine calls the XmNconvertCallback procedures, possibly multiple times, with the selection member of the XmConvertCallbackStruct set to CLIPBOARD and with the parm member set to XmMOVE. If the transfer is successful, this routine then calls the XmNconvertCallback procedures for the CLIPBOARD selection and the DELETE target. co... |
|
XmContainerGetItemChildren(3) -- Container widget function to find all children of an item
|
|
XmContainerGetItemChildren allocates a WidgetList and stores within it the widget IDs of all widgets that have item specified as the value of their XmNentryParent resource. The application programmer is responsible for freeing the allocated WidgetList using XtFree. The number of widget IDs returned in item_children is returned by the function. If no widgets specify item as the value of their XmNen... |
|
XmContainerPaste(3) -- Container widget function to insert items from the clipboard
|
|
XmContainerPaste requests data transfer from the clipboard selection to the Container. This routine calls the widget's XmNdestinationCallback procedures with the selection member of the XmDestinationCallbackStruct set to CLIPBOARD and with the operation member set to XmCOPY. The Container widget itself performs no transfers; the XmNdestinationCallback procedures are responsible for inserting the ... |
|
XmContainerPasteLink(3) -- Container widget function to insert links from the clipboard
|
|
XmContainerPasteLink requests data transfer from the clipboard selection to the Container. This routine calls the widget's XmNdestinationCallback procedures with the selection member of the XmDestinationCallbackStruct set to CLIPBOARD and with the operation member set to XmLINK. The Container widget itself performs no transfers; the XmNdestinationCallback procedures are responsible for inserting ... |
|
XmContainerRelayout(3) -- Container widget relayout function
|
|
XmContainerRelayout forces a layout of all items in the Container using the XmNpositionIndex and XmNentryParent constraint resources associated with each item. container Specifies the Container widget ID. For a complete definition of Container and its associated resources, see XmContainer(3). |
|
XmContainerReorder(3) -- Container widget function to reorder children
|
|
XmContainerReorder obtains the XmNpositionIndex constraint resources of each widget specified in widgets, sorts them in ascending order, and inserts the XmNpositionIndex constraint resources in the new order into each widget. If the XmNlayoutType resource of Container is XmOUTLINE or XmDETAIL, XmContainerReorder will force a layout of all items. container Specifies the Container widget ID. widgets... |
|
XmConvertStringToUnits(3) -- A function that converts a string specification to a unit value
|
|
XmConvertStringToUnits converts a string specification value and returns the converted value as the return value from the function. This function uses the specified screen's resolution to compute the number of units for the string specification. screen Specifies the screen whose resolution is to be used for the computation. spec Specifies the string, in format, to be conver... |
|
XmConvertUnits(3) -- A function that converts a value in one unit type to another unit type
|
|
XmConvertUnits converts the value and returns it as the return value from the function. For resources of type, dimension, or position, you can specify units using the syntax described in the XmNunitType resource of the XmPrimitive reference page. widget Specifies the widget for which the data is to be converted. orientation Specifies whether the converter uses the horizontal or vertical screen res... |
|
XmCreateArrowButton(3) -- The ArrowButton widget creation function
|
|
XmCreateArrowButton creates an instance of an ArrowButton widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of ArrowButton and its associated resources, see XmArrowButton(3)... |
|
XmCreateArrowButtonGadget(3) -- The ArrowButtonGadget creation function
|
|
XmCreateArrowButtonGadget creates an instance of an ArrowButtonGadget widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of ArrowButtonGadget and its associated resources, se... |
|
XmCreateBulletinBoard(3) -- The BulletinBoard widget creation function
|
|
XmCreateBulletinBoard creates an instance of a BulletinBoard widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of BulletinBoard and its associated resources, see XmBulletinB... |
|
XmCreateBulletinBoardDialog(3) -- The BulletinBoard BulletinBoardDialog convenience creation function
|
|
XmCreateBulletinBoardDialog is a convenience creation function that creates a DialogShell and an unmanaged BulletinBoard child of the DialogShell. A BulletinBoardDialog is used for interactions not supported by the standard dialog set. This function does not automatically create any labels, buttons, or other dialog components. Such components should be added by the application after the BulletinBo... |
|
XmCreateCascadeButton(3) -- The CascadeButton widget creation function
|
|
XmCreateCascadeButton creates an instance of a CascadeButton widget and returns the associated widget ID. parent Specifies the parent widget ID. The parent must be a RowColumn widget. name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of CascadeButton and i... |
|
XmCreateCascadeButtonGadget(3) -- The CascadeButtonGadget creation function
|
|
XmCreateCascadeButtonGadget creates an instance of a CascadeButtonGadget and returns the associated widget ID. parent Specifies the parent widget ID. The parent must be a RowColumn widget. name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of CascadeButtonG... |
|
XmCreateComboBox(3) -- The default ComboBox widget creation function
|
|
XmCreateComboBox creates an instance of a ComboBox widget of XmNcomboBoxType XmCOMBO_BOX and returns the associated widget ID. parent Specifies the parent widget ID. name Specifies the name of the created widget. arglist Specifies the argument list. arg_count Specifies the number of attribute/value pairs in the argument list (arglist). For a complete definition of ComboBox and its associated resou... |
|
XmCreateCommand(3) -- The Command widget creation function
|
|
XmCreateCommand creates an instance of a Command widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of Command and its associated resources, see XmCommand(3). |
|
XmCreateCommandDialog(3) -- The Command CommandDialog convenience creation function
|
|
XmCreateCommandDialog is a convenience function that creates a DialogShell and an unmanaged Command child of the DialogShell. A CommandDialog is used for entering commands for processing. Use XtManageChild to pop up the CommandDialog (passing the Command as the widget parameter); use XtUnmanageChild to pop it down. XmCreateCommandDialog forces the value of the Shell resource XmNallowShellResize to... |
|
XmCreateContainer(3) -- The Container widget creation function
|
|
XmCreateContainer creates an instance of a Container widget and returns the associated widget ID. parent Specifies the parent widget ID. name Specifies the name of the created widget. arglist Specifies the argument list. argcount Specifies the number of attribute/value pairs in the argument list (arglist). For a complete definition of Container and its associated resources, see XmContainer(3). |
|
XmCreateDialogShell(3) -- The DialogShell widget creation function
|
|
XmCreateDialogShell creates an instance of a DialogShell widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of DialogShell and its associated resources, see XmDialogShell(3). |
|
XmCreateDragIcon(3) -- A Drag and Drop function that creates a DragIcon widget
|
|
XmCreateDragIcon creates a DragIcon and returns the associated widget ID. widget Specifies the ID of the widget that the function uses to access default values for visual attributes of the DragIcon. This widget may be different than the actual parent of the DragIcon. name Specifies the name of the DragIcon widget. arglist Specifies the argument list. argcount Specifies the number of attribute/valu... |
|
XmCreateDrawingArea(3) -- The DrawingArea widget creation function
|
|
XmCreateDrawingArea creates an instance of a DrawingArea widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of DrawingArea and its associated resources, see XmDrawingArea(3). |
|
XmCreateDrawnButton(3) -- The DrawnButton widget creation function
|
|
XmCreateDrawnButton creates an instance of a DrawnButton widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of DrawnButton and its associated resources, see XmDrawnButton(3). |
|
XmCreateDropDownComboBox(3) -- The Drop-down ComboBox widget creation function
|
|
XmCreateDropDownComboBox creates an instance of a ComboBox widget of XmNcomboBoxType XmDROP_DOWN_COMBO_BOX and returns the associated widget ID. parent Specifies the parent widget ID. name Specifies the name of the created widget. arglist Specifies the argument list. arg_count Specifies the number of attribute/value pairs in the argument list (arglist). For a complete definition of ComboBox and it... |
|
XmCreateDropDownList(3) -- The Drop-down list ComboBox widget creation function
|
|
XmCreateDropDownList creates an instance of a ComboBox widget of XmNcomboBoxType XmDROP_DOWN_LIST and returns the associated widget ID. parent Specifies the parent widget ID. name Specifies the name of the created widget. arglist Specifies the argument list. arg_count Specifies the number of attribute/value pairs in the argument list (arglist). For a complete definition of ComboBox and its associa... |
|
XmCreateErrorDialog(3) -- The MessageBox ErrorDialog convenience creation function
|
|
XmCreateErrorDialog is a convenience creation function that creates a DialogShell and an unmanaged MessageBox child of the DialogShell. An ErrorDialog warns the user of an invalid or potentially dangerous condition. It includes a symbol, a message, and three buttons. The default symbol is an octagon with a diagonal slash. The default button labels are OK, Cancel, and Help. Use XtManageChild to pop... |
|
XmCreateFileSelectionBox(3) -- The FileSelectionBox widget creation function
|
|
XmCreateFileSelectionBox creates an unmanaged FileSelectionBox. A FileSelectionBox is used to select a file and includes the following: + An editable text field for the directory mask + A scrolling list of filenames + An editable text field for the selected file + Labels for the list and text fields + Four buttons The default button labels are OK, Filter, Cancel, and Help. Additional work area chi... |
|
XmCreateFileSelectionDialog(3) -- The FileSelectionBox FileSelectionDialog convenience creation function
|
|
XmCreateFileSelectionDialog is a convenience creation function that creates a DialogShell and an unmanaged FileSelectionBox child of the DialogShell. A FileSelectionDialog selects a file. It includes the following: + An editable text field for the directory mask + A scrolling list of filenames + An editable text field for the selected file + Labels for the list and text fields + Four buttons The d... |
|
XmCreateForm(3) -- The Form widget creation function
|
|
XmCreateForm creates an instance of a Form widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of Form and its associated resources, see XmForm(3). |
|
XmCreateFormDialog(3) -- A Form FormDialog convenience creation function
|
|
XmCreateFormDialog is a convenience creation function that creates a DialogShell and an unmanaged Form child of the DialogShell. A FormDialog is used for interactions not supported by the standard dialog set. This function does not automatically create any labels, buttons, or other dialog components. Such components should be added by the application after the FormDialog is created. Use XtManageCh... |
|
XmCreateFrame(3) -- The Frame widget creation function
|
|
XmCreateFrame creates an instance of a Frame widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of Frame and its associated resources, see XmFrame(3). |
|
XmCreateIconGadget(3) -- The IconGadget widget creation function
|
|
XmCreateIconGadget creates an instance of an IconGadget widget and returns the associated widget ID. parent Specifies the parent widget ID. name Specifies the name of the created widget. arglist Specifies the argument list. argcount Specifies the number of attribute/value pairs in the argument list (arglist). For a complete definition of IconGadget and its associated resources, see XmIconGadget(3)... |
|
XmCreateInformationDialog(3) -- The MessageBox InformationDialog convenience creation function
|
|
XmCreateInformationDialog is a convenience creation function that creates a DialogShell and an unmanaged MessageBox child of the DialogShell. An InformationDialog gives the user information, such as the status of an action. It includes a symbol, a message, and three buttons. The default symbol is i. The default button labels are OK, Cancel, and Help. Use XtManageChild to pop up the InformationDial... |
|
XmCreateLabel(3) -- The Label widget creation function
|
|
XmCreateLabel creates an instance of a Label widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of Label and its associated resources, see XmLabel(3). |
|
XmCreateLabelGadget(3) -- The LabelGadget creation function
|
|
XmCreateLabelGadget creates an instance of a LabelGadget widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of LabelGadget and its associated resources, see XmLabelGadget(3). |
|
XmCreateList(3) -- The List widget creation function
|
|
XmCreateList creates an instance of a List widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of List and its associated resources, see XmList(3). |
|
XmCreateMainWindow(3) -- The MainWindow widget creation function
|
|
XmCreateMainWindow creates an instance of a MainWindow widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of MainWindow and its associated resources, see XmMainWindow(3). |
|
XmCreateMenuBar(3) -- A RowColumn widget convenience creation function
|
|
XmCreateMenuBar creates an instance of a RowColumn widget of type XmMENU_BAR and returns the associated widget ID. It is provided as a convenience function for creating RowColumn widgets configured to operate as a MenuBar and is not implemented as a separate widget class. The MenuBar widget is generally used for building a Pulldown menu system. Typically, a MenuBar is created and placed along the ... |
|
XmCreateMenuShell(3) -- The MenuShell widget creation function
|
|
XmCreateMenuShell creates an instance of a MenuShell widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of MenuShell and its associated resources, see XmMenuShell(3). |
|
XmCreateMessageBox(3) -- The MessageBox widget creation function
|
|
XmCreateMessageBox creates an unmanaged MessageBox. A MessageBox is used for common interaction tasks, which include giving information, asking questions, and reporting errors. It includes an optional symbol, a message, and three buttons. By default, there is no symbol. The default button labels are OK, Cancel, and Help. If the parent of the MessageBox is a DialogShell, use XtManageChild to pop up... |
|
XmCreateMessageDialog(3) -- The MessageBox MessageDialog convenience creation function
|
|
XmCreateMessageDialog is a convenience creation function that creates a DialogShell and an unmanaged MessageBox child of the DialogShell. A MessageDialog is used for common interaction tasks, which include giving information, asking questions, and reporting errors. It includes a symbol, a message, and three buttons. By default, there is no symbol. The default button labels are OK, Cancel, and Help... |
|
XmCreateNotebook(3) -- The Notebook widget creation function
|
|
XmCreateNotebook creates an instance of a Notebook widget and returns the associated widget ID. parent Specifies the parent widget ID. name Specifies the name of the created widget. arglist Specifies the argument list. argcount Specifies the number of attribute/value pairs in the argument list (arglist). For a complete definition of Notebook and its associated resources, see XmNotebook(3). |
|
XmCreateOptionMenu(3) -- A RowColumn widget convenience creation function
|
|
XmCreateOptionMenu creates an instance of a RowColumn widget of type XmMENU_OPTION and returns the associated widget ID. It is provided as a convenience function for creating a RowColumn widget configured to operate as an OptionMenu and is not implemented as a separate widget class. The OptionMenu widget is a specialized RowColumn manager composed of a label, a selection area, and a single Pulldow... |
|
XmCreatePanedWindow(3) -- The PanedWindow widget creation function
|
|
XmCreatePanedWindow creates an instance of a PanedWindow widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of PanedWindow and its associated resources, see XmPanedWindow(3). |
|
XmCreatePopupMenu(3) -- A RowColumn widget convenience creation function
|
|
XmCreatePopupMenu creates an instance of a RowColumn widget of type XmMENU_POPUP and returns the associated widget ID. When this function is used to create the Popup menu pane, a MenuShell widget is automatically created as the parent of the menu pane. The parent of the MenuShell widget is the widget indicated by the parent parameter. XmCreatePopupMenu is provided as a convenience function for cre... |
|
XmCreatePromptDialog(3) -- The SelectionBox PromptDialog convenience creation function
|
|
XmCreatePromptDialog is a convenience creation function that creates a DialogShell and an unmanaged SelectionBox child of the DialogShell. A PromptDialog prompts the user for text input. It includes a message, a text input region, and three managed buttons. The default button labels are OK, Cancel, and Help. An additional button, with Apply as the default label, is created unmanaged; it may be exp... |
|
XmCreatePulldownMenu(3) -- A RowColumn widget convenience creation function
|
|
XmCreatePulldownMenu creates an instance of a RowColumn widget of type XmMENU_PULLDOWN and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) Specifies the number of attribute/value pairs in the argument list (a... |
|
XmCreatePushButton(3) -- The PushButton widget creation function
|
|
XmCreatePushButton creates an instance of a PushButton widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of PushButton and its associated resources, see XmPushButton(3). |
|
XmCreatePushButtonGadget(3) -- The PushButtonGadget creation function
|
|
XmCreatePushButtonGadget creates an instance of a PushButtonGadget widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of PushButtonGadget and its associated resources, see Xm... |
|
XmCreateQuestionDialog(3) -- The MessageBox QuestionDialog convenience creation function
|
|
XmCreateQuestionDialog is a convenience creation function that creates a DialogShell and an unmanaged MessageBox child of the DialogShell. A QuestionDialog is used to get the answer to a question from the user. It includes a symbol, a message, and three buttons. The default symbol is a question mark. The default button labels are OK, Cancel, and Help. Use XtManageChild to pop up the QuestionDialog... |
|
XmCreateRadioBox(3) -- A RowColumn widget convenience creation function
|
|
XmCreateRadioBox creates an instance of a RowColumn widget of type XmWORK_AREA and returns the associated widget ID. Typically, this is a composite widget that contains multiple ToggleButtonGadgets. The RadioBox arbitrates and ensures that at most one ToggleButtonGadget is on at any time. Unless the application supplies other values in the arglist, this function provides initial values for several... |
|
XmCreateRowColumn(3) -- The RowColumn widget creation function
|
|
XmCreateRowColumn creates an instance of a RowColumn widget and returns the associated widget ID. If XmNrowColumnType is not specified, then it is created with XmWORK_AREA, which is the default. If this function is used to create a Popup Menu of type XmMENU_POPUP or a Pulldown Menu of type XmMENU_PULLDOWN, a MenuShell widget is not automatically created as the parent of the menu pane. The applicat... |
|
XmCreateScale(3) -- The Scale widget creation function
|
|
XmCreateScale creates an instance of a Scale widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of Scale and its associated resources, see XmScale(3). |
|
XmCreateScrollBar(3) -- The ScrollBar widget creation function
|
|
XmCreateScrollBar creates an instance of a ScrollBar widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of ScrollBar and its associated resources, see XmScrollBar(3). |
|
XmCreateScrolledList(3) -- The List ScrolledList convenience creation function
|
|
XmCreateScrolledList creates an instance of a List widget that is contained within a ScrolledWindow. The ScrolledWindow parent is created managed. All ScrolledWindow subarea widgets are automatically created by this function. The ID returned by this function is that of the List widget (not the ScrolledWindow widget). Use this widget ID for all operations on the List widget. Use the widget ID of th... |
|
XmCreateScrolledText(3) -- The Text ScrolledText convenience creation function
|
|
XmCreateScrolledText creates an instance of a Text widget that is contained within a ScrolledWindow. The ScrolledWindow parent is created managed. All ScrolledWindow subarea widgets are automatically created by this function. The ID returned by this function is that of the Text widget (not the ScrolledWindow widget). Use this widget ID for all operations on the Text widget. Use the widget ID of th... |
|
XmCreateScrolledWindow(3) -- The ScrolledWindow widget creation function
|
|
XmCreateScrolledWindow creates an instance of a ScrolledWindow widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of ScrolledWindow and its associated resources, see XmScroll... |
|
XmCreateSelectionBox(3) -- The SelectionBox widget creation function
|
|
XmCreateSelectionBox creates an unmanaged SelectionBox. A SelectionBox is used to get a selection from a list of alternatives from the user and includes the following: + A scrolling list of alternatives + An editable text field for the selected alternative + Labels for the list and text field + Three or four buttons The default button labels are OK, Cancel, and Help. By default, an Apply button is... |
|
XmCreateSelectionDialog(3) -- The SelectionBox SelectionDialog convenience creation function
|
|
XmCreateSelectionDialog is a convenience creation function that creates a DialogShell and an unmanaged SelectionBox child of the DialogShell. A SelectionDialog offers the user a choice from a list of alternatives and gets a selection. It includes the following: + A scrolling list of alternatives + An editable text field for the selected alternative + Labels for the text field + Four buttons The de... |
|
XmCreateSeparator(3) -- The Separator widget creation function
|
|
XmCreateSeparator creates an instance of a Separator widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of Separator and its associated resources, see XmSeparator(3). |
|
XmCreateSeparatorGadget(3) -- The SeparatorGadget creation function
|
|
XmCreateSeparatorGadget creates an instance of a SeparatorGadget widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of SeparatorGadget and its associated resources, see XmSep... |
|
XmCreateSimpleCheckBox(3) -- A RowColumn widget convenience creation function
|
|
XmCreateSimpleCheckBox creates an instance of a RowColumn widget of type XmWORK_AREA and returns the associated widget ID. This routine creates a CheckBox and its ToggleButtonGadget children. A CheckBox is similar to a RadioBox, except that more than one button can be selected at a time. The name of each button is button_n, where n, where n is an integer from 0 (zero) to the number of buttons in t... |
|
XmCreateSimpleMenuBar(3) -- A RowColumn widget convenience creation function
|
|
XmCreateSimpleMenuBar creates an instance of a RowColumn widget of type XmMENU_BAR and returns the associated widget ID. This routine creates a MenuBar and its CascadeButtonGadget children. The name of each button is button_n, where n, where n is an integer from 0 (zero) to the number of buttons in the menu minus 1. Buttons are named and created in the order they are specified in the RowColumn sim... |
|
XmCreateSimpleOptionMenu(3) -- A RowColumn widget convenience creation function
|
|
XmCreateSimpleOptionMenu creates an instance of a RowColumn widget of type XmMENU_OPTION and returns the associated widget ID. This routine creates an OptionMenu and its submenu containing PushButtonGadget or CascadeButtonGadget children. The name of each button is button_n, where n, where n is an integer from 0 (zero) to the number of buttons in the menu minus 1. The name of each separator is sep... |
|
XmCreateSimplePopupMenu(3) -- A RowColumn widget convenience creation function
|
|
XmCreateSimplePopupMenu creates an instance of a RowColumn widget of type XmMENU_POPUP and returns the associated widget ID. This routine creates a Popup menu pane and its button children. The name of each button is button_n, where n, where n is an integer from 0 (zero) to the number of buttons in the menu minus 1. The name of each separator is separator_n, where n, where n is an integer from 0 (z... |
|
XmCreateSimplePulldownMenu(3) -- A RowColumn widget convenience creation function
|
|
XmCreateSimplePulldownMenu creates an instance of a RowColumn widget of type XmMENU_PULLDOWN and returns the associated widget ID. This routine creates a Pulldown menu pane and its button children. The name of each button is button_n, where n, where n is an integer from 0 (zero) to the number of buttons in the menu minus 1. The name of each separator is separator_n, where n, where n is an integer ... |
|
XmCreateSimpleRadioBox(3) -- A RowColumn widget convenience creation function
|
|
XmCreateSimpleRadioBox creates an instance of a RowColumn widget of type XmWORK_AREA and returns the associated widget ID. This routine creates a RadioBox and its ToggleButtonGadget children. The name of each button is button_n, where n, where n is an integer from 0 (zero) to the number of buttons in the menu minus 1. Buttons are named and created in the order they are specified in the RowColumn s... |
|
XmCreateSimpleSpinBox(3) -- the SimpleSpinBox widget creation function
|
|
The XmCreateSimpleSpinBox function creates an instance of a SpinBox widget and returns the associated widget ID. The parent argument specifies the parent widget ID. The name argument specifies the name of the created widget. The arglist argument specifies the argument list. The argcount argument specifies the number of attribute/value pairs in the argument list. |
|
XmCreateSpinBox(3) -- The SpinBox creation function
|
|
XmCreateSpinBox creates a SpinBox widget. This function creates a SpinBox with two arrows, but without any traversable children (choices to spin). The application can create text children to go with this parent SpinBox using XmCreateTextField or XmCreateText. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies t... |
|
XmCreateTemplateDialog(3) -- A MessageBox TemplateDialog convenience creation function
|
|
XmCreateTemplateDialog is a convenience creation function that creates a DialogShell and an unmanaged MessageBox child of the DialogShell. The MessageBox widget's XmNdialogType resource is set to XmDIALOG_TEMPLATE. By default, the TemplateDialog widget contains only the separator child. You can build a customized dialog by adding children to the TemplateDialog. You can create the standard Message... |
|
XmCreateText(3) -- The Text widget creation function
|
|
XmCreateText creates an instance of a Text widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of Text and its associated resources, see XmText(3). |
|
XmCreateTextField(3) -- The TextField widget creation function
|
|
XmCreateTextField creates an instance of a TextField widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of TextField and its associated resources, see XmTextField(3). |
|
XmCreateToggleButton(3) -- The ToggleButton widget creation function
|
|
XmCreateToggleButton creates an instance of a ToggleButton widget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of ToggleButton and its associated resources, see XmToggleButton... |
|
XmCreateToggleButtonGadget(3) -- The ToggleButtonGadget creation function
|
|
XmCreateToggleButtonGadget creates an instance of a ToggleButtonGadget and returns the associated widget ID. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of ToggleButtonGadget and its associated resources, see XmT... |
|
XmCreateWarningDialog(3) -- The MessageBox WarningDialog convenience creation function
|
|
XmCreateWarningDialog is a convenience creation function that creates a DialogShell and an unmanaged MessageBox child of the DialogShell. A WarningDialog warns users of action consequences and gives them a choice of resolutions. It includes a symbol, a message, and three buttons. The default symbol is an exclamation point. The default button labels are OK, Cancel, and Help. Use XtManageChild to po... |
|
XmCreateWorkArea(3) -- A function that creates a RowColumn WorkArea
|
|
XmCreateWorkArea creates an instance of a RowColumn widget and returns the associated widget ID. The widget is created with XmNrowColumnType set to XmWORK_AREA. parent Specifies the parent widget ID name Specifies the name of the created widget arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of RowC... |
|
XmCreateWorkingDialog(3) -- The MessageBox WorkingDialog convenience creation function
|
|
XmCreateWorkingDialog is a convenience creation function that creates a DialogShell and an unmanaged MessageBox child of the DialogShell. A WorkingDialog informs users that there is a time-consuming operation in progress and allows them to cancel the operation. It includes a symbol, a message, and three buttons. The default symbol is an hourglass. The default button labels are OK, Cancel, and Help... |
|
XmCvtByteStreamToXmString(3) -- A compound string function that converts from a compound string in Byte Stream format to a compound string
|
|
XmCvtByteStreamToXmString converts a stream of bytes representing a compound string in Byte Stream format to a compound string. This routine is typically used by the destination of a data transfer operation to produce a compound string from a transferred Byte Stream representation. property Specifies a compound string representation in Byte Stream format. |
|
XmCvtCTToXmString(3) -- A compound string function that converts compound text to a compound string
|
|
XmCvtCTToXmString converts a (char *) string in compound text format to a compound string. The application must call XtAppInitialize before calling this function. Conversion of compound text to compound strings is implementation dependent. text Specifies a string in compound text format to be converted to a compound string. |
|
XmCvtStringToUnitType(3) -- A function that converts a string to a unittype value
|
|
XmCvtStringToUnitType converts a string to a unit type. Refer to the reference pages for XmGadget, XmManager, or XmPrimitive for a description of the valid unit types. Use of this function as a resource converter is obsolete. It has been replaced by a new resource converter that uses the RepType facility. args Specifies a list of additional XrmValue arguments to the converter if additional context... |
|
XmCvtTextPropertyToXmStringTable(3) -- A function that converts from a TextProperty Structure to a StringTable
|
|
XmCvtTextPropertyToXmStringTable converts the specified XTextProperty structure into an XmStringTable, as follows: + If the encoding member of text_prop is the Atom STRING, each returned XmString has a tag of "ISO8859-1" and a text type of XmCHARSET_TEXT. + If the encoding member of text_prop is the encoding of the current locale, and if that encoding is not STRING, each returned XmString has a ... |
|
XmCvtXmStringTableToTextProperty(3) -- A function that converts from XmStringTable to an XTextProperty Structure
|
|
XmCvtXmStringTableToTextProperty converts the XmStrings in the specified XmStringTable into an XTextProperty structure. The function sets the encoding member of text_prop_return to an Atom for the specified display naming the encoding determined by the specified style, and it converts the first count compound strings in the specified XmStringTable to this encoding for storage in the text_prop_retu... |
|
XmCvtXmStringToByteStream(3) -- A compound string function that converts a compound string to a Byte Stream format
|
|
XmCvtXmStringToByteStream converts a compound string to a string of bytes representing the compound string in Byte Stream format. This routine is typically used by the source of a data transfer operation to produce a Byte Stream representation for transferring a compound string to a destination. If prop_return is not NULL, this function creates a string of characters in Byte Stream format and retu... |
|
XmCvtXmStringToCT(3) -- A compound string function that converts a compound string to compound text
|
|
XmCvtXmStringToCT converts a compound string to a (char *) string in compound text format. The application must call XtAppInitialize before calling this function. The converter uses the font list tag associated with a given compound string segment to select a compound text format for that segment. A registry defines a mapping between font list tags and compound text encoding formats. The converter... |
|
XmDeactivateProtocol(3) -- A VendorShell function that deactivates a protocol without removing it
|
|
XmDeactivateProtocol deactivates a protocol without removing it. It updates the handlers and the property if the shell is realized. It is sometimes useful to allow a protocol's state information (callback lists, and so on) to persist, even though the client may choose to temporarily resign from the interaction. The main use of this capability is to gray/ungray f.send_msg entries in the MWM system... |
|
XmDeactivateWMProtocol(3) -- A VendorShell convenience interface that deactivates a protocol without removing it
|
|
XmDeactivateWMProtocol is a convenience interface. It calls XmDeactivateProtocol with the property value set to the atom returned by interning WM_PROTOCOLS. shell Specifies the widget with which the protocol property is associated protocol Specifies the protocol atom For a complete definition of VendorShell and its associated resources, see VendorShell(3). |
|
XmDestroyPixmap(3) -- A pixmap caching function that removes a pixmap from the pixmap cache
|
|
XmDestroyPixmap removes pixmaps that are no longer used. Pixmaps are completely freed only when there is no further reference to them. screen Specifies the display screen for which the pixmap was requested pixmap Specifies the pixmap to be destroyed |
|
XmDialogShell(3) -- The DialogShell widget class
|
|
Modal and modeless dialogs use DialogShell as the Shell parent. DialogShell widgets cannot be iconified. Instead, all secondary DialogShell widgets associated with an ApplicationShell widget are iconified and de-iconified as a group with the primary widget. The client indirectly manipulates DialogShell through the convenience interfaces during creation, and it can directly manipulate its BulletinB... |
|
XmDirection(3) -- Data type for the direction of widget components
|
|
XmDirection is the data type specifying the direction in which the system displays subwidgets, children of widgets, or other visual components that are to be laid out. This data type also affects traversal order within tab groups. XmDirection is implemented as an unsigned char bit mask. The horizontal and vertical directions can be specified independent of each other. XmDirection also specifies th... |
|
XmDirectionMatch(3) -- A function that checks for a specified direction component
|
|
XmDirectionMatch compares two XmDirection values. The function returns a Boolean value depending on whether or not the two input values "match." The simplest match is when d1 and d2 are identical. However, other matches are possible. XmDirectionMatch attempts to compare specified bits only; nonspecified bits automatically match. For example, suppose that d1 equals XmTOP_TO_BOTTOM_RIGHT_TO_LEFT. ... |
|
XmDirectionMatchPartial(3) -- A function that checks for a specified direction component
|
|
XmDirectionMatchPartial compares d1 and d2 along the direction component specified by dmask. For example, if dmask equals XmVERTICAL_MASK, then the function will compare only the vertical components of d1 and d2. d1 Specifies an XmDirection value to check. d2 Specifies an XmDirection value to check. dmask Specifies the direction component along which d1 and d2 are to be checked. Appropriate values... |
|
XmDirectionToStringDirection(3) -- A function that converts an XmDirection value to an XmStringDirection value
|
|
XmDirectionToStringDirection converts the specified XmDirection direction value to its equivalent XmStringDirection value. Basically, if the XmDirection value has a horizontal direction specification, that horizontal element is used; otherwise, the XmStringDirection value is interpreted as XmSTRING_DIRECTION_L_TO_R. This function provides backward compatibility with the XmStringDirection data type... |
|
XmDisplay(3) -- The Display widget class
|
|
The XmDisplay object is used by the Motif widgets to store information that is specific to a display. It also allows the toolkit to access certain information on widget hierarchies that would otherwise be unavailable. Each client has one XmDisplay object for each display it accesses. An XmDisplay object is automatically created when the application creates the first shell on a display (usually acc... |
|
XmDragCancel(3) -- A Drag and Drop function that terminates a drag transaction
|
|
XmDragCancel terminates a drag operation and cancels any pending actions of the specified DragContext. This routine can only be called by the initiator client. dragcontext Specifies the ID of the DragContext widget associated with the drag and drop transaction to be terminated For a complete definition of DragContext and its associated resources, see XmDragContext(3). |
|
XmDragContext(3) -- The DragContext widget class
|
|
DragContexts are special widgets used in drag and drop transactions. A DragContext is implemented as a widget, but a client does not explicitly create a DragContext widget. Instead, a client initiates a drag and drop transaction by calling XmDragStart, and this routine initializes and returns a DragContext widget. There is a unique DragContext for each drag operation. The toolkit frees a DragConte... |
|
XmDragIcon(3) -- The DragIcon widget class
|
|
A DragIcon is a component of the visual used to represent the source data in a drag and drop transaction. During a drag operation, a real or simulated X cursor provides drag-over visuals consisting of a static portion that represents the object being dragged, and dynamic cues that provide visual feedback during the drag operation. The visual is attained by blending together various XmDragIcons spe... |
|
XmDragStart(3) -- A Drag and Drop function that initiates a drag and drop transaction
|
|
XmDragStart initiates a drag operation. This routine returns the DragContext widget that it initializes for the associated drag transaction. The toolkit is responsible for freeing the DragContext when the drag and drop transaction is complete. widget Specifies the ID of the smallest widget and/or gadget that encloses the source elements selected for a drag operation. event Specifies the XEvent tha... |
|
XmDrawingArea(3) -- The DrawingArea widget class
|
|
DrawingArea is an empty widget that is easily adaptable to a variety of purposes. It does no drawing and defines no behavior except for invoking callbacks. Callbacks notify the application when graphics need to be drawn (exposure events or widget resize) and when the widget receives input from the keyboard or mouse. Applications are responsible for defining appearance and behavior as needed in res... |
|
XmDrawnButton(3) -- The DrawnButton widget class
|
|
The DrawnButton widget consists of an empty widget window surrounded by a shadow border. It provides the application developer with a graphics area that can have PushButton input semantics. Callback types are defined for widget exposure and widget resize to allow the application to redraw or reposition its graphics. If the DrawnButton widget has a highlight and shadow thickness, the application sh... |
|
XmDropSite(3) -- The DropSite Registry
|
|
A client registers a widget or gadget as a drop site using the XmDropSiteRegister function. In addition, this routine defines the behavior and capabilities of a drop site by specifying appropriate resources. For example, the XmNimportTargets and XmNnumImportTargets resources identify respectively the selection target types and number of types supported by a drop site. The visual animation effects ... |
|
XmDropSiteConfigureStackingOrder(3) -- A Drag and Drop function that reorders a stack of widgets that are registered drop sites
|
|
XmDropSiteConfigureStackingOrder changes the stacking order of the drop site specified by widget. The stacking order controls the manner in which drag-under effects are clipped by overlapping siblings, regardless of whether they are active. The stack mode is relative either to the entire stack, or to another drop site within the stack. The stack order can be modified only if the drop sites are sib... |
|
XmDropSiteEndUpdate(3) -- A Drag and Drop function that facilitates processing updates to multiple drop sites
|
|
XmDropSiteEndUpdate is used in conjunction with XmDropSiteStartUpdate to process updates to multiple drop sites within the same hierarchy. XmDropSiteStartUpdate and XmDropSiteEndUpdate signal the beginning and the end respectively of a series of calls to XmDropSiteUpdate. Calls to XmDropSiteStartUpdate and XmDropSiteEndUpdate can be recursively stacked. Using these routines optimizes the processin... |
|
XmDropSiteQueryStackingOrder(3) -- A Drag and Drop function that returns the parent, a list of children, and the number of children for a specifi
|
|
XmDropSiteQueryStackingOrder obtains the parent, a list of children registered as drop sites, and the number of children registered as drop sites for a given widget. The children are listed in current stacking order, from bottom-most (first child) to the top-most (last child). This function allocates memory for the returned data that must be freed by calling XtFree. widget Specifies the widget ID.... |
|
XmDropSiteRegister(3) -- A Drag and Drop function that identifies a drop site and assigns resources that specify its behavior
|
|
XmDropSiteRegister identifies the specified widget or gadget as a drop site and sets resource values that define the drop site's behavior. The routine assigns default values to any resources that are not specified in the argument list. The toolkit generates a warning message if a drop site is registered with XmNdropSiteActivity set to XmDROP_SITE_ACTIVE and the XmNdropProc resource is NULL. If th... |
|
XmDropSiteRegistered(3) -- A Drag and Drop function that determines if a drop site has been registered
|
|
XmDropSiteRegistered determines if the specified widget has a drop site registered. If a drop site is registered, this function returns True. widget Specifies the ID of the widget being queried. For a complete definition of DropSite and its associated resources, see XmDropSite(3). |
|
XmDropSiteRetrieve(3) -- A Drag and Drop function that retrieves resource values set on a drop site
|
|
XmDropSiteRetrieve extracts values for the given resources from the drop site specified by widget. An initiator can also obtain information about the current drop site by passing the associated DragContext widget as the widget parameter to this routine. The initiator can retrieve all of the drop site resources except XmNdragProc and XmNdropProc using this method. widget Specifies the ID of the wid... |
|
XmDropSiteStartUpdate(3) -- A Drag and Drop function that facilitates processing updates to multiple drop sites
|
|
XmDropSiteStartUpdate is used in conjunction with XmDropSiteEndUpdate to process updates to multiple drop sites within the same shell widget. XmDropSiteStartUpdate and XmDropSiteEndUpdate signal the beginning and the end respectively of a series of calls to XmDropSiteUpdate. Calls to XmDropSiteStartUpdate and XmDropSiteEndUpdate can be recursively stacked. Using these routines optimizes the proces... |
|
XmDropSiteUnregister(3) -- A Drag and Drop function that frees drop site information
|
|
XmDropSiteUnregister informs the toolkit that the specified widget is no longer a registered drop site. The function frees all associated drop site information. widget Specifies the ID of the widget, registered as a drop site, that is to be unregistered For a complete definition of DropSite and its associated resources, see XmDropSite(3). |
|
XmDropSiteUpdate(3) -- A Drag and Drop function that sets resource values for a drop site
|
|
XmDropSiteUpdate modifies drop site resources associated with the specified widget. This routine updates the drop site resources specified in the arglist. widget Specifies the ID of the widget registered as a drop site arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of DropSite and its associated re... |
|
XmDropTransfer(3) -- The DropTransfer widget class
|
|
DropTransfer provides a set of resources that identifies the procedures and associated information required by the toolkit in order to process and complete a drop transaction. Clients should not explicitly create a DropTransfer widget. Instead, a client initiates a transfer by calling XmDropTransferStart, which initializes and returns a DropTransfer widget. If this function is called within an XmN... |
|
XmDropTransferAdd(3) -- A Drag and Drop function that enables additional drop transfer entries to be processed after initiating a drop
|
|
XmDropTransferAdd identifies a list of additional drop transfer entries to be processed after a drop transfer is started. drop_transfer Specifies the ID of the DropTransfer widget returned by XmDropTransferStart transfers Specifies the additional drop transfer entries that the receiver wants processed num_transfers Specifies the number of items in the transfers array For a complete definition of D... |
|
XmDropTransferStart(3) -- A Drag and Drop function that initiates a drop transfer
|
|
XmDropTransferStart initiates a drop transfer and uses the specified argument list to initialize an XmDropTransfer object. The DropTransfer object can be manipulated with XtSetValues and XtGetValues until the last call to the XmNtransferProc procedure is made. After that point, the result of using the widget pointer is undefined. The DropTransfer object is freed by the toolkit when a transfer is c... |
|
XmFileSelectionBox(3) -- The FileSelectionBox widget class
|
|
FileSelectionBox traverses through directories, views the files and subdirectories in them, and then selects files. A FileSelectionBox has five main areas: + A text input field for displaying and editing a directory mask used to select the files to be displayed + An optional text input field for displaying and editing a filter mask used to select the files to be displayed. + A scrollable list of f... |
|
XmFileSelectionBoxGetChild(3) -- A FileSelectionBox function used to access a component
|
|
XmFileSelectionBoxGetChild is used to access a component within a FileSelectionBox. The parameters given to the function are the FileSelectionBox widget and a value indicating which component to access. NOTE: This routine is obsolete and exists for compatibility with previous releases. Instead of calling XmFileSelectionBoxGetChild, you should call XtNameToWidget as described in the XmFileSelection... |
|
XmFileSelectionDoSearch(3) -- A FileSelectionBox function that initiates a directory search
|
|
XmFileSelectionDoSearch initiates a directory and file search in a FileSelectionBox widget. For a description of the actions that the FileSelectionBox takes when doing a search, see XmFileSelectionBox(3). widget Specifies the FileSelectionBox widget ID. dirmask Specifies the directory mask used in determining the directories and files displayed in the FileSelectionBox lists. This value is used as ... |
|
XmFontList(3) -- Data type for a font list
|
|
XmFontList is the data type for a font list. A font list consists of font list entries. Each entry contains a font or a font set (a group of fonts) and is identified with a tag, which is optional. If this tag is NULL, the tag is set to XmFONTLIST_DEFAULT_TAG. The value of XmFONTLIST_DEFAULT_TAG is XmFONTLIST_DEFAULT_TAG_STRING. When a compound string is displayed, the font list element tag of the ... |
|
XmFontListAdd(3) -- A font list function that creates a new font list
|
|
XmFontListAdd creates a new font list consisting of the contents of oldlist and the new font list element being added. This function deallocates oldlist after extracting the required information; therefore, do not reference oldlist thereafter. NOTE: This function is obsolete and exists for compatibility with previous releases. It has been replaced by XmFontListAppendEntry. oldlist Specifies a poin... |
|
XmFontListAppendEntry(3) -- A font list function that appends an entry to a font list
|
|
XmFontListAppendEntry creates a new font list that contains the contents of oldlist. This function copies the contents of the font list entry being added into this new font list. If oldlist is NULL, XmFontListAppendEntry creates a new font list containing only the single entry specified. This function deallocates the original font list after extracting the required information. The caller must fre... |
|
XmFontListCopy(3) -- A font list function that copies a font list
|
|
XmFontListCopy creates a new font list consisting of the contents of the fontlist argument. fontlist Specifies a font list to be copied |
|
XmFontListCreate(3) -- A font list function that creates a font list
|
|
XmFontListCreate creates a new font list with a single element specified by the provided font and character set. It also allocates the space for the font list. NOTE: This function is obsolete and exists for compatibility with previous releases. It is replaced by XmFontListAppendEntry. font Specifies a pointer to a font structure for which the new font list is generated. This is the structure retur... |
|
XmFontListEntryCreate(3) -- A font list function that creates a font list entry
|
|
XmFontListEntryCreate creates a font list entry that contains either a font or font set and is identified by a tag. tag Specifies a NULL terminated string for the tag of the font list entry. The tag may be specified as XmFONTLIST_DEFAULT_TAG, which is used to identify the default font list element in a font list. type Specifies whether the font argument is a font structure or a font set. Valid val... |
|
XmFontListEntryFree(3) -- A font list function that recovers memory used by a font list entry
|
|
XmFontListEntryFree recovers memory used by a font list entry. This routine does not free the XFontSet or XFontStruct associated with the font list entry. entry Specifies a pointer to the font list entry to be freed. In addition, it may be necessary to take the address of the font list entry (via the & operator) before passing it to this function. |
|
XmFontListEntryGetFont(3) -- A font list function that retrieves font information from a font list entry
|
|
XmFontListEntryGetFont retrieves font information for a specified font list entry. If the font list entry contains a font, type_return returns XmFONT_IS_FONT and the function returns a pointer to an XFontStruct. If the font list entry contains a font set, type_return returns XmFONT_IS_FONTSET and the function returns the XFontSet. entry Specifies the font list entry. type_return Specifies a pointe... |
|
XmFontListEntryGetTag(3) -- A font list function that retrieves the tag of a font list entry
|
|
XmFontListEntryGetTag retrieves a copy of the tag of the specified font list entry. This routine allocates memory for the tag string that must be freed by the application. entry Specifies the font list entry |
|
XmFontListEntryLoad(3) -- A font list function that loads a font or creates a font set and creates an accompanying font list entry
|
|
XmFontListEntryLoad loads a font or creates a font set based on the value of the type argument. It creates and returns a font list entry that contains the font or font set and the specified tag. If the value of type is XmFONT_IS_FONT, the function uses the XtCvtStringToFontStruct routine to convert the value of font_name to a font struct. If the value of type is XmFONT_IS_FONTSET, the function use... |
|
XmFontListFree(3) -- A font list function that recovers memory used by a font list
|
|
XmFontListFree recovers memory used by a font list. This routine does not free the XFontSet or XFontStruct associated with the specified font list. list Specifies the font list to be freed |
|
XmFontListFreeFontContext(3) -- A font list function that instructs the toolkit that the font list context is no longer needed
|
|
XmFontListFreeFontContext instructs the toolkit that the context is no longer needed and will not be used without reinitialization. context Specifies the font list context structure that was allocated by the XmFontListInitFontContext function |
|
XmFontListGetNextFont(3) -- A font list function that allows applications to access the fonts and character sets in a font list
|
|
XmFontListGetNextFont accesses the character set and font for the next entry of the font list. The application first uses the XmFontListInitFontContext routine to create a font list context. The application then calls XmFontListGetNextFont repeatedly with the same context. Each succeeding call accesses the next element of the font list. When finished, the application calls XmFontListFreeFontContex... |
|
XmFontListInitFontContext(3) -- A font list function that allows applications to access the entries in a font list
|
|
XmFontListInitFontContext establishes a context to allow applications to access the contents of a font list. This context is used when reading the font list entry tag, font, or font set associated with each entry in the font list. A Boolean status is returned to indicate whether or not the font list is valid. If an application deallocates the font list passed to XmFontListInitFontContext as the fo... |
|
XmFontListNextEntry(3) -- A font list function that returns the next entry in a font list
|
|
XmFontListNextEntry returns the next entry in the font list. The application uses the XmFontListInitFontContext routine to create a font list context. The first call to XmFontListNextEntry sets the context to the first entry in the font list. The application then calls XmFontListNextEntry repeatedly with the same context. Each succeeding call accesses the next entry of the font list. When finished... |
|
XmFontListRemoveEntry(3) -- A font list function that removes a font list entry from a font list
|
|
XmFontListRemoveEntry creates a new font list that contains the contents of oldlist minus those entries specified in entry. The routine removes any entries from oldlist that match the components (tag, type font/font set) of the specified entry. The function deallocates the original font list after extracting the required information. The caller uses XmFontListEntryFree to recover memory allocated ... |
|
XmForm(3) -- The Form widget class
|
|
Form is a container widget with no input semantics of its own. Constraints are placed on children of the Form to define attachments for each of the child's four sides. These attachments can be to the Form, to another child widget or gadget, to a relative position within the Form, or to the initial position of the child. The attachments determine the layout behavior of the Form when resizing occur... |
|
XmFrame(3) -- The Frame widget class
|
|
Frame is a very simple manager used to enclose a single work area child in a border drawn by Frame. It uses the Manager class resources for border drawing and performs geometry management so that its size always matches its child's outer size plus the Frame's margins and shadow thickness. Frame is most often used to enclose other managers when the application developer wants the manager to have ... |
|
XmGadget(3) -- The Gadget widget class
|
|
Gadget is a widget class used as a supporting superclass for other gadget classes. It handles shadow-border drawing and highlighting, traversal activation and deactivation, and various callback lists needed by gadgets. The color and pixmap resources defined by XmManager are directly used by gadgets. If XtSetValues is used to change one of the resources for a manager widget, all of the gadget child... |
|
XmGetAtomName(3) -- A function that returns the string representation for an atom
|
|
XmGetAtomName returns the string representation for an atom. It mirrors the Xlib interfaces for atom management but provides clientside caching. When and where caching is provided in Xlib, the routines will become pseudonyms for the Xlib routines. display Specifies the connection to the X server atom Specifies the atom for the property name you want returned |
|
XmGetColorCalculation(3) -- A function to get the procedure used for default color calculation
|
|
XmGetColorCalculation returns the procedure being used to calculate default colors. For a description of XmColorProc, see XmSetColorCalculation(3). |
|
XmGetColors(3) -- A function that generates foreground, select, and shadow colors
|
|
XmGetColors takes a screen, a colormap, and a background pixel, and returns pixel values for foreground, select, and shadow colors. screen Specifies the screen for which these colors should be allocated. colormap Specifies the colormap from which these colors should be allocated. background Specifies the background on which the colors should be based. foreground Specifies a pointer to the returned... |
|
XmGetDestination(3) -- A function that returns the widget ID of the widget to be used as the current destination for quick paste and
|
|
XmGetDestination returns the widget that is the current destination on the specified display. The destination is generally the last editable widget on which a select, edit, insert, or paste operation was performed and is the destination for quick paste and certain clipboard functions. The destination is NULL until a keyboard or mouse operation has been done on an editable widget. Refer to the Moti... |
|
XmGetDragContext(3) -- A Drag and Drop function that retrieves the DragContext widget ID associated with a timestamp
|
|
XmGetDragContext returns the widget ID of the active DragContext associated with a given display and timestamp. A timestamp uniquely identifies which DragContext is active when more than one drag and drop transaction has been initiated on a display. If the specified timestamp matches a timestamp processed between the start and finish of a single drag and drop transaction, the function returns the ... |
|
XmGetFocusWidget(3) -- Returns the ID of the widget that has keyboard focus
|
|
XmGetFocusWidget examines the hierarchy that contains the specified widget and returns the ID of the widget that has keyboard focus. The function extracts the widget ID from the associated Shell widget; therefore, the specified widget can be located anywhere in the hierarchy. widget Specifies a widget ID within a given hierarchy |
|
XmGetMenuCursor(3) -- A function that returns the cursor ID for the current menu cursor
|
|
XmGetMenuCursor queries the menu cursor currently being used by this client on the specified display and returns the cursor ID. This function returns the menu cursor for the default screen of the display. NOTE: XmGetMenuCursor is obsolete and exists for compatibility with previous releases. Instead of using this function, call XtGetValues for the XmScreen resource XmNmenuCursor. display Specifies ... |
|
XmGetPixmap(3) -- A pixmap caching function that generates a pixmap, stores it in a pixmap cache, and returns the pixmap
|
|
XmGetPixmap uses the parameter data to perform a lookup in the pixmap cache to see if a pixmap has already been generated that matches the data. If one is found, a reference count is incremented and the pixmap is returned. Applications should use XmDestroyPixmap when the pixmap is no longer needed. screen Specifies the display screen on which the pixmap is to be drawn. The depth of the pixmap is t... |
|
XmGetPixmapByDepth(3) -- A pixmap caching function that generates a pixmap, stores it in a pixmap cache, and returns the pixmap
|
|
XmGetPixmapByDepth uses the parameter data to perform a lookup in the pixmap cache to see if a pixmap has already been generated that matches the data. If one is found, a reference count is incremented and the pixmap is returned. Applications should use XmDestroyPixmap when the pixmap is no longer needed. screen Specifies the display screen on which the pixmap is to be drawn image_name Specifies t... |
|
XmGetPostedFromWidget(3) -- A RowColumn function that returns the widget from which a menu was posted
|
|
XmGetPostedFromWidget returns the widget from which a menu was posted. For torn-off menus, this function returns the widget from which the menu was originally torn. An application can use this routine during the activate callback to determine the context in which the menu callback should be interpreted. menu Specifies the widget ID of the menu For a complete definition of RowColumn and its associa... |
|
XmGetScaledPixmap(3) -- read a pixmap file and scale it according to pixmap and print resolution
|
|
XmGetScaledPixmap uses its Widget argument to look up for a Print Shell ancestor to get the pixmap resolution and the default printer resolution information to be used if scaling_ratio ==0. If scaling is 0, and a valid PrintShell is present XmGetScaledPixmap applies a ratio equals to (printer resolution / default pixmap resolution) before creating the Pixmap on the widget's Screen. Otherwise, the... |
|
XmGetSecondaryResourceData(3) -- A function that provides access to secondary widget resource data
|
|
Some Motif widget classes (such as Gadget, Text, and VendorShell) have resources that are not accessible through the functions XtGetResourceList and XtGetConstraintResourceList. In order to retrieve the descriptions of these resources, an application must use XmGetSecondaryResourceData. When a widget class has such resources, this function provides descriptions of the resources in one or more data... |
|
XmGetTabGroup(3) -- Returns the widget ID of a tab group
|
|
XmGetTabGroup returns the widget ID of the tab group that contains the specified widget. widget Specifies a widget ID within a tab group |
|
XmGetTearOffControl(3) -- A RowColumn function that obtains the widget ID
|
|
XmGetTearOffControl provides the application with the means for obtaining the widget ID of the internally created tear-off control in a tear-off menu. RowColumn creates a tear-off control for a PulldownMenu or PopupMenu when the XmNtearOffModel resource is initialized or set to XmTEAR_OFF_ENABLED. The tear-off control is a widget that appears as the first element in the menu. The user tears off th... |
|
XmGetVisibility(3) -- A function that determines if a widget is visible
|
|
XmGetVisibility returns the visibility state of the specified widget. It checks to see if some part of the widget's rectangular area is unobscured by the widget's ancestors, or some part of the widget's rectangular area is inside the work window (but possibly outside the clip window) of a ScrolledWindow whose XmNscrollingPolicy is XmAUTOMATIC and whose XmNtraverseObscuredCallback is not NULL. X... |
|
XmGetXmDisplay(3) -- A Display function that returns the XmDisplay object ID for a specified display
|
|
XmGetXmDisplay returns the XmDisplay object ID associated with a display. The application can access Display resources with XtGetValues. display Specifies the display for which the XmDisplay object ID is to be returned For a complete definition of Display and its associated resources, see XmDisplay(3). |
|
XmGetXmScreen(3) -- A Screen function that returns the XmScreen object ID for a specified screen
|
|
XmGetXmScreen returns the XmScreen object ID associated with a screen. The application can access and manipulate Screen resources with XtGetValues and XtSetValues. screen Specifies the screen for which the XmScreen ID is to be returned For a complete definition of Screen and its associated resources, see XmScreen(3). |
|
XmIconGadget(3) -- The IconGadget widget class
|
|
IconGadget is an instantiable widget used to display both text and a pixmap in various combinations. Other widgets that hold the XmQTcontainer trait, such as Container, can use IconGadget to represent objects. IconGadget text is a compound string. If no text is supplied, then the compound string is generated from the gadget name. IconGadget text is placed relative to the type of associated pixmap.... |
|
XmImCloseXIM(3) -- An input manager function that releases the input method associated with a specified widget
|
|
XmImCloseXIM closes all input contexts associated with the Input Method (IM) of widget. widget is used to identify the Display that specifies the Input Method opened for the widget. Upon closure, all widgets registered with the input contexts are unregistered. Also, the Input Method specified by Display is closed. widget Specifies the ID of a widget whose reference Input Method is to be closed. |
|
XmImFreeXIC(3) -- An input manager function that unregisters widgets for an XIC
|
|
XmImFreeXIC unregisters all widgets associated with the specified X Input Context (XIC). The specified widget must be associated with the specified xic. After unregistering the associated widgets, this call frees the xic. widget Specifies the ID of a widget used to identify the VendorShell and XmDisplay that maintain the widget-XIC registry. xic Specifies the Input Context associated with the widg... |
|
XmImGetXIC(3) -- An input manager function that obtains an XIC for a widget
|
|
XmImGetXIC creates and registers an X Input Context (XIC) with the specified arguments for widget. If XmINHERIT_POLICY is specified for input_policy, a new XIC will be created only if required to by the arguments or by the VendorShell input policy. Any existing XIC registered with widget is unregistered. Refer to the VendorShell reference page for further details. widget Specifies the ID of a widg... |
|
XmImGetXIM(3) -- An input manager function that retrieves the input method associated with a specified widget
|
|
XmImGetXIM retrieves the XIM data structure representing the input method that the input manager has opened for the specified widget. If an input method has not been opened by a previous call to XmImRegister, the first time this routine is called it opens an input method using the XmNinputMethod resource for the VendorShell. If the XmNinputMethod is NULL, an input method is opened using the curren... |
|
XmImMbLookupString(3) -- An input manager function that retrieves a composed string from an input method
|
|
XmImMbLookupString returns a string composed in the locale associated with the widget's input method and a KeySym that is currently mapped to the keycode in a KeyPress event. The KeySym is obtained by using the standard interpretation of Shift, Lock and Group modifiers as defined in the X Protocol specification. An XIM will be created, but an XIC will not be created. One of the functions, XmImSet... |
|
XmImMbResetIC(3) -- An input manager function that resets the input context for a widget
|
|
XmImMbResetIC gets the XIC of the widget and resets it. It puts a pointer to a string containing the current preedit string to mb. The caller should free the returned string after use by calling Xfree. widget Specifies the ID of the widget. mb Contains a pointer to the preedit string upon return. |
|
XmImRegister(3) -- An input manager function that registers a widget with an input manager
|
|
XmImRegister registers a widget with its input manager. This adds the specified widget to a list of widgets that are supported by the input manager for an input method. If an input method has not been opened by a previous call to XmImRegister, the first time this routine is called it opens an input method using the XmNinputMethod resource for the VendorShell. If the XmNinputMethod is NULL, an inpu... |
|
XmImSetFocusValues(3) -- An input manager function that notifies an input manager that a widget has received input focus and updates th
|
|
XmImSetFocusValues notifies the input manager that the specified widget has received input focus. This function also updates the attributes of the input context associated with the widget. The focus window for the XIC is set to the window of the widget. The arglist argument is a list of attribute/value pairs for the input context. This function passes the attributes and values to XICSetValues. The... |
|
XmImSetValues(3) -- An input manager function that updates attributes of an input context
|
|
XmImSetValues updates attributes of the input context associated with the specified widget. The arglist argument is a list of attribute/value pairs for the input context. This function passes the attributes and values to XICSetValues. The initial call to this routine should pass in all of the input context attributes. Thereafter, the application programmer calls XmImSetValues, for an XIC, only if ... |
|
XmImSetXIC(3) -- An input manager function that registers an existing XIC with a widget
|
|
XmImSetXIC registers the specified X Input Context (XIC) with widget. Any existing XIC registered for widget is unregistered. The new XIC registered for widget is returned. If xic was not created by XmImGetXIC or XmImRegister, it will not be subject to closing activities when it has no widgets registered with it. widget Specifies the ID of a widget for which a new Input Context is to be registered... |
|
XmImUnregister(3) -- An input manager function that removes a widget from association with its input manager
|
|
XmImUnregister removes the specified widget from the list of widgets registered for input by the input manager. Note that the Text, TextField, and List widgets already call the XmImRegister internally. You should call the XmImUnregister function for these widgets before calling XmImRegister. widget Specifies the ID of the widget to be unregistered |
|
XmImUnsetFocus(3) -- An input manager function that notifies an input method that a widget has lost input focus
|
|
XmImUnsetFocus unsets a specified widget's focus, then notifies the input manager that the specified widget has lost its input focus. Note that the Text, TextField, and List widgets already call the XmImUnsetFocus internally. Therefore, further calls to the XmImUnsetFocus function for those widgets are unnecessary. widget Specifies the ID of the widget registered with the input manager |
|
XmImVaSetFocusValues(3) -- An input manager function that notifies an input manager that a widget has received input focus and updates th
|
|
XmImVaSetFocusValues notifies the input manager that the specified widget has received input focus. This function also updates the attributes of the input context associated with the widget. This function passes the attributes and values to XICSetValues. The caller of this routine should pass in only those values that have changed since the last call to any of these functions; XmImVaSetValues, XmI... |
|
XmImVaSetValues(3) -- An input manager function that updates attributes of an input context
|
|
XmImVaSetValues updates attributes of the input context associated with the specified widget. This function passes the attributes to XICSetValues. The initial call to this routine should pass in all of the input context attributes. Thereafter, the application programmer calls XmImVaSetValues only if a value has changed. See the description in the XmImSetValues(3) man page for a list of associated ... |
|
XmInstallImage(3) -- A pixmap caching function that adds an image to the image cache
|
|
XmInstallImage stores an image in an image cache that can later be used to generate a pixmap. Part of the installation process is to extend the resource converter used to reference these images. The resource converter is given the image name so that the image can be referenced in a .Xdefaults file. Since an image can be referenced by a widget through its pixmap resources, it is up to the applicati... |
|
XmInternAtom(3) -- A macro that returns an atom for a given name
|
|
XmInternAtom returns an atom for a given name. The returned atom remains defined even after the client's connection closes. The returned atom becomes undefined when the last connection to the X server closes. display Specifies the connection to the X server name Specifies the name associated with the atom you want returned. The value of name is case dependent. only_if_exists Specifies a Boolean v... |
|
XmIsMotifWMRunning(3) -- A function that determines whether the window manager is running
|
|
XmIsMotifWMRunning lets a user know whether the Motif Window Manager is running on a screen that contains a specific widget hierarchy. This function first sees whether the _MOTIF_WM_INFO property is present on the root window of the shell's screen. If it is, its window field is used to query for the presence of the specified window as a child of root. shell Specifies the shell whose screen will b... |
|
XmIsTraversable(3) -- A function that identifies whether a widget can be traversed
|
|
XmIsTraversable determines whether the specified widget is eligible to receive focus through keyboard traversal. In general, a widget is eligible to receive focus when all of the following conditions are true: + The widget and its ancestors are not being destroyed, are sensitive, and have a value of True for XmNtraversalOn. + The widget and its ancestors are realized, managed, and (except for gadg... |
|
XmLabel(3) -- The Label widget class
|
|
Label is an instantiable widget and is also used as a superclass for other button widgets, such as PushButton and ToggleButton. The Label widget does not accept any button or key input, and the help callback is the only callback defined. Label also receives enter and leave events. Label can contain either text or a pixmap. Label text is a compound string. Refer to the Motif Programmer's Guide for... |
|
XmLabelGadget(3) -- The LabelGadget widget class
|
|
LabelGadget is an instantiable widget and is also used as a superclass for other button gadgets, such as PushButtonGadget and ToggleButtonGadget. LabelGadget can contain either text or a pixmap. LabelGadget text is a compound string. Refer to the Motif Programmer's Guide for more information on compound strings. The text can be multilingual, multiline, and/or multifont. When a LabelGadget is inse... |
|
XmList(3) -- The List widget class
|
|
List allows a user to select one or more items from a group of choices. Items are selected from the list in a variety of ways, using both the pointer and the keyboard. List operates on an array of compound strings that are defined by the application. Each compound string becomes an item in the List, with the first compound string becoming the item in position 1, the second becoming the item in pos... |
|
XmListAddItem(3) -- A List function that adds an item to the list
|
|
XmListAddItem adds an item to the list at the given position. When the item is inserted into the list, it is compared with the current XmNselectedItems list. If the new item matches an item on the selected list, it appears selected. widget Specifies the ID of the List to which an item is added. item Specifies the item to be added to the list. position Specifies the position of the new item in the ... |
|
XmListAddItems(3) -- A List function that adds items to the list
|
|
XmListAddItems adds the specified items to the list at the given position. The first item_count items of the items array are added to the list. When the items are inserted into the list, they are compared with the current XmNselectedItems list. If any of the new items matches an item on the selected list, it appears selected. widget Specifies the ID of the List to which an item is added. items Spe... |
|
XmListAddItemsUnselected(3) -- A List function that adds items to a list
|
|
XmListAddItemsUnselected adds the specified items to the list at the given position. The inserted items remain unselected, even if they currently appear in the XmNselectedItems list. widget Specifies the ID of the List widget to add items to. items Specifies a pointer to the items to be added to the list. item_count Specifies the number of elements in items. This number must be nonnegative. positi... |
|
XmListAddItemUnselected(3) -- A List function that adds an item to the list
|
|
XmListAddItemUnselected adds an item to the list at the given position. The item does not appear selected, even if it matches an item in the current XmNselectedItems list. widget Specifies the ID of the List from whose list an item is added. item Specifies the item to be added to the list. position Specifies the position of the new item in the list. A value of 1 makes the new item the first item i... |
|
XmListDeleteAllItems(3) -- A List function that deletes all items from the list
|
|
XmListDeleteAllItems deletes all items from the list. widget Specifies the ID of the List from whose list the items are deleted For a complete definition of List and its associated resources, see XmList(3). |
|
XmListDeleteItem(3) -- A List function that deletes an item from the list
|
|
XmListDeleteItem deletes the first item in the list that matches item. A warning message appears if the item does not exist. widget Specifies the ID of the List from whose list an item is deleted. item Specifies the text of the item to be deleted from the list. If item appears more than once in the List, only the first occurrence is matched. For a complete definition of List and its associated res... |
|
XmListDeleteItems(3) -- A List function that deletes items from the list
|
|
XmListDeleteItems deletes the specified items from the list. For each element of items, the first item in the list that matches that element is deleted. A warning message appears if any of the items do not exist. widget Specifies the ID of the List from whose list an item is deleted items Specifies a pointer to items to be deleted from the list item_count Specifies the number of elements in items ... |
|
XmListDeleteItemsPos(3) -- A List function that deletes items from the list starting at the given position
|
|
XmListDeleteItemsPos deletes the specified number of items from the list starting at the specified position. widget Specifies the ID of the List from whose list an item is deleted. item_count Specifies the number of items to be deleted. This number must be nonnegative. position Specifies the position in the list of the first item to be deleted. A value of 1 indicates that the first deleted item is... |
|
XmListDeletePos(3) -- A List function that deletes an item from a list at a specified position
|
|
XmListDeletePos deletes an item at a specified position. A warning message appears if the position does not exist. widget Specifies the ID of the List from which an item is to be deleted. position Specifies the position of the item to be deleted. A value of 1 indicates that the first item in the list is deleted; a value of 2 indicates that the second item is deleted; and so on. A value of 0 (zero)... |
|
XmListDeletePositions(3) -- A List function that deletes items from a list based on an array of positions
|
|
XmListDeletePositions deletes noncontiguous items from a list. The function deletes all items whose corresponding positions appear in the position_list array. A warning message is displayed if a specified position is invalid; that is, the value is 0, a negative integer, or a number greater than the number of items in the list. widget Specifies the ID of the List widget position_list Specifies an a... |
|
XmListDeselectAllItems(3) -- A List function that unhighlights and removes all items from the selected list
|
|
XmListDeselectAllItems unhighlights and removes all items from the selected list. widget Specifies the ID of the List widget from whose list all selected items are deselected For a complete definition of List and its associated resources, see XmList(3). |
|
XmListDeselectItem(3) -- A List function that deselects the specified item from the selected list
|
|
XmListDeselectItem unhighlights and removes from the selected list the first item in the list that matches item. widget Specifies the ID of the List from whose list an item is deselected. item Specifies the item to be deselected from the list. If item appears more than once in the List, only the first occurrence is matched. For a complete definition of List and its associated resources, see XmList... |
|
XmListDeselectPos(3) -- A List function that deselects an item at a specified position in the list
|
|
XmListDeselectPos unhighlights the item at the specified position and deletes it from the list of selected items. widget Specifies the ID of the List widget position Specifies the position of the item to be deselected. A value of 1 indicates that the first item in the list is deselected; a value of 2 indicates that the second item is deselected; and so on. A value of 0 (zero) indicates that the la... |
|
XmListGetKbdItemPos(3) -- A List function that returns the position of the item at the location cursor
|
|
XmListGetKbdItemPos returns the position of the list item at the location cursor. widget Specifies the ID of the List widget For a complete definition of List and its associated resources, see XmList(3). |
|
XmListGetMatchPos(3) -- A List function that returns all instances of an item in the list
|
|
XmListGetMatchPos is a Boolean function that returns an array of positions where a specified item is found in a List. widget Specifies the ID of the List widget. item Specifies the item to search for. position_list Returns an array of positions at which the item occurs in the List. The position of the first item in the list is 1; the position of the second item is 2; and so on. When the return val... |
|
XmListGetSelectedPos(3) -- A List function that returns the position of every selected item in the list
|
|
This routine is obsolete. It is replaced by calling XtGetValues for the List resources XmNselectedPositions and XmNselectedPositionCount. XmListGetSelectedPos is a Boolean function that returns an array of the positions of the selected items in a List. widget Specifies the ID of the List widget. position_list Returns an array of the positions of the selected items in the List. The position of the ... |
|
XmListItemExists(3) -- A List function that checks if a specified item is in the list
|
|
XmListItemExists is a Boolean function that checks if a specified item is present in the list. widget Specifies the ID of the List widget item Specifies the item whose presence is checked For a complete definition of List and its associated resources, see XmList(3). |
|
XmListItemPos(3) -- A List function that returns the position of an item in the list
|
|
XmListItemPos returns the position of the first instance of the specified item in a list. widget Specifies the ID of the List widget item Specifies the item whose position is returned For a complete definition of List and its associated resources, see XmList(3). |
|
XmListPosSelected(3) -- A List function that determines if the list item at a specified position is selected
|
|
XmPosSelected determines if the list item at the specified position is selected or not. widget Specifies the ID of the List widget position Specifies the position of the list item. A value of 1 indicates the first item in the list; a value of 2 indicates the second item; and so on. A value of 0 (zero) specifies the last item in the list. For a complete definition of List and its associated resourc... |
|
XmListPosToBounds(3) -- A List function that returns the bounding box of an item at a specified position in a list
|
|
XmListPosToBounds returns the coordinates of an item within a list and the dimensions of its bounding box. The function returns the associated x and y-coordinates of the upper left corner of the bounding box relative to the upper left corner of the List widget, as well as the width and the height of the box. The caller can pass a NULL value for the x, y, width, or height parameters to indicate tha... |
|
XmListReplaceItems(3) -- A List function that replaces the specified elements in the list
|
|
XmListReplaceItems replaces each specified item of the list with a corresponding new item. When the items are inserted into the list, they are compared with the current XmNselectedItems list. If any of the new items matches an item on the selected list, it appears selected. widget Specifies the ID of the List widget. old_items Specifies the items to be replaced. item_count Specifies the number of ... |
|
XmListReplaceItemsPos(3) -- A List function that replaces the specified elements in the list
|
|
XmListReplaceItemsPos replaces the specified number of items of the List with new items, starting at the specified position in the List. When the items are inserted into the list, they are compared with the current XmNselectedItems list. If any of the new items matches an item on the selected list, it appears selected. widget Specifies the ID of the List widget. new_items Specifies the replacement... |
|
XmListReplaceItemsPosUnselected(3) -- A List function that replaces items in a list without selecting the replacement items
|
|
XmListReplaceItemsPosUnselected replaces the specified number of items in the list with new items, starting at the given position. The replacement items remain unselected, even if they currently appear in the XmNselectedItems list. widget Specifies the ID of the List widget to replace items in. new_items Specifies a pointer to the replacement items. item_count Specifies the number of elements in n... |
|
XmListReplaceItemsUnselected(3) -- A List function that replaces items in a list
|
|
XmListReplaceItemsUnselected replaces each specified item in the list with a corresponding new item. The replacement items remain unselected, even if they currently appear in the XmNselectedItems list. widget Specifies the ID of the List widget to replace items in. old_items Specifies a pointer to the list items to be replaced. item_count Specifies the number of elements in old_items and new_items... |
|
XmListReplacePositions(3) -- A List function that replaces items in a list based on position
|
|
XmListReplacePositions replaces noncontiguous items in a list. The item at each position specified in position_list is replaced with the corresponding entry in item_list. When the items are inserted into the list, they are compared with the current XmNselectedItems list. Any of the new items that match items on the selected list appear selected. A warning message is displayed if a specified positi... |
|
XmListSelectItem(3) -- A List function that selects an item in the list
|
|
XmListSelectItem highlights and adds to the selected list the first item in the list that matches item. widget Specifies the ID of the List widget from whose list an item is selected. item Specifies the item to be selected in the List widget. If item appears more than once in the List, only the first occurrence is matched. notify Specifies a Boolean value that when TRUE invokes the selection callb... |
|
XmListSelectPos(3) -- A List function that selects an item at a specified position in the list
|
|
XmListSelectPos highlights a List item at the specified position and adds it to the list of selected items. widget Specifies the ID of the List widget. position Specifies the position of the item to be selected. A value of 1 indicates that the first item in the list is selected; a value of 2 indicates that the second item is selected; and so on. A value of 0 (zero) indicates that the last item in ... |
|
XmListSetAddMode(3) -- A List function that sets add mode in the list
|
|
XmListSetAddMode allows applications control over Add Mode in the extended selection model. This function ensures that the mode it sets is compatible with the selection policy (XmNselectionPolicy) of the widget. For example, it cannot put the widget into add mode when the value of XmNselectionPolicy is XmBROWSE_SELECT. widget Specifies the ID of the List widget state Specifies whether to activate ... |
|
XmListSetBottomItem(3) -- A List function that makes an existing item the last visible item in the list
|
|
XmListSetBottomItem makes the first item in the list that matches item the last visible item in the list. widget Specifies the ID of the List widget from whose list an item is made the last visible item Specifies the item For a complete definition of List and its associated resources, see XmList(3). |
|
XmListSetBottomPos(3) -- A List function that makes a specified item the last visible item in the list
|
|
XmListSetBottomPos makes the item at the specified position the last visible item in the List. widget Specifies the ID of the List widget. position Specifies the position of the item to be made the last visible item in the list. A value of 1 indicates that the first item in the list is the last visible item; a value of 2 indicates that the second item is the last visible item; and so on. A value o... |
|
XmListSetHorizPos(3) -- A List function that scrolls to the specified position in the list
|
|
XmListSetHorizPos sets the XmNvalue resource of the horizontal ScrollBar to the specified position and updates the visible portion of the list with the new value if the List widget's XmNlistSizePolicy is set to XmCONSTANT or XmRESIZE_IF_POSSIBLE and the horizontal ScrollBar is currently visible. This is equivalent to moving the horizontal ScrollBar to the specified position. widget Specifies the ... |
|
XmListSetItem(3) -- A List function that makes an existing item the first visible item in the list
|
|
XmListSetItem makes the first item in the list that matches item the first visible item in the list. widget Specifies the ID of the List widget from whose list an item is made the first visible item Specifies the item For a complete definition of List and its associated resources, see XmList(3). |
|
XmListSetKbdItemPos(3) -- A List function that sets the location cursor at a specified position
|
|
XmListSetKbdItemPos sets the location cursor at the item specified by position. This function does not determine if the item at the specified position is selected or not. widget Specifies the ID of the List widget. position Specifies the position of the item at which the location cursor is set. A value of 1 indicates the first item in the list; a value of 2 indicates the second item; and so on. A ... |
|
XmListSetPos(3) -- A List function that makes the item at the given position the first visible position in the list
|
|
XmListSetPos makes the item at the given position the first visible position in the list. widget Specifies the ID of the List widget. position Specifies the position of the item to be made the first visible item in the list. A value of 1 indicates that the first item in the list is the first visible item; a value of 2 indicates that the second item is the first visible item; and so on. A value of ... |
|
XmListUpdateSelectedList(3) -- A List function that updates the XmNselectedItems resource
|
|
XmListUpdateSelectedList frees the contents of the current XmNselectedItems list. The routine traverses the XmNitems list and adds each currently selected item to the XmNselectedItems list. For each selected item, there is a corresponding entry in the updated XmNselectedItems list. widget Specifies the ID of the List widget to update For a complete definition of List and its associated resources, ... |
|
XmListYToPos(3) -- A List function that returns the position of the item
|
|
XmListYToPos returns the position of the item at the given ycoordinate within the list. widget Specifies the ID of the List widget y Specifies the y-coordinate in the list's coordinate system For a complete definition of List and its associated resources, see XmList(3). |
|
XmMainWindow(3) -- The MainWindow widget class
|
|
MainWindow provides a standard layout for the primary window of an application. This layout includes a MenuBar, a CommandWindow, a work region, a MessageWindow, and ScrollBars. Any or all of these areas are optional. The work region and ScrollBars in the MainWindow behave identically to the work region and ScrollBars in the ScrolledWindow widget. The user can think of the MainWindow as an extended... |
|
XmMainWindowSep1(3) -- A MainWindow function that returns the widget ID of the first Separator
|
|
XmMainWindowSep1 returns the widget ID of the first Separator in the MainWindow. The first Separator is located between the MenuBar and the Command widget. This Separator is visible only when XmNshowSeparator is True. NOTE: XmMainWindowSep1 is obsolete and exists for compatibility with previous releases. Use XtNameToWidget instead. Pass a MainWindow variable as the first argument to XtNameToWidget... |
|
XmMainWindowSep2(3) -- A MainWindow function that returns the widget ID of the second Separator widget
|
|
XmMainWindowSep2 returns the widget ID of the second Separator in the MainWindow. The second Separator is located between the Command widget and the ScrolledWindow. This Separator is visible only when XmNshowSeparator is True. NOTE: XmMainWindowSep2 is obsolete and exists for compatibility with previous releases. Use XtNameToWidget instead. Pass a MainWindow variable as the first argument to XtNam... |
|
XmMainWindowSep3(3) -- A MainWindow function that returns the widget ID of the third Separator widget
|
|
XmMainWindowSep3 returns the widget ID of the third Separator in the MainWindow. The third Separator is located between the message window and the widget above it. This Separator is visible only when XmNshowSeparator is True. NOTE: XmMainWindowSep3 is obsolete and exists for compatibility with previous releases. Use XtNameToWidget instead. Pass a MainWindow variable as the first argument to XtName... |
|
XmMainWindowSetAreas(3) -- A MainWindow function that identifies manageable children for each area
|
|
XmMainWindowSetAreas identifies which of the valid children for each area (such as the MenuBar and work region) are to be actively managed by MainWindow. This function also sets up or adds the MenuBar, work window, command window, and ScrollBar widgets to the application's main window widget. Each area is optional; therefore, the user can pass NULL to one or more of the following arguments. The w... |
|
XmManager(3) -- The Manager widget class
|
|
Manager is a widget class used as a supporting superclass for other widget classes. It supports the visual resources, graphics contexts, and traversal resources necessary for the graphics and traversal mechanisms. |
|
XmMapSegmentEncoding(3) -- A compound string function that returns the compound text encoding format associated with the specified font l
|
|
XmMapSegmentEncoding searches the segment encoding registry for an entry that matches the specified font list tag and returns a copy of the associated compound text encoding format. The application is responsible for freeing the storage associated with the returned data by calling XtFree. fontlist_tag Specifies the compound string font list tag |
|
XmMenuPosition(3) -- A RowColumn function that positions a Popup menu pane
|
|
XmMenuPosition positions a Popup menu pane using the information in the specified event. Unless an application is positioning the menu pane itself, it must first invoke this function before managing the PopupMenu. The x_root and y_root fields in the specified X event are used to determine the menu position. menu Specifies the PopupMenu to be positioned event Specifies the event passed to the actio... |
|
XmMenuShell(3) -- The MenuShell widget class
|
|
The MenuShell widget is a custom OverrideShell widget. An OverrideShell widget bypasses mwm when displaying itself. It is designed specifically to contain Popup or Pulldown menu panes. Most application writers never encounter this widget if they use the menu-system convenience functions, XmCreatePopupMenu or XmCreatePulldown Menu, to create a Popup or Pulldown menu pane. The convenience functions ... |
|
XmMessageBox(3) -- The MessageBox widget class
|
|
MessageBox is a dialog class used for creating simple message dialogs. Convenience dialogs based on MessageBox are provided for several common interaction tasks, which include giving information, asking questions, and reporting errors. A MessageBox dialog is typically transient in nature, displayed for the duration of a single interaction. MessageBox is a subclass of BulletinBoard and depends on i... |
|
XmMessageBoxGetChild(3) -- A MessageBox function that is used to access a component
|
|
XmMessageBoxGetChild is used to access a component within a MessageBox. The parameters given to the function are the MessageBox widget and a value indicating which component to access. NOTE: This routine is obsolete and exists for compatibility with previous releases. Instead of calling XmMessageBoxGetChild, you should call XtNameToWidget as described in the XmMessageBox(3) reference page. widget ... |
|
XmNotebook(3) -- The Notebook widget class
|
|
Notebook is a manager widget that organizes its children into pages, tabs, status areas, and page scrollers to simulate a real notebook. It stacks its page children so that all page children occupy the same area like real book pages. Notebook displays visuals that look like the binding of a book and the edges of other pages around the page that is shown. Tab children simulate notebook tabs. Major ... |
|
XmNotebookGetPageInfo(3) -- A Notebook function that returns page information
|
|
XmNotebookGetPageInfo returns status information for the specified Notebook page. notebook Specifies the Notebook widget. page_number Specifies the page number to be queried. page_info Points to the structure containing the page information. The structure has the following form: typedef struct { int page_number; Widget page_widget; Widget status_area_widget; Widget major_tab_widget; Widget minor_t... |
|
XmObjectAtPoint(3) -- A toolkit function that determines which child intersects or comes closest to a specified point
|
|
XmObjectAtPoint searches the child list of the specified manager widget and returns the child most closely associated with the specified x,y coordinate pair. For the typical Motif manager widget, XmObjectAtPoint uses the following rules to determine the returned object: + If one child intersects x,y, XmObjectAtPoint returns the widget ID of that child. + If more than one child intersects x,y, XmOb... |
|
XmOptionButtonGadget(3) -- A RowColumn function that obtains the widget ID for the CascadeButtonGadget in an OptionMenu
|
|
XmOptionButtonGadget provides the application with the means for obtaining the widget ID for the internally created CascadeButtonGadget. Once the application has obtained the widget ID, it can adjust the visuals for the CascadeButtonGadget, if desired. When an application creates an instance of the OptionMenu widget, the widget creates two internal gadgets. One is a LabelGadget that is used to dis... |
|
XmOptionLabelGadget(3) -- A RowColumn function that obtains the widget ID for the LabelGadget in an OptionMenu
|
|
XmOptionLabelGadget provides the application with the means for obtaining the widget ID for the internally created LabelGadget. Once the application has obtained the widget ID, it can adjust the visuals for the LabelGadget, if desired. option_menu Specifies the OptionMenu widget ID When an application creates an instance of the OptionMenu widget, the widget creates two internal gadgets. One is a L... |
|
XmPanedWindow(3) -- The PanedWindow widget class
|
|
PanedWindow is a composite widget that lays out children in a vertically tiled format. Children appear in top-to-bottom fashion, with the first child inserted appearing at the top of the PanedWindow and the last child inserted appearing at the bottom. The PanedWindow grows to match the width of its widest child and all other children are forced to this width. The height of the PanedWindow is equal... |
|
XmParseMapping(3) -- Data type for a compound string parse mapping
|
|
XmParseMapping is an opaque data type for a parse mapping used by XmStringParseText to create a compound string. A parse mapping contains a pattern to be matched in text being parsed to create a compound string. It also contains a compound string, or a function to be invoked to provide a compound string, to be included in the compound string being created whenever the pattern is matched. An applic... |
|
XmParseMappingCreate(3) -- A compound string function to create a parse mapping
|
|
XmParseMappingCreate creates a parse mapping for use in a parse table. This function allows the application to specify values for components of the parse mapping using a resource-style argument list. arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of XmParseMapping and its associated resources, see ... |
|
XmParseMappingFree(3) -- A compound string function to free a parse mapping
|
|
XmParseMappingFree recovers memory used by an XmParseMapping. parse_mapping Specifies the parse mapping to be freed |
|
XmParseMappingGetValues(3) -- A compound string function to retrieve attributes of a parse mapping
|
|
XmParseMappingGetValues retrieves attributes of an XmParseMapping object, using a resource-style argument list. If the XmNsubstitute resource is in the arglist, the function will allocate space to hold the returned XmString value. The application is responsible for managing this allocated space. The application can recover the allocated space by calling XmStringFree. arglist Specifies the argument... |
|
XmParseMappingSetValues(3) -- A compound string function to set attributes of a parse mapping
|
|
XmParseMappingSetValues specifies attributes of an XmParseMapping object, using a resource-style argument list. arglist Specifies the argument list argcount Specifies the number of attribute/value pairs in the argument list (arglist) For a complete definition of XmParseMapping and its associated resources, see XmParseMapping(3). |
|
XmParseTable(3) -- Data type for a compound string parse table
|
|
XmParseTable is the data type for an array of parse mappings (objects of type XmParseMapping). A parse table is used by some routines that parse and unparse compound strings. The table is an ordered list of parse mappings. A parsing routine that uses a parse table scans the input text and searches the parse mappings, in order, for one containing a pattern that matches the input text. The matching ... |
|
XmParseTableFree(3) -- A compound string function that recovers memory
|
|
XmParseTableFree recovers memory used by an XmParseTable and its constituent XmParseMappings. parse_table Specifies the parse table to be freed count Specifies the number of parse mappings in the parse table |
|
XmPrimitive(3) -- The Primitive widget class
|
|
Primitive is a widget class used as a supporting superclass for other widget classes. It handles border drawing and highlighting, traversal activation and deactivation, and various callback lists needed by Primitive widgets. Primitive and all its subclasses hold the XmQTcareParentVisual trait. |
|
XmPrintPopupPDM(3) -- Send a notification for the PDM to be popped up
|
|
A convenience function that sends a notification to start a Print Dialog Manager on behalf of the application, XmPrintPopupPDM hides the details of the X selection mechanism used to notify the PDM that a new dialog must be popped up for this application. XmPrintPopupPDM sends a selection request to either the print display of the print shell, or the video display of the transient_for video widget ... |
|
XmPrintSetup(3) -- setup and create a Print Shell widget
|
|
A function that does the appropriate setting and creates a realized XmPrintShell that it returns to the caller. This function hides the details of the Xt to set up a valid print shell heirarchy for the application. It is also meant to encourage consistency in the way applications root their print widget hierarchy. print_screen must belong to a Display connection that has already been initialized w... |
|
XmPrintShell(3) -- a shell widget class used for printing in Motif
|
|
The XmPrintShell provides the Motif application programmer with an Xt widget oriented API to some of the X Print resources and a callback to drive the pagination. The XmPrintShell provides a simple callback to handle the pagination logic, and a set of resources to get and set common printer attributes. If not created on an XPrint connection, XmPrintShell behaves as a regular applicationShell. The ... |
|
XmPrintToFile(3) -- Retrieves and saves data that would normally be printed by the X Print Server.
|
|
XmPrintToFile hides the details of X display connection and XpGetDocumentData to the Motif application programmer. This function is a convenience routine that hides the details of the X and Xp internals to the application programmer by calling the XpGetDocumentData function with appropriate save and finish callbacks. This is used in the context of X Printing when the user has specified the "print... |
|
XmProcessTraversal(3) -- A function that determines which component receives keyboard events when a widget has the focus
|
|
XmProcessTraversal determines which component of a hierarchy receives keyboard events when the hierarchy that contains the given widget has keyboard focus. XmProcessTraversal changes focus only when the keyboard focus policy of the widget hierarchy is explicit. If the XmNkeyboardFocusPolicy of the nearest shell ancestor of the given widget is not XmEXPLICIT, XmProcessTraversal returns False withou... |
|
XmPushButton(3) -- The PushButton widget class
|
|
PushButton issues commands within an application. It consists of a text label or pixmap surrounded by a border shadow. When a PushButton is selected, the shadow changes to give the appearance that it has been pressed in. When a PushButton is unselected, the shadow changes to give the appearance that it is out. The default behavior associated with a PushButton in a menu depends on the type of menu ... |
|
XmPushButtonGadget(3) -- The PushButtonGadget widget class
|
|
PushButtonGadget issues commands within an application. It consists of a text label or pixmap surrounded by a border shadow. When PushButtonGadget is selected, the shadow changes to give the appearance that the PushButtonGadget has been pressed in. When PushButtonGadget is unselected, the shadow changes to give the appearance that the PushButtonGadget is out. The default behavior associated with a... |
|
XmRedisplayWidget(3) -- Synchronously activates the expose method of a widget to draw its content
|
|
This function is a convenience routine that hides the details of the Xt internals to the application programmer by calling the expose method of the given widget with a well formed Expose event and Region corresponding to the total area of the widget. If the widget doesn't have an Expose method, the function does nothing. This is primarily used in the context of X Printing if the programming model... |
|
XmRegisterSegmentEncoding(3) -- A compound string function that registers a compound text encoding format for a specified font list element ta
|
|
XmRegisterSegmentEncoding registers a compound text encoding format with the specified font list element tag. The XmCvtXmStringToCT function uses this registry to map the font list tags of compound string segments to compound text encoding formats. Registering a font list tag that already exists in the registry overwrites the original entry. You can unregister a font list tag by passing a NULL val... |
|
XmRemoveFromPostFromList(3) -- a RowColumn function that disables a menu for a particular widget
|
|
XmRemoveFromPostFromList makes a Popup or Pulldown menu no longer accessible from a widget. This function does not destroy a menu, or deallocate the memory associated with it. It simply removes the widget from the menu's list of widgets permitted to post that menu. If the menu argument refers to a Popup menu, the event handlers are removed from the post_from_widget widget. If the argument refers ... |
|
XmRemoveProtocolCallback(3) -- A VendorShell function that removes a callback from the internal list
|
|
XmRemoveProtocolCallback removes a callback from the internal list. XmRemoveWMProtocolCallback is a convenience interface. It calls XmRemoveProtocolCallback with the property value set to the atom returned by interning WM_PROTOCOLS. shell Specifies the widget with which the protocol property is associated property Specifies the protocol property protocol Specifies the protocol atom callback Specif... |
|
XmRemoveProtocols(3) -- A VendorShell function that removes the protocols from the protocol manager and deallocates the internal table
|
|
XmRemoveProtocols removes the protocols from the protocol manager and deallocates the internal tables. If any of the protocols are active, it will update the handlers and update the property if shell is realized. XmRemoveWMProtocols is a convenience interface. It calls XmRemoveProtocols with the property value set to the atom returned by interning WM_PROTOCOLS. shell Specifies the widget with whic... |
|
XmRemoveTabGroup(3) -- A function that removes a tab group
|
|
This function is obsolete and its behavior is replaced by setting XmNnavigationType to XmNONE. XmRemoveTabGroup removes a widget from the list of tab groups associated with a particular widget hierarchy and sets the widget's XmNnavigationType to XmNONE. tab_group Specifies the widget ID |
|
XmRemoveWMProtocolCallback(3) -- A VendorShell convenience interface that removes a callback from the internal list
|
|
XmRemoveWMProtocolCallback is a convenience interface. It calls XmRemoveProtocolCallback with the property value set to the atom returned by interning WM_PROTOCOLS. shell Specifies the widget with which the protocol property is associated protocol Specifies the protocol atom callback Specifies the procedure to call when a protocol message is received closure Specifies the client data to be passed ... |
|
XmRemoveWMProtocols(3) -- A VendorShell convenience interface that removes the protocols from the protocol manager and deallocates the i
|
|
XmRemoveWMProtocols is a convenience interface. It calls XmRemoveProtocols with the property value set to the atom returned by interning WM_PROTOCOLS. shell Specifies the widget with which the protocol property is associated protocols Specifies the protocol atoms num_protocols Specifies the number of elements in protocols For a complete definition of VendorShell and its associated resources, see V... |
|
XmRenderTable(3) -- Data type for a render table
|
|
XmRenderTable is the data type for a render table, which contains a table of renditions (XmRenditions). Each rendition consists of a set of attributes for rendering text, including a font or fontset, colors, tabs, and lines. Each rendition is identified with a tag. When a compound string is displayed, for each segment in the string, the rendition used to render that string is formed as follows. If... |
|
XmRenderTableAddRenditions(3) -- Creates a new render table
|
|
XmRenderTableAddRenditions is a function to create a new render table that includes the renditions listed in oldtable, if there is one. This function also copies specified renditions (renditions) to the new render table. The first rendition_count renditions of the renditions array are added to the new table. If a rendition is tagged with a tag that matches a tag already in oldtable, then the exist... |
|
XmRenderTableCopy(3) -- A render table function that copies renditions
|
|
XmRenderTableCopy creates a new render table which will contain the renditions of the table whose tags match those in tags. table Specifies the table containing the renditions to be copied. tags Specifies an array of tags, whose corresponding renditions are to be copied. NULL indicates that the complete table should be copied. tag_count Specifies the number of tags in tags. |
|
XmRenderTableCvtFromProp(3) -- A render table function that converts from a string representation to a render table
|
|
XmRenderTableCvtFromProp converts a string of characters representing a render table to a render table. This routine is typically used by the destination of a data transfer operation to produce a render table from a transferred representation. widget Specifies the widget that is the destination for the render table property Specifies a string of characters representing a render table length Specif... |
|
XmRenderTableCvtToProp(3) -- A render table function that converts a render table to a string representation
|
|
XmRenderTableCvtToProp converts a render table to a string of characters representing the render table. This routine is typically used by the source of a data transfer operation to produce a representation for transferring a render table to a destination. widget Specifies the widget that is the source of the render table table Specifies a render table to be converted prop_return Specifies a pointe... |
|
XmRenderTableFree(3) -- A render table function that recovers memory
|
|
XmRenderTableFree frees the memory associated with the specified render table. table Specifies the table to be freed. |
|
XmRenderTableGetRendition(3) -- A convenience function that matches a rendition tag
|
|
XmRenderTableGetRendition searches table and returns a copy of the rendition whose XmNtag resource matches tag. If no rendition matches, then NULL is returned. This function is to be used for just one rendition match. It is the responsibility of the caller to free the returned rendition with the XmRenditionFree function. table Specifies the table containing renditions to be searched. tag Specifies... |
|
XmRenderTableGetRenditions(3) -- A convenience function that matches rendition tags
|
|
XmRenderTableGetRenditions searches table and returns an array of copies of the renditions whose XmNtag resources match a tag in tags. If no renditions match, then NULL is returned. The size of the returned array is tag_count. The XmNtag resource of each rendition will match the corresponding tag in tags. If no match is found for a particular tag, the corresponding slot in the return value will be... |
|
XmRenderTableGetTags(3) -- A convenience function that gets rendition tags
|
|
XmRenderTableGetTags searches the specified table for the XmNtag resources of all the renditions (XmRenditions) entries. These tag resources are then composed into an array. table Specifies the table containing the XmRenditions. tag_list Is the array of XmStringTags generated by this function. The function allocates space to hold the returned tags and to hold the tag_list itself. The application i... |
|
XmRenderTableRemoveRenditions(3) -- A convenience function that removes renditions
|
|
XmRenderTableRemoveRenditions removes from oldtable the renditions whose tags match the tags specified in tags, then places the remaining renditions in a newly created render table. oldtable Specifies the render table from which renditions are to be removed. This function deallocates the original render table and the matching renditions after extracting the required information. tags Specifies an ... |
|
XmRendition(3) -- The Rendition registry
|
|
XmRendition is a pseudo widget used for the rendering of XmStrings. XmRendition has two parts: XmStringTag and rendering information. The XmStringTag part can be matched with an XmStringTag associated with a LOCALE, CHARSET, or RENDITION[BEGIN|END] component within XmString. The rendering information contains information about the font or fontset, colors, tabs, and lines to be used in rendering a ... |
|
XmRenditionCreate(3) -- A convenience function that creates a rendition
|
|
XmRenditionCreate creates a rendition whose resources are set to the values specified in arglist. Default values are assigned to resources that are not specified. widget Specifies the widget used for deriving any necessary information for creating the rendition. In particular, the X display of widget will be used for loading fonts. tag Specifies the tag for the rendition. (This will become the XmN... |
|
XmRenditionFree(3) -- A convenience function that frees a rendition
|
|
XmRenditionFree recovers memory used by rendition. rendition Specifies the rendition to be freed. |
|
XmRenditionRetrieve(3) -- A convenience function that retrieves rendition resources
|
|
XmRenditionRetrieve extracts values for the given resources (arglist) from the specified rendition. Note that the function returns the actual values of the resources, not copies. Therefore it is necessary to copy before modifying any resource whose value is an address. This will include such resources as XmNfontName, XmNfont, and XmNtabList. rendition Specifies the rendition. arglist Specifies the... |
|
XmRenditionUpdate(3) -- A convenience function that modifies resources
|
|
XmRenditionUpdate modifies resources in the specified rendition. rendition Specifies the rendition. arglist Specifies the argument list. argcount Specifies the number of attribute/value pairs in the argument list (arglist). |
|
XmRepTypeAddReverse(3) -- A representation type manager function that installs the reverse converter for a previously registered represe
|
|
XmRepTypeAddReverse installs the reverse converter for a previously registered representation type. The reverse converter takes a numerical representation type value and returns its corresponding string value. Certain applications may require this capability to obtain a string value to display on a screen or to build a resource file. The values argument of the XmRepTypeRegister function can be use... |
|
XmRepTypeGetId(3) -- A representation type manager function that retrieves the identification number of a representation type
|
|
XmRepTypeGetId searches the registration list for the specified representation type and returns the associated identification number. rep_type Specifies the representation type for which an identification number is requested |
|
XmRepTypeGetNameList(3) -- A representation type manager function that generates a list of values for a representation type
|
|
XmRepTypeGetNameList generates a NULL-terminated list of the value names associated with the specified representation type. Each value name is a NULL-terminated string. This routine allocates memory for the returned data. The application must free this memory using XtFree. rep_type_id Specifies the identification number of the representation type. use_uppercase_format Specifies a Boolean value tha... |
|
XmRepTypeGetRecord(3) -- A representation type manager function that returns information about a representation type
|
|
XmRepTypeGetRecord retrieves information about a particular representation type that is registered with the representation type manager. This routine allocates memory for the returned data. The application must free this memory using XtFree. rep_type_id The identification number of the representation type The representation type entry structure contains the following information: typedef struct { ... |
|
XmRepTypeGetRegistered(3) -- A representation type manager function that returns a copy of the registration list
|
|
XmRepTypeGetRegistered retrieves information about all representation types that are registered with the representation type manager. The registration list is an array of structures, each of which contains information for a representation type entry. The end of the registration list is marked with a representation type entry whose rep_type_name field has a NULL pointer. This routine allocates memo... |
|
XmRepTypeInstallTearOffModelConvert(3) -- A representation type manager function that installs the resource converter for XmNtearOffModel.
|
|
XmRepTypeInstallTearOffModelConverter installs the resource converter that allows values for the XmNtearOffModel resource to be specified in resource default files. |
|
XmRepTypeRegister(3) -- A representation type manager function that registers a representation type resource
|
|
XmRepTypeRegister registers a representation type resource with the representation type manager. All features of the representation type management facility become available for the specified representation type. The function installs a forward type converter to convert string values to numerical representation type values. When the values argument is NULL, consecutive numerical values are assumed... |
|
XmRepTypeValidValue(3) -- A representation type manager function that tests the validity of a numerical value of a representation type r
|
|
XmRepTypeValidValue tests the validity of a numerical value for a given representation type resource. The function generates a default warning message if the value is invalid and the enable_default_warning argument is non-NULL. rep_type_id Specifies the identification number of the representation type. test_value Specifies the numerical value to test. enable_default_warning Specifies the ID of the... |
|
XmResolveAllPartOffsets(3) -- A function that allows writing of upwardcompatible applications and widgets
|
|
Note: This routine is obsolete and exists for compatibility with previous releases. You should call XmeResolvePartOffsets instead. The use of offset records requires two extra global variables per widget class. The variables consist of pointers to arrays of offsets into the widget record and constraint record for each part of the widget structure. The XmResolveAllPartOffsets function allocates the... |
|
XmResolvePartOffsets(3) -- A function that allows writing of upwardcompatible applications and widgets
|
|
The use of offset records requires one extra global variable per widget class. The variable consists of a pointer to an array of offsets into the widget record for each part of the widget structure. The XmResolvePartOffsets function allocates the offset records needed by an application to guarantee upward-compatible access to widget instance records by applications and widgets. These offset record... |
|
XmRowColumn(3) -- The RowColumn widget class
|
|
The RowColumn widget is a general purpose RowColumn manager capable of containing any widget type as a child. In general, it requires no special knowledge about how its children function and provides nothing beyond support for several different layout styles. However, it can be configured as a menu, in which case, it expects only certain children, and it configures to a particular layout. The menu... |
|
XmScale(3) -- The Scale widget class
|
|
Scale is used by an application to indicate a value from within a range of values, and it allows the user to input or modify a value from the same range. A Scale has an elongated rectangular region similar to a ScrollBar. A slider inside this region indicates the current value along the Scale. The user can also modify the Scale's value by moving the slider within the rectangular region of the Sca... |
|
XmScaleGetValue(3) -- A Scale function that returns the current slider position
|
|
XmScaleGetValue returns the current slider position value displayed in the scale. widget Specifies the Scale widget ID value_return Returns the current slider position value For a complete definition of Scale and its associated resources, see XmScale(3). |
|
XmScaleSetTicks(3) -- A Scale function that controls tick marks
|
|
XmScaleSetTicks controls the number, location, and size of the tick marks on a Scale. Each tick mark is a SeparatorGadget oriented perpendicular to the Scale's orientation. For example, if the Scale is oriented horizontally, the tick marks will be oriented vertically. If you specify tick marks for a Scale and then change the Scale's orientation, you will have to do the following: + Remove all th... |
|
XmScaleSetValue(3) -- A Scale function that sets a slider value
|
|
XmScaleSetValue sets the slider value within the Scale widget. widget Specifies the Scale widget ID. value Specifies the slider position along the scale. This sets the XmNvalue resource. For a complete definition of Scale and its associated resources, see XmScale(3). |
|
XmScreen(3) -- The Screen widget class
|
|
The XmScreen object is used by Motif widgets to store information that is specific to a screen. It also allows the toolkit to store certain information on widget hierarchies that would otherwise be unavailable. Each client has one XmScreen object for each screen that it accesses. An XmScreen object is automatically created when the application creates the first shell on a screen (usually accomplis... |
|
XmScrollBar(3) -- The ScrollBar widget class
|
|
The ScrollBar widget allows the user to view data that is too large to be displayed all at once. ScrollBars are usually located inside a ScrolledWindow and adjacent to the widget that contains the data to be viewed. When the user interacts with the ScrollBar, the data within the other widget scrolls. A ScrollBar consists of two arrows placed at each end of a rectangle. The rectangle is called the ... |
|
XmScrollBarGetValues(3) -- A ScrollBar function that returns the ScrollBar's increment values
|
|
XmScrollBarGetValues returns the the ScrollBar's increment values. The scroll region is overlaid with a slider bar that is adjusted in size and position using the main ScrollBar or set slider function attributes. widget Specifies the ScrollBar widget ID. value_return Returns the ScrollBar's slider position between the XmNminimum and XmNmaximum resources. Specify NULL to prevent the return of a p... |
|
XmScrollBarSetValues(3) -- A ScrollBar function that changes ScrollBar's increment values and the slider's size and position
|
|
XmSetScrollBarValues changes the ScrollBar's increment values and the slider's size and position. The scroll region is overlaid with a slider bar that is adjusted in size and position using the main ScrollBar or set slider function attributes. widget Specifies the ScrollBar widget ID. value Specifies the ScrollBar's slider position. Refer to the XmNvalue resource described on XmScrollBar(3). sl... |
|
XmScrolledWindow(3) -- The ScrolledWindow widget class
|
|
The ScrolledWindow widget combines one or two ScrollBar widgets and a viewing area to implement a visible window onto some other (usually larger) data display. The visible part of the window can be scrolled through the larger display by the use of ScrollBars. To use ScrolledWindow, an application first creates a ScrolledWindow widget, any needed ScrollBar widgets, and a widget capable of displayin... |
|
XmScrolledWindowSetAreas(3) -- A ScrolledWindow function that adds or changes a window work region and a horizontal or vertical ScrollBar wid
|
|
XmScrolledWindowSetAreas adds or changes a window work region and a horizontal or vertical ScrollBar widget to the ScrolledWindow widget for the application. Each widget is optional and may be passed as NULL. This function is obsolete and exists for compatibility with other releases. Use the XmNscrolledWindowChildType resource of XmScrolledWindow instead. widget Specifies the ScrolledWindow widget... |
|
XmScrollVisible(3) -- A ScrolledWindow function that makes an invisible descendant of a ScrolledWindow work area visible
|
|
XmScrollVisible makes an obscured or partially obscured widget or gadget descendant of a ScrolledWindow work area visible. The function repositions the work area and sets the specified margins between the widget and the nearest viewport boundary. The widget's location relative to the viewport determines whether one or both of the margins must be adjusted. This function requires that the XmNscroll... |
|
XmSelectionBox(3) -- The SelectionBox widget class
|
|
SelectionBox is a general dialog widget that allows the user to select one item from a list. By default, a SelectionBox includes the following: + A scrolling list of alternatives + An editable text field for the selected alternative + Labels for the list and text field + Three or four buttons The default button labels are OK, Cancel, and Help. By default an Apply button is also created; if the par... |
|
XmSelectionBoxGetChild(3) -- A SelectionBox function that is used to access a component
|
|
XmSelectionBoxGetChild is used to access a component within a SelectionBox. The parameters given to the function are the SelectionBox widget and a value indicating which component to access. NOTE: This routine is obsolete and exists for compatibility with previous releases. Instead of calling XmSelectionBoxGetChild, you should call XtNameToWidget as described in the XmSelectionBox(3) reference pag... |
|
XmSeparator(3) -- The Separator widget class
|
|
Separator is a primitive widget that separates items in a display. Several different line drawing styles are provided, as well as horizontal or vertical orientation. The Separator line drawing is automatically centered within the height of the widget for a horizontal orientation and centered within the width of the widget for a vertical orientation. An XtSetValues with a new XmNseparatorType resiz... |
|
XmSeparatorGadget(3) -- The SeparatorGadget widget class
|
|
SeparatorGadget separates items in a display. Several line drawing styles are provided, as well as horizontal or vertical orientation. Lines drawn within the SeparatorGadget are automatically centered within the height of the gadget for a horizontal orientation and centered within the width of the gadget for a vertical orientation. An XtSetValues with a new XmNseparatorType resizes the widget to i... |
|
XmSetColorCalculation(3) -- A function to set the procedure used for default color calculation
|
|
XmSetColorCalculation sets the procedure to calculate default colors. This procedure is used to calculate the foreground, top shadow, bottom shadow, and select colors on the basis of a given background color. If called with an argument of NULL, it restores the default procedure used to calculate colors. color_proc Specifies the procedure to use for color calculation. Following is a description of ... |
|
XmSetFontUnit(3) -- A function that sets the font unit value for a display
|
|
XmSetFontUnit provides an external function to initialize font unit values. Applications may want to specify resolution-independent data based on a global font size. See the XmNunitType resource description in the reference pages for XmGadget, XmManager, and XmPrimitive for more information on resolution independence. This function sets the font units for all screens on the display. NOTE: XmSetFon... |
|
XmSetFontUnits(3) -- A function that sets the font unit value for a display
|
|
XmSetFontUnits provides an external function to initialize font unit values. Applications may want to specify resolution-independent data based on a global font size. This function must be called before any widgets with resolution-independent data are created. See the XmNunitType resource description in the reference pages for XmGadget, XmManager, and XmPrimitive for more information on resolution... |
|
XmSetMenuCursor(3) -- A function that modifies the menu cursor for a client
|
|
XmSetMenuCursor programmatically modifies the menu cursor for a client; after the cursor has been created by the client, this function registers the cursor with the menu system. After calling this function, the specified cursor is displayed whenever this client displays a Motif menu on the indicated display. The client can then specify different cursors on different displays. This function sets th... |
|
XmSetProtocolHooks(3) -- A VendorShell function that allows preactions and postactions to be executed when a protocol message is receiv
|
|
XmSetProtocolHooks is used by shells that want to have preactions and postactions executed when a protocol message is received from MWM. Since there is no guaranteed ordering in execution of event handlers or callback lists, this allows the shell to control the flow while leaving the protocol manager structures opaque. XmSetWMProtocolHooks is a convenience interface. It calls XmSetProtocolHooks wi... |
|
XmSetWMProtocolHooks(3) -- A VendorShell convenience interface that allows preactions and postactions to be executed when a protocol mess
|
|
XmSetWMProtocolHooks is a convenience interface. It calls XmSetProtocolHooks with the property value set to the atom returned by interning WM_PROTOCOLS. shell Specifies the widget with which the protocol property is associated protocol Specifies the protocol atom (or an int cast to Atom) prehook Specifies the procedure to call before calling entries on the client callback list pre_closure Specifie... |
|
XmSimpleSpinBox(3) -- a simple SpinBox widget class
|
|
The XmSimpleSpinBox widget is a user interface control to increment and decrement an arbitrary TextField. For example, it can be used to cycle through the months of the year or days of the month. Widget subclassing is not supported for the XmSimpleSpinBox widget class. |
|
XmSimpleSpinBoxAddItem(3) -- add an item to the XmSimpleSpinBox
|
|
The XmSimpleSpinBoxAddItem function adds the given item to the XmSimpleSpinBox at the given position. The w argument specifies the widget ID. The item argument specifies the XmString for the new item. The pos argument specifies the position of the new item. |
|
XmSimpleSpinBoxDeletePos(3) -- delete a XmSimpleSpinBox item
|
|
The XmSimpleSpinBoxDeletePos function deletes a specified item from a XmSimpleSpinBox widget. The w argument specifies the widget ID. The pos argument specifies the position of the item to be deleted. A value of 1 means the first item in the list; zero means the last item. |
|
XmSimpleSpinBoxSetItem(3) -- set an item in the XmSimpleSpinBox list
|
|
The XmSimpleSpinBoxSetItem function selects an item in the list of the given XmSimpleSpinBox widget and makes it the current value. The w argument specifies the widget ID. The item argument specifies the XmString for the item to be set in the XmSimpleSpinBox. If the item is not found on the list, XmSimpleSpinBoxSetItem notifies the user via the XtWarning function. |
|
XmSpinBox(3) -- The SpinBox widget class
|
|
SpinBox allows the user to select a value from a ring of related but mutually exclusive choices which are displayed in sequence. The SpinBox always has an increment arrow, a decrement arrow, and one or more other children. The choices are displayed, one at a time, in a traversable text child ( XmText or XmTextField. The user clicks on an arrow to display the next (or previous) item in the r... |
|
XmSpinBoxValidatePosition(3) -- translate the current value of the specified XmSpinBox child into a valid position
|
|
The XmSpinBoxValidatePosition function is a utility that can be used by applications wanting to implement a policy for tracking user modifications to editable XmSpinBox children of type XmNUMERIC. The specifics of when and how the user's modifications take effect is left up to the application. text_field The text_field argument specifies the widget ID of the child of the XmSpinBox that is being m... |
|
XmString(3) -- Data type for a compound string
|
|
XmString is the data type for a compound string. Compound strings consist of a sequence of components, including, but not limited to, the following: + XmSTRING_COMPONENT_SEPARATOR + XmSTRING_COMPONENT_TAB + XmSTRING_COMPONENT_LAYOUT_POP + XmSTRING_COMPONENT_DIRECTION + XmSTRING_COMPONENT_LAYOUT_PUSH + XmSTRING_COMPONENT_CHARSET + XmSTRING_COMPONENT_FONTLIST_ELEMENT_TAG + XmSTRING_COMPONENT_LOCALE ... |
|
XmStringBaseline(3) -- A compound string function that returns the number of pixels between the top of the character box and the base
|
|
XmStringBaseline returns the number of pixels between the top of the character box and the baseline of the first line of text in the provided compound string. rendertable Specifies the render table string Specifies the string |
|
XmStringByteCompare(3) -- A compound string function that indicates the
|
|
This function is obsolete and exists for compatibility with previous releases. XmStringByteCompare returns a Boolean indicating the results of a byte-by-byte comparison of two compound strings. In general, if two compound strings are created with the same (char *) string using XmStringCreateLocalized in the same language environment, the compound strings compare as equal. If two compound strings a... |
|
XmStringByteStreamLength(3) -- A function that returns the size of a string
|
|
XmStringByteStreamLength receives a byte stream format string and returns the size, in bytes, of that stream, including the header. Because of this header information, even a NULL string will cause XmStringByteStreamLength to return a non-zero value. string Specifies the byte stream format string. |
|
XmStringCompare(3) -- A compound string function that compares two strings
|
|
XmStringCompare returns a Boolean value indicating the results of a semantically equivalent comparison of two compound strings. Semantically equivalent means that the strings have the same text components, font list element tags, directions, and separators. In general, if two compound strings are created with the same (char *) string using XmStringCreateLocalized in the same language environment, ... |
|
XmStringComponentCreate(3) -- A compound string function that creates arbitrary components
|
|
XmStringComponentCreate creates a new XmString component of type c_type, containing value. If value is invalid for the particular component type, this function fails and returns NULL. c_type Specifies the type of component to be created. length Specifies the length in bytes of value. Note that this must be precisely the length of the value string, not including any trailing null characters. value ... |
|
XmStringComponentType(3) -- Data type for compound string components
|
|
XmStringComponentType is the data type specifying compound string component types. A compound string component identifies some part of a compound string, and can have a value and length. A compound string component can be one of the following types. These component types are grouped according to their length and value types. The following components have values of NULL and lengths of 0 (zero). |
|
XmStringConcat(3) -- A compound string function that appends one string to another
|
|
XmStringConcat copies s2 to the end of s1 and returns a copy of the resulting compound string. The original strings are preserved. The function will allocate space to hold the returned compound string. The application is responsible for managing the allocated space. The application can recover the allocated space by calling XmStringFree. s1 Specifies the compound string to which a copy of s2 is ap... |
|
XmStringConcatAndFree(3) -- A compound string function that appends one string to another and frees the original strings
|
|
XmStringConcatAndFree copies s2 to the end of s1 and returns a copy of the resulting compound string. The original strings are freed. The function will allocate space to hold the returned compound string. The application is responsible for managing the allocated space. The application can recover the allocated space by calling XmStringFree. s1 Specifies the compound string to which a copy of s2 is... |
|
XmStringCopy(3) -- A compound string function that makes a copy of a string
|
|
XmStringCopy makes a copy of an existing compound string. When the application no longer needs the returned compound string, the application should call XmStringFree. s1 Specifies the compound string to be copied |
|
XmStringCreate(3) -- A compound string function that creates a compound string
|
|
XmStringCreate creates a compound string with two components: text and a font list element tag. The function will allocate space to hold the returned compound string. When the application no longer needs the returned compound string, the application should call XmStringFree. text Specifies a NULL-terminated string to be used as the text component of the compound string. tag Specifies the tag compo... |
|
XmStringCreateLocalized(3) -- A compound string function that creates a compound string in the current locale
|
|
XmStringCreateLocalized creates a compound string containing the specified text in the current language environment. An identical compound string would result from the function XmStringCreate called with XmFONTLIST_DEFAULT_TAG explicitly as the tag component. The function will allocate space to hold the returned compound string. The application is responsible for managing the allocated space. The ... |
|
XmStringCreateLtoR(3) -- A compound string function that creates a compound string
|
|
This function is obsolete and exists for compatibility with previous releases. It is replaced by XmStringGenerate. XmStringCreateLtoR creates a compound string with two components: text and a tag component. This function scans for \n characters in the text. When one is found, the text up to that point is put into a segment followed by a separator component. No final separator component is appende... |
|
XmStringCreateSimple(3) -- A compound string function that creates a compound string in the language environment of a widget
|
|
XmStringCreateSimple creates a compound string with a text component and a charset tag. It derives the character set from the current language environment. The routine attempts to derive a character set from the value of the LANG environment variable. If this does not result in a valid character set, the routine uses a vendor-specific default. If the vendor has not specified a different value, thi... |
|
XmStringDirection(3) -- Data type for the direction of display in a string
|
|
XmStringDirection is the data type for specifying the direction in which the system displays characters of a string, or characters of a segment of a compound string. This is an enumeration with three possible values: |
|
XmStringDirectionCreate(3) -- A compound string function that creates a compound string
|
|
XmStringDirectionCreate creates a compound string with a single component, a direction with the given value. When the application no longer needs the returned compound string, the application should call XmStringFree. direction Specifies the value of the direction component. The possible values are: |
|
XmStringDirectionToDirection(3) -- A function that converts from XmStringDirection to XmDirection
|
|
XmStringDirectionToDirection converts the specified XmStringDirection direction value to its equivalent XmDirection value. This function provides backward compatibility with the XmStringDirection data type. direction Specifies the XmStringDirection value to be converted. |
|
XmStringDraw(3) -- A compound string function that draws a compound string in an X window
|
|
XmStringDraw draws a compound string in an X Window. If a compound string segment uses a rendition that contains a font set, the graphic context passed to this routine will have the GC font member left in an undefined state. The underlying XmbStringDraw function called by this routine modifies the font ID field of the GC passed into it and does not attempt to restore the font ID to the incoming va... |
|
XmStringDrawImage(3) -- A compound string function that draws a compound string in an X Window and creates an image
|
|
XmStringDrawImage draws a compound string in an X Window and paints both the foreground and background bits of each character. If a compound string segment uses a rendition that contains a font set, the graphic context passed to this routine will have the GC font member left in an undefined state. The underlying XmbStringDraw function called by this routine modifies the font ID field of the GC pas... |
|
XmStringDrawUnderline(3) -- A compound string function that underlines a string drawn in an X Window
|
|
XmStringDrawUnderline draws a compound string in an X Window. If the substring identified by underline can be matched in string, the substring will be underlined. Once a match has occurred, no further matches or underlining will be done. Only the first text component of underline is used for matching. If a compound string segment uses a rendition that contains a font set, the graphic context passe... |
|
XmStringEmpty(3) -- A compound string function that provides information
|
|
XmStringEmpty returns a Boolean value indicating whether any nonzero-length text components exist in the provided compound string. It returns True if there are no text segments in the string. If this routine is passed NULL as the string, it returns True. s1 Specifies the compound string |
|
XmStringExtent(3) -- A compound string function that determines the size of the smallest rectangle that will enclose the compound s
|
|
XmStringExtent determines the width and height, in pixels, of the smallest rectangle that will enclose the provided compound string. rendertable Specifies the render table string Specifies the string width Specifies a pointer to the width of the rectangle height Specifies a pointer to the height of the rectangle |
|
XmStringFree(3) -- A compound string function that conditionally deallocates memory
|
|
XmStringFree conditionally recovers memory used by a compound string. Applications should call XmStringFree when the application no longer needs string. string Specifies the compound string to be freed |
|
XmStringFreeContext(3) -- A compound string function that releases the string scanning context data structure
|
|
XmStringFreeContext releases the string scanning context data structure. context Specifies the string context structure that was allocated by the XmStringInitContext function |
|
XmStringGenerate(3) -- A convenience function that generates a compound string
|
|
XmStringGenerate calls the XmStringParseText function with a default parse table of entries consisting of '0', which maps to Separator, and '', which maps to Tab. Matching RENDITION_BEGIN and RENDITION_END components containing rendition are placed around the resulting XmString. text Specifies a NULL-terminated string containing characters of a type determined by type. tag Specifies the tag to... |
|
XmStringGetLtoR(3) -- A compound string function that searches for a text segment in the input compound string
|
|
This function is obsolete and exists for compatibility with previous releases. It is replaced by XmStringUnparse. XmStringGetLtoR returns the first text component in the input compound string that is tagged with the given tag component. The returned text is to be a NULLterminated sequence of single byte characters. If the function returns True, the function will allocate space to hold the returned... |
|
XmStringGetNextComponent(3) -- A compound string function that returns the type and value of the next component in a compound string
|
|
This function is obsolete and exists for compatibility with previous releases. It is replaced by XmStringGetNextTriple. XmStringGetNextComponent returns the type and value of the next component in the compound string identified by context. Components are returned one at a time. On return, only some output parameters will be valid; which ones can be determined by examining the returned component ty... |
|
XmStringGetNextSegment(3) -- A compound string function that fetches the bytes in the next segment of a compound string
|
|
This routine is obsolete and exists for compatibility with previous releases. To read the contents of a compound string, read each component of the string with XmStringGetNextTriple. This XmString function returns the type, length, and value of the next component in the compound string. XmStringGetNextSegment fetches the bytes in the next segment; repeated calls fetch sequential segments. The text... |
|
XmStringGetNextTriple(3) -- An XmString function that returns the type, length, and value of the next component in the compound string
|
|
XmStringGetNextTriple returns the type, length, and value of the next component in the compound string identified by context. This function returns one component at a time. context Specifies the string context structure that was allocated by the XmStringInitContext function. length Specifies a pointer to the length of the value of the returned component. value Specifies a pointer to the value of t... |
|
XmStringHasSubstring(3) -- A compound string function that indicates whether one compound string is contained within another
|
|
XmStringHasSubstring indicates whether or not one compound string is contained within another. string Specifies the compound string to be searched substring Specifies the compound string to be searched for |
|
XmStringHeight(3) -- A compound string function that returns the line height of the given compound string
|
|
XmStringHeight returns the height, in pixels, of the sum of all the line heights of the given compound string. Separator components delimit lines. rendertable Specifies the render table string Specifies the string |
|
XmStringInitContext(3) -- A compound string function that creates a data structure for scanning an XmString component by component
|
|
XmStringInitContext creates a context to allow applications to read out the contents of a compound string component by component. A Boolean status is returned to indicate that the context could not be initalized. If the function returns True, the function will allocate space to hold the returned context. The application is responsible for managing the allocated space. The memory can be recovered b... |
|
XmStringIsVoid(3) -- A compound string function that provides information
|
|
XmStringIsVoid returns a Boolean value indicating whether or not string s1 is void. s1 Specifies the compound string |
|
XmStringLength(3) -- A compound string function that obtains the length of a compound string
|
|
This function is obsolete and exists for compatibility with previous releases. It is replaced by XmStringByteStreamLength. XmStringLength obtains the length of a compound string. It returns the number of bytes in s1 including all tags, direction indicators, and separators. If the compound string has an invalid structure, 0 (zero) is returned. s1 Specifies the compound string |
|
XmStringLineCount(3) -- A compound string function that returns the number of separators plus one in the provided compound string
|
|
XmStringLineCount returns the number of separators plus one in the provided compound string. In effect, it counts the lines of text. string Specifies the string |
|
XmStringNConcat(3) -- A compound string function that appends a specified number of bytes to a compound string
|
|
This function is obsolete and exists for compatibility with previous releases. It is replaced by XmStringConcat. XmStringNConcat appends a specified number of bytes from s2 to the end of s1, including tags, directional indicators, and separators. It then returns the resulting compound string. The original strings are preserved. The function allocates space for the resulting compound string. The ap... |
|
XmStringNCopy(3) -- A compound string function that creates a copy of a compound string
|
|
This function is obsolete and exists for compatibility with previous releases. XmStringNCopy creates a copy of s1 that contains a specified number of bytes, including tags, directional indicators, and separators. It then returns the resulting compound string. The original strings are preserved. The function allocates space for the resulting compound string. The application is responsible for manag... |
|
XmStringParseText(3) -- A function that converts a character string to a compound string
|
|
XmStringParseText converts characters specified in text to corresponding components in the returned compound string. The resulting compound string consists of at least one locale or charset tag component and a series of XmString text components and other components. The conversion proceeds according to the parse information contained in parse_table. See the Motif Programmer's Guide for more infor... |
|
XmStringPeekNextComponent(3) -- A compound string function that returns the component type of the next component to be fetched
|
|
This function is obsolete and exists for compatibility with previous releases. It is replaced by XmStringPeekNextTriple. XmStringPeekNextComponent examines the next component that would be fetched by XmStringGetNextComponent and returns the component type. context Specifies the string context structure that was allocated by the XmStringInitContext function |
|
XmStringPeekNextTriple(3) -- A function that returns the component type of the next component
|
|
XmStringPeekNextTriple examines the next component that would be fetched by XmStringGetNextTriple and returns the component type. context Specifies the string context structure that was allocated by the XmStringInitContext function. |
|
XmStringPutRendition(3) -- A convenience function that places renditions around strings
|
|
XmStringPutRendition places matching Xm_STRING_COMPONENT_RENDITION_BEGIN and XmSTRING_COMPONENT_RENDITION_END components containing rendition around string. The original string is preserved. string Specifies the compound string to which begin and end rendition components should be added. rendition Specifies the rendition tag to be used in an XmSTRING_COMPONENT_RENDITION_BEGIN component which will ... |
|
XmStringSegmentCreate(3) -- A compound string function that creates a compound string
|
|
This function is obsolete and exists for compatibility with previous releases. It can be replaced by using a combination of XmStringComponentCreate and XmStringConcat. XmStringSegmentCreate is a high-level function that assembles a compound string consisting of a font list element tag, a direction component, a text component, and an optional separator component. The function allocates space for th... |
|
XmStringSeparatorCreate(3) -- A compound string function that creates a compound string
|
|
XmStringSeparatorCreate creates a compound string with a single component, a separator. |
|
XmStringTable(3) -- Data type for an array of compound strings
|
|
XmStringTable is the data type for an array of compound strings (objects of type XmString). |
|
XmStringTableParseStringArray(3) -- A convenience function that converts an array of strings to a compound string table
|
|
XmStringTableParseStringArray takes an array of strings, allocates an XmStringTable with an equal number of slots, calls XmStringParseText on each string in strings, and inserts the resulting XmString in the corresponding slot in the XmStringTable. strings Specifies an array of strings of characters as determined by type. count Specifies the number of strings in strings. tag Specifies the tag to b... |
|
XmStringTableProposeTablist(3) -- A convenience function that returns a tab list
|
|
XmStringTableProposeTablist takes an XmStringTable structure containing tabbed compound strings, information on padding between columns, and rendering information and returns a tab list that, if used to render the strings in the table, would cause the strings to line up in columns with no overlap and with the specified amount of padding between the widest item in each column and the start of the n... |
|
XmStringTableToXmString(3) -- A convenience function that converts a compound string table to a single compound string
|
|
XmStringTableToXmString takes as input table of compound strings and a specified string component (such as a tab) and returns a single compound string consisting of each of the elements of table concatenated together with a single copy of break_component inserted between each element. table Specifies an XmStringTable containing the compound strings to be converted. count Specifies the number of co... |
|
XmStringTableUnparse(3) -- A convenience function that converts a table of compound strings to an array of text
|
|
XmStringTableUnparse takes an array of compound strings, allocates a string array for the type of characters determined by type with an equal number of slots, calls XmStringUnparse on each compound string in table, and inserts the resulting string in the corresponding slot in the array. table Specifies an XmStringTable containing the compound string to be converted. count Specifies the number of c... |
|
XmStringToXmStringTable(3) -- A convenience function that converts a single compound string to a table of compound strings
|
|
XmStringToXmStringTable takes as input a single compound string and a specified string component (such as a tab) and returns a table of compound strings consisting of portions of string delimited by components matching break_component. The components marking breaks will not appear in the resulting table. string Specifies the XmString to be converted. break_component Specifies the XmStringComponent... |
|
XmStringUnparse(3) -- A compound string function that unparses text
|
|
XmStringUnparse looks in the input string for text segments that are tagged with locale or charset tags that match tag. The tag_type parameter specifies whether the tag is a locale or charset type. If tag has a value of NULL, all the segments are matched. When a text segment is found with a matching tag, it is added to the end of a resulting string. The characters in the resulting string are of ty... |
|
XmStringWidth(3) -- A compound string function that returns the width of the widest line in a compound string
|
|
XmStringWidth returns the width, in pixels, of the widest line in the provided compound string. rendertable Specifies the render table string Specifies the string |
|
XmTab(3) -- Data type for a tab stop
|
|
XmTab is a data structure that specifies a tab stop to be used in rendering an XmString containing tab components. An XmTab value contains a value, a unit type, an offset model (either XmABSOLUTE or XmRELATIVE), an alignment model (XmALIGNMENT_BEGINNING), and a decimal point character. The resource file syntax for XmTab is specified in the XmTabList reference page. |
|
XmTabCreate(3) -- A convenience function that creates a tab stop
|
|
XmTabCreate creates a tab stop at a position defined by the value and units arguments. value Specifies the floating point value to be used in conjunction with units to calculate the location of the tab stop. Note that negative values are not permitted. units Specifies the unit type (for example, XmMILLIMETERS) to be used in conjunction with value to calculate the location of the tab stop. You can ... |
|
XmTabFree(3) -- A convenience function that frees a tab
|
|
XmTabFree frees the memory associated with the specified tab. tab Specifies the tab to be freed. |
|
XmTabGetValues(3) -- A convenience function that returns tab values
|
|
XmTabGetValues takes an XmTab structure, returns the floating point number that is set as the value of the tab, and then sets values for the units, offset, alignment, and decimal arguments where they are not NULL. The returned floating point number represents the distance that the rendering of the XmString segment associated with tab will be offset. The offset is from either the beginning of the r... |
|
XmTabList(3) -- Data type for a tab list
|
|
XmTabList is the data type for a tab list. A tab list consists of tab stop list entries (XmTabs). Whenever a tab component is encountered while an XmString is being rendered, the origin of the next X draw depends on the next XmTab. If a tab stop would cause text to overlap, the x position for the segment is reset to follow immediately after the end of the previous segment. Tab lists are specified ... |
|
XmTabListCopy(3) -- A convenience function that creates a new tab list from an existing list
|
|
XmTabListCopy creates a new tab list consisting of a copy of a portion of the contents of the tablist argument. This function starts copying at the specified offset value of the tab list and copies count values. tablist Specifies a tab list to be copied. offset Specifies where to start copying. A value of 0 (zero) indicates begin at the beginning, a value of 1 indicates to skip the first tab, and ... |
|
XmTabListFree(3) -- A convenience function that frees the memory of a new tab list
|
|
XmTabListFree recovers memory used by a tab list. In addition, this function frees all contained tabs. If the tablist is NULL, the function returns immediately. tablist Specifies the tab list to be freed. |
|
XmTabListGetTab(3) -- A convenience function that returns a copy of a tab
|
|
XmTabListGetTab returns a copy of the tab that is located at the specified position in the tab list. tablist Specifies the tab list. position Specifies the position of the tab to be returned. A value of 0 (zero) returns the first tab in the tab list, a value of 1 returns the second tab, and so on. |
|
XmTabListInsertTabs(3) -- A convenience function that inserts tabs into a tab list
|
|
XmTabListInsertTabs creates a new tab list that includes the tabs in oldlist. This function copies specified tabs to the tab list at the given position. The first tab_count tabs of the tabs array are added to the tab list. If oldlist is NULL, XmTabListInsertTabs creates a new tab list containing only the tabs specified. oldlist Specifies the tab list to add the tabs to. The function deallocates ol... |
|
XmTabListRemoveTabs(3) -- A convenience function that removes noncontiguous tabs
|
|
XmTabListRemoveTabs removes noncontiguous tabs from a tab list. The function creates a new tab list by copying the contents of oldlist and removing all tabs whose corresponding positions appear in the position_list array. A warning message is displayed if a specified position is invalid; for example, if the value is a number greater than the number of tabs in the tab list. tablist Specifies the ta... |
|
XmTabListReplacePositions(3) -- A convenience function that creates a new tab list with replacement tabs
|
|
XmTabListReplacePositions creates a new tab list that contains the contents of oldlist, but with the tabs at the positions in position_list replaced with copies of the corresponding tabs in tabs. A warning message is displayed if a specified position is invalid; for example, if the value is a number greater than the number of tabs in the tab list. This function deallocates the original tab list af... |
|
XmTabListTabCount(3) -- A convenience function that counts the number of tabs
|
|
XmTabListTabCount counts the number of tabs in the specified tablist. tablist Specifies the tab list. |
|
XmTabSetValue(3) -- A convenience function that sets a tab stop
|
|
XmTabSetValue sets the value field of the XmTab structure associated with tab. tab Specifies the tab to set the value of. value Specifies the floating point number which represents the distance that the rendering of the XmString segment associated with tab will be offset. The offset is from either the beginning of the rendering or from the previous tab stop, depending on the setting for the offset... |
|
XmTargetsAreCompatible(3) -- A function that tests whether the target types match between a drop site and source object
|
|
XmTargetsAreCompatible determines whether the import targets of the destination match any of the export targets of a source. If there is at least one target in common, the function returns True. display Specifies the display connection. export_targets Specifies the list of target atoms associated with the source object. This resource identifies the selection targets the source can convert to. num_... |
|
XmText(3) -- The Text widget class
|
|
Text provides a single-line and multiline text editor for customizing both user and programmatic interfaces. It can be used for single-line string entry, forms entry with verification procedures, and fullwindow editing. It provides an application with a consistent editing system for textual data. The screen's textual data adjusts to the application writer's needs. Text provides separate callback... |
|
XmTextClearSelection(3) -- A Text function that clears the primary selection
|
|
XmTextClearSelection clears the primary selection in the Text widget. widget Specifies the Text widget ID. time Specifies the server time at which the selection value is desired. This should be the time of the event that triggered this request. One source of a valid time stamp is the function XtLastTimestampProcessed(). For a complete definition of Text and its associated resources, see XmText(3). |
|
XmTextCopy(3) -- A Text function that copies the primary selection to the clipboard
|
|
XmTextCopy copies the primary selected text to the clipboard. This routine calls the XmNconvertCallback procedures, possibly multiple times, with the selection member of the XmConvertCallbackStruct set to CLIPBOARD and with the parm member set to XmCOPY. widget Specifies the Text widget ID. time Specifies the server time at which the selection value is to be modified. This should be the time of th... |
|
XmTextCopyLink(3) -- A Text function that copies a link to the primary selection to the clipboard
|
|
XmTextCopyLink copies a link to the primary selected text to the clipboard. This routine calls the XmNconvertCallback procedures, possibly multiple times, with the selection member of the XmConvertCallbackStruct set to CLIPBOARD and with the parm member set to XmLINK. The Text widget itself does not copy any links; XmNconvertCallback procedures are responsible for copying the link to the clipboard... |
|
XmTextCut(3) -- A Text function that copies the primary selection to the clipboard and deletes the selected text
|
|
XmTextCut copies the primary selected text to the clipboard and then deletes the primary selected text. This routine calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, or both. If both verification callback lists are registered, the procedures of the XmNmodifyVerifyCallback list are executed first and the resulting ... |
|
XmTextDisableRedisplay(3) -- A Text function that temporarily prevents visual update of the Text widget
|
|
XmTextDisableRedisplay prevents redisplay of the specified Text widget even though its visual attributes have been modified. The visual appearance of the widget remains unchanged until XmTextEnableRedisplay is called, although the insertion cursor is not displayed. This allows an application to make multiple changes to the widget without causing intermediate visual updates. widget Specifies the Te... |
|
XmTextEnableRedisplay(3) -- A Text function that forces the visual update of a Text widget
|
|
XmTextEnableRedisplay is used in conjunction with XmTextDisableRedisplay, which suppresses visual update of the Text widget. When XmTextEnableRedisplay is called, it determines if any visual attributes have been set or modified for the specified widget since XmTextDisableRedisplay was called. If so, it forces the widget to update its visual display for all of the intervening changes. Any subsequen... |
|
XmTextField(3) -- The TextField class
|
|
The TextField widget provides a single line text editor for customizing both user and programmatic interfaces. It is used for single-line string entry, and forms entry with verification procedures. It provides an application with a consistent editing system for textual data. TextField provides separate callback lists to verify movement of the insert cursor, modification of the text, and changes in... |
|
XmTextFieldClearSelection(3) -- A TextField function that clears the primary selection
|
|
XmTextFieldClearSelection clears the primary selection in the TextField widget. widget Specifies the TextField widget ID. time Specifies the time at which the selection value is desired. This should be the time of the event that triggered this request. For a complete definition of TextField and its associated resources, see XmTextField(3). |
|
XmTextFieldCopy(3) -- A TextField function that copies the primary selection to the clipboard
|
|
XmTextFieldCopy copies the primary selected text to the clipboard. This routine calls the XmNconvertCallback procedures, possibly multiple times, with the selection member of the XmConvertCallbackStruct set to CLIPBOARD and with the parm member set to XmCOPY. widget Specifies the TextField widget ID. time Specifies the time at which the selection value is to be modified. This should be the time of... |
|
XmTextFieldCopyLink(3) -- A TextField function that copies a link to the primary selection to the clipboard
|
|
XmTextFieldCopyLink copies a link to the primary selected text to the clipboard. This routine calls the XmNconvertCallback procedures, possibly multiple times, with the selection member of the XmConvertCallbackStruct set to CLIPBOARD and with the parm member set to XmLINK. The TextField widget itself does not copy any links; XmNconvertCallback procedures are responsible for copying the link to the... |
|
XmTextFieldCut(3) -- A TextField function that copies the primary selection to the clipboard and deletes the selected text
|
|
XmTextFieldCut copies the primary selected text to the clipboard and then deletes the primary selected text. This routine calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, or both. If both verification callback lists are registered, the procedures of the XmNmodifyVerifyCallback list are executed first and the resul... |
|
XmTextFieldGetBaseline(3) -- A TextField function that accesses the y position of the baseline
|
|
XmTextFieldGetBaseline accesses the y position of the baseline in the TextField widget, relative to the y position of the top of the widget. widget Specifies the TextField widget ID For a complete definition of TextField and its associated resources, see XmTextField(3). |
|
XmTextFieldGetEditable(3) -- A TextField function that accesses the edit permission state
|
|
XmTextFieldGetEditable accesses the edit permission state of the TextField widget. widget Specifies the TextField widget ID For a complete definition of TextField and its associated resources, see XmTextField(3). |
|
XmTextFieldGetInsertionPosition(3) -- A TextField function that accesses the position of the insertion cursor
|
|
XmTextFieldGetInsertionPosition accesses the insertion cursor position of the TextField widget. widget Specifies the TextField widget ID For a complete definition of TextField and its associated resources, see XmTextField(3). |
|
XmTextFieldGetLastPosition(3) -- A TextField function that accesses the position of the last text character
|
|
XmTextFieldGetLastPosition accesses the position of the last character in the text buffer of the TextField widget. widget Specifies the TextField widget ID For a complete definition of TextField and its associated resources, see XmTextField(3). |
|
XmTextFieldGetMaxLength(3) -- A TextField function that accesses the value of the current maximum allowable length of a text string entered
|
|
XmTextFieldGetMaxLength accesses the value of the current maximum allowable length of the text string in the TextField widget entered from the keyboard. The maximum allowable length prevents the user from entering a text string larger than this limit. Note that the maximum allowable length is the same as the value of the widget's XmNmaxLength resource. widget Specifies the TextField widget ID For... |
|
XmTextFieldGetSelection(3) -- A TextField function that retrieves the value of the primary selection
|
|
XmTextFieldGetSelection retrieves the value of the primary selection. It returns a NULL pointer if no text is selected in the widget. The application is responsible for freeing the storage associated with the string by calling XtFree. widget Specifies the TextField widget ID For a complete definition of TextField and its associated resources, see XmTextField(3). |
|
XmTextFieldGetSelectionPosition(3) -- A TextField function that accesses the position of the primary selection
|
|
XmTextFieldGetSelectionPosition accesses the left and right position of the primary selection in the text buffer of the TextField widget. widget Specifies the TextField widget ID left Specifies the pointer in which the position of the left boundary of the primary selection is returned. This is an integer number of characters from the beginning of the buffer. The first character position is 0 (zero... |
|
XmTextFieldGetSelectionWcs(3) -- A TextField function that retrieves the value of a wide character encoded primary selection
|
|
XmTextFieldGetSelectionWcs retrieves the value of the primary selection, encoded in a wide character format. It returns a NULL pointer if no text is selected in the widget. The application is responsible for freeing the storage associated with the wide character buffer by calling XtFree. widget Specifies the TextField widget ID For a complete definition of TextField and its associated resources, s... |
|
XmTextFieldGetString(3) -- A TextField function that accesses the string value
|
|
XmTextFieldGetString accesses the string value of the TextField widget. The application is responsible for freeing the storage associated with the string by calling XtFree. widget Specifies the TextField widget ID For a complete definition of TextField and its associated resources, see XmTextField(3). |
|
XmTextFieldGetStringWcs(3) -- A TextField function that retrieves a copy of the wide character string value of a TextField widget
|
|
XmTextFieldGetStringWcs retrieves a copy of the wide character string value of the TextField widget. The application is responsible for freeing the storage associated with the string by calling XtFree. widget Specifies the TextField widget ID For a complete definition of TextField and its associated resources, see XmTextField(3). |
|
XmTextFieldGetSubstring(3) -- A TextField function that retrieves a copy of a portion of the internal text buffer
|
|
XmTextFieldGetSubstring retrieves a copy of a portion of the internal text buffer of a TextField widget. The function copies a specified number of characters from a given start position in the internal text buffer into a buffer provided by the application. A NULL terminator is placed at the end of the copied data. The size of the required buffer depends on the maximum number of bytes per character... |
|
XmTextFieldGetSubstringWcs(3) -- A TextField function that retrieves a portion of a wide character internal text buffer
|
|
XmTextFieldGetSubstringWcs retrieves a copy of a portion of the internal text buffer of a TextField widget that is stored in a wide character format. The function copies a specified number of characters from a given start position in the internal text buffer into a buffer provided by the application. A NULL terminator is placed at the end of the copied data. widget Specifies the TextField widget I... |
|
XmTextFieldInsert(3) -- A TextField function that inserts a character string into a text string
|
|
XmTextFieldInsert inserts a character string into the text string in the TextField widget. The character positions begin at 0 (zero) and are numbered sequentially from the beginning of the text. For example, to insert a string after the fourth character, the position parameter must be 4. This routine calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyCall... |
|
XmTextFieldInsertWcs(3) -- A TextField function that inserts a wide character string into a TextField widget
|
|
XmTextFieldInsertWcs inserts a wide character string into the TextField widget at a specified location. The character positions begin at 0 (zero) and are numbered sequentially from the beginning of the text. For example, to insert a string after the fourth character, the position parameter must be 4. This routine calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmod... |
|
XmTextFieldPaste(3) -- A TextField function that inserts the clipboard selection
|
|
XmTextFieldPaste inserts the clipboard selection at the insertion cursor of the destination widget. If XmNpendingDelete is True and the insertion cursor is inside the current selection, the clipboard selection replaces the selected text. This routine calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, or both. If bot... |
|
XmTextFieldPasteLink(3) -- A TextField function that inserts a link to the clipboard selection
|
|
XmTextFieldPasteLink inserts a link to the clipboard selection at the insertion cursor. This routine calls the widget's XmNdestinationCallback procedures with the selection member of the XmDestinationCallbackStruct set to CLIPBOARD and with the operation member set to XmLINK. The TextField widget itself performs no transfers; the XmNdestinationCallback procedures are responsible for inserting the... |
|
XmTextFieldPosToXY(3) -- A TextField function that accesses the x and y position of a character position
|
|
XmTextFieldPosToXY accesses the x and y position, relative to the upper left corner of the TextField widget, of a given character position in the text buffer. widget Specifies the TextField widget ID position Specifies the character position in the text for which the x and y position is accessed. This is an integer number of characters from the beginning of the buffer. The first character position... |
|
XmTextFieldRemove(3) -- A TextField function that deletes the primary selection
|
|
XmTextFieldRemove deletes the primary selected text. If there is a selection, this routine also calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, or both. If both verification callback lists are registered, the procedures of the XmNmodifyVerifyCallback list are executed first and the resulting data is passed to the... |
|
XmTextFieldReplace(3) -- A TextField function that replaces part of a text string
|
|
XmTextFieldReplace replaces part of the text string in the TextField widget. The character positions begin at 0 (zero) and are numbered sequentially from the beginning of the text. An example text replacement would be to replace the second and third characters in the text string. To accomplish this, the parameter from_pos must be 1 and to_pos must be 3. To insert a string after the fourth characte... |
|
XmTextFieldReplaceWcs(3) -- A TextField function that replaces part of a wide character string in a TextField widget
|
|
XmTextFieldReplaceWcs replaces part of the wide character string in the TextField widget. The character positions begin at 0 (zero) and are numbered sequentially from the beginning of the text. An example text replacement would be to replace the second and third characters in the text string. To accomplish this, the parameter from_pos must be 1 and to_pos must be 3. To insert a string after the fo... |
|
XmTextFieldSetAddMode(3) -- A TextField function that sets the state of Add mode
|
|
XmTextFieldSetAddMode controls whether or not the TextField widget is in Add mode. When the widget is in Add mode, the insert cursor can be moved without disturbing the primary selection. widget Specifies the TextField widget ID state Specifies whether or not the widget is in Add mode. A value of True turns on Add mode; a value of False turns off Add mode. For a complete definition of TextField an... |
|
XmTextFieldSetEditable(3) -- A TextField function that sets the edit permission
|
|
XmTextFieldSetEditable sets the edit permission state of the TextField widget. When set to True, the text string can be edited. widget Specifies the TextField widget ID editable Specifies a Boolean value that when True allows text string edits For a complete definition of TextField and its associated resources, see XmTextField(3). |
|
XmTextFieldSetHighlight(3) -- A TextField function that highlights text
|
|
XmTextFieldSetHighlight highlights text between the two specified character positions. The mode parameter determines the type of highlighting. Highlighting text merely changes the visual appearance of the text; it does not set the selection. widget Specifies the TextField widget ID left Specifies the position of the left boundary of text to be highlighted. This is an integer number of characters f... |
|
XmTextFieldSetInsertionPosition(3) -- A TextField function that sets the position of the insertion cursor
|
|
XmTextFieldSetInsertionPosition sets the insertion cursor position of the TextField widget. This routine also calls the widget's XmNmotionVerifyCallback callbacks if the insertion cursor position changes. widget Specifies the TextField widget ID position Specifies the position of the insert cursor. This is an integer number of characters from the beginning of the text buffer. The first character ... |
|
XmTextFieldSetMaxLength(3) -- A TextField function that sets the value of the current maximum allowable length of a text string entered from
|
|
XmTextFieldSetMaxLength sets the value of the current maximum allowable length of the text string in the TextField widget. The maximum allowable length prevents the user from entering a text string from the keyboard that is larger than this limit. Strings that are entered using the XmNvalue (or XmNvalueWcs) resource, or the XmTextFieldSetString (or XmTextFieldSetStringWcs) function ignore this res... |
|
XmTextFieldSetSelection(3) -- A TextField function that sets the primary selection of the text
|
|
XmTextFieldSetSelection sets the primary selection of the text in the widget. It also sets the insertion cursor position to the last position of the selection and calls the widget's XmNmotionVerifyCallback callbacks. XmTextFieldSetSelection always generates an XmNgainPrimaryCallback unless it fails to take ownership of the primary text selection. widget Specifies the TextField widget ID first Mar... |
|
XmTextFieldSetString(3) -- A TextField function that sets the string value
|
|
XmTextFieldSetString sets the string value of the TextField widget. This routine calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, or both. If both verification callback lists are registered, the procedures of the XmNmodifyVerifyCallback list are executed first and the resulting data is passed to the XmNmodifyVerif... |
|
XmTextFieldSetStringWcs(3) -- A TextField function that sets a wide character string value
|
|
XmTextFieldSetStringWcs sets the wide character string value of the TextField widget. This routine calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, or both. If both verification callback lists are registered, the procedures of the XmNmodifyVerifyCallback list are executed first and the resulting data is passed to ... |
|
XmTextFieldShowPosition(3) -- A TextField function that forces text at a given position to be displayed
|
|
XmTextFieldShowPosition forces text at the specified position to be displayed. The cursor position is not updated nor is the cursor shown at this position. widget Specifies the TextField widget ID position Specifies the character position to be displayed. This is an integer number of characters from the beginning of the text buffer. The first character position is 0 (zero). See XmTextPosition(3) f... |
|
XmTextFieldXYToPos(3) -- A TextField function that accesses the character position nearest an x and y position
|
|
XmTextFieldXYToPos accesses the character position nearest to the specified x and y position, relative to the upper left corner of the TextField widget. widget Specifies the TextField widget ID x Specifies the x position, relative to the upper left corner of the widget. y Specifies the y position, relative to the upper left corner of the widget. For a complete definition of TextField and its assoc... |
|
XmTextFindString(3) -- A Text function that finds the beginning position of a text string
|
|
XmTextFindString locates the beginning position of a specified text string. This routine searches forward or backward for the first occurrence of the string starting from the given start position. If it finds a match, the function returns the position of the first character of the string in position. If the match string begins at the current position, this routine returns the current position. wid... |
|
XmTextFindStringWcs(3) -- A Text function that finds the beginning position of a wide character text string
|
|
XmTextFindStringWcs locates the beginning position of a specified wide character text string. This routine searches forward or backward for the first occurrence of the string, starting from the given start position. If a match is found, the function returns the position of the first character of the string in position. If the match string begins at the current position, this routine returns the cu... |
|
XmTextGetBaseline(3) -- A Text function that accesses the y position of the baseline
|
|
XmTextGetBaseline accesses the y position of the baseline in the Text widget, relative to the y position of the top of the widget. In vertical mode (when the XmNlayoutDirection resource is XmTOP_TO_BOTTOM) this function returns 0 and the program should use XmTextGetCenterline widget Specifies the Text widget ID For a complete definition of Text and its associated resources, see XmText(3). |
|
XmTextGetCenterline(3) -- Return the height (length) of a character string when the writing direction is vertical
|
|
XmTextGetCenterline accesses the x position of the centerline in the Text widget, relative to the x position of the top of the widget. widget Specifies the Text widget ID. |
|
XmTextGetEditable(3) -- A Text function that accesses the edit permission state
|
|
XmTextGetEditable accesses the edit permission state of the Text widget. widget Specifies the Text widget ID For a complete definition of Text and its associated resources, see XmText(3). |
|
XmTextGetInsertionPosition(3) -- A Text function that accesses the position of the insert cursor
|
|
XmTextGetInsertionPosition accesses the insertion cursor position of the Text widget. widget Specifies the Text widget ID For a complete definition of Text and its associated resources, see XmText(3). |
|
XmTextGetLastPosition(3) -- A Text function that accesses the last position in the text
|
|
XmTextGetLastPosition accesses the last position in the text buffer of the Text widget. This is an integer number of characters from the beginning of the buffer, and represents the position that text added to the end of the buffer is placed after. The first character position is 0 (zero). The last character position is equal to the number of characters in the text buffer. widget Specifies the Text... |
|
XmTextGetMaxLength(3) -- A Text function that accesses the value of the current maximum allowable length of a text string entered from
|
|
XmTextGetMaxLength accesses the value of the current maximum allowable length of the text string in the Text widget entered from the keyboard. The maximum allowable length prevents the user from entering a text string larger than this limit. Note that the maximum allowable length is the same as the value of the widget's XmNmaxLength resource. widget Specifies the Text widget ID For a complete def... |
|
XmTextGetSelection(3) -- A Text function that retrieves the value of the primary selection
|
|
XmTextGetSelection retrieves the value of the primary selection. It returns a NULL pointer if no text is selected in the widget. The application is responsible for freeing the storage associated with the string by calling XtFree. widget Specifies the Text widget ID For a complete definition of Text and its associated resources, see XmText(3). |
|
XmTextGetSelectionPosition(3) -- A Text function that accesses the position of the primary selection
|
|
XmTextGetSelectionPosition accesses the left and right position of the primary selection in the text buffer of the Text widget. widget Specifies the Text widget ID left Specifies the pointer in which the position of the left boundary of the primary selection is returned. This is an integer number of characters from the beginning of the buffer. The first character position is 0 (zero). right Specif... |
|
XmTextGetSelectionWcs(3) -- A Text function that retrieves the value of a wide character encoded primary selection
|
|
XmTextGetSelectionWcs retrieves the value of the primary selection that is encoded in a wide character format. It returns a NULL pointer if no text is selected in the widget. The application is responsible for freeing the storage associated with the wide character buffer by calling XtFree. widget Specifies the Text widget ID For a complete definition of Text and its associated resources, see XmTex... |
|
XmTextGetSource(3) -- A Text function that accesses the source of the widget
|
|
XmTextGetSource accesses the source of the Text widget. Text widgets can share sources of text so that editing in one widget is reflected in another. This function accesses the source of one widget so that it can be made the source of another widget, using the function XmTextSetSource(3). Setting a new text source destroys the old text source if no other Text widgets are using that source. To repl... |
|
XmTextGetString(3) -- A Text function that accesses the string value
|
|
XmTextGetString accesses the string value of the Text widget. The application is responsible for freeing the storage associated with the string by calling XtFree. widget Specifies the Text widget ID For a complete definition of Text and its associated resources, see XmText(3). |
|
XmTextGetStringWcs(3) -- A Text function that retrieves a copy of the wide character string value of a Text widget
|
|
XmTextGetStringWcs retrieves a copy of the wide character string value of the Text widget. The application is responsible for freeing the storage associated with the string by calling XtFree. widget Specifies the Text widget ID For a complete definition of Text and its associated resources, see XmText(3). |
|
XmTextGetSubstring(3) -- A Text function that retrieves a copy of a portion of the internal text buffer
|
|
XmTextGetSubstring retrieves a copy of a portion of the internal text buffer of a Text widget. The function copies a specified number of characters from a given start position in the internal text buffer into a buffer provided by the application. A NULL terminator is placed at the end of the copied data. The size of the required buffer depends on the maximum number of bytes per character (MB_CUR_M... |
|
XmTextGetSubstringWcs(3) -- A Text function that retrieves a portion of a wide character internal text buffer
|
|
XmTextGetSubstringWcs retrieves a copy of a portion of the internal text buffer of a Text widget that is stored in a wide character format. The function copies a specified number of characters from a given start position in the internal text buffer into a buffer provided by the application. A NULL terminator is placed at the end of the copied data. widget Specifies the Text widget ID. start Specif... |
|
XmTextGetTopCharacter(3) -- A Text function that accesses the position of the first character displayed
|
|
XmTextGetTopCharacter accesses the position of the text at the top of the Text widget. If there is no text in the Text widget (in other words, XmNvalue contains an empty string), then XmTextGetTopCharacter returns 0. Suppose that the XmNtopCharacter resource has been set to a value greater than the number of characters in the text widget. In this case, XmTextGetTopCharacter returns an XmTextPositi... |
|
XmTextInsert(3) -- A Text function that inserts a character string into a text string
|
|
XmTextInsert inserts a character string into the text string in the Text widget. The character positions begin at 0 (zero) and are numbered sequentially from the beginning of the text. For example, to insert a string after the fourth character, the parameter position must be 4. This routine calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyCallback or Xm... |
|
XmTextInsertWcs(3) -- A Text function that inserts a wide character string into a Text widget
|
|
XmTextInsertWcs inserts a wide character string into the Text widget at a specified location. The character positions begin at 0 (zero) and are numbered sequentially from the beginning of the text. For example, to insert a string after the fourth character, the position parameter must be 4. This routine calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyC... |
|
XmTextPaste(3) -- A Text function that inserts the clipboard selection
|
|
XmTextPaste inserts the clipboard selection at the insertion cursor of the destination widget. If XmNpendingDelete is True and the insertion cursor is inside the current selection, the clipboard selection replaces the selected text. This routine calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, or both. If both ver... |
|
XmTextPasteLink(3) -- A Text function that inserts a link to the clipboard selection
|
|
XmTextPasteLink inserts a link to the clipboard selection at the insertion cursor. This routine calls the widget's XmNdestinationCallback procedures with the selection member of the XmDestinationCallbackStruct set to CLIPBOARD and with the operation member set to XmLINK. The Text widget itself performs no transfers; the XmNdestinationCallback procedures are responsible for inserting the link to t... |
|
XmTextPosition(3) -- Data type for a character position within a text string
|
|
XmTextPosition is an integer data type that holds a character's position within a text string for Text and TextField. An XmTextPosition value conceptually points to the gap between two characters. For example, consider a text string consisting of N characters. A value of 0 refers to the position immediately prior to the first character. A value of 1 refers to the position in between the first and... |
|
XmTextPosToXY(3) -- A Text function that accesses the x and y position of a character position
|
|
XmTextPosToXY accesses the x and y position, relative to the upper left corner of the Text widget, of a given character position in the text buffer. In the case of horizontal writing, the position is the origin of the character. In the case of vertical writing, the position is the vertical origin of the character. widget Specifies the Text widget ID position Specifies the character position in the... |
|
XmTextRemove(3) -- A Text function that deletes the primary selection
|
|
XmTextRemove deletes the primary selected text. If there is a selection, this routine also calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, or both. If both verification callback lists are registered, the procedures of the XmNmodifyVerifyCallback list are executed first and the resulting data is passed to the XmNm... |
|
XmTextReplace(3) -- A Text function that replaces part of a text string
|
|
XmTextReplace replaces part of the text string in the Text widget. The character positions begin at 0 (zero) and are numbered sequentially from the beginning of the text. An example text replacement would be to replace the second and third characters in the text string. To accomplish this, the parameter from_pos must be 1 and to_pos must be 3. To insert a string after the fourth character, both pa... |
|
XmTextReplaceWcs(3) -- A Text function that replaces part of a wide character string in a Text widget
|
|
XmTextReplaceWcs replaces part of the wide character string in the Text widget. The character positions begin at zero and are numbered sequentially from the beginning of the text. An example text replacement would be to replace the second and third characters in the text string. To accomplish this, the from_pos parameter must be 1 and the to_pos parameter must be 3. To insert a string after the fo... |
|
XmTextScroll(3) -- A Text function that scrolls text
|
|
XmTextScroll scrolls text by a given number of lines in a Text widget. The sign of the number is interpreted according to the value of the XmNlayoutDirection resource. widget Specifies the Text widget ID lines Specifies the number of lines of text to scroll. A positive value causes text to scroll upward; a negative value causes text to scroll downward. Note that the text will scroll only as long a... |
|
XmTextSetAddMode(3) -- A Text function that sets the state of Add mode
|
|
XmTextSetAddMode controls whether or not the Text widget is in Add mode. When the widget is in Add mode, the insert cursor can be moved without disturbing the primary selection. widget Specifies the Text widget ID state Specifies whether or not the widget is in Add mode. A value of True turns on Add mode; a value of False turns off Add mode. For a complete definition of Text and its associated res... |
|
XmTextSetEditable(3) -- A Text function that sets the edit permission
|
|
XmTextSetEditable sets the edit permission state of the Text widget. When set to True, the text string can be edited. widget Specifies the Text widget ID editable Specifies a Boolean value that when True allows text string edits For a complete definition of Text and its associated resources, see XmText(3). |
|
XmTextSetHighlight(3) -- A Text function that highlights text
|
|
XmTextSetHighlight highlights text between the two specified character positions. The mode parameter determines the type of highlighting. Highlighting text merely changes the visual appearance of the text; it does not set the selection. widget Specifies the Text widget ID left Specifies the position of the left boundary of text to be highlighted. This is an integer number of characters from the be... |
|
XmTextSetInsertionPosition(3) -- A Text function that sets the position of the insert cursor
|
|
XmTextSetInsertionPosition sets the insertion cursor position of the Text widget. This routine also calls the widget's XmNmotionVerifyCallback callbacks if the insertion cursor position changes. widget Specifies the Text widget ID position Specifies the position of the insertion cursor. This is an integer number of characters from the beginning of the text buffer. The first character position is ... |
|
XmTextSetMaxLength(3) -- A Text function that sets the value of the current maximum allowable length of a text string entered from the
|
|
XmTextSetMaxLength sets the value of the current maximum allowable length of the text string in the Text widget. The maximum allowable length prevents the user from entering a text string from the keyboard that is larger than this limit. Strings that are entered using the XmNvalue (or XmNvalueWcs) resource, or the XmTextSetString (or XmTextSetStringWcs) function ignore this resource. widget Specif... |
|
XmTextSetSelection(3) -- A Text function that sets the primary selection of the text
|
|
XmTextSetSelection sets the primary selection of the text in the widget. It also sets the insertion cursor position to the last position of the selection and calls the widget's XmNmotionVerifyCallback callbacks. widget Specifies the Text widget ID first Marks the first character position of the text to be selected last Marks the last position of the text to be selected time Specifies the time at ... |
|
XmTextSetSource(3) -- A Text function that sets the source of the widget
|
|
XmTextSetSource sets the source of the Text widget. Text widgets can share sources of text so that editing in one widget is reflected in another. This function sets the source of one widget so that it can share the source of another widget. Setting a new text source destroys the old text source if no other Text widgets are using that source. To replace a text source but keep it for later use, crea... |
|
XmTextSetString(3) -- A Text function that sets the string value
|
|
XmTextSetString sets the string value of the Text widget. This routine calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, or both. If both verification callback lists are registered, the procedures of the XmNmodifyVerifyCallback list are executed first and the resulting data is passed to the XmNmodifyVerifyCallbackW... |
|
XmTextSetStringWcs(3) -- A Text function that sets a wide character string value
|
|
XmTextSetStringWcs sets the wide character string value of the Text widget. This routine calls the widget's XmNvalueChangedCallback and verification callbacks, either XmNmodifyVerifyCallback or XmNmodifyVerifyCallbackWcs, or both. If both verification callback lists are registered, the procedures of the XmNmodifyVerifyCallback list are executed first and the resulting data is passed to the XmNmod... |
|
XmTextSetTopCharacter(3) -- A Text function that sets the position of the first character displayed
|
|
XmTextSetTopCharacter sets the position of the text at the top of the Text widget. If the XmNeditMode is XmMULTI_LINE_EDIT, the line of text that contains top_character is displayed at the top of the widget without the text shifting left or right. If the edit mode is XmSINGLE_LINE_EDIT, the text moves horizontally so that top_character is the first character displayed. widget Specifies the Text wi... |
|
XmTextShowPosition(3) -- A Text function that forces text at a given position to be displayed
|
|
XmTextShowPosition forces text at the specified position to be displayed. If the XmNautoShowCursorPosition resource is True, the application should also set the insert cursor to this position. widget Specifies the Text widget ID position Specifies the character position to be displayed. This is an integer number of characters from the beginning of the text buffer. The first character position is 0... |
|
XmTextXYToPos(3) -- A Text function that accesses the character position nearest an x and y position
|
|
XmTextXYToPos accesses the character position nearest to the specified x and y position, relative to the upper left corner of the Text widget. In the case of horizontal writing, the position is the origin of the character. In the case of vertical writing, the position is the vertical origin of the character. widget Specifies the Text widget ID x Specifies the x position, relative to the upper left... |
|
XmToggleButton(3) -- The ToggleButton widget class
|
|
ToggleButton sets nontransitory state data within an application. Usually this widget consists of an indicator (square, diamond, or round) with either text or a pixmap on one side of it. However, it can also consist of just text or a pixmap without the indicator. The toggle graphics display a 1-of-many, N-of-many, or 1-of-many-round selection state. When a toggle indicator is displayed, a square i... |
|
XmToggleButtonGadget(3) -- The ToggleButtonGadget widget class
|
|
ToggleButtonGadget sets nontransitory state data within an application. Usually this gadget consists of an indicator (square, diamond, or round) with either text or a pixmap on one side of it. However, it can also consist of just text or a pixmap without the indicator. The toggle graphics display a 1-of-many, N-of-many, or N-of-many-round selection state. When a toggle indicator is displayed, a sq... |
|
XmToggleButtonGadgetGetState(3) -- A ToggleButtonGadget function that obtains the state of a ToggleButtonGadget
|
|
XmToggleButtonGadgetGetState obtains the state of a ToggleButtonGadget. widget Specifies the ToggleButtonGadget ID For a complete definition of ToggleButtonGadget and its associated resources, see XmToggleButtonGadget(3). |
|
XmToggleButtonGadgetSetState(3) -- A ToggleButtonGadget function that sets or changes the current state
|
|
XmToggleButtonGadgetSetState sets or changes the ToggleButtonGadget's current state. widget Specifies the ToggleButtonGadget widget ID. state Specifies a Boolean value that indicates whether the ToggleButtonGadget state is selected or unselected. If the value is True, the button state is selected; if it is False, the button state is unselected. notify Indicates whether XmNvalueChangedCallback is ... |
|
XmToggleButtonGetState(3) -- A ToggleButton function that obtains the state of a ToggleButton
|
|
XmToggleButtonGetState obtains the state of a ToggleButton. widget Specifies the ToggleButton widget ID For a complete definition of ToggleButton and its associated resources, see XmToggleButton(3). |
|
XmToggleButtonSetState(3) -- A ToggleButton function that sets or changes the current state
|
|
XmToggleButtonSetState sets or changes the ToggleButton's current state. widget Specifies the ToggleButton widget ID. state Specifies a Boolean value that indicates whether the ToggleButton state is selected or unselected. If the value is True, the button state is selected; if it is False, the button state is unselected. notify Indicates whether XmNvalueChangedCallback is called; it can be either... |
|
XmToggleButtonSetValue(3) -- A ToggleButton function that sets or changes the current state
|
|
XmToggleButtonSetValue sets or changes the ToggleButton's current state. widget Specifies the ToggleButton widget ID. state Specifies whether the ToggleButton state is selected or unselected. If the value is True, the button state is selected; if it is False, the button state is unselected, if it is XmINDETERMINATE, the button state is neither. notify Indicates whether XmNvalueChangedCallback is ... |
|
XmTrackingEvent(3) -- A Toolkit function that provides a modal interaction
|
|
XmTrackingEvent provides a modal interface for selection of a component. It is intended to support context help. The function calls the XmUpdateDisplay function. XmTrackingEvent then grabs the pointer and discards succeeding events until BSelect is released or a key is pressed and then released. The function then returns the widget or gadget that contains the pointer when BSelect is released or a ... |
|
XmTrackingLocate(3) -- A Toolkit function that provides a modal interaction
|
|
XmTrackingLocate provides a modal interface for selection of a component. It is intended to support context help. This function is implemented as XmTrackingEvent. NOTE: This function is obsolete and exists for compatibility with previous releases. It has been replaced by XmTrackingEvent. widget Specifies the widget ID of a widget to use as the basis of the modal interaction. That is, the widget wi... |
|
XmTransferDone(3) -- A toolkit function that completes a data transfer
|
|
XmTransferDone completes an already-initiated data transfer operation. An application can call this routine from an XmNdestinationCallback procedure or any function called as a result, including the selection procedures called as a result of calls to XmTransferValue. The caller of XmTransferDone supplies an identifier for the transfer operation and an indication of the completion status. XmTransfe... |
|
XmTransferSendRequest(3) -- A toolkit function that transfers a MULTIPLE request
|
|
XmTransferSendRequest marks the end of a MULTIPLE request started by XmTransferStartRequest. transfer_id Specifies a unique indentifier for the data transfer operation. time Specifies the time of the XEvent that triggered the data transfer. You should typically set this field to XtLastTimestampProcessed. |
|
XmTransferSetParameters(3) -- A toolkit function that establishes parameters to be passed by the next call to XmTransferValue
|
|
XmTransferSetParameters establishes a parameter definition. Your application calls XmTransferSetParameters just before calling XmTransferValue, and only if XmTransferValue needs to transfer a value containing a parameter. transfer_id Specifies a unique indentifier for the data transfer operation. The value must be the same as the value of the transfer_id member of the XmDestinationCallbackStruct p... |
|
XmTransferStartRequest(3) -- A toolkit function that begins a MULTIPLE transfer
|
|
XmTransferStartRequest begins a MULTIPLE request. The MULTIPLE request may contain one or more calls to XmTransferValue. Your application concludes a MULTIPLE request by calling XmTransferSendRequest. XmTransferStartRequest is typically called by a destination callback or by a transfer procedure. transfer_id Specifies a unique indentifier for the data transfer operation. You should use the transfe... |
|
XmTransferValue(3) -- A toolkit function that transfers data to a destination
|
|
XmTransferValue converts a selection, transferring any data from the selection owner, in the context of an already-initiated data transfer operation. An application can call this routine from an XmNdestinationCallback procedure or any function called as a result. The caller of XmTransferValue supplies the target to which the selection is converted. The caller also supplies a callback procedure to ... |
|
XmTranslateKey(3) -- The default keycode-to-keysym translator
|
|
XmTranslateKey is the default XtKeyProc translation procedure for Motif applications. The function takes a keycode and modifiers and returns the corresponding keysym. XmTranslateKey serves two main purposes: to enable new translators with expanded functionality to get the default Motif keycode-to-keysym translation in addition to whatever they add, and to reinstall the default translator. This fun... |
|
XmUninstallImage(3) -- A pixmap caching function that removes an image from the image cache
|
|
XmUninstallImage removes an image from the image cache. image Points to the image structure given to the XmInstallImage() routine |
|
XmUpdateDisplay(3) -- A function that processes all pending exposure events immediately
|
|
XmUpdateDisplay provides the application with a mechanism for forcing all pending exposure events to be removed from the input queue and processed immediately. When a user selects a button within a menu pane, the menu panes are unposted and then any activation callbacks registered by the application are invoked. If one of the callbacks performs a time-consuming action, the portion of the applicati... |
|
XmVaCreateSimpleCheckBox(3) -- A RowColumn widget convenience creation function
|
|
XmVaCreateSimpleCheckBox creates an instance of a RowColumn widget of type XmWORK_AREA and returns the associated widget ID. This routine uses the ANSI C variable-length argument list (varargs) calling convention. This routine creates a CheckBox and its ToggleButtonGadget children. A CheckBox is similar to a RadioBox, except that more than one button can be selected at a time. The name of each but... |
|
XmVaCreateSimpleMenuBar(3) -- A RowColumn widget convenience creation function
|
|
XmVaCreateSimpleMenuBar creates an instance of a RowColumn widget of type XmMENU_BAR and returns the associated widget ID. This routine uses the ANSI C variable-length argument list (varargs) calling convention. This routine creates a MenuBar and its CascadeButtonGadget children. The name of each button is button_n, where n, where n is an integer from 0 (zero) to the number of buttons in the menu ... |
|
XmVaCreateSimpleOptionMenu(3) -- A RowColumn widget convenience creation function
|
|
XmVaCreateSimpleOptionMenu creates an instance of a RowColumn widget of type XmMENU_OPTION and returns the associated widget ID. This routine uses the ANSI C variable-length argument list (varargs) calling convention. This routine creates an OptionMenu and its Pulldown submenu containing PushButtonGadget or CascadeButtonGadget children. The name of each button is button_n, where n, where n is an i... |
|
XmVaCreateSimplePopupMenu(3) -- A RowColumn widget convenience creation function
|
|
XmVaCreateSimplePopupMenu creates an instance of a RowColumn widget of type XmMENU_POPUP and returns the associated widget ID. This routine uses the ANSI C variable-length argument list (varargs) calling convention. This routine creates a Popup menu pane and its button children. The name of each button is button_n, where n, where n is an integer from 0 (zero) to the number of buttons in the menu m... |
|
XmVaCreateSimplePulldownMenu(3) -- A RowColumn widget convenience creation function
|
|
XmVaCreateSimplePulldownMenu creates an instance of a RowColumn widget of type XmMENU_PULLDOWN and returns the associated widget ID. This routine uses the ANSI C variable-length argument list (varargs) calling convention. This routine creates a Pulldown menu pane and its button children. The name of each button is button_n, where n, where n is an integer from 0 to the number of buttons in the menu... |
|
XmVaCreateSimpleRadioBox(3) -- A RowColumn widget convenience creation function
|
|
XmVaCreateSimpleRadioBox creates an instance of a RowColumn widget of type XmWORK_AREA and returns the associated widget ID. This routine uses the ANSI C variable-length argument list (varargs) calling convention. This routine creates a RadioBox and its ToggleButtonGadget children. The name of each button is button_n, where n, where n is an integer from 0 (zero) to the number of buttons in the men... |
|
XmWidgetGetBaselines(3) -- Retrieves baseline information for a widget
|
|
XmWidgetGetBaselines returns an array that contains one or more baseline values associated with the specified widget. The baseline of any given line of text is a vertical offset in pixels from the origin of the widget's bounding box to the given baseline. widget Specifies the ID of the widget for which baseline values are requested baselines Returns an array that contains the value of each baseli... |
|
XmWidgetGetDisplayRect(3) -- Retrieves display rectangle information for a widget
|
|
XmWidgetGetDisplayRect returns the width, height and the x and ycoordinates of the upper left corner of the display rectangle of the specified widget. The display rectangle is the smallest rectangle that encloses either a string or a pixmap. If the widget contains a string, the return values specify the x and y-coordinates of the upper left corner of the display rectangle relative to the origin of... |
|
__uc_get_ar(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ar_bsp(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ar_bspstore(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ar_ccv(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ar_csd(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ar_ec(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ar_fpsr(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ar_lc(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ar_pfs(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ar_rsc(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ar_ssd(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ar_unat(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_brs(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_cfm(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_cr(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ed(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_frs(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_grs(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_ip(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_prs(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_reason(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_rsebs(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_rsebs64(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_get_um(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_ar(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_ar_ccv(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_ar_csd(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_ar_ec(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_ar_fpsr(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_ar_lc(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_ar_pfs(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_ar_rsc(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_ar_ssd(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_ar_unat(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_brs(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_cfm(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_ed(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_frs(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_grs(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_ip(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_prs(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_rsebs(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_rsebs64(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
|
__uc_set_um(3) -- ucontext_t (user context) access
|
|
The Ucontext Access interfaces allow an application to access Itanium(R)-based register state contained inside the opaque mcontext_t structure within the ucontext_t user context structure. In all these interfaces, ucp is a pointer to a ucontext_t passed to the application as the third argument to a signal handler, allocated by the user and filled in with getcontext() or read from an application co... |
