File: refs1inf.sgm

package info (click to toggle)
docbook-doc 30d10-4
  • links: PTS
  • area: main
  • in suites: potato
  • size: 10,112 kB
  • ctags: 3
  • sloc: makefile: 40; sh: 1
file content (332 lines) | stat: -rw-r--r-- 13,832 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
<RefEntry ID="dbre.elem.RefSect1Info">
<!-- Created by DTDParseRefentry version 0.94 -->
<!-- Consult http://www.ora.com/homepages/dtdparse/ -->
<!-- for more information. -->

<![ %dbre.ms.refmeta [
<RefMeta>
<IndexTerm><Primary>RefSect1Info Element</Primary></IndexTerm>
<RefEntryTitle>RefSect1Info</RefEntryTitle>
<RefMiscInfo>Element</RefMiscInfo>
</RefMeta>
]]>

<RefNameDiv>
<RefName>RefSect1Info</RefName>
<RefPurpose>
Metainformation for a Refsect1

</RefPurpose>
</RefNameDiv>

<![ %dbre.ms.refsynopsisdiv [
<RefSynopsisDiv><Title>Content Model</Title>
<Synopsis>
  ((<Link LinkEnd="dbre.elem.Graphic">Graphic</Link> | <Link LinkEnd="dbre.elem.LegalNotice">LegalNotice</Link> | <Link LinkEnd="dbre.elem.ModeSpec">ModeSpec</Link> | <Link LinkEnd="dbre.elem.SubjectSet">SubjectSet</Link>
  | <Link LinkEnd="dbre.elem.KeywordSet">KeywordSet</Link> | <Link LinkEnd="dbre.elem.ITermSet">ITermSet</Link> | <Link LinkEnd="dbre.elem.Abbrev">Abbrev</Link> | <Link LinkEnd="dbre.elem.Abstract">Abstract</Link> | <Link LinkEnd="dbre.elem.Address">Address</Link>
  | <Link LinkEnd="dbre.elem.ArtPageNums">ArtPageNums</Link> | <Link LinkEnd="dbre.elem.Author">Author</Link> | <Link LinkEnd="dbre.elem.AuthorGroup">AuthorGroup</Link> | <Link LinkEnd="dbre.elem.AuthorInitials">AuthorInitials</Link>
  | <Link LinkEnd="dbre.elem.BiblioMisc">BiblioMisc</Link> | <Link LinkEnd="dbre.elem.BiblioSet">BiblioSet</Link> | <Link LinkEnd="dbre.elem.Collab">Collab</Link> | <Link LinkEnd="dbre.elem.ConfGroup">ConfGroup</Link> | <Link LinkEnd="dbre.elem.ContractNum">ContractNum</Link>
  | <Link LinkEnd="dbre.elem.ContractSponsor">ContractSponsor</Link> | <Link LinkEnd="dbre.elem.Copyright">Copyright</Link> | <Link LinkEnd="dbre.elem.CorpAuthor">CorpAuthor</Link> | <Link LinkEnd="dbre.elem.CorpName">CorpName</Link>
  | <Link LinkEnd="dbre.elem.Date">Date</Link> | <Link LinkEnd="dbre.elem.Edition">Edition</Link> | <Link LinkEnd="dbre.elem.Editor">Editor</Link> | <Link LinkEnd="dbre.elem.InvPartNumber">InvPartNumber</Link> | <Link LinkEnd="dbre.elem.ISBN">ISBN</Link> | <Link LinkEnd="dbre.elem.ISSN">ISSN</Link>
  | <Link LinkEnd="dbre.elem.IssueNum">IssueNum</Link> | <Link LinkEnd="dbre.elem.OrgName">OrgName</Link> | <Link LinkEnd="dbre.elem.OtherCredit">OtherCredit</Link> | <Link LinkEnd="dbre.elem.PageNums">PageNums</Link>
  | <Link LinkEnd="dbre.elem.PrintHistory">PrintHistory</Link> | <Link LinkEnd="dbre.elem.ProductName">ProductName</Link> | <Link LinkEnd="dbre.elem.ProductNumber">ProductNumber</Link> | <Link LinkEnd="dbre.elem.PubDate">PubDate</Link>
  | <Link LinkEnd="dbre.elem.Publisher">Publisher</Link> | <Link LinkEnd="dbre.elem.PublisherName">PublisherName</Link> | <Link LinkEnd="dbre.elem.PubsNumber">PubsNumber</Link> | <Link LinkEnd="dbre.elem.ReleaseInfo">ReleaseInfo</Link>
  | <Link LinkEnd="dbre.elem.RevHistory">RevHistory</Link> | <Link LinkEnd="dbre.elem.SeriesVolNums">SeriesVolNums</Link> | <Link LinkEnd="dbre.elem.Subtitle">Subtitle</Link> | <Link LinkEnd="dbre.elem.Title">Title</Link>
  | <Link LinkEnd="dbre.elem.TitleAbbrev">TitleAbbrev</Link> | <Link LinkEnd="dbre.elem.VolumeNum">VolumeNum</Link> | <Link LinkEnd="dbre.elem.Honorific">Honorific</Link> | <Link LinkEnd="dbre.elem.FirstName">FirstName</Link> | <Link LinkEnd="dbre.elem.Surname">Surname</Link>
  | <Link LinkEnd="dbre.elem.Lineage">Lineage</Link> | <Link LinkEnd="dbre.elem.OtherName">OtherName</Link> | <Link LinkEnd="dbre.elem.Affiliation">Affiliation</Link> | <Link LinkEnd="dbre.elem.AuthorBlurb">AuthorBlurb</Link>
  | <Link LinkEnd="dbre.elem.Contrib">Contrib</Link>)+)
  -(<Link LinkEnd="dbre.elem.BeginPage">BeginPage</Link>)
</Synopsis>

<![ %dbre.ms.refsynopsisdiv.excl [
<RefSect2><Title>Exclusions</Title>
<Para>
RefSect1Info excludes these elements at every level:
</Para>
<Synopsis>
  <Link LinkEnd="dbre.elem.BeginPage">BeginPage</Link>
</Synopsis>
</RefSect2>
]]>

<![ %dbre.ms.refsynopsisdiv.attr [
<RefSect2><Title>Attributes</Title>
<Para>
This element has <link linkend="dbre.x.common">common</link> and <link linkend="dbre.x.role"><sgmltag class=attribute>Role</></link> attributes.
</Para>
</RefSect2>
]]>

<![ %dbre.ms.refsynopsisdiv.tagmin [
<RefSect2><Title>Tag Minimization</Title>
<Para>
Both the start- and end-tags are required for this element.
</Para>
</RefSect2>
]]>

</RefSynopsisDiv>
]]>

<![ %dbre.ms.description [
<RefSect1><Title>Description</Title>
<para>Metainformation for a Refsect1,
in which it may appear.  
Refsect1Info may contain any number, in any order,
any member of bibliocomponent.mix, Graphic, LegalNotice,
ModeSpec, SubjectSet, or ITermSet.
Refsect1Info has common attributes.
</para>


<![ %dbre.ms.description.parents [
<RefSect2><Title>Parents</Title>
<Para>
RefSect1Info occurs in
<Link LinkEnd="dbre.elem.RefSect1">RefSect1</Link>.
</Para>

</RefSect2>
]]>

<![ %dbre.ms.description.children [
<RefSect2><Title>Children</Title>
<Para>
RefSect1Info contains these elements:
<SimpleList Type=Inline>
<Member><Link LinkEnd="dbre.elem.Abbrev">Abbrev</Link></Member>
<Member><Link LinkEnd="dbre.elem.Abstract">Abstract</Link></Member>
<Member><Link LinkEnd="dbre.elem.Address">Address</Link></Member>
<Member><Link LinkEnd="dbre.elem.Affiliation">Affiliation</Link></Member>
<Member><Link LinkEnd="dbre.elem.ArtPageNums">ArtPageNums</Link></Member>
<Member><Link LinkEnd="dbre.elem.Author">Author</Link></Member>
<Member><Link LinkEnd="dbre.elem.AuthorBlurb">AuthorBlurb</Link></Member>
<Member><Link LinkEnd="dbre.elem.AuthorGroup">AuthorGroup</Link></Member>
<Member><Link LinkEnd="dbre.elem.AuthorInitials">AuthorInitials</Link></Member>
<Member><Link LinkEnd="dbre.elem.BiblioMisc">BiblioMisc</Link></Member>
<Member><Link LinkEnd="dbre.elem.BiblioSet">BiblioSet</Link></Member>
<Member><Link LinkEnd="dbre.elem.Collab">Collab</Link></Member>
<Member><Link LinkEnd="dbre.elem.ConfGroup">ConfGroup</Link></Member>
<Member><Link LinkEnd="dbre.elem.ContractNum">ContractNum</Link></Member>
<Member><Link LinkEnd="dbre.elem.ContractSponsor">ContractSponsor</Link></Member>
<Member><Link LinkEnd="dbre.elem.Contrib">Contrib</Link></Member>
<Member><Link LinkEnd="dbre.elem.Copyright">Copyright</Link></Member>
<Member><Link LinkEnd="dbre.elem.CorpAuthor">CorpAuthor</Link></Member>
<Member><Link LinkEnd="dbre.elem.CorpName">CorpName</Link></Member>
<Member><Link LinkEnd="dbre.elem.Date">Date</Link></Member>
<Member><Link LinkEnd="dbre.elem.Edition">Edition</Link></Member>
<Member><Link LinkEnd="dbre.elem.Editor">Editor</Link></Member>
<Member><Link LinkEnd="dbre.elem.FirstName">FirstName</Link></Member>
<Member><Link LinkEnd="dbre.elem.Graphic">Graphic</Link></Member>
<Member><Link LinkEnd="dbre.elem.Honorific">Honorific</Link></Member>
<Member><Link LinkEnd="dbre.elem.ISBN">ISBN</Link></Member>
<Member><Link LinkEnd="dbre.elem.ISSN">ISSN</Link></Member>
<Member><Link LinkEnd="dbre.elem.ITermSet">ITermSet</Link></Member>
<Member><Link LinkEnd="dbre.elem.InvPartNumber">InvPartNumber</Link></Member>
<Member><Link LinkEnd="dbre.elem.IssueNum">IssueNum</Link></Member>
<Member><Link LinkEnd="dbre.elem.KeywordSet">KeywordSet</Link></Member>
<Member><Link LinkEnd="dbre.elem.LegalNotice">LegalNotice</Link></Member>
<Member><Link LinkEnd="dbre.elem.Lineage">Lineage</Link></Member>
<Member><Link LinkEnd="dbre.elem.ModeSpec">ModeSpec</Link></Member>
<Member><Link LinkEnd="dbre.elem.OrgName">OrgName</Link></Member>
<Member><Link LinkEnd="dbre.elem.OtherCredit">OtherCredit</Link></Member>
<Member><Link LinkEnd="dbre.elem.OtherName">OtherName</Link></Member>
<Member><Link LinkEnd="dbre.elem.PageNums">PageNums</Link></Member>
<Member><Link LinkEnd="dbre.elem.PrintHistory">PrintHistory</Link></Member>
<Member><Link LinkEnd="dbre.elem.ProductName">ProductName</Link></Member>
<Member><Link LinkEnd="dbre.elem.ProductNumber">ProductNumber</Link></Member>
<Member><Link LinkEnd="dbre.elem.PubDate">PubDate</Link></Member>
<Member><Link LinkEnd="dbre.elem.Publisher">Publisher</Link></Member>
<Member><Link LinkEnd="dbre.elem.PublisherName">PublisherName</Link></Member>
<Member><Link LinkEnd="dbre.elem.PubsNumber">PubsNumber</Link></Member>
<Member><Link LinkEnd="dbre.elem.ReleaseInfo">ReleaseInfo</Link></Member>
<Member><Link LinkEnd="dbre.elem.RevHistory">RevHistory</Link></Member>
<Member><Link LinkEnd="dbre.elem.SeriesVolNums">SeriesVolNums</Link></Member>
<Member><Link LinkEnd="dbre.elem.SubjectSet">SubjectSet</Link></Member>
<Member><Link LinkEnd="dbre.elem.Subtitle">Subtitle</Link></Member>
<Member><Link LinkEnd="dbre.elem.Surname">Surname</Link></Member>
<Member><Link LinkEnd="dbre.elem.Title">Title</Link></Member>
<Member><Link LinkEnd="dbre.elem.TitleAbbrev">TitleAbbrev</Link></Member>
<Member><Link LinkEnd="dbre.elem.VolumeNum">VolumeNum</Link></Member>
</SimpleList>.
</Para>

</RefSect2>
]]>


</RefSect1>
]]>

<![ %dbre.ms.examples [
<RefSect1><Title>Examples</Title>
<programlisting>
<![ CDATA [
<REFENTRY ID="RE-1007-UNMANAGECHILDREN-1">
<REFMETA>
<REFENTRYTITLE>XtUnmanageChildren</REFENTRYTITLE>
<REFMISCINFO>Xt - Geometry Management</REFMISCINFO>
</REFMETA>
<REFNAMEDIV>
<REFNAME>XtUnmanageChildren
</REFNAME>
<REFPURPOSE>remove a list of children from a parent widget's managed list.
</REFPURPOSE>
<INDEXTERM ID="IX-1007-UNMANAGECHILDREN-1"><PRIMARY>widgets</PRIMARY><SECONDARY>removing</SECONDARY></INDEXTERM>
<INDEXTERM ID="IX-1007-UNMANAGECHILDREN-2"><PRIMARY>XtUnmanageChildren</PRIMARY></INDEXTERM>
</REFNAMEDIV>
<REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO>
<DATE>4 March 1996</DATE>
</REFSYNOPSISDIVINFO>
<SYNOPSIS>
void XtUnmanageChildren(<REPLACEABLE CLASS="PARAMETER">children</REPLACEABLE>, <REPLACEABLE CLASS="PARAMETER">num_children</REPLACEABLE>)
    WidgetList <REPLACEABLE CLASS="PARAMETER">children</REPLACEABLE>;
    Cardinal <REPLACEABLE CLASS="PARAMETER">num_children</REPLACEABLE>;</SYNOPSIS>
<REFSECT2 ID="R2-1007-UNMANAGECHILDREN-1">
<REFSECT2INFO>
<DATE>6 March 1996</DATE>
</REFSECT2INFO>
<TITLE>Inputs
</TITLE>
<VARIABLELIST>
<VARLISTENTRY>
<TERM><REPLACEABLE CLASS="PARAMETER">children</REPLACEABLE>
</TERM>
<LISTITEM>
<PARA>Specifies an array of child widgets.  Each child must be of
class RectObj or any subclass thereof.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM><REPLACEABLE CLASS="PARAMETER">num_children</REPLACEABLE>
</TERM>
<LISTITEM>
<PARA>Specifies the number of elements in <REPLACEABLE CLASS="PARAMETER">children</REPLACEABLE>.
</PARA>
</LISTITEM>
</VARLISTENTRY>
</VARIABLELIST>
<REFSECT3>
<TITLE>Subsidiary Inputs</TITLE>
<PARA>Inputs into unmanageable children may also include
food, drink, and discipline.
</PARA>
</REFSECT3>
</REFSECT2></REFSYNOPSISDIV>
<REFSECT1 ID="R1-1007-UNMANAGECHILDREN-1">
<REFSECT1INFO>
<DATE>5 March 1996</DATE>
</REFSECT1INFO>
<TITLE>Description
</TITLE>
<PARA><FUNCTION>XtUnmanageChildren()</FUNCTION> unmaps the specified widgets
and removes them from their parent's geometry management.
The widgets will disappear from the screen, and (depending
on its parent) may no longer have screen space allocated for
them.
</PARA>
<PARA>Each of the widgets in the <REPLACEABLE CLASS="PARAMETER">children</REPLACEABLE> array must have
the same parent.
</PARA>
<PARA>See the &ldquo;Algorithm&rdquo; section below for full details of the
widget unmanagement procedure.
</PARA>
</REFSECT1>
<REFSECT1 ID="R1-1007-UNMANAGECHILDREN-2">
<TITLE>Usage
</TITLE>
<PARA>Unmanaging widgets is the usual method for temporarily
making them invisible.  They can be re-managed with
<FUNCTION>XtManageChildren()</FUNCTION>.
</PARA>
<PARA>You can unmap a widget, but leave it under geometry
management by calling <FUNCTION>XtUnmapWidget()</FUNCTION>.  You can
destroy a widget's window without destroying the widget by
calling <FUNCTION>XtUnrealizeWidget()</FUNCTION>.  You can destroy a
widget completely with <FUNCTION>XtDestroyWidget()</FUNCTION>.
</PARA>
<PARA>If you are only going to unmanage a single widget, it is
more convenient to call <FUNCTION>XtUnmanageChild()</FUNCTION>.  It is
often more convenient to call <FUNCTION>XtUnmanageChild()</FUNCTION>
several times than it is to declare and initialize an array
of widgets to pass to <FUNCTION>XtUnmanageChildren()</FUNCTION>.  Calling
<FUNCTION>XtUnmanageChildren()</FUNCTION> is more efficient, however,
because it only calls the parent's <FUNCTION>change_managed()</FUNCTION>
method once.
</PARA>
</REFSECT1>
<REFSECT1 ID="R1-1007-UNMANAGECHILDREN-3">
<TITLE>Algorithm
</TITLE>
<PARA><FUNCTION>XtUnmanageChildren()</FUNCTION> performs the following:
</PARA>
<VARIABLELIST>
<VARLISTENTRY>
<TERM>&bull;
</TERM>
<LISTITEM>
<PARA>Issues an error if the children do not all have the same
parent or if the parent is not a subclass of
<CLASSNAME>compositeWidgetClass</CLASSNAME>.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM>&bull;
</TERM>
<LISTITEM>
<PARA>Returns immediately if the common parent is being destroyed;
otherwise, for each unique child on the list,
<FUNCTION>XtUnmanageChildren()</FUNCTION> performs the following:
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM>-
</TERM>
<LISTITEM>
<PARA>Ignores the child if it already is unmanaged or is being
destroyed.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM>-
</TERM>
<LISTITEM>
<PARA>Otherwise, if the child is realized, it makes it nonvisible
by unmapping it.
</PARA>
</LISTITEM>
</VARLISTENTRY>
<VARLISTENTRY>
<TERM>&bull;
</TERM>
<LISTITEM>
<PARA>Calls the <FUNCTION>change_managed()</FUNCTION> method of the widgets'
parent if the parent is realized.
</PARA>
</LISTITEM>
</VARLISTENTRY>
</VARIABLELIST>
<PARA>
</PARA>
</REFSECT1>
<REFSECT1 ID="R1-1007-UNMANAGECHILDREN-4">
<TITLE>Structures
</TITLE>
<PARA>The <TYPE>WidgetList</TYPE> type is simply an array of widgets:
</PARA>
<SCREEN ID="SC-1007-UNMANAGECHILDREN-1">typedef Widget *WidgetList;
</SCREEN>
</REFSECT1></REFENTRY>
]]>

</programlisting>

</RefSect1>
]]>

</RefEntry>