~ubuntu-branches/ubuntu/dapper/tk8.0/dapper-updates

« back to all changes in this revision

Viewing changes to doc/OwnSelect.3

  • Committer: Bazaar Package Importer
  • Author(s): Mike Markley
  • Date: 2001-07-24 21:57:40 UTC
  • Revision ID: james.westby@ubuntu.com-20010724215740-r70t25rtmbqjil2h
Tags: upstream-8.0.5
ImportĀ upstreamĀ versionĀ 8.0.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\"
 
2
'\" Copyright (c) 1990-1994 The Regents of the University of California.
 
3
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
 
4
'\"
 
5
'\" See the file "license.terms" for information on usage and redistribution
 
6
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 
7
'\" 
 
8
'\" RCS: @(#) $Id: OwnSelect.3,v 1.2 1998/09/14 18:22:53 stanton Exp $
 
9
'\" 
 
10
.so man.macros
 
11
.TH Tk_OwnSelection 3 4.0 Tk "Tk Library Procedures"
 
12
.BS
 
13
.SH NAME
 
14
Tk_OwnSelection \- make a window the owner of the primary selection
 
15
.SH SYNOPSIS
 
16
.nf
 
17
\fB#include <tk.h>\fR
 
18
.sp
 
19
\fBTk_OwnSelection\fR(\fItkwin, selection, proc, clientData\fR)
 
20
.SH ARGUMENTS
 
21
.AS Tk_LostSelProc clientData
 
22
.AP Tk_Window tkwin in
 
23
Window that is to become new selection owner.
 
24
.AP Atom selection in
 
25
The name of the selection to be owned, such as XA_PRIMARY.
 
26
.AP Tk_LostSelProc *proc in
 
27
Procedure to invoke when \fItkwin\fR loses selection ownership later.
 
28
.AP ClientData clientData in
 
29
Arbitrary one-word value to pass to \fIproc\fR.
 
30
.BE
 
31
 
 
32
.SH DESCRIPTION
 
33
.PP
 
34
\fBTk_OwnSelection\fR arranges for \fItkwin\fR to become the
 
35
new owner of the selection specified by the atom
 
36
\fIselection\fR.  After this call completes, future requests
 
37
for the selection will be directed to handlers created for
 
38
\fItkwin\fR using \fBTk_CreateSelHandler\fR.  When \fItkwin\fR
 
39
eventually loses the selection ownership, \fIproc\fR will be
 
40
invoked so that the window can clean itself up (e.g. by
 
41
unhighlighting the selection).  \fIProc\fR should have arguments and
 
42
result that match the type \fBTk_LostSelProc\fR:
 
43
.CS
 
44
typedef void Tk_LostSelProc(ClientData \fIclientData\fR);
 
45
.CE
 
46
The \fIclientData\fR parameter to \fIproc\fR is a copy of the
 
47
\fIclientData\fR argument given to \fBTk_OwnSelection\fR, and is
 
48
usually a pointer to a data structure containing application-specific
 
49
information about \fItkwin\fR.
 
50
 
 
51
.SH KEYWORDS
 
52
own, selection owner