Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xtcancelconvertselectionproc(2) [hpux man page]

XtCancelConvertSelectionProc()											    XtCancelConvertSelectionProc()

Name
  XtCancelConvertSelectionProc - interface definition for procedure to cancel incremental selection transfer.

Synopsis
  typedef void (*XtCancelConvertSelectionProc)(Widget, Atom*, Atom*,
  XtRequestId*, XtPointer);
	 Widget w;
	 Atom *selection;
	 Atom *target;
	 XtRequestId *request_id;
	 XtPointer client_data;

Inputs
  w	    Specifies the widget that owns the selection.

  selection Specifies the atom that names the selection being transferred.

  target    Specifies the target type to which the conversion was done.

  request_id
	    Specifies an opaque identification for a specific request.

  client_data
	    Specifies the value passed in by the widget when it took ownership of the selection.

Availability
  Release 4 and later.

Description
  This	procedure  is  registered  in a call to XtOwnSelectionIncremental(), and is called by the Intrinsics to abort an incremental transfer
  when (as determined by the selection timeout or other mechanism) any remaining segments of the selection no longer need to be  transferred.
  Upon	receiving  this  callback,  the selection request is considered complete and the owner should free the memory and any other resources
  that have been allocated for the transfer.

  The w, selection, and client_data arguments are those passed in the call to XtOwnSelectionIncremental().  The target and  request_id	argu-
  ments  are  the  selection target type specified by the selection requestor, and the unique ID assigned to this transfer by the Intrinsics.
  Both will have been passed to a previous call to the XtConvertSelectionIncrProc also registered with XtOwnSelectionIncremental().

See Also
  XtGetSelectionValueIncremental(1), XtGetSelectionValuesIncremental(1), XtGetSelectionTimeout(1), XtOwnSelectionIncremental(1), XtSetSelec-
  tionTimeout(1),
  XtConvertSelectionIncrProc(2), XtLoseSelectionIncrProc(2), XtSelectionDoneIncrProc(2).

Xt - Selections 												    XtCancelConvertSelectionProc()

Check Out this Related Man Page

XtOwnSelection(3)						   XT FUNCTIONS 						 XtOwnSelection(3)

NAME
XtOwnSelection, XtOwnSelectionIncremental, XtDisownSelection - set selection owner SYNTAX
Boolean XtOwnSelection(Widget w, Atom selection, Time time, XtConvertSelectionProc convert_proc, XtLoseSelectionProc lose_selection, XtSe- lectionDoneProc done_proc); Boolean XtOwnSelectionIncremental(Widget w, Atom selection, Time time, XtConvertSelectionIncrProc convert_callback, XtLoseSelectionIncrProc lose_callback, XtSelectionDoneIncrProc done_callback, XtCancelConvertSelectionProc cancel_callback, XtPointer client_data); void XtDisownSelection(Widget w, Atom selection, Time time); ARGUMENTS
convert_proc Specifies the procedure that is to be called whenever someone requests the current value of the selection. done_proc Specifies the procedure that is called after the requestor has received the selection or NULL if the owner is not interested in being called back. lose_selection Specifies the procedure that is to be called whenever the widget has lost selection ownership or NULL if the owner is not inter- ested in being called back. selection Specifies an atom that describes the type of the selection (for example, XA_PRIMARY, XA_SECONDARY, or XA_CLIPBOARD). time Specifies the timestamp that indicates when the selection ownership should commence or is to be relinquished. w Specifies the widget that wishes to become the owner or to relinquish ownership. DESCRIPTION
The XtOwnSelection function informs the Intrinsics selection mechanism that a widget believes it owns a selection. It returns True if the widget has successfully become the owner and False otherwise. The widget may fail to become the owner if some other widget has asserted ownership at a time later than this widget. Note that widgets can lose selection ownership either because someone else asserted later own- ership of the selection or because the widget voluntarily gave up ownership of the selection. Also note that the lose_selection procedure is not called if the widget fails to obtain selection ownership in the first place. The XtOwnSelectionIncremental procedure informs the Intrinsics incremental selection mechanism that the specified widget wishes to own the selection. It returns True if the specified widget successfully becomes the selection owner or False otherwise. For more information about selection, target, and time, see Section 2.6 of the Inter-Client Communication Conventions Manual. A widget that becomes the selection owner using XtOwnSelectionIncremental may use XtDisownSelection to relinquish selection ownership. The XtDisownSelection function informs the Intrinsics selection mechanism that the specified widget is to lose ownership of the selection. If the widget does not currently own the selection either because it lost the selection or because it never had the selection to begin with, XtDisownSelection does nothing. After a widget has called XtDisownSelection, its convert procedure is not called even if a request arrives later with a timestamp during the period that this widget owned the selection. However, its done procedure will be called if a conversion that started before the call to XtDisownSelection finishes after the call to XtDisownSelection. SEE ALSO
XtAppGetSelectionTimeout(3), XtGetSelectionValue(3) X Toolkit Intrinsics - C Language Interface Xlib - C Language X Interface X Version 11 libXt 1.1.3 XtOwnSelection(3)
Man Page