XmTextFieldCopyLink(library call)         XmTextFieldCopyLink(library call)




 NAME    [Toc]    [Back]
      XmTextFieldCopyLink - A TextField function that copies a link to the
      primary selection to the clipboard

 SYNOPSIS    [Toc]    [Back]
      #include <Xm/TextF.h>
      Boolean XmTextFieldCopyLink(
      Widget widget,
      Time time);

 DESCRIPTION    [Toc]    [Back]
      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 clipboard and for taking any related actions.

      widget    Specifies the TextField widget ID.

      time      Specifies the time of the transfer.  This should be the time
                of the event which triggered this request.  One source of a
                valid time stamp is the function XtLastTimestampProcessed.

      For a complete definition of TextField and its associated resources,
      see XmTextField(3).

 RETURN    [Toc]    [Back]
      This function returns False if the primary selection is NULL, if the
      widget does not own the primary selection, if the function is unable
      to gain ownership of the clipboard selection, or if no data is placed
      on the clipboard.  Otherwise, it returns True.

 RELATED    [Toc]    [Back]
      XmTextField(3).


                                    - 1 -       Formatted:  January 24, 2005