Merge branch 'devel/upgrade' into tizen
[platform/upstream/libXt.git] / man / XtInitialize.man
1 .\" Copyright (c) 1993, 1994  X Consortium
2 .\"
3 .\" Permission is hereby granted, free of charge, to any person obtaining a
4 .\" copy of this software and associated documentation files (the "Software"),
5 .\" to deal in the Software without restriction, including without limitation
6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
7 .\" and/or sell copies of the Software, and to permit persons to whom the
8 .\" Software furnished to do so, subject to the following conditions:
9 .\"
10 .\" The above copyright notice and this permission notice shall be included in
11 .\" all copies or substantial portions of the Software.
12 .\"
13 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
16 .\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
17 .\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
18 .\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19 .\" SOFTWARE.
20 .\"
21 .\" Except as contained in this notice, the name of the X Consortium shall not
22 .\" be used in advertising or otherwise to promote the sale, use or other
23 .\" dealing in this Software without prior written authorization from the
24 .\" X Consortium.
25 .\"
26 .ds tk X Toolkit
27 .ds xT X Toolkit Intrinsics \- C Language Interface
28 .ds xI Intrinsics
29 .ds xW X Toolkit Athena Widgets \- C Language Interface
30 .ds xL Xlib \- C Language X Interface
31 .ds xC Inter-Client Communication Conventions Manual
32 .ds Rn 3
33 .ds Vn 2.2
34 .hw Xt-Initialize
35 .na
36 .de Ds
37 .nf
38 .\\$1D \\$2 \\$1
39 .ft CW
40 .ps \\n(PS
41 .\".if \\n(VS>=40 .vs \\n(VSu
42 .\".if \\n(VS<=39 .vs \\n(VSp
43 ..
44 .de De
45 .ce 0
46 .if \\n(BD .DF
47 .nr BD 0
48 .in \\n(OIu
49 .if \\n(TM .ls 2
50 .sp \\n(DDu
51 .fi
52 ..
53 .de IN          \" send an index entry to the stderr
54 ..
55 .de Pn
56 .ie t \\$1\fB\^\\$2\^\fR\\$3
57 .el \\$1\fI\^\\$2\^\fP\\$3
58 ..
59 .de ZN
60 .ie t \fB\^\\$1\^\fR\\$2
61 .el \fI\^\\$1\^\fP\\$2
62 ..
63 .ny0
64 .TH XtInitialize __libmansuffix__ __xorgversion__ "XT COMPATIBILITY FUNCTIONS"
65 .SH NAME
66 XtInitialize \- initialize
67 .SH SYNTAX
68 .HP
69 Widget XtInitialize(String \fIshell_name\fP, String \fIapplication_class\fP,
70 XrmOptionDescRec* \fIoptions\fP, Cardinal \fInum_options\fP, int* \fIargc\fP,
71 char** \fIargv\fP);
72 .SH ARGUMENTS
73 .IP \fIshell_name\fP 1i
74 Specifies the name of the created shell widget.
75 .ds Ac , which usually is the generic name for all instances of this application
76 .IP \fIapplication_class\fP 1i
77 Specifies the class name of this application\*(Ac.
78 .IP \fIoptions\fP 1i
79 Specifies how to parse the command line for any application-specific resources.
80 The options argument is passed as a parameter to
81 .ZN XrmParseCommand .
82 For further information,
83 see \fI\*(xL\fP.
84 .IP \fInum_options\fP 1i
85 Specifies the number of entries in the options list.
86 .IP \fIargc\fP 1i
87 Specifies a pointer to the number of command line parameters.
88 .IP \fIargv\fP 1i
89 Specifies the command line parameters.
90 .SH DESCRIPTION
91 .ZN XtInitialize
92 calls
93 .ZN XtToolkitInitialize
94 followed by
95 .ZN XtOpenDisplay
96 with \fIdisplay_string\fP NULL and \fIapplication_name\fP NULL, and
97 finally calls
98 .ZN XtAppCreateShell
99 with \fIapplication_name\fP NULL, \fIwidget_class\fP
100 .ZN applicationShellWidgetClass ,
101 and the specified \fIargs\fP and \fInum_args\fP and returns the
102 created shell. The semantics of calling
103 .ZN XtInitialize
104 more than once are undefined. This routine has been replaced by
105 .ZN XtAppInitialize .
106 .SH "SEE ALSO"
107 .BR XtAppInitialize (__libmansuffix__)
108 .br
109 \fI\*(xT\fP
110 .br
111 \fI\*(xL\fP