diff options
author | Matt Dew <marcoz@osource.org> | 2011-10-22 00:43:42 -0600 |
---|---|---|
committer | Matt Dew <marcoz@osource.org> | 2011-10-22 00:43:42 -0600 |
commit | 88a9dd80556e564c085fdd6c4728f465c7f28384 (patch) | |
tree | a1ccd59b2164ba336596625bdd4d06fb7ef8a224 | |
parent | 7bc9a5a043255ba3b3691f9020941cf4cf1666d9 (diff) |
Ch12.xml updates
-rw-r--r-- | specs/CH12.xml | 729 |
1 files changed, 198 insertions, 531 deletions
diff --git a/specs/CH12.xml b/specs/CH12.xml index cc5b177..8285c9f 100644 --- a/specs/CH12.xml +++ b/specs/CH12.xml @@ -1,64 +1,7 @@ -<!-- .\" $Xorg: CH12,v 1.3 2000/08/17 19:42:47 cpqbld Exp $ --> -<!-- .\" Copyright \(co 1985, 1986, 1987, 1988, 1991, 1994 --> -<!-- .\" 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. --> -<!-- .\" --> -<!-- .\" Copyright \(co 1985, 1986, 1987, 1988, 1991, 1994 --> -<!-- .\" Digital Equipment Corporation, Maynard, Massachusetts. --> -<!-- .\" --> -<!-- .\" Permission to use, copy, modify and distribute this documentation for any --> -<!-- .\" purpose and without fee is hereby granted, provided that the above copyright --> -<!-- .\" notice appears in all copies and that both that copyright notice and this --> -<!-- .\" permission notice appear in supporting documentation, and that the name of --> -<!-- .\" Digital not be used in in advertising or publicity pertaining --> -<!-- .\" to distribution of the software without specific, written prior permission. --> -<!-- .\" Digital makes no representations about the suitability of the --> -<!-- .\" software described herein for any purpose. --> -<!-- .\" It is provided ``as is'' without express or implied warranty. --> -<!-- .\" --> -\& -<!-- .sp 1 --> -<!-- .ce 3 --> -\s+1<function>Chapter 12</function>\s-1 +<chapter id='Nonwidget_Objects'> +<title>Nonwidget Objects</title> -\s+1<function>Nonwidget Objects</function>\s-1 -<!-- .sp 2 --> -<!-- .nr H1 12 --> -<!-- .nr H2 0 --> -<!-- .nr H3 0 --> -<!-- .nr H4 0 --> -<!-- .nr H5 0 --> <para> -<!-- .LP --> -<!-- .XS --> -<!-- Chapter 12 \(em Nonwidget Objects --> -<!-- .XE --> -</para> -<para> -<!-- .LP --> Although widget writers are free to treat Core as the base class of @@ -66,7 +9,7 @@ the widget hierarchy, there are actually three classes above it. These classes are Object, RectObj -(Rectangle Object), and (<emphasis remap='I'>unnamed</emphasis>), +(Rectangle Object), and (unnamed), and members of these classes are referred to generically as <emphasis remap='I'>objects</emphasis>. By convention, the term <emphasis remap='I'>widget</emphasis> refers only to objects that are a subclass of @@ -77,16 +20,11 @@ In the preceding portion of this specification, the interface descriptions indicate explicitly whether the generic <emphasis remap='I'>widget</emphasis> argument is restricted to particular subclasses of Object. Sections 12.2.5, 12.3.5, and 12.5 summarize the permissible classes of the arguments to, and -return values from, each of the (xI routines. - +return values from, each of the Intrinsics routines. </para> -<sect2 id="Data_Structures"> +<sect1 id="Data_Structures"> <title>Data Structures</title> -<!-- .XS --> -<!-- (SN Data Structures --> -<!-- .XE --> <para> -<!-- .LP --> In order not to conflict with previous widget code, the data structures used by nonwidget objects do not follow all the same conventions as those for widgets. In particular, the class records @@ -94,17 +32,12 @@ are not composed of parts but instead are complete data structures with filler for the widget fields they do not use. This allows the static class initializers for existing widgets to remain unchanged. - </para> -</sect2> -<sect2 id="Object_Objects"> +</sect1> + +<sect1 id="Object_Objects"> <title>Object Objects</title> -<!-- .XS --> -<!-- <function>(SN Object Objects</function> --> -<!-- .XE --> <para> -<!-- .LP --> -<!-- .IN "Object" "" "@DEF@" --> The Object object contains the definitions of fields common to all @@ -116,20 +49,15 @@ which is defined by the and <function>ObjectPart</function> structures. - </para> -<sect3 id="ObjectClassPart_Structure"> +<sect2 id="ObjectClassPart_Structure"> <title>ObjectClassPart Structure</title> -<!-- .XS --> -<!-- (SN ObjectClassPart Structure --> -<!-- .XE --> <para> -<!-- .LP --> The common fields for all object classes are defined in the <function>ObjectClassPart</function> structure. All fields have the same purpose, function, and restrictions as the corresponding fields in -<function>CoreClassPart ;</function> +<function>CoreClassPart</function>; fields whose names are obj<emphasis remap='I'>\s+1n\s-1</emphasis> for some integer \s+1<emphasis remap='I'>n</emphasis>\s-1 are not used for Object, @@ -137,13 +65,7 @@ but exist to pad the data structure so that it matches Core's class record. The class record initialization must fill all obj<emphasis remap='I'>\s+1n\s-1</emphasis> fields with NULL or zero as appropriate to the type. </para> -<para> -<!-- .LP --> -<!-- .IN "ObjectClassPart" "" "@DEF@" --> -<!-- .sM --> <literallayout class="monospaced"> -<!-- .TA .5i 3i --> -<!-- .ta .5i 3i --> typedef struct _ObjectClassPart { WidgetClass superclass; String class_name; @@ -179,24 +101,15 @@ typedef struct _ObjectClassPart { XtPointer extension; } ObjectClassPart; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> The extension record defined for <function>ObjectClassPart</function> with a <emphasis remap='I'>record_type</emphasis> equal to <function>\s-1NULLQUARK\s+1</function> is -<function>ObjectClassExtensionRec .</function> +<function>ObjectClassExtensionRec</function>. </para> -<para> -<!-- .LP --> -<!-- .IN "ObjectClassExtensionRec" "" "@DEF@" --> -<!-- .sM --> <literallayout class="monospaced"> -<!-- .TA .5i 3i --> -<!-- .ta .5i 3i --> typedef struct { XtPointer next_extension; See Section 1.6.12 XrmQuark record_type; See Section 1.6.12 @@ -206,58 +119,38 @@ typedef struct { XtDeallocateProc deallocate; See Section 2.8.4. } ObjectClassExtensionRec, *ObjectClassExtension; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> The prototypical <function>ObjectClass</function> consists of just the -<function>ObjectClassPart .</function> +<function>ObjectClassPart</function>. </para> -<para> -<!-- .LP --> -<!-- .IN "ObjectClassRec" "" "@DEF@" --> -<!-- .IN "ObjectClass" "" "@DEF@" --> -<!-- .IN "objectClass" "" "@DEF@" --> -<!-- .sM --> <literallayout class="monospaced"> -<!-- .TA .5i 3i --> -<!-- .ta .5i 3i --> typedef struct _ObjectClassRec { ObjectClassPart object_class; } ObjectClassRec, *ObjectClass; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> The predefined class record and pointer for <function>ObjectClassRec</function> are </para> + <para> -<!-- .LP --> In -<function>IntrinsicP.h :</function> -<!-- .sM --> +<function>IntrinsicP.h</function>: +</para> <literallayout class="monospaced"> extern ObjectClassRec objectClassRec; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> In -<function>Intrinsic.h :</function> -<!-- .sM --> +<function>Intrinsic.h</function>: +</para> <literallayout class="monospaced"> extern WidgetClass objectClass; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> The opaque types <function>Object</function> and @@ -274,39 +167,22 @@ version identifier is uses an incomplete structure definition to ensure that the compiler catches attempts to access private data: </para> -<para> -<!-- .LP --> -<!-- .sM --> <literallayout class="monospaced"> typedef struct _ObjectClassRec* ObjectClass; </literallayout> -</para> -<para> -<!-- .LP --> -<!-- .eM --> -</para> -</sect3> -<sect3 id="ObjectPart_Structure"> +</sect2> + +<sect2 id="ObjectPart_Structure"> <title>ObjectPart Structure</title> -<!-- .XS --> -<!-- (SN ObjectPart Structure --> -<!-- .XE --> <para> -<!-- .LP --> The common fields for all object instances are defined in the <function>ObjectPart</function> structure. All fields have the same meaning as the corresponding fields in -<function>CorePart .</function> +<function>CorePart</function>. </para> -<para> -<!-- .LP --> -<!-- .sM --> <literallayout class="monospaced"> -<!-- .TA .5i 3i --> -<!-- .ta .5i 3i --> -<!-- .IN "ObjectPart" "" "@DEF@" --> typedef struct _ObjectPart { Widget self; WidgetClass widget_class; @@ -316,10 +192,7 @@ typedef struct _ObjectPart { XtPointer constraints; } ObjectPart; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> All object instances have the Object fields as their first component. The prototypical type @@ -328,179 +201,130 @@ is defined with only this set of fields. Various routines can cast object pointers, as needed, to specific object types. </para> + <para> -<!-- .LP --> In -<function>IntrinsicP.h :</function> +<function>IntrinsicP.h</function>: </para> -<para> -<!-- .LP --> -<!-- .sM --> <literallayout class="monospaced"> -<!-- .TA .5i 3i --> -<!-- .ta .5i 3i --> typedef struct _ObjectRec { ObjectPart object; } ObjectRec, *Object; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> -<!-- .IN "ObjectRec" "" "@DEF@" --> In -<function>Intrinsic.h :</function> +<function>Intrinsic.h</function>: </para> -<para> -<!-- .LP --> -<!-- .sM --> <literallayout class="monospaced"> typedef struct _ObjectRec *Object; </literallayout> -</para> -<para> -<!-- .LP --> -<!-- .eM --> -</para> -</sect3> -<sect3 id="Object_Resources"> +</sect2> + +<sect2 id="Object_Resources"> <title>Object Resources</title> -<!-- .XS --> -<!-- <function>(SN Object Resources</function> --> -<!-- .XE --> <para> -<!-- .LP --> The resource names, classes, and representation types specified in the <function>objectClassRec</function> resource list are: </para> -<para> -<!-- .LP --> + <informaltable> - <tgroup cols='4' align='center'> + <tgroup cols='3' align='center'> <colspec colname='c1'/> <colspec colname='c2'/> <colspec colname='c3'/> - <colspec colname='c4'/> <tbody> <row> - <entry>lw(1.5i) lw(1.5i) lw(2.5i) .</entry> - </row> - <row> - <entry>_</entry> - </row> - <row> <entry>Name</entry> <entry>Class</entry> <entry>Representation</entry> </row> <row> - <entry>_</entry> - </row> - <row> <entry>XtNdestroyCallback</entry> <entry>XtCCallback</entry> <entry>XtRCallback</entry> </row> - <row> - <entry>_</entry> - </row> </tbody> </tgroup> </informaltable> +</sect2> -</para> -</sect3> -<sect3 id="ObjectPart_Default_Values"> +<sect2 id="ObjectPart_Default_Values"> <title>ObjectPart Default Values</title> -<!-- .XS --> -<!-- <function>(SN ObjectPart Default Values</function> --> -<!-- .XE --> <para> -<!-- .LP --> All fields in <function>ObjectPart</function> have the same default values as the corresponding fields in -<function>CorePart .</function> - +<function>CorePart</function>. </para> -</sect3> -<sect3 id="Object_Arguments_to_xI_Routines"> -<title>Object Arguments to (xI Routines</title> -<!-- .XS --> -<!-- (SN Object Arguments to (xI Routines --> -<!-- .XE --> +</sect2> + +<sect2 id="Object_Arguments_to_xI_Routines"> +<title>Object Arguments to Intrinsics Routines</title> <para> -<!-- .LP --> The WidgetClass arguments to the following procedures may be <function>objectClass</function> or any subclass: -<!-- .sp --> </para> -<!-- .IP --> -<function>XtInitializeWidgetClass ,</function> -<function>XtCreateWidget ,</function> +<para> +<function>XtInitializeWidgetClass</function>, +<function>XtCreateWidget</function>, <function>XtVaCreateWidget</function> -<!-- .IP --> -<function>XtIsSubclass ,</function> +<function>XtIsSubclass</function>, <function>XtCheckSubclass</function> -<!-- .IP --> -<function>XtGetResourceList ,</function> +<function>XtGetResourceList</function>, <function>XtGetConstraintResourceList</function> -<!-- .sp --> +</para> <para> -<!-- .LP --> The Widget arguments to the following procedures may be of class Object or any subclass: -<!-- .sp --> </para> <itemizedlist> <listitem> <para> -<function>XtCreateWidget ,</function> +<function>XtCreateWidget</function>, <function>XtVaCreateWidget</function> </para> </listitem> <listitem> <para> -<function>XtAddCallback ,</function> -<function>XtAddCallbacks ,</function> -<function>XtRemoveCallback ,</function> -<function>XtRemoveCallbacks ,</function> -<function>XtRemoveAllCallbacks ,</function> -<function>XtCallCallbacks ,</function> -<function>XtHasCallbacks ,</function> +<function>XtAddCallback</function>, +<function>XtAddCallbacks</function>, +<function>XtRemoveCallback</function>, +<function>XtRemoveCallbacks</function>, +<function>XtRemoveAllCallbacks</function>, +<function>XtCallCallbacks</function>, +<function>XtHasCallbacks</function>, <function>XtCallCallbackList</function> </para> </listitem> <listitem> <para> -<function>XtClass ,</function> -<function>XtSuperclass ,</function> -<function>XtIsSubclass ,</function> -<function>XtCheckSubclass ,</function> -<function>XtIsObject ,</function> -<function>XtIsRectObj ,</function> -<function>XtIsWidget ,</function> -<function>XtIsComposite ,</function> -<function>XtIsConstraint ,</function> -<function>XtIsShell ,</function> -<function>XtIsOverrideShell ,</function> -<function>XtIsWMShell ,</function> -<function>XtIsVendorShell ,</function> -<function>XtIsTransientShell ,</function> -<function>XtIsToplevelShell ,</function> -<function>XtIsApplicationShell ,</function> +<function>XtClass</function>, +<function>XtSuperclass</function>, +<function>XtIsSubclass</function>, +<function>XtCheckSubclass</function>, +<function>XtIsObject</function>, +<function>XtIsRectObj</function>, +<function>XtIsWidget</function>, +<function>XtIsComposite</function>, +<function>XtIsConstraint</function>, +<function>XtIsShell</function>, +<function>XtIsOverrideShell</function>, +<function>XtIsWMShell</function>, +<function>XtIsVendorShell</function>, +<function>XtIsTransientShell</function>, +<function>XtIsToplevelShell</function>, +<function>XtIsApplicationShell</function>, <function>XtIsSessionShell</function> </para> </listitem> <listitem> <para> -<function>XtIsManaged ,</function> +<function>XtIsManaged</function>, <function>XtIsSensitive</function> -<!-- .br --> (both will return <function>False</function> if argument is not a subclass of @@ -510,7 +334,6 @@ RectObj) <listitem> <para> <function>XtIsRealized</function> -<!-- .br --> (returns the state of the nearest windowed ancestor if class of argument is not a subclass of Core) @@ -528,9 +351,9 @@ Core) </listitem> <listitem> <para> -<function>XtParent ,</function> -<function>XtDisplayOfObject ,</function> -<function>XtScreenOfObject ,</function> +<function>XtParent</function>, +<function>XtDisplayOfObject</function>, +<function>XtScreenOfObject</function>, <function>XtWindowOfObject</function> </para> </listitem> @@ -542,7 +365,7 @@ Core) </listitem> <listitem> <para> -<function>XtGetGC ,</function> +<function>XtGetGC</function>, <function>XtReleaseGC</function> </para> </listitem> @@ -553,39 +376,36 @@ Core) </listitem> <listitem> <para> -<function>XtSetValues ,</function> -<function>XtGetValues ,</function> -<function>XtVaSetValues ,</function> +<function>XtSetValues</function>, +<function>XtGetValues</function>, +<function>XtVaSetValues</function>, <function>XtVaGetValues</function> </para> </listitem> <listitem> <para> -<function>XtGetSubresources ,</function> -<function>XtGetApplicationResources ,</function> -<function>XtVaGetSubresources ,</function> +<function>XtGetSubresources</function>, +<function>XtGetApplicationResources</function>, +<function>XtVaGetSubresources</function>, <function>XtVaGetApplicationResources</function> </para> </listitem> <listitem> <para> -<function>XtConvert ,</function> +<function>XtConvert</function>, <function>XtConvertAndStore</function> -<!-- .sp --> </para> </listitem> </itemizedlist> <para> -<!-- .LP --> The return value of the following procedures will be of class Object or a subclass: -<!-- .sp --> </para> <itemizedlist> <listitem> <para> -<function>XtCreateWidget ,</function> +<function>XtCreateWidget</function>, <function>XtVaCreateWidget</function> </para> </listitem> @@ -597,57 +417,50 @@ or a subclass: <listitem> <para> <function>XtNameToWidget</function> -<!-- .sp --> </para> </listitem> </itemizedlist> <para> -<!-- .LP --> The return value of the following procedures will be <function>objectClass</function> or a subclass: -<!-- .sp --> </para> <itemizedlist> <listitem> <para> -<function>XtClass ,</function> +<function>XtClass</function>, <function>XtSuperclass</function> - </para> </listitem> </itemizedlist> -</sect3> -<sect3 id="Use_of_Objects"> +</sect2> + +<sect2 id="Use_of_Objects"> <title>Use of Objects</title> -<!-- .XS --> -<!-- <function>(SN Use of Objects</function> --> -<!-- .XE --> <para> -<!-- .LP --> The Object -class exists to enable programmers to use the (xI' +class exists to enable programmers to use the Intrinsics' classing and resource-handling mechanisms for things smaller and simpler than widgets. Objects make obsolete many common uses of subresources as described in Sections 9.4, 9.7.2.4, and 9.7.2.5. </para> + <para> -<!-- .LP --> Composite widget classes that wish to accept nonwidget children must set the <emphasis remap='I'>accepts_objects</emphasis> field in the <function>CompositeClassExtension</function> structure to -<function>True .</function> +<function>True</function>. <function>XtCreateWidget</function> will otherwise generate an error message on an attempt to create a nonwidget child. </para> + <para> -<!-- .LP --> -Of the classes defined by the (xI, +Of the classes defined by the Intrinsics, ApplicationShell and SessionShell @@ -662,42 +475,32 @@ and SessionShell is to provide clients a simple mechanism for establishing the resource-naming root of an object hierarchy. - </para> -</sect3> </sect2> -<sect2 id="Rectangle_Objects"> +</sect1> + +<sect1 id="Rectangle_Objects"> <title>Rectangle Objects</title> -<!-- .XS --> -<!-- <function>(SN Rectangle Objects</function> --> -<!-- .XE --> <para> -<!-- .LP --> The class of rectangle objects is a subclass of Object that represents rectangular areas. It encapsulates the mechanisms for geometry management and is called RectObj -<!-- .IN "RectObj" "" "@DEF@" --> to avoid conflict with the Xlib <function>Rectangle</function> data type. - </para> -<sect3 id="RectObjClassPart_Structure"> +<sect2 id="RectObjClassPart_Structure"> <title>RectObjClassPart Structure</title> -<!-- .XS --> -<!-- (SN RectObjClassPart Structure --> -<!-- .XE --> <para> -<!-- .LP --> As with the <function>ObjectClassPart</function> structure, all fields in the <function>RectObjClassPart</function> structure have the same purpose and function as the corresponding fields in -<function>CoreClassPart ;</function> +<function>CoreClassPart</function>; fields whose names are rect<emphasis remap='I'>\s+1n\s-1</emphasis> for some integer <emphasis remap='I'>\s+1n\s-1</emphasis> are not used for RectObj, but exist to pad the data structure so that it matches @@ -705,13 +508,7 @@ Core's class record. The class record initialization must fill all rect<emphasis remap='I'>\s+1n\s-1</emphasis> fields with NULL or zero as appropriate to the type. </para> -<para> -<!-- .LP --> -<!-- .sM --> <literallayout class="monospaced"> -<!-- .TA .5i 3i --> -<!-- .ta .5i 3i --> -<!-- .IN "RectObjClassPart" "" "@DEF@" --> typedef struct _RectObjClassPart { WidgetClass superclass; String class_name; @@ -747,63 +544,38 @@ typedef struct _RectObjClassPart { XtPointer extension ; } RectObjClassPart; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> The RectObj class record consists of just the -<function>RectObjClassPart .</function> +<function>RectObjClassPart</function>. </para> -<para> -<!-- .LP --> -<!-- .sM --> <literallayout class="monospaced"> -<!-- .TA .5i 3i --> -<!-- .ta .5i 3i --> -<!-- .IN "RectObjClassRec" "" "@DEF@" --> -<!-- .IN "RectObjClass" "" "@DEF@" --> typedef struct _RectObjClassRec { RectObjClassPart rect_class; } RectObjClassRec, *RectObjClass; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> The predefined class record and pointer for <function>RectObjClassRec</function> are </para> + <para> -<!-- .LP --> In -<function>Intrinsic.h :</function> +<function>Intrinsic.h</function>: </para> -<para> -<!-- .LP --> -<!-- .sM --> <literallayout class="monospaced"> extern RectObjClassRec rectObjClassRec; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> In -<function>Intrinsic.h :</function> +<function>Intrinsic.h</function>: </para> -<para> -<!-- .LP --> -<!-- .sM --> <literallayout class="monospaced"> extern WidgetClass rectObjClass; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> The opaque types <function>RectObj</function> and @@ -817,26 +589,15 @@ RectObj. uses an incomplete structure definition to ensure that the compiler catches attempts to access private data: </para> -<para> -<!-- .LP --> -<!-- .sM --> <literallayout class="monospaced"> typedef struct _RectObjClassRec* RectObjClass; </literallayout> -</para> -<para> -<!-- .LP --> -<!-- .eM --> -</para> -</sect3> -<sect3 id="RectObjPart_Structure"> +</sect2> + +<sect2 id="RectObjPart_Structure"> <title>RectObjPart Structure</title> -<!-- .XS --> -<!-- (SN RectObjPart Structure --> -<!-- .XE --> <para> -<!-- .LP --> In addition to the <function>ObjectPart</function> fields, @@ -844,15 +605,9 @@ RectObj objects have the following fields defined in the <function>RectObjPart</function> structure. All fields have the same meaning as the corresponding field in -<function>CorePart .</function> +<function>CorePart</function>. </para> -<para> -<!-- .LP --> -<!-- .sM --> <literallayout class="monospaced"> -<!-- .TA .5i 3i --> -<!-- .ta .5i 3i --> -<!-- .IN "RectObjPart" "" "@DEF@" --> typedef struct _RectObjPart { Position x, y; Dimension width, height; @@ -862,77 +617,44 @@ typedef struct _RectObjPart { Boolean ancestor_sensitive; } RectObjPart; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> RectObj objects have the RectObj fields immediately following the Object fields. </para> -<para> -<!-- .LP --> -<!-- .sM --> <literallayout class="monospaced"> -<!-- .TA .5i 3i --> -<!-- .ta .5i 3i --> -<!-- .IN "RectObjRec" "" "@DEF@" --> typedef struct _RectObjRec { ObjectPart object; RectObjPart rectangle; } RectObjRec, *RectObj; </literallayout> -</para> <para> -<!-- .LP --> -<!-- .eM --> In -<function>Intrinsic.h :</function> +<function>Intrinsic.h</function>: </para> -<para> -<!-- .LP --> -<!-- .sM --> <literallayout class="monospaced"> typedef struct _RectObjRec* RectObj; </literallayout> -</para> -<para> -<!-- .LP --> -<!-- .eM --> -</para> -</sect3> -<sect3 id="RectObj_Resources"> +</sect2> + +<sect2 id="RectObj_Resources"> <title>RectObj Resources</title> -<!-- .XS --> -<!-- <function>(SN RectObj Resources</function> --> -<!-- .XE --> <para> -<!-- .LP --> The resource names, classes, and representation types that are specified in the <function>rectObjClassRec</function> resource list are: <informaltable> - <tgroup cols='4' align='center'> + <tgroup cols='3' align='center'> <colspec colname='c1'/> <colspec colname='c2'/> <colspec colname='c3'/> - <colspec colname='c4'/> <tbody> <row> - <entry>lw(1.5i) lw(1.5i) lw(2.5i) .</entry> - </row> - <row> - <entry>_</entry> - </row> - <row> <entry>Name</entry> <entry>Class</entry> <entry>Representation</entry> </row> <row> - <entry>_</entry> - </row> - <row> <entry>XtNancestorSensitive</entry> <entry>XtCSensitive</entry> <entry>XtRBoolean</entry> @@ -967,77 +689,62 @@ resource list are: <entry>XtCPosition</entry> <entry>XtRPosition</entry> </row> - <row> - <entry>_</entry> - </row> </tbody> </tgroup> </informaltable> - </para> -</sect3> -<sect3 id="RectObjPart_Default_Values"> +</sect2> + +<sect2 id="RectObjPart_Default_Values"> <title>RectObjPart Default Values</title> -<!-- .XS --> -<!-- <function>(SN RectObjPart Default Values</function> --> -<!-- .XE --> <para> -<!-- .LP --> All fields in <function>RectObjPart</function> have the same default values as the corresponding fields in -<function>CorePart .</function> - +<function>CorePart</function>. </para> -</sect3> -<sect3 id="Widget_Arguments_to_xI_Routines"> -<title>Widget Arguments to (xI Routines</title> -<!-- .XS --> -<!-- <function>(SN Widget Arguments to (xI Routines</function> --> -<!-- .XE --> +</sect2> + +<sect2 id="Widget_Arguments_to_xI_Routines"> +<title>Widget Arguments to Intrinsics Routines</title> <para> -<!-- .LP --> The WidgetClass arguments to the following procedures may be <function>rectObjClass</function> or any subclass: -<!-- .sp --> </para> <itemizedlist> <listitem> <para> -<function>XtCreateManagedWidget ,</function> +<function>XtCreateManagedWidget</function>, <function>XtVaCreateManagedWidget</function> -<!-- .sp --> </para> </listitem> </itemizedlist> <para> -<!-- .LP --> The Widget arguments to the following procedures may be of class RectObj or any subclass: -<!-- .sp --> </para> <itemizedlist> <listitem> <para> -<function>XtConfigureWidget ,</function> -<function>XtMoveWidget ,</function> +<function>XtConfigureWidget</function>, +<function>XtMoveWidget</function>, <function>XtResizeWidget</function> </para> </listitem> <listitem> <para> -<function>XtMakeGeometryRequest ,</function> +<function>XtMakeGeometryRequest</function>, <function>XtMakeResizeRequest</function> </para> </listitem> <listitem> <para> -<function>XtManageChildren ,</function> -<function>XtManageChild ,</function> -<function>XtUnmanageChildren ,</function> -<function>XtUnmanageChild ,</function> +<function>XtManageChildren</function>, +<function>XtManageChild</function>, +<function>XtUnmanageChildren</function>, +<function>XtUnmanageChild</function>, <function>XtChangeManagedSet</function> </para> </listitem> @@ -1054,34 +761,27 @@ or any subclass: <listitem> <para> <function>XtTranslateCoords</function> -<!-- .sp --> </para> </listitem> </itemizedlist> <para> -<!-- .LP --> The return value of the following procedures will be of class RectObj or a subclass: -<!-- .sp --> </para> <itemizedlist> <listitem> <para> -<function>XtCreateManagedWidget ,</function> +<function>XtCreateManagedWidget</function>, <function>XtVaCreateManagedWidget</function> - </para> </listitem> </itemizedlist> -</sect3> -<sect3 id="Use_of_Rectangle_Objects"> +</sect2> + +<sect2 id="Use_of_Rectangle_Objects"> <title>Use of Rectangle Objects</title> -<!-- .XS --> -<!-- (SN Use of Rectangle Objects --> -<!-- .XE --> <para> -<!-- .LP --> RectObj can be subclassed to provide widgetlike objects (sometimes called gadgets) that do not use windows and do not have those @@ -1095,14 +795,14 @@ RectObj, but not Core or a subclass of Core. </para> + <para> -<!-- .LP --> Composite widget classes that wish to accept rectobj children must set the <emphasis remap='I'>accepts_objects</emphasis> field in the <function>CompositeClassExtension</function> extension structure to -<function>True .</function> +<function>True</function>. <function>XtCreateWidget</function> or <function>XtCreateManagedWidget</function> @@ -1112,10 +812,10 @@ RectObj or a subclass (i.e., not of the general Object class), it must declare an insert_child procedure and check the subclass of each new child in that procedure. None of the classes defined by the -(xI accept rectobj children. +Intrinsics accept rectobj children. </para> + <para> -<!-- .LP --> If gadgets are defined in an object set, the parent is responsible for much more than the parent of a widget. The parent must request and handle input events that occur for the gadget and is responsible for making @@ -1127,13 +827,13 @@ specified in their class records, but the parent is free to ignore them, instead drawing the contents of the child itself. This can potentially save graphics context switching. The precise contents of the exposure event and region arguments to the RectObj expose -procedure are not specified by the (xI; a particular rectangle object is +procedure are not specified by the Intrinsics; a particular rectangle object is free to define the coordinate system origin (self-relative or parent-relative) and whether or not the rectangle or region is assumed to have been intersected with the visible region of the object. </para> + <para> -<!-- .LP --> In general, it is expected that a composite widget that accepts nonwidget children will document those children it is able to handle, since a gadget cannot be viewed as a completely self-contained entity, @@ -1142,9 +842,9 @@ designed to handle nonwidget children of only a limited set of classes, it shoul check the classes of newly added children in its insert_child procedure to make sure that it can deal with them. </para> + <para> -<!-- .LP --> -The (xI will clear areas of a parent window obscured by +The Intrinsics will clear areas of a parent window obscured by rectobj children, causing exposure events, under the following circumstances: </para> @@ -1159,7 +859,7 @@ A rectobj child is managed or unmanaged. In a call to <function>XtSetValues</function> on a rectobj child, one or more of the set_values procedures returns -<function>True .</function> +<function>True</function>. </para> </listitem> <listitem> @@ -1194,39 +894,34 @@ old and the new child geometries if they are different. In a call to <function>XtMakeGeometryRequest</function> (or -<function>XtMakeResizeRequest )</function> +<function>XtMakeResizeRequest</function>) on a rectobj child with <function>XtQueryOnly</function> not set, if the manager returns -<function>XtGeometryYes ,</function> +<function>XtGeometryYes</function>, two rectangles will be cleared corresponding to both the old and the new child geometries. </para> </listitem> </itemizedlist> <para> -<!-- .LP --> Stacking order is not supported for rectobj children. Composite widgets with rectobj children are free to define any semantics desired if the child geometries overlap, including making this an error. </para> + <para> -<!-- .LP --> When a rectobj is playing the role of a widget, developers must be reminded to avoid making assumptions about the object passed in the Widget argument to a callback procedure. - </para> -</sect3> </sect2> -<sect2 id="Undeclared_Class"> +</sect1> + +<sect1 id="Undeclared_Class"> <title>Undeclared Class</title> -<!-- .XS --> -<!-- (SN Undeclared Class --> -<!-- .XE --> <para> -<!-- .LP --> -The (xI define an unnamed class between +The Intrinsics define an unnamed class between RectObj and Core @@ -1252,64 +947,53 @@ in its <emphasis remap='I'>object_class.superclass</emphasis> field. </listitem> </itemizedlist> <para> -<!-- .LP --> Except for the above, the contents of the class record for this class and the result of an attempt to subclass or to create a widget of this unnamed class are undefined. - </para> -</sect2> -<sect2 id="Widget_Arguments_to_xI_Routines"> -<title>Widget Arguments to (xI Routines</title> -<!-- .XS --> -<!-- (SN Widget Arguments to (xI Routines --> -<!-- .XE --> +</sect1> + +<sect1 id="Widget_Arguments_to_Intrinsics_Routines"> +<title>Widget Arguments to Intrinsics Routines</title> <para> -<!-- .LP --> The WidgetClass arguments to the following procedures must be of class Shell or a subclass: -<!-- .sp --> </para> <itemizedlist> <listitem> <para> -<function>XtCreatePopupShell ,</function> -<function>XtVaCreatePopupShell ,</function> -<function>XtAppCreateShell ,</function> -<function>XtVaAppCreateShell ,</function> -<function>XtOpenApplication ,</function> +<function>XtCreatePopupShell</function>, +<function>XtVaCreatePopupShell</function>, +<function>XtAppCreateShell</function>, +<function>XtVaAppCreateShell</function>, +<function>XtOpenApplication</function>, <function>XtVaOpenApplication</function> -<!-- .sp --> </para> </listitem> </itemizedlist> <para> -<!-- .LP --> The Widget arguments to the following procedures must be of class Core or any subclass: -<!-- .sp --> </para> <itemizedlist> <listitem> <para> -<function>XtCreatePopupShell ,</function> +<function>XtCreatePopupShell</function>, <function>XtVaCreatePopupShell</function> </para> </listitem> <listitem> <para> -<function>XtAddEventHandler ,</function> -<function>XtAddRawEventHandler ,</function> -<function>XtRemoveEventHandler ,</function> -<!-- .br --> -<function>XtRemoveRawEventHandler ,</function> -<function>XtInsertEventHandler ,</function> +<function>XtAddEventHandler</function>, +<function>XtAddRawEventHandler</function>, +<function>XtRemoveEventHandler</function>, +<function>XtRemoveRawEventHandler</function>, +<function>XtInsertEventHandler</function>, <function>XtInsertRawEventHandler</function> -<!-- .br --> -<function>XtInsertEventTypeHandler ,</function> -<function>XtRemoveEventTypeHandler ,</function> +<function>XtInsertEventTypeHandler</function>, +<function>XtRemoveEventTypeHandler</function>, </para> </listitem> <listitem> @@ -1320,16 +1004,15 @@ or any subclass: </listitem> <listitem> <para> -<function>XtAddGrab ,</function> -<function>XtRemoveGrab ,</function> -<function>XtGrabKey ,</function> -<function>XtGrabKeyboard ,</function> -<function>XtUngrabKey ,</function> -<function>XtUngrabKeyboard ,</function> -<function>XtGrabButton ,</function> -<function>XtGrabPointer ,</function> -<function>XtUngrabButton ,</function> -<!-- .br --> +<function>XtAddGrab</function>, +<function>XtRemoveGrab</function>, +<function>XtGrabKey</function>, +<function>XtGrabKeyboard</function>, +<function>XtUngrabKey</function>, +<function>XtUngrabKeyboard</function>, +<function>XtGrabButton</function>, +<function>XtGrabPointer</function>, +<function>XtUngrabButton</function>, <function>XtUngrabPointer</function> </para> </listitem> @@ -1340,9 +1023,9 @@ or any subclass: </listitem> <listitem> <para> -<function>XtCreateWindow ,</function> -<function>XtDisplay ,</function> -<function>XtScreen ,</function> +<function>XtCreateWindow</function>, +<function>XtDisplay</function>, +<function>XtScreen</function>, <function>XtWindow</function> </para> </listitem> @@ -1353,42 +1036,40 @@ or any subclass: </listitem> <listitem> <para> -<function>XtGetSelectionValue ,</function> -<function>XtGetSelectionValues ,</function> -<function>XtOwnSelection ,</function> -<function>XtDisownSelection ,</function> -<function>XtOwnSelectionIncremental ,</function> -<function>XtGetSelectionValueIncremental ,</function> -<function>XtGetSelectionValuesIncremental ,</function> -<!-- .br --> +<function>XtGetSelectionValue</function>, +<function>XtGetSelectionValues</function>, +<function>XtOwnSelection</function>, +<function>XtDisownSelection</function>, +<function>XtOwnSelectionIncremental</function>, +<function>XtGetSelectionValueIncremental</function>, +<function>XtGetSelectionValuesIncremental</function>, <function>XtGetSelectionRequest</function> </para> </listitem> <listitem> <para> -<function>XtInstallAccelerators ,</function> +<function>XtInstallAccelerators</function>, <function>XtInstallAllAccelerators</function> (both destination and source) </para> </listitem> <listitem> <para> -<function>XtAugmentTranslations ,</function> -<function>XtOverrideTranslations ,</function> -<function>XtUninstallTranslations ,</function> -<!-- .br --> +<function>XtAugmentTranslations</function>, +<function>XtOverrideTranslations</function>, +<function>XtUninstallTranslations</function>, <function>XtCallActionProc</function> </para> </listitem> <listitem> <para> -<function>XtMapWidget ,</function> +<function>XtMapWidget</function>, <function>XtUnmapWidget</function> </para> </listitem> <listitem> <para> -<function>XtRealizeWidget ,</function> +<function>XtRealizeWidget</function>, <function>XtUnrealizeWidget</function> </para> </listitem> @@ -1399,7 +1080,7 @@ or any subclass: </listitem> <listitem> <para> -<function>XtCallAcceptFocus ,</function> +<function>XtCallAcceptFocus</function>, <function>XtSetKeyboardFocus</function> (subtree) </para> @@ -1412,80 +1093,66 @@ or any subclass: <listitem> <para> <function>XtSetWMColormapWindows</function> -<!-- .sp --> </para> </listitem> </itemizedlist> <para> -<!-- .LP --> The Widget arguments to the following procedures must be of class Composite or any subclass: -<!-- .sp --> </para> <itemizedlist> <listitem> <para> -<function>XtCreateManagedWidget ,</function> +<function>XtCreateManagedWidget</function>, <function>XtVaCreateManagedWidget</function> -<!-- .sp --> </para> </listitem> </itemizedlist> <para> -<!-- .LP --> The Widget arguments to the following procedures must be of a subclass of Shell: -<!-- .sp --> </para> <itemizedlist> <listitem> <para> -<function>XtPopdown ,</function> -<function>XtCallbackPopdown ,</function> -<function>XtPopup ,</function> -<function>XtCallbackNone ,</function> -<function>XtCallbackNonexclusive ,</function> -<function>XtCallbackExclusive ,</function> +<function>XtPopdown</function>, +<function>XtCallbackPopdown</function>, +<function>XtPopup</function>, +<function>XtCallbackNone</function>, +<function>XtCallbackNonexclusive</function>, +<function>XtCallbackExclusive</function>, <function>XtPopupSpringLoaded</function> -<!-- .sp --> </para> </listitem> </itemizedlist> <para> -<!-- .LP --> The return value of the following procedure will be of class Core or a subclass: -<!-- .sp --> </para> <itemizedlist> <listitem> <para> <function>XtWindowToWidget</function> -<!-- .sp --> </para> </listitem> </itemizedlist> <para> -<!-- .LP --> The return value of the following procedures will be of a subclass of Shell: -<!-- .sp --> </para> <itemizedlist> <listitem> <para> -<function>XtAppCreateShell ,</function> -<function>XtVaAppCreateShell ,</function> -<function>XtAppInitialize ,</function> -<function>XtVaAppInitialize ,</function> -<function>XtCreatePopupShell ,</function> +<function>XtAppCreateShell</function>, +<function>XtVaAppCreateShell</function>, +<function>XtAppInitialize</function>, +<function>XtVaAppInitialize</function>, +<function>XtCreatePopupShell</function>, <function>XtVaCreatePopupShell</function> -<!-- .bp --> </para> </listitem> </itemizedlist> -</sect2> +</sect1> </chapter> -</book> |