1Shell(library call)                                        Shell(library call)
2
3
4

NAME

6       Shell — The Shell widget class
7

SYNOPSIS

9       #include <Xm/Xm.h>
10       #include <X11/Shell.h>
11

DESCRIPTION

13       Shell is a top-level widget (with only one managed child) that encapsu‐
14       lates the interaction with the window manager.
15
16       At the time the shell's child is managed, the child's width is used for
17       both widgets if the shell is unrealized and no width has been specified
18       for the shell. Otherwise, the shell's width is used for  both  widgets.
19       The same relations hold for the height of the shell and its child.
20
21   Classes
22       Shell inherits behavior and resources from Composite and Core.
23
24       The class pointer is shellWidgetClass.
25
26       The class name is Shell.
27
28   New Resources
29       The  following table defines a set of widget resources used by the pro‐
30       grammer to specify data. The programmer can also set the resource  val‐
31       ues  for  the  inherited  classes to set attributes for this widget. To
32       reference a resource by name or by class in a .Xdefaults  file,  remove
33       the  XmN or XmC prefix and use the remaining letters. To specify one of
34       the defined values for a resource in a .Xdefaults file, remove  the  Xm
35       prefix and use the remaining letters (in either lowercase or uppercase,
36       but include any underscores between words).  The codes  in  the  access
37       column  indicate if the given resource can be set at creation time (C),
38       set by using XtSetValues (S), retrieved by using XtGetValues (G), or is
39       not applicable (N/A).
40
41       ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐
42       │                        │                Shell Res│ource Set                │                │        │
43Name                    Class                   Type                   Default        Access 
44       ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
45       │XmNallowShellResize     │ XmCAllowShellResize     │ Boolean                │ False          │ CG     │
46       ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
47       │XmNcreatePopupChildProc │ XmCCreatePopupChildProc │ XtCreatePopupChildProc │ NULL           │ CSG    │
48       ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
49       │XmNgeometry             │ XmCGeometry             │ String                 │ NULL           │ CSG    │
50       ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
51       │XmNoverrideRedirect     │ XmCOverrideRedirect     │ Boolean                │ False          │ CSG    │
52       ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
53       │XmNpopdownCallback      │ XmCCallback             │ XtCallbackList         │ NULL           │ C      │
54       ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
55       │XmNpopupCallback        │ XmCCallback             │ XtCallbackList         │ NULL           │ C      │
56       ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
57       │XmNsaveUnder            │ XmCSaveUnder            │ Boolean                │ False          │ CSG    │
58       ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
59       │XmNvisual               │ XmCVisual               │ Visual *               │ CopyFromParent │ CSG    │
60       ├────────────────────────┼─────────────────────────┼────────────────────────┼────────────────┼────────┤
61       └────────────────────────┴─────────────────────────┴────────────────────────┴────────────────┴────────┘
62       XmNallowShellResize
63                 Specifies  that  if  this resource is False, the Shell widget
64                 instance returns XtGeometryNo to all geometry  requests  from
65                 its  children.  All Motif convenience create dialog functions
66                 override this default value and  set  XmNallowShellResize  to
67                 True.
68
69       XmNcreatePopupChildProc
70                 Specifies  the  pointer to a function that is called when the
71                 Shell widget instance is popped up by XtPopup.  The  function
72                 creates  the child widget when the shell is popped up instead
73                 of when the application starts up.  This can be used  if  the
74                 child  needs to be reconfigured each time the shell is popped
75                 up.  The function takes one argument, the  popup  shell,  and
76                 returns  no  result.   It is called after the popup callbacks
77                 specified by XmNpopupCallback.
78
79       XmNgeometry
80                 Specifies the desired geometry for the widget instance.  This
81                 resource is examined only when the widget instance is unreal‐
82                 ized and the number of its managed children is changed. It is
83                 used  to  change  the values of the XmNx, XmNy, XmNwidth, and
84                 XmNheight resources.  When  XtGetValues  is  called  on  this
85                 resource,  the  returned  value  is  a  pointer to the actual
86                 resource value and should not be  freed.  In  addition,  this
87                 resource  is  not  copied  on creation or by XtSetValues. The
88                 application must ensure that the string remains  valid  until
89                 the shell is realized.
90
91       XmNoverrideRedirect
92                 If  True,  specifies  that the widget instance is a temporary
93                 window that should be ignored by the window manager. Applica‐
94                 tions and users should not normally alter this resource.
95
96       XmNpopdownCallback
97                 Specifies  a list of callbacks that is called when the widget
98                 instance is popped down by XtPopdown.
99
100       XmNpopupCallback
101                 Specifies a list of callbacks that is called when the  widget
102                 instance  is  popped  up  by XtPopup.  The second argument to
103                 XtPopup must be XtGrabNone.
104
105       XmNsaveUnder
106                 If True, specifies that it is desirable to save the  contents
107                 of  the  screen beneath this widget instance, avoiding expose
108                 events when the instance is unmapped. This is a hint, and  an
109                 implementation may save contents whenever it desires, includ‐
110                 ing always or never.
111
112       XmNvisual Specifies the visual used in creating the widget.
113
114   Inherited Resources
115       Shell inherits behavior and resources from the superclass described  in
116       the  following  table.   For  a  complete description of each resource,
117       refer to the reference page for that superclass.
118
119       ┌───────────────────────────────────────────────────────────────────────┐
120       │                  │     Composite Reso│urce Set      │         │        │
121Name              Class             Type        Default Access 
122       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
123       │XmNchildren       │ XmCReadOnly       │ WidgetList  │ NULL    │ G      │
124       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
125       │XmNinsertPosition │ XmCInsertPosition │ XtOrderProc │ NULL    │ CSG    │
126       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
127       │XmNnumChildren    │ XmCReadOnly       │ Cardinal    │ 0       │ G      │
128       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
129       └──────────────────┴───────────────────┴─────────────┴─────────┴────────┘
130       ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
131       │                              │               Core Resource Se│t                │                      │        │
132Name                          Class                         Type           Default              Access 
133       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
134       │XmNaccelerators               │ XmCAccelerators               │ XtAccelerators │ dynamic              │ CSG    │
135       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
136       │XmNancestorSensitive          │ XmCSensitive                  │ Boolean        │ dynamic              │ G      │
137       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
138       │XmNbackground                 │ XmCBackground                 │ Pixel          │ dynamic              │ CSG    │
139       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
140       │XmNbackgroundPixmap           │ XmCPixmap                     │ Pixmap         │ XmUNSPECIFIED_PIXMAP │ CSG    │
141       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
142       │XmNborderColor                │ XmCBorderColor                │ Pixel          │ XtDefaultForeground  │ CSG    │
143       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
144       │XmNborderPixmap               │ XmCPixmap                     │ Pixmap         │ XmUNSPECIFIED_PIXMAP │ CSG    │
145       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
146       │XmNborderWidth                │ XmCBorderWidth                │ Dimension      │ 0                    │ CSG    │
147       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
148       │XmNcolormap                   │ XmCColormap                   │ Colormap       │ dynamic              │ CG     │
149       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
150       │XmNdepth                      │ XmCDepth                      │ int            │ dynamic              │ CG     │
151       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
152       │XmNdestroyCallback            │ XmCCallback                   │ XtCallbackList │ NULL                 │ C      │
153       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
154       │XmNheight                     │ XmCHeight                     │ Dimension      │ dynamic              │ CSG    │
155       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
156       │XmNinitialResourcesPersistent │ XmCInitialResourcesPersistent │ Boolean        │ True                 │ C      │
157       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
158       │XmNmappedWhenManaged          │ XmCMappedWhenManaged          │ Boolean        │ True                 │ CSG    │
159       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
160       │XmNscreen                     │ XmCScreen                     │ Screen *       │ dynamic              │ CG     │
161       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
162       │XmNsensitive                  │ XmCSensitive                  │ Boolean        │ True                 │ CSG    │
163       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
164       │XmNtranslations               │ XmCTranslations               │ XtTranslations │ dynamic              │ CSG    │
165       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
166       │XmNwidth                      │ XmCWidth                      │ Dimension      │ dynamic              │ CSG    │
167       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
168       │XmNx                          │ XmCPosition                   │ Position       │ 0                    │ CSG    │
169       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
170       │XmNy                          │ XmCPosition                   │ Position       │ 0                    │ CSG    │
171       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
172       └──────────────────────────────┴───────────────────────────────┴────────────────┴──────────────────────┴────────┘
173   Translations
174       There are no translations for Shell.
175
177       Composite(3) and Core(3).
178
179
180
181                                                           Shell(library call)
Impressum