1
.\" $Xorg: XtAppInit.man,v 1.3 2000/08/17 19:41:58 cpqbld Exp $
3
.\" Copyright (c) 1993, 1994 X Consortium
5
.\" Permission is hereby granted, free of charge, to any person obtaining a
6
.\" copy of this software and associated documentation files (the "Software"),
7
.\" to deal in the Software without restriction, including without limitation
8
.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
9
.\" and/or sell copies of the Software, and to permit persons to whom the
10
.\" Software furnished to do so, subject to the following conditions:
12
.\" The above copyright notice and this permission notice shall be included in
13
.\" all copies or substantial portions of the Software.
15
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18
.\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
19
.\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
20
.\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
.\" Except as contained in this notice, the name of the X Consortium shall not
24
.\" be used in advertising or otherwise to promote the sale, use or other
25
.\" dealing in this Software without prior written authorization from the
28
.\" $XFree86: xc/doc/man/Xt/XtAppInit.man,v 1.4 2001/03/04 00:04:25 tsi Exp $
31
.ds xT X Toolkit Intrinsics \- C Language Interface
33
.ds xW X Toolkit Athena Widgets \- C Language Interface
34
.ds xL Xlib \- C Language X Interface
35
.ds xC Inter-Client Communication Conventions Manual
38
.hw XtApp-Initialize XtVa-App-Initialize
45
.\".if \\n(VS>=40 .vs \\n(VSu
46
.\".if \\n(VS<=39 .vs \\n(VSp
69
.de IN \" send an index entry to the stderr
76
.\" choose appropriate monospace font
77
.\" the imagen conditional, 480,
78
.\" may be changed to L if LB is too
79
.\" heavy for your eyes...
81
.ie "\\*(.T"480" .ft L
82
.el .ie "\\*(.T"300" .ft L
83
.el .ie "\\*(.T"202" .ft PO
84
.el .ie "\\*(.T"aps" .ft CW
87
.ie \\n(VS>40 .vs \\n(VSu
95
.ie t \\$1\fB\^\\$2\^\fR\\$3
96
.el \\$1\fI\^\\$2\^\fP\\$3
99
.ie t \fB\^\\$1\^\fR\\$2
100
.el \fI\^\\$1\^\fP\\$2
105
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
106
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
120
. \" Note End -- doug kraft 3/85
129
.TH XtAppInitialize 3Xt __xorgversion__ "XT FUNCTIONS"
131
XtAppInitialize, XtVaAppInitialize \- initialize, open, or close a display
133
Widget XtAppInitialize(\fIapp_context_return\fP, \fIapplication_class\fP,
134
\fIoptions\fP, \fInum_options\fP, \fIargc_in_out\fP, \fIargv_in_out\fP,
135
\fIfallback_resources\fP, \fIargs\fP, \fInum_args\fP)
137
XtAppContext* \fIapp_context_return\fP;
139
String \fIapplication_class\fP;
141
XrmOptionDescRec* \fIoptions\fP;
143
Cardinal \fInum_options\fP;
145
int* \fIargc_in_out\fP;
147
String* \fIargv_in_out\fP;
149
String* \fIfallback_resources\fP;
153
Cardinal \fInum_args\fP;
155
Widget XtVaAppInitialize(\fIapp_context_return\fP, \fIapplication_class\fP,
156
\fIoptions\fP, \fInum_options\fP, \fIargc_in_out\fP, \fIargv_in_out\fP,
157
\fIfallback_resources\fP, ...)
159
XtAppContext* \fIapp_context_return\fP;
161
String \fIapplication_class\fP;
163
XrmOptionDescRec* \fIoptions\fP;
165
Cardinal \fInum_options\fP;
167
int* \fIargc_in_out\fP;
169
String* \fIargv_in_out\fP;
171
String* \fIfallback_resources\fP;
173
.IP \fIapp_context_return\fP 1i
174
Specifies the application context.
175
.ds Ac , which usually is the generic name for all instances of this application
176
.IP \fIapplication_class\fP 1i
177
Specifies the class name of this application\*(Ac.
179
Specifies how to parse the command line for any application-specific resources.
180
The options argument is passed as a parameter to
181
.ZN XrmParseCommand .
182
For further information,
184
.IP \fInum_options\fP 1i
185
Specifies the number of entries in the options list.
186
.IP \fIargc_in_out\fP 1i
187
Specifies a pointer to the number of command line parameters.
188
.IP \fIargv_in_out\fP 1i
189
Specifies the command line parameters.
190
.IP \fIfallback_resources\fP 1i
191
Specifies resource valus to be used if the application class resource
192
file cannot be opened or read, or NULL.
194
Specifies the argument list to override any other resource specification
195
for the created shell widget.
196
.IP \fInum_args\fP 1i
197
Specifies the number of entries in the argument list.
199
Specifies the variable argument list to override any other resource
200
specification for the created shell widget.
205
.ZN XtToolkitInitialize
207
.ZN XtCreateApplicationContext ,
210
with \fIdisplay_string\fP NULL and \fIapplication_name\fP NULL, and
213
with \fIapplication_name\fP NULL, \fIwidget_class\fP
214
.ZN applicationShellWidgetClass ,
215
and the specified \fIargs\fP and \fInum_args\fP and returns the
216
created shell. The modified \fIargc\fP and \fIargv\fP returned by
217
.ZN XtDisplayInitialize
218
are returned in \fIargc_in_out\fP and \fIargv_in_out\fP. If
219
\fIapp_context_return\fP is not NULL, the created application context
220
is also returned. If the display specified by the command line cannot
221
be opened, an error message is issued and
223
terminates the application. If \fIfallback_resources\fP is non-NULL,
224
.ZN XtAppSetFallbackResources
225
is called with the value prior to calling
228
XtAppInitialize and XtVaAppInitialize have been superceded by
229
.ZN XtOpenApplication
231
.ZN XtVaOpenApplication
234
XtOpenApplication(3Xt), XtVaOpenApplication(3Xt)