XDialog Functions

Description

Functions for working with Xdialog controls and commands.

Name
Description
ui_dlg_background_refresh Function

Force xdialogs that have quickdraw backgrounds to regenerate the background.

UI_DLG_BOX Function

Generic dialog get - display a dialog, returns button push, plus valus in variables.

ui_dlg_card_embed Function

Populate an xdialog card sub-control - returns non-blank string if existing control could not be commited.

ui_dlg_card_embed_can_close Function

Query an xdialog card sub-control with a can_close message - empty string returned means no problems, else a 'reason' for failure is retured.

ui_dlg_card_embed_close Function

Force a close/commit of embedded card.

ui_dlg_card_embed_object Function

Query an xdialog card sub-control's object.

ui_dlg_card_embed_on_close Function

Register the code to run when the user attempts to close an embedded card.

ui_dlg_column_adjust Function

Adjust resizable column size in column format.

UI_DLG_COMMIT Function

Force dialog to commit contents.

UI_DLG_CONTROL_ANCHOR_FROM_POS Function

Get a control anchor from a position - if position is ommitted, use mouse cursor position.

ui_dlg_control_commit Function

Commit the contents of a specific xdialog control.

ui_dlg_control_embedded_get Function

Get name of embedded xdialog given parent dialog and control.

UI_DLG_CONTROL_FROM_POS Function

Get the control from a position - if position is ommitted, use mouse cursor position.

ui_dlg_control_item_get Function

Get override settings via tag (requires control preceded by {tag=}).

ui_dlg_control_item_set Function

Set override settings via tag (requires control preceded by {tag=}) D-disable E:enable C:checked U:unchecked X:clear.

UI_DLG_CREATE Function

Create an invisible modeless dialog (which can be later shown).

UI_DLG_CTL_COMMAND Function

Send a command to an xdialog control.

UI_DLG_CTL_CURRENT Function

Get the definition of the current control in the named dialog.

UI_DLG_CTL_GOTO Function

Goto a control in the open dialog, return TRUE if succeeded.

ui_dlg_ctl_visible Function

Returns true if the control is visible.

ui_dlg_dock Function

Dock an xdialog.

ui_dlg_dock_topology Function

Return docking bar topology.

ui_dlg_docked_panel_dock Function

Dock a source dialog to a target (using container for optional target).

ui_dlg_docked_panel_undock Function

Tear off current panel from dialog.

ui_dlg_docked_state_end Function

Finish docking dialogs with respect to a particular layout.

ui_dlg_docked_state_get Function

Get the current state of all dockable control bars, combines optional old state information if old windows are missing from new saved definition.

ui_dlg_docked_state_position Function

Returns docked position information for a controlbar given docked state information.

ui_dlg_docked_state_set Function

Set the current state of all dockable control bars.

ui_dlg_docked_state_start Function

Start docking dialogs with respect to a particular laoput.

ui_dlg_docking_listener_add Function

Expression get evaluated after user docks or undocks, Name lets user remove the listener.

ui_dlg_docking_listener_drop Function

Remove a registered docking listener.

UI_DLG_DOM Function

Get the document object model for the xdialog.

UI_DLG_DRAG_TEXT_GET Function

Get the text for a drag event.

UI_DLG_DRAG_TEXT_SET Function

Set the text in response to drag/drop event.

ui_dlg_editor_active Function

Returns if control on xdialog has an open edit control.

ui_dlg_editor_get Function

Returns pointer to open edit control on xdialog.

UI_DLG_EVAL Function

Return the result of an expression evaluated in the context of an xdialog.

UI_DLG_EVAL_VALID Function

Tests is an expression is valid in the context of a modeless dialog box

UI_DLG_EVENT Function

Invoke an action event in the named dialog - flags I)mmediate, W)ait for input idle.

ui_dlg_event_occurred Function

Causes the 'events occured' flag to get incremented - this indicates that there is work for the xdialog processor to do.

ui_dlg_hdc_render Function

Render xdialog to an HDC - used for printing of xdialogs.

UI_DLG_HIDE Function

Hide a dialog.

ui_dlg_hotspot_query Function

Report back information about hotspot (X,Y,W,H,R,B for position & size - I/P modifiers - inch or pixel).

ui_dlg_hotspot_refresh Function

Invalidate window style's hotspot area (if exists).

UI_DLG_IS_ACTIVE Function

Is the dialog active (focus on dialog or parent).

UI_DLG_IS_MAXIMIZED Function

Returns true if the named xdialog is maximized.

UI_DLG_IS_MINIMIZED Function

Returns true if the named xdialog is minimized.

UI_DLG_MAXIMIZE Function

Maximize a dialog.

UI_DLG_MINIMIZE Function

Minimize a dialog.

UI_DLG_MODAL Function

Make a modeless dialog behave like a modal dialog.

UI_DLG_MOVE Function

Move a dialog to a new location.

UI_DLG_NAVIGATE Function

Move to a different control - directions are 'next' and 'prev'.

ui_dlg_navigation Function

Determine what control would be navigated to by a command.

ui_dlg_object_get Function

Returns a pointer to the '.object' that would normally be filled in for a control.

UI_DLG_OPTIONAL_EVENT Function

Invoke an action event in the named dialog, but only if named dialog exists.

UI_DLG_PANEL Function

Create an xdialog panel - this is an xdialog that lives in a panel - and doesn't need to exist to honor automation.

ui_dlg_panel_destroy Function

Destroy a panel definition.

ui_dlg_panel_name Function

Returns the name of the panel being loaded.

UI_DLG_PARENT_GET Function

Return the name of dialogs parent (if the named dialog has a parent).

ui_dlg_query Function

Return dialogs and/or panels that match the criteria.

UI_DLG_REFRESH Function

Refresh the contents of the named dialog box, optional flag allows call to return *before* refresh is ever done.

UI_DLG_REFRESH_TARGETED Function

Refresh a dialogs controls that match vars - ommit the control def.

UI_DLG_REMEMBERED_CLEAR Function

Clear any remembered alignment/size/position data.

UI_DLG_REMEMBERED_GET Function

Retrieve any remembered alignment/size/position data.

UI_DLG_RESIZE Function

Cause a sizable dialog to be resized - width or height of -1 means keep old size for width or height.

ui_dlg_return Function

Return a value to a return handler (i.e. modal xdialog context).

ui_dlg_session_refresh_expr Function

Set condition to limit auto-external refresh for a session.

ui_dlg_session_refresh_result Function

Get the result of the current ambient session auto-external refresh.

UI_DLG_SHOW Function

Show a dialog.

ui_dlg_size_to_content Function

Resizes xdialog that contains an htmlHost area to the best-fit size of the HTML. size_to_options:- 'W'-keep width.

ui_dlg_to_html Function

Convert an xdialog format to dependency map and HTML.

ui_dlg_undock Function

Undock an xdialog.

UI_INFO_DLG_DEF_CLIENT_HEIGHT Function

Get the height of the client area of a dialog in inches based on a dialog definition.

UI_INFO_DLG_DEF_CLIENT_WIDTH Function

Get the width of the client area of a of the dialog in inches based on a dialog definition.

ui_info_dlg_def_conditions Function

Get the conditions for the dialog based on a dialog definition.

ui_info_dlg_def_controls_get Function

Gets ui_dialog control information - i.e. positioning & settings.

UI_INFO_DLG_DEF_EVENTS Function

Get the events for the dialog based on a dialog definition.

UI_INFO_DLG_DEF_HEIGHT Function

Get the height of the dialog in inches based on a dialog definition.

UI_INFO_DLG_DEF_LISTS Function

Get the lists for the dialog based on a dialog definition.

ui_info_dlg_def_tooltip_get Function

Extracts the tooltip definition from a xdialog format for the named control.

UI_INFO_DLG_DEF_VARS Function

Get the variables for the dialog based on a dialog definition.

UI_INFO_DLG_DEF_WIDTH Function

Get the width of the dialog in inches based on a dialog definition.

UI_MODELESS_DLG_BOX Function

Create a modeless dialog box - optional script to handle button requests is the third argument.

UI_MODELESS_DLG_BUTTON Function

Return which button is being pressed for the named modeless dialog box, Blank if no button being pressed.

UI_MODELESS_DLG_BUTTON_RESET Function

Reset the value of a dialog box button.

UI_MODELESS_DLG_CLOSE Function

Close an named modeless dialog box, returns .T. if dialog was found, .f. if dialog is not open.

UI_MODELESS_DLG_EXIST Function

Returns TRUE if named modeless dialog box exists.

ui_modeless_dlg_hover Function

Return the xdialog that is being hovered over if no title, else return control hovered over for specified dialog.

UI_MODELESS_DLG_REFRESH Function

Refresh the contents of the named modeless dialog box.

UI_MODELESS_DLG_SETFOCUS Function

Sets focus to the named modeless dialog box.

UI_MODELESS_DLG_SIZING Function

Returns .T. if named dialog is a controlbar whose layout is being determined.