NAME

XtAddGrab, XtRemoveGrab - redirect user input to a modal widget

SYNTAX

void XtAddGrab(Widget _w, Boolean _e_x_c_l_u_s_i_v_e, Boolean _s_p_r_i_n_g___l_o_a_d_e_d); void XtRemoveGrab(Widget _w);

ARGUMENTS

_e_x_c_l_u_s_i_v_e Specifies whether user events should be dispatched exclusively to this widget
or also to previous widgets in the cascade.
_s_p_r_i_n_g___l_o_a_d_e_d Specifies whether this widget was popped up because the user pressed
a pointer button.
_w Specifies the widget to add to or remove from the modal cascade.

DESCRIPTION

The _X_t_A_d_d_G_r_a_b function appends the widget (and associated parameters) to the modal cascade and checks that exclusive is _T_r_u_e if spring_loaded is _T_r_u_e. If these are not _T_r_u_e, _X_t_A_d_d_G_r_a_b generates an error.

The modal cascade is used by _X_t_D_i_s_p_a_t_c_h_E_v_e_n_t when it tries to dispatch a user event. When at least one modal widget is in the widget cascade, _X_t_D_i_s_p_a_t_c_h_E_v_e_n_t first determines if the event should be delivered. It starts at the most recent cascade entry and follows the cascade up to and including the most recent cascade entry added with the exclusive parameter _T_r_u_e.

This subset of the modal cascade along with all descendants of these widgets comprise the active subset. User events that occur outside the widgets in this subset are ignored or remapped. Modal menus with submenus generally add a submenu widget to the cascade with exclusive _F_a_l_s_e. Modal dialog boxes that need to restrict user input to the most deeply nested dialog box add a subdialog widget to the cascade with exclusive _T_r_u_e. User events that occur within the active subset are delivered to the appropriate widget, which is usually a child or further descendant of the modal widget.

Regardless of where on the screen they occur, remap events are always delivered to the most recent widget in the active subset of the cascade that has spring_loaded _T_r_u_e, if any such widget exists.

The _X_t_R_e_m_o_v_e_G_r_a_b function removes widgets from the modal cascade starting at the most recent widget up to and including the specified widget. It issues an error if the specified widget is not on the modal cascade.

SEE ALSO


_X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s _- _C _L_a_n_g_u_a_g_e _I_n_t_e_r_f_a_c_e
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e