xenocara/lib/libXt/man/XtAppGetSelectionTimeout.man

75 lines
2.8 KiB
Groff
Raw Normal View History

2006-11-25 11:01:46 -07:00
.\" Copyright 1993 X Consortium
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining
.\" a copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, sublicense, and/or sell copies of the Software, and to
.\" permit persons to whom the Software is furnished to do so, subject to
.\" the following conditions:
.\"
.\" The above copyright notice and this permission notice shall be
.\" included in all copies or substantial portions of the Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
.\" OTHER DEALINGS IN THE SOFTWARE.
.\"
.\" Except as contained in this notice, the name of the X Consortium shall
.\" not be used in advertising or otherwise to promote the sale, use or
.\" other dealings in this Software without prior written authorization
.\" from the X Consortium.
.\"
.ds tk X Toolkit
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xI Intrinsics
.ds xW X Toolkit Athena Widgets \- C Language Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
.ds Rn 3
.ds Vn 2.2
.hw XtApp-Get-Selection-Timeout XtApp-Set-Selection-Timeout wid-get
.na
.TH XtAppGetSelectionTimeout __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
.SH NAME
XtAppGetSelectionTimeout, XtAppSetSelectionTimeout \- set and obtain selection timeout values
.SH SYNTAX
2020-01-14 13:48:59 -07:00
#include <X11/Intrinsic.h>
2006-11-25 11:01:46 -07:00
.HP
2012-03-10 09:45:48 -07:00
unsigned long XtAppGetSelectionTimeout(XtAppContext \fIapp_context\fP);
2006-11-25 11:01:46 -07:00
.HP
void XtAppSetSelectionTimeout(XtAppContext \fIapp_context\fP, unsigned long
2012-03-10 09:45:48 -07:00
\fItimeout\fP);
2006-11-25 11:01:46 -07:00
.SH ARGUMENTS
.IP \fIapp_context\fP 1i
Specifies the application context.
.IP \fItimeout\fP 1i
Specifies the selection timeout in milliseconds.
.SH DESCRIPTION
The
2020-01-14 13:48:59 -07:00
.B XtAppGetSelectionTimeout
2006-11-25 11:01:46 -07:00
function returns the current selection timeout value, in milliseconds.
2012-03-10 09:45:48 -07:00
The selection timeout is the time within which the two communicating
2006-11-25 11:01:46 -07:00
applications must respond to one another.
2012-03-10 09:45:48 -07:00
The initial timeout value is set by the
2020-01-14 13:48:59 -07:00
.B selectionTimeout
2006-11-25 11:01:46 -07:00
application resource, or, if
2020-01-14 13:48:59 -07:00
.B selectionTimeout
2006-11-25 11:01:46 -07:00
is not specified,
it defaults to five seconds.
.LP
The
2020-01-14 13:48:59 -07:00
.B XtAppSetSelectionTimeout
2006-11-25 11:01:46 -07:00
function sets the \*(xI's selection timeout mechanism.
Note that most applications should not set the selection timeout.
.SH "SEE ALSO"
2011-09-10 03:36:19 -06:00
XtOwnSelection(__libmansuffix__)
2006-11-25 11:01:46 -07:00
.br
\fI\*(xT\fP
.br
\fI\*(xL\fP