XtAppCreateShell.man   [plain text]

.\" $Xorg: XtAppCSh.man,v 1.3 2000/08/17 19:41:58 cpqbld Exp $
.\"
.\" 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.
.\"
.\" $XFree86: xc/doc/man/Xt/XtAppCSh.man,v 1.3 2001/02/09 03:47:49 tsi Exp $
.\"
.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 XtApp-Create-Shell XtVa-App-Create-Shell wid-get
.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 XtAppCreateShell __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
.SH NAME
XtAppCreateShell, XtVaAppCreateShell \- create top-level widget instance
.SH SYNTAX
.HP
Widget XtAppCreateShell(String \fIapplication_name\fP, String
\fIapplication_class\fP, WidgetClass \fIwidget_class\fP, Display
*\fIdisplay\fP, ArgList \fIargs\fP, Cardinal \fInum_args\fP); 
.HP
Widget XtVaAppCreateShell(String \fIapplication_name\fP, String
\fIapplication_class\fP, WidgetClass \fIwidget_class\fP, Display
*\fIdisplay\fP, ...\^); 
.SH ARGUMENTS
.IP \fIapplication_name\fP 1i
Specifies the name of the application instance.
.IP \fIapplication_class\fP 1i
Specifies the class name of this application\*(Ac.
.ds Wc \ that the application top-level widget should be
.IP \fIwidget_class\fP 1i
Specifies the widget class\*(Wc.
.ds Di \ from which to get the resources
.IP \fIdisplay\fP 1i
Specifies the display\*(Di.
.IP \fIargs\fP 1i
Specifies the argument list\*(Di.
.IP \fInum_args\fP 1i
Specifies the number of arguments in the argument list.
.IP \fI...\fP 1i
Specifies the variable argument list\*(Di.
.SH DESCRIPTION
The
.ZN XtAppCreateShell
function saves the specified application name and application class 
for qualifying all widget resource specifiers.
The application name and application class are used as the left-most components
in all widget resource names for this application.
.ZN XtAppCreateShell
should be used to create a new logical application within a program
or to create a shell on another display.
In the first case, 
it allows the specification of a new root in the resource hierarchy.
In the second case,
it uses the resource database associated with the other display.
.LP
Note that the widget returned by
.ZN XtAppCreateShell
has the \s-1WM_COMMAND\s+1
property set for session managers (see Chapter 4).
.SH "SEE ALSO"
XtCreateWidget(3Xt)
.br
\fI\*(xT\fP
.br
\fI\*(xL\fP