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

NAME

6       XmFrame — The Frame widget class
7

SYNOPSIS

9       #include <Xm/Frame.h>
10

DESCRIPTION

12       Frame is a very simple manager used to enclose a single work area child
13       in a border drawn by Frame.  It uses the Manager  class  resources  for
14       border drawing and performs geometry management so that its size always
15       matches its child's outer size plus  the  Frame's  margins  and  shadow
16       thickness.
17
18       Frame is most often used to enclose other managers when the application
19       developer wants the manager to have the same border appearance  as  the
20       primitive  widgets. Frame can also be used to enclose primitive widgets
21       that do not support the same type of border drawing. This gives  visual
22       consistency  when  you  develop applications using diverse widget sets.
23       Constraint resources are used to designate a child as the Frame  title,
24       align  its  text,  and  control  its  vertical alignment in relation to
25       Frame's top shadow. The title appears only at the top of the Frame.
26
27       If the Frame's parent is a Shell  widget,  the  XmNshadowType  resource
28       defaults to XmSHADOW_OUT, and the Manager's XmNshadowThickness resource
29       defaults to 1.
30
31       If the Frame's parent is not a Shell widget, the XmNshadowType  resouce
32       defaults  to  XmSHADOW_ETCHED_IN,  and the Manager's XmNshadowThickness
33       resource defaults to 2.
34
35   Classes
36       Frame inherits behavior and resources from the  Core,  Composite,  Con‐
37       straint, and XmManager classes.
38
39       The class pointer is xmFrameWidgetClass.
40
41       The class name is XmFrame.
42
43   New Resources
44       The  following table defines a set of widget resources used by the pro‐
45       grammer to specify data. The programmer can also set the resource  val‐
46       ues  for  the  inherited  classes to set attributes for this widget. To
47       reference a resource by name or by class in a .Xdefaults  file,  remove
48       the  XmN or XmC prefix and use the remaining letters. To specify one of
49       the defined values for a resource in a .Xdefaults file, remove  the  Xm
50       prefix and use the remaining letters (in either lowercase or uppercase,
51       but include any underscores between words).  The codes  in  the  access
52       column  indicate if the given resource can be set at creation time (C),
53       set by using XtSetValues (S), retrieved by using XtGetValues (G), or is
54       not applicable (N/A).
55
56       ┌─────────────────────────────────────────────────────────────────────┐
57       │                │       XmFrame Re│source Set      │         │        │
58Name            Class           Type          Default Access 
59       ├────────────────┼─────────────────┼───────────────┼─────────┼────────┤
60       │XmNmarginWidth  │ XmCMarginWidth  │ Dimension     │ 0       │ CSG    │
61       ├────────────────┼─────────────────┼───────────────┼─────────┼────────┤
62       │XmNmarginHeight │ XmCMarginHeight │ Dimension     │ 0       │ CSG    │
63       ├────────────────┼─────────────────┼───────────────┼─────────┼────────┤
64       │XmNshadowType   │ XmCShadowType   │ unsigned char │ dynamic │ CSG    │
65       ├────────────────┼─────────────────┼───────────────┼─────────┼────────┤
66       └────────────────┴─────────────────┴───────────────┴─────────┴────────┘
67       XmNmarginWidth
68                 Specifies  the  padding  space  on  the  left and right sides
69                 between Frame's child and Frame's shadow drawing.
70
71       XmNmarginHeight
72                 Specifies the padding space  on  the  top  and  bottom  sides
73                 between  Frame's  child  and  Frame's shadow drawing.  When a
74                 title is present, the top margin equals the  value  specified
75                 by  this  resource  plus the distance (if any) that the title
76                 extends below the top shadow.
77
78       XmNshadowType
79                 Describes the drawing style for Frame. This resource can have
80                 the following values:
81
82                 XmSHADOW_IN
83                           Draws  Frame  so that it appears inset.  This means
84                           that the bottom shadow visuals and top shadow visu‐
85                           als are reversed.
86
87                 XmSHADOW_OUT
88                           Draws Frame so that it appears outset.  This is the
89                           default if Frame's parent is a Shell widget.
90
91                 XmSHADOW_ETCHED_IN
92                           Draws Frame using a double line giving  the  effect
93                           of  a line etched into the window. The thickness of
94                           the double line is equal to the value  of  XmNshad‐
95                           owThickness.  This is the default when Frame's par‐
96                           ent is not a Shell widget.
97
98                 XmSHADOW_ETCHED_OUT
99                           Draws Frame using a double line giving  the  effect
100                           of  a  line coming out of the window. The thickness
101                           of the double line is equal to the  value  of  XmN‐
102                           shadowThickness.
103
104       ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
105       │                            │         XmFrame Constraint R│esource Set     │                        │        │
106Name                        Class                       Type          Default                Access 
107       ├────────────────────────────┼─────────────────────────────┼───────────────┼────────────────────────┼────────┤
108       │XmNchildType                │ XmCChildType                │ unsigned char │ XmFRAME_WORKAREA_CHILD │ CSG    │
109       ├────────────────────────────┼─────────────────────────────┼───────────────┼────────────────────────┼────────┤
110       │XmNchildHorizontalAlignment │ XmCChildHorizontalAlignment │ unsigned char │ XmALIGNMENT_BEGINNING  │ CSG    │
111       ├────────────────────────────┼─────────────────────────────┼───────────────┼────────────────────────┼────────┤
112       │XmNchildHorizontalSpacing   │ XmCChildHorizontalSpacing   │ Dimension     │ dynamic                │ CSG    │
113       ├────────────────────────────┼─────────────────────────────┼───────────────┼────────────────────────┼────────┤
114       │XmNchildVerticalAlignment   │ XmCChildVerticalAlignment   │ unsigned char │ XmALIGNMENT_CENTER     │ CSG    │
115       ├────────────────────────────┼─────────────────────────────┼───────────────┼────────────────────────┼────────┤
116       │XmNframeChildType           │ XmCFrameChildType           │ unsigned char │ XmFRAME_WORKAREA_CHILD │ CSG    │
117       ├────────────────────────────┼─────────────────────────────┼───────────────┼────────────────────────┼────────┤
118       └────────────────────────────┴─────────────────────────────┴───────────────┴────────────────────────┴────────┘
119       XmNchildType
120                 Refer to the XmNframeChildType resource description. The XmN‐
121                 childType resource is obsoleted by XmNframeChildType, but  is
122                 kept here for backward compatibility.
123
124       XmNchildHorizontalAlignment
125                 Specifies  the  alignment of the title. This resource has the
126                 following values:
127
128                    ·  XmALIGNMENT_BEGINNING
129
130                    ·  XmALIGNMENT_CENTER
131
132                    ·  XmALIGNMENT_END
133
134                 See the description of XmNalignment in the XmLabel  reference
135                 page for an explanation of these values.
136
137       XmNchildHorizontalSpacing
138                 Specifies  the  minimum  distance  between either edge of the
139                 title text and the inner edge of the Frame  shadow.  Clipping
140                 of  the  title text occurs in order to maintain this spacing.
141                 The default value is the margin width of the Frame.
142
143       XmNchildVerticalAlignment
144                 Specifies the vertical alignment of the title  text,  or  the
145                 title area in relation to the top shadow of the Frame.
146
147                 XmALIGNMENT_BASELINE_BOTTOM
148                           Causes  the  baseline  of the title to align verti‐
149                           cally with the top shadow of the Frame. In the case
150                           of  a  multi-line  title,  the baseline of the last
151                           line of text aligns vertically with the top  shadow
152                           of the Frame.
153
154                 XmALIGNMENT_BASELINE_TOP
155                           Causes  the baseline of the first line of the title
156                           to align vertically with  the  top  shadow  of  the
157                           Frame.
158
159                 XmALIGNMENT_CHILD_TOP
160                           Causes the top edge of the title area to align ver‐
161                           tically with the top shadow of the Frame.
162
163                 XmALIGNMENT_CENTER
164                           Causes the center of the title area to align verti‐
165                           cally with the top shadow of the Frame.
166
167                 XmALIGNMENT_CHILD_BOTTOM
168                           Causes  the  bottom edge of the title area to align
169                           vertically with the top shadow of the Frame.
170
171       XmNframeChildType
172                 Specifies whether a child is a title or work area. Frame sup‐
173                 ports  a  single  title  and/or work area child. The possible
174                 values are
175
176                    ·  XmFRAME_TITLE_CHILD
177
178                    ·  XmFRAME_WORKAREA_CHILD
179
180                    ·  XmFRAME_GENERIC_CHILD
181
182                 The  Frame  geometry  manager  ignores  any  child  of   type
183                 XmFRAME_GENERIC_CHILD.  This resource replaces XmNchildType.
184
185   Inherited Resources
186       Frame  inherits behavior and resources from the following superclasses.
187       For a complete description of each resource,  refer  to  the  reference
188       page for that superclass.
189
190       ┌────────────────────────────────────────────────────────────────────────────────────────────────────┐
191       │                        │             XmManager │Resource Set        │                      │        │
192Name                    Class                 Type              Default              Access 
193       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
194       │XmNbottomShadowColor    │ XmCBottomShadowColor  │ Pixel             │ dynamic              │ CSG    │
195       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
196       │XmNbottomShadowPixmap   │ XmCBottomShadowPixmap │ Pixmap            │ XmUNSPECIFIED_PIXMAP │ CSG    │
197       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
198       │XmNforeground           │ XmCForeground         │ Pixel             │ dynamic              │ CSG    │
199       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
200       │XmNhelpCallback         │ XmCCallback           │ XtCallbackList    │ NULL                 │ C      │
201       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
202       │XmNhighlightColor       │ XmCHighlightColor     │ Pixel             │ dynamic              │ CSG    │
203       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
204       │XmNhighlightPixmap      │ XmCHighlightPixmap    │ Pixmap            │ dynamic              │ CSG    │
205       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
206       │XmNinitialFocus         │ XmCInitialFocus       │ Widget            │ NULL                 │ CSG    │
207       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
208       │XmNlayoutDirection      │ XmCLayoutDirection    │ XmDirection       │ dynamic              │ CG     │
209       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
210       │XmNnavigationType       │ XmCNavigationType     │ XmNavigationType  │ XmTAB_GROUP          │ CSG    │
211       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
212       │XmNpopupHandlerCallback │ XmCCallback           │ XtCallbackList    │ NULL                 │ C      │
213       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
214       │XmNshadowThickness      │ XmCShadowThickness    │ Dimension         │ dynamic              │ CSG    │
215       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
216       │XmNstringDirection      │ XmCStringDirection    │ XmStringDirection │ dynamic              │ CG     │
217       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
218       │XmNtopShadowColor       │ XmCTopShadowColor     │ Pixel             │ dynamic              │ CSG    │
219       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
220       │XmNtopShadowPixmap      │ XmCTopShadowPixmap    │ Pixmap            │ dynamic              │ CSG    │
221       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
222       │XmNtraversalOn          │ XmCTraversalOn        │ Boolean           │ True                 │ CSG    │
223       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
224       │XmNunitType             │ XmCUnitType           │ unsigned char     │ dynamic              │ CSG    │
225       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
226       │XmNuserData             │ XmCUserData           │ XtPointer         │ NULL                 │ CSG    │
227       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
228       └────────────────────────┴───────────────────────┴───────────────────┴──────────────────────┴────────┘
229       ┌───────────────────────────────────────────────────────────────────────┐
230       │                  │     Composite Reso│urce Set      │         │        │
231Name              Class             Type        Default Access 
232       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
233       │XmNchildren       │ XmCReadOnly       │ WidgetList  │ NULL    │ G      │
234       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
235       │XmNinsertPosition │ XmCInsertPosition │ XtOrderProc │ NULL    │ CSG    │
236       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
237       │XmNnumChildren    │ XmCReadOnly       │ Cardinal    │ 0       │ G      │
238       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
239       └──────────────────┴───────────────────┴─────────────┴─────────┴────────┘
240       ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
241       │                              │               Core Resource Se│t                │                      │        │
242Name                          Class                         Type           Default              Access 
243       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
244       │XmNaccelerators               │ XmCAccelerators               │ XtAccelerators │ dynamic              │ CSG    │
245       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
246       │XmNancestorSensitive          │ XmCSensitive                  │ Boolean        │ dynamic              │ G      │
247       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
248       │XmNbackground                 │ XmCBackground                 │ Pixel          │ dynamic              │ CSG    │
249       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
250       │XmNbackgroundPixmap           │ XmCPixmap                     │ Pixmap         │ XmUNSPECIFIED_PIXMAP │ CSG    │
251       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
252       │XmNborderColor                │ XmCBorderColor                │ Pixel          │ XtDefaultForeground  │ CSG    │
253       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
254       │XmNborderPixmap               │ XmCPixmap                     │ Pixmap         │ XmUNSPECIFIED_PIXMAP │ CSG    │
255       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
256       │XmNborderWidth                │ XmCBorderWidth                │ Dimension      │ 0                    │ CSG    │
257       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
258       │XmNcolormap                   │ XmCColormap                   │ Colormap       │ dynamic              │ CG     │
259       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
260       │XmNdepth                      │ XmCDepth                      │ int            │ dynamic              │ CG     │
261       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
262       │XmNdestroyCallback            │ XmCCallback                   │ XtCallbackList │ NULL                 │ C      │
263       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
264       │XmNheight                     │ XmCHeight                     │ Dimension      │ dynamic              │ CSG    │
265       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
266       │XmNinitialResourcesPersistent │ XmCInitialResourcesPersistent │ Boolean        │ True                 │ C      │
267       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
268       │XmNmappedWhenManaged          │ XmCMappedWhenManaged          │ Boolean        │ True                 │ CSG    │
269       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
270       │XmNscreen                     │ XmCScreen                     │ Screen *       │ dynamic              │ CG     │
271       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
272       │XmNsensitive                  │ XmCSensitive                  │ Boolean        │ True                 │ CSG    │
273       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
274       │XmNtranslations               │ XmCTranslations               │ XtTranslations │ dynamic              │ CSG    │
275       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
276       │XmNwidth                      │ XmCWidth                      │ Dimension      │ dynamic              │ CSG    │
277       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
278       │XmNx                          │ XmCPosition                   │ Position       │ 0                    │ CSG    │
279       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
280       │XmNy                          │ XmCPosition                   │ Position       │ 0                    │ CSG    │
281       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
282       └──────────────────────────────┴───────────────────────────────┴────────────────┴──────────────────────┴────────┘
283   Translations
284       XmFrame inherits translations from XmManager.
285
287       Composite(3),  Constraint(3),  Core(3), XmCreateFrame(3), XmManager(3),
288       XmVaCreateFrame(3), and XmVaCreateManagedFrame(3).
289
290
291
292                                                         XmFrame(library call)
Impressum