480 lines
13 KiB
Plaintext
480 lines
13 KiB
Plaintext
.ds xT X Toolkit Intrinsics \- C Language Interface
|
|
.ds xW Athena X Widgets \- C Language X Toolkit Interface
|
|
.ds xL Xlib \- C Language X Interface
|
|
.ds xC Inter-Client Communication Conventions Manual
|
|
.na
|
|
.de Ds
|
|
.nf
|
|
.\\$1D \\$2 \\$1
|
|
.ft 1
|
|
.\".ps \\n(PS
|
|
.\".if \\n(VS>=40 .vs \\n(VSu
|
|
.\".if \\n(VS<=39 .vs \\n(VSp
|
|
..
|
|
.de De
|
|
.ce 0
|
|
.if \\n(BD .DF
|
|
.nr BD 0
|
|
.in \\n(OIu
|
|
.if \\n(TM .ls 2
|
|
.sp \\n(DDu
|
|
.fi
|
|
..
|
|
.de FD
|
|
.LP
|
|
.KS
|
|
.TA .5i 3i
|
|
.ta .5i 3i
|
|
.nf
|
|
..
|
|
.de FN
|
|
.fi
|
|
.KE
|
|
.LP
|
|
..
|
|
.de IN \" send an index entry to the stderr
|
|
..
|
|
.de C{
|
|
.KS
|
|
.nf
|
|
.D
|
|
.\"
|
|
.\" choose appropriate monospace font
|
|
.\" the imagen conditional, 480,
|
|
.\" may be changed to L if LB is too
|
|
.\" heavy for your eyes...
|
|
.\"
|
|
.ie "\\*(.T"480" .ft L
|
|
.el .ie "\\*(.T"300" .ft L
|
|
.el .ie "\\*(.T"202" .ft PO
|
|
.el .ie "\\*(.T"aps" .ft CW
|
|
.el .ft R
|
|
.ps \\n(PS
|
|
.ie \\n(VS>40 .vs \\n(VSu
|
|
.el .vs \\n(VSp
|
|
..
|
|
.de C}
|
|
.DE
|
|
.R
|
|
..
|
|
.de Pn
|
|
.ie t \\$1\fB\^\\$2\^\fR\\$3
|
|
.el \\$1\fI\^\\$2\^\fP\\$3
|
|
..
|
|
.de ZN
|
|
.ie t \fB\^\\$1\^\fR\\$2
|
|
.el \fI\^\\$1\^\fP\\$2
|
|
..
|
|
.de NT
|
|
.ne 7
|
|
.ds NO Note
|
|
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
|
|
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
|
|
.ie n .sp
|
|
.el .sp 10p
|
|
.TB
|
|
.ce
|
|
\\*(NO
|
|
.ie n .sp
|
|
.el .sp 5p
|
|
.if '\\$1'C' .ce 99
|
|
.if '\\$2'C' .ce 99
|
|
.in +5n
|
|
.ll -5n
|
|
.R
|
|
..
|
|
. \" Note End -- doug kraft 3/85
|
|
.de NE
|
|
.ce 0
|
|
.in -5n
|
|
.ll +5n
|
|
.ie n .sp
|
|
.el .sp 10p
|
|
..
|
|
.ny0
|
|
.TH XGetWindowProperty 3X11 "Release 5" "X Version 11" "XLIB FUNCTIONS"
|
|
.SH NAME
|
|
XGetWindowProperty, XListProperties, XChangeProperty, XRotateWindowProperties, XDeleteProperty \- obtain and change window properties
|
|
.SH SYNTAX
|
|
.\" $Header: XGetProperty.f,v 1.1 88/02/26 10:00:55 mento Exp $
|
|
int XGetWindowProperty\^(\^\fIdisplay\fP, \fIw\fP\^, \fIproperty\fP\^, \fIlong_offset\fP\^, \fIlong_length\fP\^, \fIdelete\fP\^, \fIreq_type\fP\^,
|
|
.br
|
|
\fIactual_type_return\fP\^, \fIactual_format_return\fP\^, \fInitems_return\fP\^, \fIbytes_after_return\fP\^,
|
|
.br
|
|
\fIprop_return\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
Window \fIw\fP\^;
|
|
.br
|
|
Atom \fIproperty\fP\^;
|
|
.br
|
|
long \fIlong_offset\fP\^, \fIlong_length\fP\^;
|
|
.br
|
|
Bool \fIdelete\fP\^;
|
|
.br
|
|
Atom \fIreq_type\fP\^;
|
|
.br
|
|
Atom *\fIactual_type_return\fP\^;
|
|
.br
|
|
int *\fIactual_format_return\fP\^;
|
|
.br
|
|
unsigned long *\fInitems_return\fP\^;
|
|
.br
|
|
unsigned long *\fIbytes_after_return\fP\^;
|
|
.br
|
|
unsigned char **\fIprop_return\fP\^;
|
|
.LP
|
|
.\" $Header: XListProps.f,v 1.1 88/02/26 10:01:22 mento Exp $
|
|
Atom *XListProperties\^(\^\fIdisplay\fP, \fIw\fP\^, \fInum_prop_return\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
Window \fIw\fP\^;
|
|
.br
|
|
int *\fInum_prop_return\fP\^;
|
|
.LP
|
|
.\" $Header: XChProperty.f,v 1.1 88/02/26 09:58:33 mento Exp $
|
|
XChangeProperty\^(\^\fIdisplay\fP, \fIw\fP\^, \fIproperty\fP\^, \fItype\fP\^, \fIformat\fP\^, \fImode\fP\^, \fIdata\fP\^, \fInelements\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
Window \fIw\fP\^;
|
|
.br
|
|
Atom \fIproperty\fP\^, \fItype\fP\^;
|
|
.br
|
|
int \fIformat\fP\^;
|
|
.br
|
|
int \fImode\fP\^;
|
|
.br
|
|
unsigned char *\fIdata\fP\^;
|
|
.br
|
|
int \fInelements\fP\^;
|
|
.LP
|
|
XRotateWindowProperties\^(\^\fIdisplay\fP, \fIw\fP, \fIproperties\fP, \fInum_prop\fP, \fInpositions\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
Window \fIw\fP\^;
|
|
.br
|
|
Atom \fIproperties\fP\^[]\^;
|
|
.br
|
|
int \fInum_prop\fP\^;
|
|
.br
|
|
int \fInpositions\fP\^;
|
|
.LP
|
|
.\" $Header: XDeleteProp.f,v 1.1 88/02/26 09:59:36 mento Exp $
|
|
XDeleteProperty\^(\^\fIdisplay\fP, \fIw\fP\^, \fIproperty\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
Window \fIw\fP\^;
|
|
.br
|
|
Atom \fIproperty\fP\^;
|
|
.SH ARGUMENTS
|
|
.\" $Header: act_format.a,v 1.1 88/02/26 10:04:45 mento Exp $
|
|
.IP \fIactual_format_return\fP 1i
|
|
Returns the actual format of the property.
|
|
.\" $Header: actual_type.a,v 1.1 88/02/26 10:04:47 mento Exp $
|
|
.IP \fIactual_type_return\fP 1i
|
|
Returns the atom identifier that defines the actual type of the property.
|
|
.IP \fIbytes_after_return\fP 1i
|
|
Returns the number of bytes remaining to be read in the property if
|
|
a partial read was performed.
|
|
.\" $Header: data1.a,v 1.1 88/02/26 10:06:15 mento Exp $
|
|
.IP \fIdata\fP 1i
|
|
Specifies the property data.
|
|
.\" $Header: delete.a,v 1.4 88/05/08 11:45:29 mento Exp $
|
|
.IP \fIdelete\fP 1i
|
|
Specifies a Boolean value that determines whether the property is deleted.
|
|
.\" $Header: display.a,v 1.1 88/02/26 10:26:29 mento Exp $
|
|
.IP \fIdisplay\fP 1i
|
|
Specifies the connection to the X server.
|
|
.\" $Header: format.a,v 1.2 88/05/08 11:59:58 mento Exp $
|
|
.IP \fIformat\fP 1i
|
|
Specifies whether the data should be viewed as a list
|
|
of 8-bit, 16-bit, or 32-bit quantities.
|
|
Possible values are 8, 16, and 32.
|
|
This information allows the X server to correctly perform
|
|
byte-swap operations as necessary.
|
|
If the format is 16-bit or 32-bit,
|
|
you must explicitly cast your data pointer to an (unsigned char *) in the call
|
|
to
|
|
.ZN XChangeProperty .
|
|
.IP \fIlong_length\fP 1i
|
|
Specifies the length in 32-bit multiples of the data to be retrieved.
|
|
.IP \fIlong_offset\fP 1i
|
|
Specifies the offset in the specified property (in 32-bit quantities)
|
|
where the data is to be retrieved.
|
|
.\" $Header: prop_mode.a,v 1.2 88/04/04 11:18:11 mento Exp $
|
|
.\" Changed name of this file to prop_mode.a on 1/13/87
|
|
.IP \fImode\fP 1i
|
|
Specifies the mode of the operation.
|
|
You can pass
|
|
.ZN PropModeReplace ,
|
|
.ZN PropModePrepend ,
|
|
or
|
|
.ZN PropModeAppend .
|
|
.\" $Header: nelements.a,v 1.2 88/05/08 12:00:41 mento Exp $
|
|
.IP \fInelements\fP 1i
|
|
Specifies the number of elements of the specified data format.
|
|
.IP \fInitems_return\fP 1i
|
|
Returns the actual number of 8-bit, 16-bit, or 32-bit items
|
|
stored in the prop_return data.
|
|
.IP \fInum_prop\fP 1i
|
|
Specifies the length of the properties array.
|
|
.IP \fInum_prop_return\fP 1i
|
|
Returns the length of the properties array.
|
|
.IP \fInpositions\fP 1i
|
|
Specifies the rotation amount.
|
|
.IP \fIprop_return\fP 1i
|
|
Returns the data in the specified format.
|
|
.\" $Header: property.a,v 1.2 88/04/05 15:19:43 mento Exp $
|
|
.IP \fIproperty\fP 1i
|
|
Specifies the property name.
|
|
.\" $Header: properties.a,v 1.1 88/02/26 10:30:43 mento Exp $
|
|
.IP \fIproperties\fP 1i
|
|
Specifies the array of properties that are to be rotated.
|
|
.\" $Header: reqtype.a,v 1.3 88/05/08 11:46:32 mento Exp $
|
|
.IP \fIreq_type\fP 1i
|
|
Specifies the atom identifier associated with the property type or
|
|
.ZN AnyPropertyType .
|
|
.\" $Header: type.a,v 1.2 88/03/29 08:07:25 mento Exp $
|
|
.IP \fItype\fP 1i
|
|
Specifies the type of the property.
|
|
The X server does not interpret the type but simply
|
|
passes it back to an application that later calls
|
|
.ZN XGetWindowProperty .
|
|
.ds Wi whose property you want to obtain, change, rotate or delete
|
|
.\" $Header: w_gen.a,v 1.4 88/08/04 11:21:56 mento Exp $
|
|
.IP \fIw\fP 1i
|
|
Specifies the window \*(Wi.
|
|
.SH DESCRIPTION
|
|
.\" $Header: XGetProperty.d,v 1.3 88/08/17 09:10:14 mento Exp $
|
|
The
|
|
.ZN XGetWindowProperty
|
|
function returns the actual type of the property; the actual format of the property;
|
|
the number of 8-bit, 16-bit, or 32-bit items transferred; the number of bytes remaining
|
|
to be read in the property; and a pointer to the data actually returned.
|
|
.ZN XGetWindowProperty
|
|
sets the return arguments as follows:
|
|
.IP \(bu 5
|
|
If the specified property does not exist for the specified window,
|
|
.ZN XGetWindowProperty
|
|
returns
|
|
.ZN None
|
|
to actual_type_return and the value zero to
|
|
actual_format_return and bytes_after_return.
|
|
The nitems_return argument is empty.
|
|
In this case, the delete argument is ignored.
|
|
.IP \(bu 5
|
|
If the specified property exists
|
|
but its type does not match the specified type,
|
|
.ZN XGetWindowProperty
|
|
returns the actual property type to actual_type_return,
|
|
the actual property format (never zero) to actual_format_return,
|
|
and the property length in bytes (even if the actual_format_return is 16 or 32)
|
|
to bytes_after_return.
|
|
It also ignores the delete argument.
|
|
The nitems_return argument is empty.
|
|
.IP \(bu 5
|
|
If the specified property exists and either you assign
|
|
.ZN AnyPropertyType
|
|
to the req_type argument or the specified type matches the actual property type,
|
|
.ZN XGetWindowProperty
|
|
returns the actual property type to actual_type_return and the actual
|
|
property format (never zero) to actual_format_return.
|
|
It also returns a value to bytes_after_return and nitems_return, by
|
|
defining the following
|
|
values:
|
|
.IP
|
|
.nf
|
|
N = actual length of the stored property in bytes
|
|
(even if the format is 16 or 32)
|
|
I = 4 * long_offset
|
|
T = N - I
|
|
L = MINIMUM(T, 4 * long_length)
|
|
A = N - (I + L)
|
|
.fi
|
|
.IP
|
|
The returned value starts at byte index I in the property (indexing
|
|
from zero), and its length in bytes is L.
|
|
If the value for long_offset causes L to be negative,
|
|
a
|
|
.ZN BadValue
|
|
error results.
|
|
The value of bytes_after_return is A,
|
|
giving the number of trailing unread bytes in the stored property.
|
|
.LP
|
|
.ZN XGetWindowProperty
|
|
always allocates one extra byte in prop_return
|
|
(even if the property is zero length)
|
|
and sets it to ASCII null so that simple properties consisting of characters
|
|
do not have to be copied into yet another string before use.
|
|
If delete is
|
|
.ZN True
|
|
and bytes_after_return is zero,
|
|
.ZN XGetWindowProperty
|
|
deletes the property
|
|
from the window and generates a
|
|
.ZN PropertyNotify
|
|
event on the window.
|
|
.LP
|
|
The function returns
|
|
.ZN Success
|
|
if it executes successfully.
|
|
To free the resulting data,
|
|
use
|
|
.ZN XFree .
|
|
.LP
|
|
.ZN XGetWindowProperty
|
|
can generate
|
|
.ZN BadAtom ,
|
|
.ZN BadValue ,
|
|
and
|
|
.ZN BadWindow
|
|
errors.
|
|
.LP
|
|
.\" $Header: XListProps.d,v 1.4 88/05/08 11:58:22 mento Exp $
|
|
The
|
|
.ZN XListProperties
|
|
function returns a pointer to an array of atom properties that are defined for
|
|
the specified window or returns NULL if no properties were found.
|
|
To free the memory allocated by this function, use
|
|
.ZN XFree .
|
|
.LP
|
|
.ZN XListProperties
|
|
can generate a
|
|
.ZN BadWindow
|
|
error.
|
|
.LP
|
|
.\" $Header: XChProperty.d,v 1.2 88/06/11 07:49:04 mento Exp $
|
|
The
|
|
.ZN XChangeProperty
|
|
function alters the property for the specified window and
|
|
causes the X server to generate a
|
|
.ZN PropertyNotify
|
|
event on that window.
|
|
.ZN XChangeProperty
|
|
performs the following:
|
|
.IP \(bu 5
|
|
If mode is
|
|
.ZN PropModeReplace ,
|
|
.ZN XChangeProperty
|
|
discards the previous property value and stores the new data.
|
|
.IP \(bu 5
|
|
If mode is
|
|
.ZN PropModePrepend
|
|
or
|
|
.ZN PropModeAppend ,
|
|
.ZN XChangeProperty
|
|
inserts the specified data before the beginning of the existing data
|
|
or onto the end of the existing data, respectively.
|
|
The type and format must match the existing property value,
|
|
or a
|
|
.ZN BadMatch
|
|
error results.
|
|
If the property is undefined,
|
|
it is treated as defined with the correct type and
|
|
format with zero-length data.
|
|
.LP
|
|
The lifetime of a property is not tied to the storing client.
|
|
Properties remain until explicitly deleted, until the window is destroyed,
|
|
or until the server resets.
|
|
For a discussion of what happens when the connection to the X server is closed,
|
|
see section 2.6.
|
|
The maximum size of a property is server dependent and can vary dynamically
|
|
depending on the amount of memory the server has available.
|
|
(If there is insufficient space, a
|
|
.ZN BadAlloc
|
|
error results.)
|
|
.LP
|
|
.ZN XChangeProperty
|
|
can generate
|
|
.ZN BadAlloc ,
|
|
.ZN BadAtom ,
|
|
.ZN BadMatch ,
|
|
.ZN BadValue ,
|
|
and
|
|
.ZN BadWindow
|
|
errors.
|
|
.LP
|
|
.\" $Header: XRotProp.d,v 1.3 88/06/11 07:52:52 mento Exp $
|
|
The
|
|
.ZN XRotateWindowProperties
|
|
function allows you to rotate properties on a window and causes
|
|
the X server to generate
|
|
.ZN PropertyNotify
|
|
events.
|
|
If the property names in the properties array are viewed as being numbered
|
|
starting from zero and if there are num_prop property names in the list,
|
|
then the value associated with property name I becomes the value associated
|
|
with property name (I + npositions) mod N for all I from zero to N \- 1.
|
|
The effect is to rotate the states by npositions places around the virtual ring
|
|
of property names (right for positive npositions,
|
|
left for negative npositions).
|
|
If npositions mod N is nonzero,
|
|
the X server generates a
|
|
.ZN PropertyNotify
|
|
event for each property in the order that they are listed in the array.
|
|
If an atom occurs more than once in the list or no property with that
|
|
name is defined for the window,
|
|
a
|
|
.ZN BadMatch
|
|
error results.
|
|
If a
|
|
.ZN BadAtom
|
|
or
|
|
.ZN BadMatch
|
|
error results,
|
|
no properties are changed.
|
|
.LP
|
|
.ZN XRotateWindowProperties
|
|
can generate
|
|
.ZN BadAtom ,
|
|
.ZN BadMatch ,
|
|
and
|
|
.ZN BadWindow
|
|
errors.
|
|
.LP
|
|
.\" $Header: XDeleteProp.d,v 1.2 88/05/08 12:07:50 mento Exp $
|
|
The
|
|
.ZN XDeleteProperty
|
|
function deletes the specified property only if the
|
|
property was defined on the specified window
|
|
and causes the X server to generate a
|
|
.ZN PropertyNotify
|
|
event on the window unless the property does not exist.
|
|
.LP
|
|
.ZN XDeleteProperty
|
|
can generate
|
|
.ZN BadAtom
|
|
and
|
|
.ZN BadWindow
|
|
errors.
|
|
.SH DIAGNOSTICS
|
|
.\" $Header: badalloc.e,v 1.3 87/09/11 11:17:14 mento Exp $
|
|
.TP 1i
|
|
.ZN BadAlloc
|
|
The server failed to allocate the requested resource or server memory.
|
|
.\" $Header: badatom.e,v 1.1 87/09/04 08:22:55 mento Exp $
|
|
.TP 1i
|
|
.ZN BadAtom
|
|
A value for an Atom argument does not name a defined Atom.
|
|
.\" $Header: badvalue.e,v 1.1 87/09/04 08:23:19 mento Exp $
|
|
.TP 1i
|
|
.ZN BadValue
|
|
Some numeric value falls outside the range of values accepted by the request.
|
|
Unless a specific range is specified for an argument, the full range defined
|
|
by the argument's type is accepted. Any argument defined as a set of
|
|
alternatives can generate this error.
|
|
.\" $Header: badwindow.e,v 1.1 87/09/04 08:23:20 mento Exp $
|
|
.TP 1i
|
|
.ZN BadWindow
|
|
A value for a Window argument does not name a defined Window.
|
|
.SH "SEE ALSO"
|
|
XFree(3X11),
|
|
XInternAtom(3X11)
|
|
.br
|
|
\fI\*(xL\fP
|