This is the Open C API interface to the NX user interface. The
prototypes, descriptions and typedef's here will only be usable by Internal
Open C API programs.
This file is divided into the following sections:
.
Presentation APIs
.
User Interface Support
.
Selection .
File Selection Dialog
.
Menu Routine
.
Graphics Interaction
NOTE:
Several Open C APIs that used to exist in uf_ui_xt.h now
reside in the uf_ui.h header file. These functions are:
. UF_UI_ask_lock_status
. UF_UI_cancel_uf_dialog
. UF_UI_dismiss_dialog_area_2
. UF_UI_lock_ug_access
. UF_UI_unlock_ug_access
. UF_UI_register_change_state_fn
. UF_UI_set_force_unlock
Although these functions are tightly coupled with the functions that
still remain in uf_ui_xt.h, it was determined that it was best to move
those items that do not require a Software Development Kit for X and
Motif. This way Open C developers creating Open C API programs
using the UIStyler are not required to buy this development kit from
their hardware vendor. If you are developing Motif dialogs then this
development kit is still required.
PUBLIC FUNCTIONS --
UF_UI_set_status - Display text in the status area
UF_UI_set_prompt - Display text in the prompt area
UF_UI_toggle_stoplight - Toggle the stoplight on/off
UF_UI_select_point_collection - Select a collection of points
UF_UI_select_single - Select a single object.
UF_UI_select_by_class - Select multiple objects via class
selection.
UF_UI_select_feature - Multiple selection of features.
UF_UI_select_conehead - Select one of many coneheads.
UF_UI_select_rpo_dimensions - Select rpo dimensions of a feature.
UF_UI_select_parameters - Select parameters of a feature.
UF_UI_select_sketch - Select a single sketch.
UF_UI_select_sketch_dimensions - Select dimension constraints of a sketch.
UF_UI_specify_plane - Specify plane subfunctions
UF_UI_specify_vector - Specify vector subfunctions
UF_UI_ask_cursor_view - Read the view of cursor
UF_UI_set_cursor_view - Change the view of cursor
UF_UI_create_usertool - Create a User Tool
UF_UI_display_usertool - Change visibility of a User Tool
UF_UI_set_usertool_menu_entry - Change label and tool on User Tool menu
UF_UI_open_listing_window - Opens a listing window
UF_UI_close_listing_window - Closes and unmanages a listing window
UF_UI_write_listing_window - Writes (varargs) to a listing window
UF_UI_is_listing_window_open - Checks to see if listing window is open
UF_UI_save_listing_window - Saves the contents of a listing window
to file.
UF_UI_ask_create_part_filename - Display the File-New FSD
UF_UI_create_part - Perform the File-New NX function
UF_UI_ask_open_part_filename - Display the File-Open FSD
UF_UI_open_part - Perform the File-Open NX function
UF_UI_display_nonmodal_msg - Display the Nonmodal Message Dialog
UF_UI_ask_dialog_directory - Read the directory path of a FSD
UF_UI_ask_dialog_filter - Read the filter extension (ie .prt) of
a FSD
UF_UI_set_dialog_directory - Set the directory path of a FSD
UF_UI_set_dialog_filter - Set the filter extension (ie .prt) of
a FSD
UF_UI_ask_iw_decimal_places - Returns number of decimal places user
wants displayed in the listing window
UF_UI_ask_info_units - Returns units user wants info disp'd in
UF_UI_specify_screen_position - Allow user to indicate a screen pos
UF_UI_get_default_parent - Get the parent window for a dialog
UF_UI_add_to_class_sel - Add the UDO class to the class
selection filter
UF_UI_delete_from_class_sel - Remove the UDO class from the
class selection filter
UF_UI_enable_quick_access - Enable the Quick Access Menu feature
UF_UI_disable_quick_access - Disable the Quick Access Menu feature
UF_UI_lock_ug_access - Inhibit access to DA1 and appropriate
menu bar items.
UF_UI_unlock_ug_access - Enable access to DA1 and appropriate
menu bar items.
UF_UI_register_change_state_fn - Register or unregisters the custom
supplied state change routines
UF_UI_cancel_uf_dialog - Send a cancel message to NX
to cancel the user function dialog.
UF_UI_dismiss_dialog_area_2 - Dismiss interactive user function dialog
when cancel is selected.
UF_UI_set_force_unlock_flag - Set unlock flag.
UF_UI_ask_lock_status - Query NX lock status.
selection.
UF_UI_get_DA1_coords - Get the current x, y coordinates of the
DA1 dialog
UF_UI_get_DA2_coords - Get the current x, y coordinates of the
DA2 dialog
UF_UI_append_menubar_menu - Append a menu item to the NX
main menu bar.
UF_UI_create_toolbar - Create toolbar from .tbr file
UF_UI_remove_toolbar - Remove toolbar
UF_UI_suspend_create_toolbar - Suspend creating multiple toolbars
UF_UI_resume_create_toolbar - Resume creating multiple toolbars
UF_UI_suspend_remove_toolbar - Suspend removing multiple toolbars
UF_UI_resume_remove_toolbar - Resume removing multiple toolbars
UF_UI_set_toolbar_vis - Show/hide toolbar
UF_UI_ask_toolbar_vis - Get current visibility of toolbar
UF_UI_suspend_init_appstate - Suspend creating multiple toolbars and
restoring toolbar state per application
UF_UI_resume_init_appstate - Resume creating multiple toolbars and
restoring toolbar state per application
UF_UI_display_url - Displays the specified URL in the
internal web browser
UF_UI_init_attachments - Initialize the attachments structure
with default values