1LessTif Internal Functions(3)   LessTif Manuals  LessTif Internal Functions(3)
2
3
4

NAME

6       LessTif Internal Functions
7

DESCRIPTION

9       When the LessTif project began some discussion was undertaken about the
10       use of the previously undocumented internal _Xm..  functions  in  Motif
11       1.2.  Apparently many of those functions have been transformed to Xme..
12       functions in OSF/Motif® 2.x and are also documented.   As  many  people
13       use  these  functions  in  their  code  (especially widget writers) the
14       implementation of the _Xm..  functions  is  important  to  the  LessTif
15       project.
16
17       Below is a (outdated!) list of functions currently taken from the Less‐
18       Tif header files.
19

CONVENIENCE FUNCTIONS

21       void _XmCalcLabelDimensions(Widget w);
22
23       Sets the core width and height values to the values needed  to  display
24       the  current  label  contents.  It takes into account the label type as
25       well as all of the margin resources.
26
27       Boolean _XmGetInDragMode(Widget w);
28
29       returns True, if the widget (e.g. push button,...)  resides in  a  menu
30       and the user is currently dragging the mouse with button 1 pressed over
31       the menu items.  This way a widget can  figure  out,  whether  it  must
32       redraw  itself  in  the armed state if the widget gets a PrimitiveEnter
33       action.
34
35       Boolean _XmIsEventUnique(XEvent *event);
36
37       Unknown Function
38
39       Widget _XmGetRC_PopupPosted(Widget w);
40
41       Returns the widget id of the parent  of  the  menu  that  is  currently
42       posted by any of the children of w.  In other words the id of the shell
43       that is cascaded from menu w.
44
45       void _XmRecordEvent(XEvent *event);
46
47       Unknown Function
48
49       void _XmSetInDragMode(Widget w, Boolean flag);
50
51       this is used to enter or leave the dragging mode within the  menu  sys‐
52       tem.
53
54       XmFontListEntry   _XmFontListEntryFromTag(XmFontList   fontlist,   char
55       *tag);
56
57       Unknown Function
58
59       Boolean _XmCreateVisibilityRect(Widget w, XRectangle *rectPtr);
60
61       Unknown Function
62
63       Boolean _XmCvtStringToXmNavigation(Display *, XrmValue *,  Cardinal  *,
64       XrmValue *, XrmValue *, XtPointer *);
65
66       Unknown Function
67
68       Boolean  _XmCvtStringToXmString(Display *, XrmValue *, Cardinal *, Xrm‐
69       Value *, XrmValue *, XtPointer *);
70
71       Unknown Function
72
73       Boolean _XmFocusIsHere(Widget w);
74
75       Unknown Function
76
77       Boolean _XmFocusIsInShell(Widget wid);
78
79       Unknown Function
80
81       Boolean _XmGrabTheFocus(Widget w, XEvent *event);
82
83       Unknown Function
84
85       Boolean _XmIsNavigable(Widget wid);
86
87       Unknown Function
88
89       Boolean  _XmNavigSetValues(Widget  current,  Widget   request,   Widget
90       new_wid, ArgList args, Cardinal *num_args);
91
92       Unknown Function
93
94       Boolean  _XmSearchColorCache(unsigned  int  which, XmColorData *values,
95       XmColorData **ret);
96
97       Unknown Function
98
99       Boolean _XmShellIsExclusive(Widget wid);
100
101       Unknown Function
102
103       Boolean _XmStringsAreEqual()
104
105       Unknown Function
106
107       Pixel _XmAccessColorData(XmColorData *cd, unsigned char which);
108
109       Unknown Function
110
111       Pixel _XmBlackPixel(Screen *screen, Colormap  colormap,  XColor  black‐
112       color);
113
114       Unknown Function
115
116       Pixel  _XmWhitePixel(Screen  *screen,  Colormap colormap, XColor white‐
117       color);
118
119       Unknown Function
120
121       Pixmap _XmGetPixmap();
122
123       Unknown Function
124
125       String _XmGetDefaultBackgroundColorSpec(Screen *screen);
126
127       Unknown Function
128
129       Time __XmGetDefaultTime(Widget w, XEvent *event);
130
131       Unknown Function
132
133       Widget _XmFindNextTabGroup(Widget wid);
134
135       Unknown Function
136
137       Widget _XmFindPrevTabGroup(Widget wid);
138
139       Unknown Function
140
141       Widget _XmFindTopMostShell(Widget w);
142
143       Unknown Function
144
145       Widget _XmGetActiveItem(Widget w);
146
147       Unknown Function
148
149       Widget _XmGetFirstFocus(Widget wid);
150
151       Unknown Function
152
153       Widget _XmNavigate(Widget wid, XmTraversalDirection direction);
154
155       Unknown Function
156
157       XmColorData *_XmAddToColorCache(XmColorData *new_rec);
158
159       Unknown Function
160
161       XmColorData *_XmGetColors(Screen  *screen,  Colormap  color_map,  Pixel
162       background);
163
164       Unknown Function
165
166       XmColorData *_XmGetDefaultColors(Screen *screen, Colormap color_map);
167
168       Unknown Function
169
170       XmFocusData _XmCreateFocusData();
171
172       Unknown Function
173
174       XmFocusData _XmGetFocusData(Widget wid);
175
176       Unknown Function
177
178       XmFontList _XmGetDefaultFontList(Widget w, unsigned char fontListType);
179
180       Unknown Function
181
182       XmGadget _XmInputForGadget(Widget cw, int x, int y);
183
184       Unknown Function
185
186       XmGadget _XmInputInGadget(Widget cw, int x, int y);
187
188       Unknown Function
189
190       char * _XmGetBGPixmapName();
191
192       Unknown Function
193
194       char *_XmConvertCSToString(XmString cs);
195
196       Unknown Function
197
198       int _XmEmptyRect(XRectangle *r);
199
200       Unknown Function
201
202       int  _XmIntersectRect(XRectangle  *srcRectA,  Widget widget, XRectangle
203       *dstRect);
204
205       Unknown Function
206
207       unsigned char _XmGetFocusPolicy(Widget w);
208
209       Unknown Function
210
211       void  _XmBackgroundColorDefault(Widget  widget,  int  offset,  XrmValue
212       *value);
213
214       Unknown Function
215
216       void  _XmBottomShadowColorDefault(Widget  widget,  int offset, XrmValue
217       *value);
218
219       Unknown Function
220
221       void _XmCallFocusMoved(Widget old, Widget new_wid, XEvent *event);
222
223       Unknown Function
224
225       void _XmClearBGPixmap();
226
227       Unknown Function
228
229       void _XmClearFocusPath(Widget wid);
230
231       Unknown Function
232
233       void _XmClearRect(XRectangle *r);
234
235       Unknown Function
236
237       void _XmConfigureObject(Widget g, Position  x,  Position  y,  Dimension
238       width, Dimension height, Dimension border_width);
239
240       _XmConfigureObject is a wrapper around XtConfigureWidget(3) which insu‐
241       lates a widget writer from the burden of checking whether an object  is
242       a  widget  or  a gadget.  The way for a manager widget (any subclass of
243       XmManager; they're supposed to do geometry management for  their  chil‐
244       dren)  to  set  the  layout of a child is to use this function.  In the
245       case of a widget, XtConfigureWidget is called.  For a gadget, the geom‐
246       etry fields are manipulated directly.
247
248       void _XmDestroyFocusData(XmFocusData focusData);
249
250       Unknown Function
251
252       void _XmDispatchGadgetInput(Widget g, XEvent *event, Mask mask);
253
254       Unknown Function
255
256       void  _XmFocusModelChanged(Widget wid, XtPointer client_data, XtPointer
257       call_data);
258
259       Unknown Function
260
261       void  _XmForegroundColorDefault(Widget  widget,  int  offset,  XrmValue
262       *value);
263
264       Unknown Function
265
266       void  _XmGetDefaultThresholdsForScreen(Widget  widget, int offset, Xrm‐
267       Value *value);
268
269       Unknown Function
270
271       void  _XmHighlightColorDefault(Widget  widget,  int  offset,   XrmValue
272       *value);
273
274       Unknown Function
275
276       void  _XmManagerHighlightPixmapDefault(Widget  widget, int offset, Xrm‐
277       Value *value);
278
279       Unknown Function
280
281       void _XmManagerTopShadowPixmapDefault(Widget widget, int  offset,  Xrm‐
282       Value *value);
283
284       Unknown Function
285
286       void _XmMgrTraversal(Widget wid, XmTraversalDirection direction);
287
288       Unknown Function
289
290       void _XmMoveObject(Widget g, Position x, Position y);
291
292       Unknown Function
293
294       void _XmNavigChangeManaged(Widget wid);
295
296       Unknown Function
297
298       void _XmNavigDestroy(Widget wid);
299
300       Unknown Function
301
302       void  _XmNavigInitialize(Widget  request, Widget new_wid, ArgList args,
303       Cardinal num_args);
304
305       Unknown Function
306
307       void _XmNavigResize(Widget wid);
308
309       Unknown Function
310
311       void _XmPrimitiveEnter(Widget w, XEvent *event, String *params,  Cardi‐
312       nal num_params);
313
314       Unknown Function
315
316       void _XmPrimitiveHighlightPixmapDefault(Widget widget, int offset, Xrm‐
317       Value *value);
318
319       Unknown Function
320
321       void _XmPrimitiveLeave(Widget w, XEvent *event, String *params,  Cardi‐
322       nal num_params);
323
324       Unknown Function
325
326       void _XmPrimitiveTopShadowPixmapDefault(Widget widget, int offset, Xrm‐
327       Value *value);
328
329       Unknown Function
330
331       void _XmProcessTraversal(Widget w,  XmTraversalDirection  dir,  Boolean
332       check);
333
334       Unknown Function
335
336       void _XmRedisplayGadgets(Widget w, XEvent *event, Region region);
337
338       Unknown Function
339
340       void _XmRegisterConverters();
341
342       Unknown Function
343
344       void _XmRegisterPixmapConverters();
345
346       Unknown Function
347
348       void _XmResetTravGraph(Widget wid);
349
350       Unknown Function
351
352       void  _XmResizeObject(Widget  g,  Dimension  width,  Dimension  height,
353       Dimension border_width);
354
355       Unknown Function
356
357       void _XmSetActiveTabGroup(XmFocusData focusData, Widget tabGroup);
358
359       Unknown Function
360
361       void    _XmSetDefaultBackgroundColorSpec(Screen     *screen,     String
362       new_color_spec);
363
364       Unknown Function
365
366       void _XmSetInitialOfTabGroup(Widget tab_group, Widget init_focus);
367
368       Unknown Function
369
370       void _XmSetRect(XRectangle *rect, Widget w);
371
372       Unknown Function
373
374       void   _XmTopShadowColorDefault(Widget  widget,  int  offset,  XrmValue
375       *value);
376
377       Unknown Function
378
379       void _XmValidateFocus(Widget wid);
380
381       Unknown Function
382
383       void _XmWarning(Widget w, char *message);
384
385       Unknown Function
386
387       void _XmWidgetFocusChange(Widget wid, XmFocusChange change);
388
389       Unknown Function
390
391       void _XmCascadePixmapDefault(Widget w, int offset, XrmValue *val);
392
393       Unknown Function
394
395       void _XmClearBorder(Display *display, Window win, int x, int y,  Dimen‐
396       sion width, Dimension height, Dimension shadow_thickness)
397
398       Unknown Function
399
400       void  _XmDefaultButtonShadowThickness(Widget  w,  int  offset, XrmValue
401       *val);
402
403       Unknown Function
404
405       void _XmDefaultMultiClick(Widget w, int offset, XrmValue *val);
406
407       Unknown Function
408
409       void _XmDrawArrow(Display *display, Window win, GC bottomGC, GC  topGC,
410       GC  fillGC,  Position x, Position y, Dimension width, Dimension height,
411       Dimension shadow_thickness, unsigned char direction);
412
413       Unknown Function
414
415       void _XmDrawDiamond(Display  *display,  Window  win,  GC  bottomGC,  GC
416       topGC,  GC selectGC, Position x, Position y, Dimension width, Dimension
417       height, Dimension shadowThickness, Dimension fill);
418
419       Unknown Function
420
421       void _XmDrawSeparator(Display *display, Window win, GC top_gc, GC  bot‐
422       tom_gc,  separator_GC,  Position  wx,  Position  wy,  Dimension wwidth,
423       Dimension  wheight,  Dimension   shadowThickness,   Dimension   margin,
424       unsigned char orientation, unsigned char separator_type);
425
426       Unknown Function
427
428       void  _XmDrawShadowDisplay  *display,  Drawable  d,  GC top_gc, GC bot‐
429       tom_gc, Dimension shad_thick, Position x, Position y, Dimension  width,
430       Dimension height);
431
432       Unknown Function
433
434       void  _XmDrawShadows(Display  *display,  Window win, GC topShadowGC, GC
435       bottomShadowGC, Position x,  Position  y,  Dimension  width,  Dimension
436       height, Dimension shadowThickness, unsigned int shadowType);
437
438       Unknown Function
439
440       void    _XmFontListGetDefaultFont(XmFontList    fontlist,   XFontStruct
441       **font_struct);
442
443       Unknown Function
444
445       void _XmFrameHorizSpaceDefault(Widget w, int offset, XrmValue *val);
446
447       Unknown Function
448
449       void  _XmFrameShadowThicknessDefault(Widget  w,  int  offset,  XrmValue
450       *val);
451
452       Unknown Function
453
454       void _XmFrameShadowTypeDefault(Widget w, int offset, XrmValue *val);
455
456       Unknown Function
457
458       void _XmInitializeWidgetSet();
459
460       Unknown Function
461
462       void   _XmRowColumnEntryClassDefault(Widget  w,  int  offset,  XrmValue
463       *val);
464
465       Unknown Function
466
467       void _XmRowColumnIsHomogeneousDefault(Widget w,  int  offset,  XrmValue
468       *val);
469
470       Unknown Function
471
472       void _XmRowColumnMarginDefault(Widget w, int offset, XrmValue *val);
473
474       Unknown Function
475
476       void  _XmRowColumnMenuAcceleratorDefault(Widget w, int offset, XrmValue
477       *val);
478
479       Unknown Function
480
481       void _XmRowColumnPackingDefault(Widget w, int offset, XrmValue *val);
482
483       Unknown Function
484
485       void _XmRowColumnSpacingDefault(Widget w, int offset, XrmValue *val);
486
487       Unknown Function
488
489       void _XmScrollBarMaximumDefault(Widget w, int offset, XrmValue *val);
490
491       Unknown Function
492
493       void _XmScrollBarProcessingDirectionDefault(Widget w, int offset,  Xrm‐
494       Value *val);
495
496       Unknown Function
497
498       void   _XmScrollBarSliderSizeDefault(Widget  w,  int  offset,  XrmValue
499       *val);
500
501       Unknown Function
502
503       void  _XmScrollBarTroughColorDefault(Widget  w,  int  offset,  XrmValue
504       *val);
505
506       Unknown Function
507
508       void _XmScrollBarValueDefault(Widget w, int offset, XrmValue *val);
509
510       Unknown Function
511
512       void _XmSelectColorDefault(Widget w, int offset, XrmValue *val);
513
514       Unknown Function
515
516       void _XmToggleButtonIndicatorTypeDefault(Widget w, int offset, XrmValue
517       *val);
518
519       Unknown Function
520
521       void _XmVendorShellVirtualBindingsDefault(Widget w,  int  offset,  Xrm‐
522       Value *val);
523
524       Unknown Function
525
526       String _XmOSGetHomeDirName(void);
527
528       Unknown Function
529
530       XmString _XmOSGetLocalizedString(char *reserved,
531
532       Unknown Function
533
534       int _XmMicroSleep(long secs);
535
536       Unknown Function
537
538       void _XmInternAtomAndName(Display *display, Atom atom, String name);
539
540       Associates  an  atom  name with an atom id (and vice versa) without the
541       need to query the X server first for the atom id.  This way any name to
542       id  mapping  (as  well as the id to name mapping) can be set on a given
543       display.
544
545       void  _XmVirtualToActualKeysym(Display  *Dsp,   KeySym   VirtualKeysym,
546       KeySym *RealKeysymReturn, Modifiers *ModifierReturn);
547
548       For  the  given  virtual  keysym  (which must be one of the = osfXK_xxx
549       keysyms) returns the real keysym as well as the modifiers which make up
550       that  particular  virtual  keysym.   If  asked  for  an invalid virtual
551       keysym, _XmVirtualToActualKeysym returns NoSymbol for the real keysym.
552
553       int _XmVirtKeysLoadFallbackBindings(Display *Dsp, String *Bindings);
554
555       Installs the default key bindings for a specific display.  If  th=  ere
556       are any vendor specific default bindings available, then the appropiate
557       one= will be installed instead of the fallback key bindings.  Addition‐
558       ally,  the  bindings  installed are returned in Bindings. The caller is
559       responsible for freeing the space occupied by this key binding descrip‐
560       tion  string. The return code seems to be always zero. At least LessTif
561       will always retur= n a zero...
562
563       Boolean _XmVirtKeysLoadFileBindings(String filename,  String  *binding=
564       );
565
566       Reads  in  a file containing a description of the virtual key bindings.
567       If succesful, returns True and the description string. The  caller=  is
568       responsible for freeing the memory lateron.
569
570       void _XmVirtKeysInitialize(Widget w);
571
572       Sets  up  the  virtual key bindings for a display. The widget specified
573       must be a XmDisplay widget, otherwise _XmVirtKeysInitialize  will  deny
574       the  attempt to set up the key bindings. The function first checks sev‐
575       eral places in order to catch up key binding description. If all fails,
576       it will install fallback key bindings. This internal function is called
577       during when initializing a XmDisplay widget.
578
579       void _XmVirtKeysDestroy(Widget w);
580
581       Cleanup any leftovers from the virtual binding mechanism when  destroy‐
582       ing a XmDisplay widget.
583
584       void  _XmVirtKeysHandler(Widget w, XtPointer Data, XEvent *Event, Bool‐
585       ean *ContDispatch);
586
587       This handler is installed on every widget. It just records the  current
588       key press event in an widget instance field private to a XmDisplay wid‐
589       get.
590

SEE ALSO

592       lesstif(1x)
593
594
595
596LessTif Project                   April 1998     LessTif Internal Functions(3)