path: root/man/XtOpenApplication.man

.\" Copyright (c) 1993, 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 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 
.\" dealing in this Software without prior written authorization from the 
.\" X Consortium.
.\"
.ds tk X Toolkit
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xI Intrinsics
.ds xW X Toolkit Athena Widgets \- C Language Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
.ds Rn 3
.ds Vn 2.2
.hw XtOpen-Application XtVa-Open-Application
.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 XtOpenApplication __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
.SH NAME
XtOpenApplication, XtVaOpenApplication \- initialize, open, or close a display
.SH SYNTAX
.HP
Widget XtOpenApplication(XtAppContext *\fIapp_context_return\fP, String
\fIapplication_class\fP, XrmOptionDescRec *\fIoptions\fP, Cardinal
\fInum_options\fP, int *\fIargc_in_out\fP, String *\fIargv_in_out\fP, String 
*\fIfallback_resources\fP, WidgetClass \fIwidget_class\fP, ArgList \fIargs\fP,
Cardinal \fInum_args\fP); 
.HP
Widget XtVaOpenApplication(XtAppContext *\fIapp_context_return\fP, String
\fIapplication_class\fP, XrmOptionDescRec *\fIoptions\fP, Cardinal
\fInum_options\fP, int *\fIargc_in_out\fP, String *\fIargv_in_out\fP, String 
*\fIfallback_resources\fP, WidgetClass \fIwidget_class\fP, ...\^); 
.SH ARGUMENTS
.IP \fIapp_context_return\fP 1i
Specifies the application context.
.ds Ac , which usually is the generic name for all instances of this application
.IP \fIapplication_class\fP 1i
Specifies the class name of this application\*(Ac.
.IP \fIoptions\fP 1i
Specifies how to parse the command line for any application-specific resources.
The options argument is passed as a parameter to
.ZN XrmParseCommand .
For further information,
see \fI\*(xL\fP.
.IP \fInum_options\fP 1i
Specifies the number of entries in the options list.
.IP \fIargc_in_out\fP 1i
Specifies a pointer to the number of command line parameters.
.IP \fIargv_in_out\fP 1i
Specifies the command line parameters.
.IP \fIfallback_resources\fP 1i
Specifies resource values to be used if the application class resource
file cannot be opened or read, or NULL.
.IP \fIwidget_class\fP 1i
Specifies the widget class of the shell to be created.
.IP \fIargs\fP 1i
Specifies the argument list to override any other resource specification
for the created shell widget.
.IP \fInum_args\fP 1i
Specifies the number of entries in the argument list.
.IP \fI...\fP 1i
Specifies the variable argument list to override any other resource 
specification for the created shell widget.
.SH DESCRIPTION
The
.ZN XtOpenApplication
function calls
.ZN XtToolkitInitialize
followed by
.ZN XtCreateApplicationContext ,
then calls
.ZN XtOpenDisplay
with \fIdisplay_string\fP NULL and \fIapplication_name\fP NULL, and
finally calls
.ZN XtAppCreateShell
with \fIapplication_name\fP NULL, the specified \fIwidget_class\fP,
and the specified \fIargs\fP and \fInum_args\fP and returns the
created shell. The modified \fIargc\fP and \fIargv\fP returned by
.ZN XtDisplayInitialize
are returned in \fIargc_in_out\fP and \fIargv_in_out\fP. If
\fIapp_context_return\fP is not NULL, the created application context
is also returned. If the display specified by the command line cannot
be opened, an error message is issued and
.ZN XtOpenApplication
terminates the application. If \fIfallback_resources\fP is non-NULL,
.ZN XtAppSetFallbackResources
is called with the value prior to calling
.ZN XtOpenDisplay .
.LP
XtAppInitialize and XtVaAppInitialize have been superceded by
.ZN XtOpenApplication
and
.ZN XtVaOpenApplication
respectively.
.SH "SEE ALSO"
XtAppInitialize(3Xt), XtVaAppInitialize(3Xt)
.br
\fI\*(xT\fP
.br
\fI\*(xL\fP