X11 Functions

Defines

#define MxANGLECONTROL_FullCircle   0x0000000F
#define MxANGLECONTROL_Quadrant1   0x00000001
#define MxANGLECONTROL_Quadrant2   0x00000002
#define MxANGLECONTROL_Quadrant3   0x00000004
#define MxANGLECONTROL_Quadrant4   0x00000008
#define MxANGLECONTROL_ZeroAtTop   0x00000010
#define MxcbOptionUINT8   MxcbOptionUBYTE
#define MxcbToggleUINT8   MxcbToggleUBYTE
#define WaitForUnmap(w)   MxWaitForUnmap(w)

Functions

 DEPRECATED_MSG ("There's another version that doesn't have a numeric style object id for the 2nd parameter") Widget MxCreateIconPushButton(Widget pwidget
int Main_DatabaseEditor (Widget parent)
void MxAddDeleteWindowCallback (Widget widget, XtCallbackProc cbproc, void *cbdata)
void MxAlignLabels (Widget *widgets, int num)
void MxAlignWidgets (Widget *widgets, int num, UINT32 flags)
Widget MxAngleControlCreate (Widget parent, double *pValue, int radius, UINT32 flags, Arg *callerargs, int numargs)
ERRVALUE MxAngleControlSetPrompt (Widget control, Widget prompt)
Widget MxAppShellCreate (const char *posnkey, Arg *arg, int numargs)
void MxAssignCursor (Display *display, Window window, int cursor)
Widget MxblCreate (Widget pwidget, int maxsize, Arg *formargs, int formn)
void MxblRefresh (Widget dform, INT32 start)
void MxblResize (Widget dform, INT32 numitems, INT32 start)
void MxblSetEditMode (Widget dform, UINT32 mode)
void MxblSetEditPosn (Widget dform, INT32 editposn)
void MxblSetEntryCallback (Widget dform, void(*EntryCB)(INT32, char *, void *), void *udata)
void MxblSetHighlightCallback (Widget dform, void(*HighlightCB)(INT32, void *), void *udata)
void MxcbDisplayHelp (Widget, void *, void *)
void MxcbOptionUBYTE (Widget w, void *voption, void *)
void MxcbSetExit (Widget, void *, void *)
void MxcbToggleBool (Widget, void *vvalue, XmToggleButtonCallbackStruct *cbs)
void MxcbToggleUBYTE (Widget, void *vvalue, XmToggleButtonCallbackStruct *cbs)
void MxClearWidget (Widget widget, bool sendexposure=true)
double MxConvertScreenUnits (double val, int InUnits, int OutUnits)
MIUNICODE * MxConvertXmStringToUC (XmString xmstr)
Widget MxCreateButtonColumn (Widget, BUTTONITEM *, void *, void *, int, Arg *, int)
Widget MxCreateButtonFieldXe (Widget form, const char *name, Widget *xetext, Widget *button, XtCallbackProc cbfunc, void *cbdata, Arg *arglist, int argcount)
Widget MxCreateButtonRow (Widget pwidget, const BUTTONITEM *buttonitem, void *cbdata, void *userdata, int flags, const Arg *, int argcount)
Widget MxCreateFormDialog (Widget pwidget, const char *titlestr, Arg *arglist, int argcount)
Widget MxCreateFormDialog (Widget pwidget, const char *titlestr, const char *helpstr, XtCallbackProc cbpopdn, void *cbdata, Arg *arglist, int argcount)
Widget MxCreateFrame (Widget pwidget, const XTARGS &arg, const char *label=0)
Widget MxCreateHTMLWidget (Widget parent, char *name, Arg *arg, int n)
Widget MxCreateIconButtonRow (Widget pwidget, const MIUNICODE *iconfile, const char *icongroup, const BUTTONITEM *buttonitem, void *cbdata, void *userdata, int flags, const Arg *arglist, int argcount)
Widget MxCreateIconLabel (Widget pwidget, ICONID iconid, const MISTRING &tooltip, const Arg *arglist, int argcount)
Widget MxCreateIconLabel (Widget pwidget, int iconhandle, const char *IconClass, const char *IconName, const char *LabelName, const Arg *arglist, int argcount)
Widget MxCreateIconLabelExt (Widget pwidget, int iconhandle, const char *IconClass, const char *IconName, const char *StippleName, const char *LabelName, const Arg *arglist, int argcount, UINT32 flags)
Widget MxCreateIconPopupMenuButton (Widget pwidget, int iconhandle, const char *IconClass, const char *IconName, const char *LabelName, const MENUITEM *items, Widget *widget_list, void *data, void *udata, const Arg *arglist, int argcount)
Widget MxCreateIconPushButton (Widget pwidget, const char *IconGroup, const char *IconName, const char *LabelName, XtCallbackProc, void *cbdata, const Arg *arglist, int argcount, UINT32 flags=0, RVC::STYLE *StyleObj=0)
Widget MxCreateIconPushButton (Widget pwidget, ICONID iconid, const MISTRING &tooltip, XtCallbackProc cbfunc, void *cbdata, const Arg *arglist, int argcount)
Widget MxCreateIconPushButtonExt (Widget pwidget, int iconhandle, const char *IconClass, const char *IconName, const char *LabelName, XtCallbackProc, void *cbdata, const Arg *arglist, int argcount, UINT32 flags)
Widget MxCreateIconToggleButton (Widget pwidget, int iconhandle, const char *IconClass, const char *IconName, const char *LabelName, void(*)(Widget, void *, XmToggleButtonCallbackStruct *), void *cbdata, const Arg *arglist, int argcount)
Widget MxCreateIconToggleButtonExt (Widget pwidget, int iconhandle, const char *IconClass, const char *UnselIconName, const char *SelectedIconName, const char *LabelName, void(*)(Widget, void *, XmToggleButtonCallbackStruct *), void *cbdata, const Arg *arglist, int argcount, UINT32 flags)
int MxCreateImageFromWidget (Widget widget, XImage **ximage, void **buffer, int width, int height)
Widget MxCreateLabel (Widget parent, const MISTRING &label, Arg *arglist, int argcount)
Widget MxCreateLabel (Widget parent, const char *name, Arg *arglist, int argcount)
Widget MxCreateLabelFieldXe (Widget form, const char *name, Widget *xetext, Widget *label, Arg *arglist, int argcount)
Widget MxCreateLatLonFormatOptionMenu (Widget pwidget, char *label, UINT32 dftfmt, void(*)(Widget, void *, void *), void *userdata, Arg *arglist, int argcount)
Widget MxCreateManualPopupMenu (Widget parent, const char *title, const MENUITEM *items, Widget *widget_list, void *data, void *udata)
Widget MxCreateMenuBar (Widget pwidget, const MENUBARITEM *menus, void *clientdata, void *userdata)
Widget MxCreateOptionMenu (Widget pwidget, const char *title, const MENUITEM *items, void *userdata)
Widget MxCreateOptionMenuExt (Widget pwidget, const char *title, const MENUITEM *items, void *userdata, const Arg *arglist, int argcount)
Widget MxCreatePopupMenu (Widget parent, const char *title, const MENUITEM *items, Widget *widget_list, void *data, void *udata)
Widget MxCreatePulldownMenu (Widget parent, const MIUNICODE *label, const MENUITEM *items, void *cbdata, void *udata)
Widget MxCreatePushButton (Widget pwidget, const char *name, XtCallbackProc, void *cbdata, Arg *arglist, int argcount)
Widget MxCreateTextEncodingLB (Widget pwidget, const char *label, CHAR_ENCODING &encoding, ENCODELIST_FLAGS enclistflags, Arg *arglist, int argcount)
Widget MxCreateToggleButton (Widget pwidget, const char *name, void(*)(Widget, void *, XmToggleButtonCallbackStruct *), void *cbdata, Arg *arglist, int argcount)
XmString MxCreateXmStringUC (const MIUNICODE *const string, MGD::INTERFACETEXTSTYLE style=MGD::INTERFACETEXTSTYLE_Normal)
void MxDestroyPopupMenu (Widget parent, Widget popup)
void MxDestroyTopLevel ()
void MxDisplayHelp (Widget parent, const char *helpid)
void MxDisplayHelpByID (Widget parent, HELPID helpid)
int MxEditBitmapCursor (Widget pwidget, FILEPATH *filename, int flags)
int MxEditBitmapPattern (Widget pwidget, const RVC::OBJITEM &StyleObjItem, INT32 pattnum, const COLOR &varcolor, UINT32 flags)
void MxEditButtonsAddCallbacks (void *handle, Widget textwidget)
const BUTTONITEM * MxEditButtonsCreate (void **handle, MxEDITMENUFLAGS flags=MxEDITMENUFLAG_None, void(*undofunc)(Widget, void *)=0, void *undodata=0)
int MxEditColor (Widget parent, EDITCOLORINFO *EditColorInfo, int numcolors, UINT32 flags, Widget *notused)
int MxEditHatchPattern (Widget pwidget, const RVC::OBJITEM &StyleObjItem, INT32 pattnum, COLOR *varcolor, UINT32 flags)
void MxEditMenuAddCallbacks (void *handle, Widget textwidget)
const MENUITEM * MxEditMenuCreate (Widget shell, void **handle, MxEDITMENUFLAGS flags=MxEDITMENUFLAG_None, void(*undofunc)(Widget, void *)=0, void *undodata=0)
DEPRECATED const MENUITEM * MxEditMenuCreate (void **handle, MxEDITMENUFLAGS flags=MxEDITMENUFLAG_None, void(*undofunc)(Widget, void *)=0, void *undodata=0)
int MxEditSymbol (Widget pwidget, const RVC::OBJITEM &StyleObjItem, INT32 pattnum, COLOR *varcolor, UINT32 flags)
void MxEnableMouseWheel (Widget owner, Widget scrollbar, int increment=3)
Widget MxFindNamedChildWidget (Widget parent, char *name)
void MxFixWindowSizeForAppleX11 (Widget mainform)
void MxForceDialog (Widget w)
void MxForceWindowOnScreen (Widget, int)
Pixel MxGetColorPixel (COLOR const &color)
Pixel MxGetColorPixelNoICM (COLOR const &color)
XmFontList MxGetDefaultFontList ()
const char * MxGetDefaultSystemXLFD ()
const char * MxGetDefaultUIFont ()
void MxGetDisplayInfo (Widget widget, DISPLAYINFO *displayinfo)
void MxGetDrawingAreaSize (Widget dawidget, INT16 &width, INT16 &height)
int MxGetFontStructFromWidget (Widget widget, XFontStruct *fontstruct)
int MxGetMaxFontAscent (bool bForClipping=false)
int MxGetMaxFontDescent (bool bForClipping=false)
int MxGetMaxFontHeight (bool bForClipping=false)
int MxGetMaxFontWidth ()
void * MxGetNamedUserData (Widget widget, const char *name)
void MxGetScrollAreaSize (Widget, int *width, int *height)
Widget MxGetShell (Widget widget)
Pixel MxGetStdColorPixel (int index)
void MxGetStdColorPixels (Pixel *stdpixel)
void MxGetStdColors (COLOR stdcolor[NUMSTDCOLORS])
int MxGetSystemPreferences (Widget pwidget)
Widget MxGetTopLevel (Widget widget)
Widget MxGetTopShell (Widget widget)
int MxGetTypicalFontWidth ()
int MxGetTypicalFontWidth2 (MGD::INTERFACETEXTSTYLE style=MGD::INTERFACETEXTSTYLE_Normal)
void * MxGetUserDataPtr (Widget widget)
MIUNICODE * MxGetWidgetLabelString (Widget widget)
void MxGetWidgetSize (Widget widget, Dimension &width, Dimension &height)
int MxGetWindowBorders (Widget widget, int *left, int *right, int *top, int *bottom)
void MxGetWindowPosition (Widget w, int *px, int *py)
void MxIconAddDestroyCallback (Widget widget, MICONSTRUCT *)
void MxIconDrawDimmed (Display *display, Drawable drawable, GC gc, int x, int y, MICONSTRUCT *icon)
void MxIconDrawNormal (Display *display, Drawable drawable, GC gc, int x, int y, MICONSTRUCT *icon)
Pixmap MxIconGetPixmapDimmed (const MICONSTRUCT *icon)
Pixmap MxIconGetPixmapNormal (const MICONSTRUCT *icon)
int MxIsExitingProcess ()
int MxIsTimeOutInMainLoop ()
DEPRECATED Widget MxListButtonCreate (Widget pw, const char *label, int NumItems, int maxlen, MIUNICODE *(*GetItemFunc)(int, void *), void(*NotifyFunc)(int, void *), void *FuncData, Arg *arglist, int argcount)
DEPRECATED void MxListButtonSetHelpID (Widget listbutton, const char *helpid)
DEPRECATED void MxListButtonSetItem (Widget listbutton, int itemnum, int notify)
DEPRECATED void MxListButtonSetNumItems (Widget listbutton, int NumItems)
DEPRECATED void MxListButtonSetTitle (Widget listbutton, const char *title)
void MxListDisableKeySelect (Widget list)
void MxListEnableKeySelect (Widget list, int start)
void MxListEnableMouseWheel (Widget owner, int increment=3)
void MxLockWindowSize (Widget widget, UINT32 flags=MxLOCKSIZE_MinMax)
void MxLockWindowSizeAbs (Widget widget, int height, int width, UINT32 flags)
void MxLockWindowSizeRel (Widget widget, int dheight, int dwidth, UINT32 flags)
void MxMainLoopUntilConditionMet (DELEGATE_BOOL_NOPARMS Delegate)
void MxMainLoopUntilExitSet ()
void MxMainLoopWhilePending ()
void MxMakeListPosCentered (Widget listw, int listitem)
void MxMakeListPosVisible (Widget listw, int listitem)
DEPRECATED void MxMakeObjectList (Widget list, const RVC::OBJITEMLIST &items)
Widget MxMenuFileCreateIconPulldown (Widget pwidget, const FILEPATH &filepath, XtCallbackProc CB_Internal, int IconHandle, const char *IconGroup, const char *IconName, const char *LabelName, const Arg *arglist, int argcount)
int MxMenuFileLoad (Widget pwidget, const FILEPATH &filepath, XtCallbackProc CB_Internal, XtCallbackProc CB_Executable=0, FastDelegate< void(Widget, const char *, int)> DelegateAddSpecial=0)
int MxMenuGetNumItems (const MENUITEM *items)
void MxMenuInitSelectedByCallbackData (MENUITEM *menuitem, void *cbdata)
void MxMenuInitSelectedByUserData (MENUITEM *menuitem, void *userdata)
Widget MxMenuItemWidget (Widget menubar, const char *path)
void MxMsgLineClear (Widget msgline)
Widget MxMsgLineCreate (Widget pwidget, Arg *arglist, int argcount)
void MxMsgLineSetError (Widget msgline, ERRVALUE errcode)
void MxMsgLineSetText (Widget msgline, const MISTRING &string)
void MxMsgLineSetTimer (Widget msgline, const MTIMER &timer, TEXTID textid=TEXTID__None)
void MxOptionMenuAppendItems (Widget omwidget, const MENUITEM *items, void *udata)
Widget MxOptionMenuGetButton (Widget omwidget)
Widget MxOptionMenuGetLabel (Widget omwidget)
void MxOptionMenuRemoveLast (Widget omwidget)
void MxOptionMenuReplaceItems (Widget omwidget, const MENUITEM *newitems, void *userdata)
Boolean MxOptionMenuSetItem (Widget omwidget, int itemnum)
Boolean MxOptionMenuSetItemByData (Widget widget, const MENUITEM *menuitem, void *callback_data)
Boolean MxOptionMenuSetItemSensitive (Widget omwidget, int itemnum, Boolean flag)
void MxOptionMenuSetSensitive (Widget omwidget, int sensitive)
int MxPixmapFromFillPattern (Widget pwidget, Pixel bgpixel, const RVC::STYLEPATTERN_BITMAP &Pattern, Pixmap *pixmap, bool bToGrayScale=false)
Widget MxPolyfitCreateForm (Widget parent, void(*action)(void *), void *userdata, Arg *arglist, int argcount)
int MxPolyfitGetParm (Widget wPolyfit, void *vpf)
int MxPolyfitIniRead (void *vpf)
int MxPolyfitIniWrite (void *vpf)
int MxPolyfitSetParm (Widget wPolyfit, void *vpf)
void MxPopupMenuReplaceItems (Widget menupane, const MENUITEM *items, void *udata)
int MxPopupModalDialog (Widget dlgparent, const char *dlgname, const char *helpid, Widget(*CreateWidgetFunc)(Widget, void *, Arg *, int), void *CreateWidgetData, const BUTTONITEM *extrabuttons=0, bool(*CheckOkFunc)(void *)=0)
void MxPopupTransientMenu (Widget parent, XButtonPressedEvent *event, const char *title, const MENUITEM *items, void *cbdata=0, void *udata=0, bool waitforpopdown=false)
void MxPositionWindowRel (Widget child, Widget base, MxRELPOSN relposn)
int MxPromptAddCallback (Widget prompt, void(*cbfunc)(MxPromptCallbackStruct *, void *), void *cbdata, UINT32 reasonmask)
void MxPromptClearValue (Widget prompt)
int MxPromptColorAddCallback (Widget prompt, void(*cbfunc)(MxPromptCallbackStruct *, void *), void *cbdata, UINT32 reasonmask)
Widget MxPromptColorCreate (Widget pwidget, const char *name, COLOR *color, UINT32 flags, Arg *arglist, int argcount)
Widget MxPromptColorGetLabel (Widget prompt)
void MxPromptColorUpdate (Widget prompt)
Widget MxPromptCreateChar (Widget parent, const char *name, char *str, const char *help, UINT32 flags, Arg *args, int numargs)
Widget MxPromptCreateDouble (Widget parent, const char *name, double *ret, double dft, double min, double max, int places, const char *help, UINT32 flags, Arg *args, int n)
Widget MxPromptCreateFloat (Widget parent, const char *name, float *ret, float dft, float min, float max, int places, const char *help, UINT32 flags, Arg *args, int n)
Widget MxPromptCreateINT16 (Widget parent, const char *name, INT16 *ret, INT16 dft, INT16 min, INT16 max, const char *help, UINT32 flags, Arg *args, int numargs)
Widget MxPromptCreateINT32 (Widget parent, const char *name, INT32 *ret, INT32 dft, INT32 min, INT32 max, const char *help, UINT32 flags, Arg *args, int n)
Widget MxPromptCreateINT8 (Widget parent, const char *name, INT8 *ret, INT8 dft, INT8 min, INT8 max, const char *help, UINT32 flags, Arg *args, int n)
Widget MxPromptCreateLatLon (Widget parent, const char *name, double *ret, double dft, double min, double max, int places, const char *help, UINT32 flags, Arg *args, int n)
Widget MxPromptCreateNum (Widget parent, const char *name, int type, void *ret, double dft, double min, double max, int places, const char *help, char **comboitems, UINT32 flags, Arg *args, int n)
Widget MxPromptCreateString (Widget parent, const char *name, char *str, int maxlen, const char *help, UINT32 flags, Arg *args, int numargs)
Widget MxPromptCreateUINT16 (Widget parent, const char *name, UINT16 *ret, UINT16 dft, UINT16 min, UINT16 max, const char *help, UINT32 flags, Arg *args, int n)
Widget MxPromptCreateUINT32 (Widget parent, const char *name, UINT32 *ret, UINT32 dft, UINT32 min, UINT32 max, const char *help, UINT32 flags, Arg *args, int n)
Widget MxPromptCreateUINT8 (Widget parent, const char *name, UINT8 *ret, UINT8 dft, UINT8 min, UINT8 max, const char *help, UINT32 flags, Arg *args, int n)
MDLGPARENT MxPromptCreateUnicode (MDLGPARENT parent, const char *name, MIUNICODE *str, int maxlen, const char *help, UINT32 flags, Arg *args, int numargs)
void MxPromptDisableTraversal (Widget prompt)
int MxPromptDoubleToLatLon (Widget prompt)
Widget MxPromptGetLabel (Widget prompt)
void MxPromptGetMinMax (Widget widget, double *min, double *max)
Widget MxPromptGetScale (Widget prompt)
int MxPromptGetStdHeight (void)
Widget MxPromptGetUnitLabel (Widget widget)
void * MxPromptGetUserData (Widget prompt)
int MxPromptGetValueDouble (Widget widget, double *pval)
int MxPromptGetValueUnicode (Widget widget, MIUNICODE **pval)
Widget MxPromptGetXeText (Widget widget)
int MxPromptHasValue (Widget prompt)
MENUITEM * MxPromptLatLonGetFormatMenu (XtCallbackProc cbfunc, int isoption)
void MxPromptLatLonSetFormat (Widget widget, DEGTOSTRFLAGS flags)
int MxPromptLatLonSetValue (Widget prompt, double val)
int MxPromptLatLonToDouble (Widget prompt)
int MxPromptRemoveCallback (Widget prompt, void(*cbfunc)(MxPromptCallbackStruct *, void *), void *cbdata, UINT32 reasonmask)
void MxPromptSetDecPlaces (Widget prompt, int places)
void MxPromptSetEditable (Widget prompt, int editable)
int MxPromptSetEncoding (Widget prompt, char *encoding, UINT32 flags)
void MxPromptSetEnterCallback (Widget widget, void(*func)(Widget, void *), void *cbdata)
void MxPromptSetFormat (Widget prompt, char *format)
void MxPromptSetLogScaleRange (Widget prompt, double min, double max)
void MxPromptSetModifyCallback (Widget prompt, void(*func)(Widget, void *), void *funcdata)
void MxPromptSetRange (Widget prompt, double min, double max, UINT32 flags)
void MxPromptSetTraversal (Widget prompt, Widget traverseto, XmTraversalDirection traversedir)
void MxPromptSetUnitConv (Widget prompt, const UNITCONV *unitconv)
void MxPromptSetUnitConvCode (Widget prompt, int unittype, int storedcode, int showncode)
void MxPromptSetUnitConvExt (Widget widget, const UNITCONV *unitconv, UINT32 flags)
void MxPromptSetUserData (Widget prompt, void *data)
void MxPromptSetValue (Widget widget, double wal, int hasvalue)
int MxPromptSetValueDouble (Widget prompt, double val)
int MxPromptSetValueFloat (Widget prompt, float val)
int MxPromptSetValueINT16 (Widget prompt, short val)
int MxPromptSetValueINT32 (Widget prompt, INT32 val)
void MxPromptSetValuePtr (Widget prompt, void *newptr, int hasvalue)
int MxPromptSetValueString (Widget prompt, const char *val)
int MxPromptSetValueUnicode (Widget prompt, const MIUNICODE *val)
int MxPromptUpdateData (Widget prompt, Boolean notify)
void MxPromptUpdateValue (Widget prompt)
void MxPulldownMenuReplaceItems (Widget parent, const MENUITEM *items, void *userdata)
void MxRedrawWidget (Widget widget)
int MxRgnGenSetupRasterTraceAreaV (Widget pwidget, const RVC::OBJITEM &VectObjItem, RGNELEMLIST *ElemList, int NumElemTypes, void(*DispRegionFunc)(const REGION2D *, void *), void *DispRegionData)
int MxRgnGenSetupRasterTraceBoundaryV (Widget pwidget, const RVC::OBJITEM &VectObjItem, RGNELEMLIST *ElemList, int NumElemTypes, void(*DispRegionFunc)(const REGION2D *, void *), void *DispRegionData)
Widget MxSashCreate (Widget pwidget, Arg *arglist, int argcount)
int MxSaveSnapshotToRaster (Widget pwidget, const DISPLAYINFO &dispinfo, Drawable drawable)
void MxScrollBarGetValues (Widget w, int *value, int *sliderSize, int *increment, int *pageIncrement, int *minimum, int *maximum)
int MxSelectIcon (Widget pwidget, char *dialogname, char IconClass[16], char IconName[16], int minsize, int maxsize, UINT32 flags)
int MxSelectRegion (Widget parent, const RVC::OBJITEM &ObjItem, RVC::OBJTYPE ObjType, REGION2D &region)
void MxSetExitProcess ()
void MxSetFocusToWidget (Widget widget)
void MxSetHelpCallback (Widget widget, const char *helpstr)
void MxSetMenuItemCallbackData (MENUITEM *mi, void *cbdata)
void MxSetMenuItemUserData (MENUITEM *mi, void *udata)
void MxSetNamedUserData (Widget w, const char *name, void *data)
void MxSetNoExitProcess ()
void MxSetSensitive (Widget w, int sensitive)
void MxSetTextEditable (Widget widget, int editable)
void MxSetToolTipFromObjItem (Widget widget, const RVC::OBJITEM &ObjItem)
int MxSetupBasinParms (void *form, const RVC::OBJITEM &SrcVectObjItem, RGNELEMLIST *ElemList, int NumElemTypes, void(*dispreg)(const REGION2D *, void *), void *userdata)
int MxSetupBufferZoneParms (void *form, const RVC::OBJITEM &SrcObjItem, RGNELEMLIST *ElemList, int NumElemTypes, void(*dispreg)(const REGION2D *, void *), void *userdata)
int MxSetupClusterParms (Widget parent, const RVC::OBJITEM &SrcGeomObjItem, RGNELEMLIST *ElemList, int NumElemTypes, void(*dispreg)(const REGION2D *, void *), void *userdata)
int MxSetupFloodParms (void *vparent, const RVC::OBJITEM &ObjItemVector, INT32 ActiveType, INT32 ActiveLine, void(*dispreg)(const REGION2D *, void *), void *userdata)
int MxSetupPolygonFitParms (Widget parent, const RVC::OBJITEM &SrcGeomObjItem, RGNELEMLIST *ElemList, int NumElemTypes, void(*dispreg)(const REGION2D *, void *), void *userdata)
int MxSetupRasterCellsParms (MDLGPARENT parent, const RVC::OBJITEM &VectObjItem, RGNELEMLIST *ElemList, int NumElemTypes, void(*dispreg)(const REGION2D *, void *), void *userdata)
int MxSetupRegionFromRangesParms (Widget parent, const RVC::OBJITEM &ObjItem, void(*dispreg)(const REGION2D *, void *), void *userdata)
int MxSetupRegionFromRastExpressParms (Widget parent, const RVC::OBJITEM &ObjItemRaster, void(*dispreg)(const REGION2D *, void *), void *userdata)
int MxSetupTextureGrowthParms (MDLGPARENT parent, const RVC::OBJITEM &VectObjItem, RGNELEMLIST *ElemList, int NumElemTypes, void(*dispreg)(const REGION2D *, void *), void *userdata)
int MxSetupViewshedParms (MDLGPARENT parent, const RVC::OBJITEM &VectObjItem, UINT8 *setdata, INT32 NumEntries, void(*dispreg)(const REGION2D *, void *), void *userdata)
void MxSetWidgetColor (Widget widget, COLOR const &color)
void MxSetWindowFullScreen (Widget widget)
int MxSetWindowPosition (Widget widget, const char *group, const char *field)
int MxSetWindowPositionXY (Widget widget, const char *group, const char *field, int x, int y)
int MxSetWindowSize (Widget widget, const char *group, const char *field, int dftwidth, int dftheight)
void MxSetXmLabelString (Widget text, const MIUNICODE *const string)
void MxShowWidget (Widget w, bool show=true)
void MxStringDraw (Display *display, Window window, GC gc, INT32 x, INT32 y, const MIUNICODE *ucstr, TEXTBASEORIGIN origin, MGD::INTERFACETEXTSTYLE style=MGD::INTERFACETEXTSTYLE_Normal)
void MxStringDrawVisual (Display *display, Window window, GC gc, INT32 x, INT32 y, const MIUNICODE *ucstr, TEXTBASEORIGIN origin, MGD::INTERFACETEXTSTYLE style=MGD::INTERFACETEXTSTYLE_Normal)
void MxStringExtents (const MIUNICODE *const ucstr, UINT32 *TextWidth, UINT32 *TextHeight, UINT32 *TextAscent, bool bHeightForClipping, MGD::INTERFACETEXTSTYLE style=MGD::INTERFACETEXTSTYLE_Normal)
void MxStringMetrics (const MIUNICODE *const ucstr, TEXTMETRICS &metrics, MGD::INTERFACETEXTSTYLE style=MGD::INTERFACETEXTSTYLE_Normal)
int MxStringWidth (const MIUNICODE *const ucstr, bool bInkMetrics=false, MGD::INTERFACETEXTSTYLE style=MGD::INTERFACETEXTSTYLE_Normal)
int MxStringWidthVisual (const MIUNICODE *const ucstr, bool bInkMetrics=false, MGD::INTERFACETEXTSTYLE style=MGD::INTERFACETEXTSTYLE_Normal)
Widget MxTabPagesCreate (Widget pwidget, MxTABPAGEITEM *items, void *userdata, Arg *arglist, int argcount)
int MxTabPagesGetActiveItem (Widget tbwidget)
int MxTabPagesGetUserData (Widget tbwidget, void **userdata)
int MxTabPagesSetActiveItem (Widget tbwidget, int itemnum)
int MxTabPagesSetSensitiveItem (Widget tbwidget, int itemnum, int)
void MxTextClearXe (Widget xetext)
int MxTextEditBindXeText (void *vtehandle, Widget xetext)
int MxTextEditCheckSave (void *vtehandle)
int MxTextEditCreateHandle (void **vtehandle, UINT32 flags)
Widget MxTextEditCreateXeText (Widget pwidget, void *vtehandle, Arg *arglist, int argcount)
const MENUITEM * MxTextEditGetMenuEdit (void *vtehandle)
const MENUITEM * MxTextEditGetMenuFile (void *vtehandl, UINT32 flags)
int MxTextEditLoadFile (void *vtehandle, MIUNICODE *filename)
void MxTextEditSetCloseFunc (void *vtehandle, void(*CloseFunc)(void *), void *CloseData)
void MxTextEditSetDftExtn (void *vtehandle, char *dftextn)
void MxTextEditSetEncoding (void *vtehandle, char *encoding)
void MxTextSetFilePathXe (Widget xetext, const FILEPATH &filepath)
void MxTextSetObjItemXe (Widget xetext, const RVC::OBJITEM &objitem)
int MxThemeMapEdit (Widget pwidget, const RVC::OBJITEM &GeoObjItem, ELEMTYPE elemtype, INT16 &StyAsTableNum, const UINT32 styletype=0xFFFF)
void MxTimeOutInMainLoopSet (int val)
MIUNICODE * MxTitleGetString (Widget widget)
void MxTitleSetString (Widget widget, const MISTRING &string, bool ShowProcessID)
void MxTitleSetString (Widget widget, const MISTRING &string)
void MxToggleButtonSetState (Widget tb, Boolean state, Boolean notify=FALSE)
Widget MxTopLevel (void)
int MxTTFSymbolSelect (Widget widget, MISTRING &fontname, UINT16 *GlyphIndex, MIUNICODE *UnicodeNum)
void MxUngrabKeyboard (Display *display)
void MxUngrabPointer (Display *display)
void MxWaitForUnmap (Widget widget)
void MxWaitForUnmapWithIdleDelegate (Widget widget, DELEGATE_BOOL_UINT32 DelegateOnIdle)

Variables

int const char const char
const char void const Arg int 		argcount
int const char const char
const char void const Arg * 		arglist
int const char const char
const char void * 		cbdata
int const char * IconClass
int iconhandle
int const char const char * IconName
int const char const char
const char * 		LabelName
int const char const char
const char 		XtCallbackProc

Define Documentation

#define MxANGLECONTROL_FullCircle   0x0000000F

All of the above.

#define MxANGLECONTROL_Quadrant1   0x00000001
#define MxANGLECONTROL_Quadrant2   0x00000002
#define MxANGLECONTROL_Quadrant3   0x00000004
#define MxANGLECONTROL_Quadrant4   0x00000008
#define MxANGLECONTROL_ZeroAtTop   0x00000010
#define MxcbOptionUINT8   MxcbOptionUBYTE
#define MxcbToggleUINT8   MxcbToggleUBYTE
#define WaitForUnmap ( w   )     MxWaitForUnmap(w)

GENERATING_DOXYGEN_OUTPUT.

Function Documentation

DEPRECATED_MSG ( "There's another version that doesn't have a numeric style object id for the 2nd parameter"   ) 

Create Pushbutton widget with specified icon.

Returns:
Managed widget You may pass NULL for the LabelName and the widget will be assigned a generic resource name AND no ToolTip will be generated.
int Main_DatabaseEditor ( Widget  parent  ) 

Main entry point for Edit / Attribute Database.

Parameters:
parent Parent widget
void MxAddDeleteWindowCallback ( Widget  widget,
XtCallbackProc  cbproc,
void *  cbdata 
)

Handle f.delete from TWM or f.kill from MWM.

This function should be called after any dialog is created. It will add support for the "Close" item on the MWM menu (f.kill) and the f.delete (Be Polite) in TWM. It uses the standard WM_DELETE_WINDOW protocol so anything that sends WM_DELETE_WINDOW will be trapped by this callback. It is also assumed that the resource deleteResponse has been set to XmDO_NOTHING. If you do not pass a shell widget, the widget hierarchy of the widget you do pass will be searched for the nearest shell widget. If you pass NULL for the callback function, a static local callback which calls XBeep() will be added for you. See mxadwcb.c for more information about what is going on.

void MxAlignLabels ( Widget *  widgets,
int  num 
)

Make labels a uniform width and right justify them.

This routine takes an array of widgets and makes them all as wide as the widest one in the list. This forces XmALIGNMENT_CENTER for buttons and XmALIGNMENT_END for everything else.

Parameters:
widgets Array of widgets to align
num Number of widgets to align
void MxAlignWidgets ( Widget *  widgets,
int  num,
UINT32  flags 
)

Make specified widgets the same width, adjust alignment if requested.

This routine takes an array of widgets and makes them all as wide as the widest one in the list. Flags:

  • 1 = Force XmALIGNMENT_CENTER for buttons and XmALIGNMENT_END for everything else
  • 2 = Force XmALIGNMENT_BEGINNING for everything
Parameters:
widgets Array of widgets to align
num Number of widgets to align
flags Flags
Widget MxAngleControlCreate ( Widget  parent,
double *  pValue,
int  radius,
UINT32  flags,
Arg *  callerargs,
int  numargs 
)

Create a graphical control for entering an angle.

Creates a drawing area which will allow the user to graphically enter an angle. Note that no numeric prompt is created. If you want one, create it yourself, then call MxAngleControlSetPrompt(). By default, the control allows for 360 degrees. If you want to limit it to one or more quadrants, use one or more of the following flags ORd together.

  • MxANGLECONTROL_Quadrant1 Upper Right
  • MxANGLECONTROL_Quadrant2 Upper Left
  • MxANGLECONTROL_Quadrant3 Lower Left
  • MxANGLECONTROL_Quadrant4 Lower Right

There's no guarentee what you'll get if you give three quadrants or two which are diagonaly opposite.

If you intend to add a numeric prompt, you can also pass the following flag to the create function.

  • MxANGLECONTROL_ZeroAtTop

The default is for zero to be along the right X axis and increase counter-clockwise. If you give the ZeroAtTop flag, then zero is at the top (go figure!) and increases clockwise.

Parameters:
pValue Pointer to angle to modify (radians)
radius Radius of control
ERRVALUE MxAngleControlSetPrompt ( Widget  control,
Widget  prompt 
)

Set the numeric prompt for an angular prompt (graphic control).

MxAngleControlCreate only creates the graphic control for setting an angle. If you also want a numeric prompt to reflect the angle, you can create the prompt yourself, placing it wherever you want then call this function.

Widget MxAppShellCreate ( const char *  posnkey,
Arg *  arg,
int  numargs 
)

Create "application shell".

Returns:
unrealized topLevelShell widget
Parameters:
posnkey Name of shell (used for window positioning) NULL ok
arg Argument list
numargs Number of arguments
void MxAssignCursor ( Display *  display,
Window  window,
int  cursor 
)

Assign cursor to a window.

Returns:
0
Widget MxblCreate ( Widget  pwidget,
int  maxsize,
Arg *  formargs,
int  formn 
)

Create "big list".

Returns:
List widget
Parameters:
pwidget Parent widget
void MxblRefresh ( Widget  dform,
INT32  start 
)

Update the list after a change.

Parameters:
dform Widget returned by MxblCreate()
void MxblResize ( Widget  dform,
INT32  numitems,
INT32  start 
)

Change the number of items in the list.

Parameters:
dform Widget returned by MxblCreate()
void MxblSetEditMode ( Widget  dform,
UINT32  mode 
)

Set editing mode.

Parameters:
dform Widget returned by MxblCreate()
mode Mode to set
void MxblSetEditPosn ( Widget  dform,
INT32  editposn 
)

Set "selected" position in list.

Parameters:
dform Widget returned by MxblCreate()
editposn Position to select
void MxblSetEntryCallback ( Widget  dform,
void(*)(INT32, char *, void *)  EntryCB,
void *  udata 
)

Set function to be called to get list entry string.

Parameters:
dform Widget returned by MxblCreate()
udata Function to call
void MxblSetHighlightCallback ( Widget  dform,
void(*)(INT32, void *)  HighlightCB,
void *  udata 
)

Set function to be called when user selects item in list.

Returns:
Parameters:
dform Widget returned by MxblCreate()
udata Function to call
void MxcbDisplayHelp ( Widget  ,
void *  ,
void *   
)

The XmNhelpCallback to any widget that you want to give help to.

The callback data should be a string containing the refcode of the help entry. If the name of the widget is the same as it's refcode, you can just pass null for the callback data.

void MxcbOptionUBYTE ( Widget  w,
void *  voption,
void *   
)

OptionMenu callback for setting UINT8 value.

The userdata parameter specified in MxCreateOptionMenuExt() must be a pointer to the UINT8 variable or member to be set. The MENUITEM.callback_data will contain the values to be set in the specified variable.

void MxcbSetExit ( Widget  ,
void *  ,
void *   
)

Set the exit process.

void MxcbToggleBool ( Widget  ,
void *  vvalue,
XmToggleButtonCallbackStruct *  cbs 
)

Callback for toggling bool variable/member.

The callback data must be a pointer to the 'bool' value to toggle.

void MxcbToggleUBYTE ( Widget  ,
void *  vvalue,
XmToggleButtonCallbackStruct *  cbs 
)

Callback for toggling UINT8 variable/member.

The callback data must be a pointer to the UINT8 value to toggle.

void MxClearWidget ( Widget  widget,
bool  sendexposure = true 
)

Erase specified widget, optionally generating exposure notification.

double MxConvertScreenUnits ( double  val,
int  InUnits,
int  OutUnits 
)

Convert a value from one unit to another.

Returns:
converted value This function allows you to convert distances from various units to another. This differs from the normal unit conversion functions in that is can convert to and from screen pixels. It uses MxTopLevel() to get the display pixel size. Units can be any of the following:
  • SCREENUNIT_Inches
  • SCREENUNIT_mm
  • SCREENUNIT_Points
  • SCREENUNIT_Pixels
  • SCREENUNIT_1OverInches
  • SCREENUNIT_MetersAtCurrentScale
Parameters:
val Value to convert
InUnits Input units (SCREENUNIT_Xxxx values)
OutUnits Output units
MIUNICODE* MxConvertXmStringToUC ( XmString  xmstr  ) 

Convert an XmString to MIUNICODE.

Returns:
a pointer to the MIUNICODE string Free the returned pointer using MmFree() when you are done with it. The input string is not changed by this function in any way.
Parameters:
xmstr XmString to convert
Widget MxCreateButtonColumn ( Widget  ,
BUTTONITEM *  ,
void *  ,
void *  ,
int  ,
Arg *  ,
int   
)

Create column of equal-sized pushbuttons and/or togglebuttons.

Returns:
the widget There is one flag defined for the flags parameter:
  • MxBCOL_ALIGN_BEGINNING Align the labels to the left edge NOTE: If you pass 0, the labels will be centered. Flag field bit values:
  • MxBUTTON_DISABLED Button is initially not "Sensitive"
  • MxBUTTON_TOGGLE Create a toggle button
  • MxBUTTON_ONE_OF_MANY Use one-of-many indicator, enforce radio button behavior
  • MxBUTTON_NOINDICATOR Don't display indicator, button will appear pushed in when selected
  • MxBUTTON_SELECTED Toggle button is initially selected
  • MxBUTTON_IGNORE Ignore this entry, no button will be created for this item
  • MxBUTTON_PROGRAMMER Only display button if in "programmer" mode
The outermost widget created will have no margins so it will exactly cover all the buttons. You should therefore set Offset resource values when making attachments. Typically 10 is a good value for offsets from the edge of the Dialog and between groups of items in the dialog (ie. between the button column and a vertical separator).
Widget MxCreateButtonFieldXe ( Widget  form,
const char *  name,
Widget *  xetext,
Widget *  button,
XtCallbackProc  cbfunc,
void *  cbdata,
Arg *  arglist,
int  argcount 
)

Create form with button and XeText widget for selection.

Returns:
Managed form widget If the userData resource is set in the arglist it will be used for that resource in the button, but NOT the text widget. If the XmNcolumns resource is set in the arglist it will be used for the text widget. The form will also be managed after it is created.
Parameters:
form Parent widget
name Label for button
xetext XeText widget RETURNED (NULL if not needed)
button Button widget RETURNED (NULL if not needed)
cbfunc Callback for button (NULL if none) XmNactivateCallback
cbdata Calback data
arglist Arguments for form
argcount Number of arguments in arglist
Widget MxCreateButtonRow ( Widget  pwidget,
const BUTTONITEM *  buttonitem,
void *  cbdata,
void *  userdata,
int  flags,
const Arg *  ,
int  argcount 
)

Create row of equal-sized pushbuttons and/or togglebuttons.

Returns:
Managed XmForm or XmRowColumn eidget containing buttons Flags:
  • MxBUTTONROW_NoIcons Don't create icon buttons (forced set by this function)
  • MxBUTTONROW_RowColumn Use RowColumn widget instead of Form for button-row
Flag field bit values:
  • MxBUTTON_DISABLED Button is initially not "Sensitive"
  • MxBUTTON_TOGGLE Create a toggle button
  • MxBUTTON_ONE_OF_MANY Use one-of-many indicator, enforce radio button behavior if RowColumn
  • MxBUTTON_NOINDICATOR Don't display indicator, button will appear pushed in when selected
  • MxBUTTON_SELECTED Toggle button is initially selected
  • MxBUTTON_IGNORE Ignore this entry, no button will be created for this item
  • MxBUTTON_PROGRAMMER Only display button if in "programmer" mode
  • MxBUTTON_NOMANAGE Don't manage button (only allowed if MxBUTTONROW_RowColumn flag set)
  • MxBUTTON_ICON_MENU Create popup menu for icon button, callback_data is MENUITEM array
The outermost widget created will have no margins so it will exactly cover all the buttons. You should therefore set Offset resource values when making attachments. Typically 10 is a good value for offsets from the edge of the Dialog and between groups of items in the dialog (ie. between the button row and a horizontal separator).
Parameters:
pwidget Parent widget
buttonitem List of button descriptions (see below)
cbdata Data to pass to all callbacks if value in buttonitem is NULL
userdata Value for userData resource if value in buttonitem is NULL
flags Flags
argcount Argument list for outermost widget created (for attachments) Number of entries in argument list
Widget MxCreateFormDialog ( Widget  pwidget,
const char *  titlestr,
Arg *  arglist,
int  argcount 
)

Drop-in replacement for XmCreateFormDialog.

Copes with title i18n by looking title up in resource file and setting the window property to a UTF8 string which modern window managers can cope with.

Returns:
XmFormDialog widget or NULL if parameter error
Parameters:
pwidget Parent widget
titlestr Title string, must not be NULL
arglist Arguments for dialog creation
argcount Number of argumentsb
Widget MxCreateFormDialog ( Widget  pwidget,
const char *  titlestr,
const char *  helpstr,
XtCallbackProc  cbpopdn,
void *  cbdata,
Arg *  arglist,
int  argcount 
)

Create XmFormDialog and setup help and popdown callbacks.

Returns:
XmFormDialog widget or NULL if parameter error
Parameters:
pwidget Parent widget
titlestr Title string, must not be NULL
helpstr Help string, must not be NULL or "NoHelp"
cbpopdn Callback to handle when use presses [X] to close dialog
cbdata Data to pass to callback
arglist Arguments for dialog creation
argcount Number of argumentsb
Widget MxCreateFrame ( Widget  pwidget,
const XTARGS &  arg,
const char *  label = 0 
)
Parameters:
pwidget Parent widget
arg Widget creation arguments
label Option string for label resource lookup, NULL for no label
Widget MxCreateHTMLWidget ( Widget  parent,
char *  name,
Arg *  arg,
int  n 
)

Create a widget for viewing HTML.

Returns:
HTML widget
Parameters:
parent Parent widget
Widget MxCreateIconButtonRow ( Widget  pwidget,
const MIUNICODE *  iconfile,
const char *  icongroup,
const BUTTONITEM *  buttonitem,
void *  cbdata,
void *  userdata,
int  flags,
const Arg *  arglist,
int  argcount 
)

Create a row of equal-sized icon push and/or toggle buttons.

Returns:
Managed XmForm or XmRowColumn widget containing buttons Flags:
  • MxBUTTONROW_NoIcons Don't create icon buttons (forced set by this function)
  • MxBUTTONROW_RowColumn Use RowColumn widget instead of Form for button-row See also: MxCreateButtonRow
Parameters:
pwidget Parent widget
iconfile NULL for "ICONS.REF"
icongroup Icon group if all from same group (NULL for "standard")
buttonitem List of button descriptions (see MxCreateButtonRow())
cbdata Data to pass to all callbacks if value in buttonitem is NULL
userdata Value for userData resource if value in buttonitem is NULL
flags Flags
arglist Argurment list for outermost widget containing buttons
argcount Number of entries in argument list
Widget MxCreateIconLabel ( Widget  pwidget,
ICONID  iconid,
const MISTRING &  tooltip,
const Arg *  arglist,
int  argcount 
)

Create Label widget with icon instead of text.

Returns:
Managed widget You may pass NULL for the LabelName and the widget will be assigned a generic resource name AND no ToolTip will be generated.
Parameters:
pwidget Parent widget
iconid Icon ID
tooltip ToolTip text
arglist Arguments for button
argcount Number of arguments in arglist
Widget MxCreateIconLabel ( Widget  pwidget,
int  iconhandle,
const char *  IconClass,
const char *  IconName,
const char *  LabelName,
const Arg *  arglist,
int  argcount 
)

Create Label widget with icon instead of text.

Returns:
Managed widget You may pass NULL for the LabelName and the widget will be assigned a generic resource name AND no ToolTip will be generated.
Parameters:
pwidget Parent widget
iconhandle **IGNORED**
IconClass Icon class used if icon object is not already open
IconName Icon name
LabelName Widget Label name, also used for ToolTip
arglist Arguments for button
argcount Number of arguments in arglist
Widget MxCreateIconLabelExt ( Widget  pwidget,
int  iconhandle,
const char *  IconClass,
const char *  IconName,
const char *  StippleName,
const char *  LabelName,
const Arg *  arglist,
int  argcount,
UINT32  flags 
)

Create Label widget with icon instead of text, extended version.

Returns:
Managed widget Flags:
  • MXICON_Stippled Create a "dimmed" version for use when widget is made insensitive only if 'StippleName' is NULL.
  • MXICON_Size16 Resize to 16x16 if smaller
  • MXICON_Size32 Resize to 32x32 if smaller The StippleName field is useful for creating an icon that changes depending on some user input. The change is implemented by setting the sensitivity of the icon. This assumes that you will not be needing the icon to be insensitive. Note that you must specify the MXICON_Stippled flag if you want to make the icon label insensitive. If you do not, the appearance will be the same as the "sensitive" mode. You may pass NULL for the LabelName and the widget will be assigned a generic resource name AND no ToolTip will be generated.
Parameters:
pwidget Parent widget
iconhandle **IGNORED**
IconClass Icon class used if icon object is not already open
IconName Icon name
StippleName Stipple icon name, can be NULL
LabelName Widget label name, also used for ToolTip
arglist Arguments for button
argcount Number of arguments in arglist
flags MXICON_... flags
Widget MxCreateIconPopupMenuButton ( Widget  pwidget,
int  iconhandle,
const char *  IconClass,
const char *  IconName,
const char *  LabelName,
const MENUITEM *  items,
Widget *  widget_list,
void *  data,
void *  udata,
const Arg *  arglist,
int  argcount 
)

Create popup menu widget with specified icon.

Returns:
Managed widget This function will create a menubar and a cascade button that will end up looking like a simple push button icon. If the icon is pressed though, the list specified by the 'items' field will be popped up and the user then may select from that list.
Parameters:
pwidget Parent widget
iconhandle **IGNORED**
IconClass Icon class used if icon object is not already open
IconName Icon name
LabelName Widget label name used for ToolTip
items List of menu items
widget_list List of widgets created returned but the array is not allocated
data Callback data if not specified in the MENUITEM array
udata User data if not specified in the MENUITEM array
arglist Arguments for button
argcount Number of argumentd in arglist
Widget MxCreateIconPushButton ( Widget  pwidget,
const char *  IconGroup,
const char *  IconName,
const char *  LabelName,
XtCallbackProc  ,
void *  cbdata,
const Arg *  arglist,
int  argcount,
UINT32  flags = 0,
RVC::STYLE *  StyleObj = 0 
)

Create Pushbutton widget with specified icon.

Returns:
Managed widget You may pass NULL for the LabelName and the widget will be assigned a generic resource name AND no ToolTip will be generated.
Parameters:
pwidget Parent widget
IconGroup Icon group used if icon object is not already open
IconName Icon name
LabelName Widget label name, also used for ToolTip
cbdata Callback data
arglist Arguments for button
argcount Number of arguments in arglist
flags MXICON_... flags
StyleObj Style object to read icon from (pass NULL for standard icons.ref)
Widget MxCreateIconPushButton ( Widget  pwidget,
ICONID  iconid,
const MISTRING &  tooltip,
XtCallbackProc  cbfunc,
void *  cbdata,
const Arg *  arglist,
int  argcount 
)

Create Pushbutton widget with specified icon.

Returns:
Managed widget You may pass NULL for the LabelName and the widget will be assigned a generic resource name AND no ToolTip will be generated.
Parameters:
pwidget Parent widget
iconid Icon ID
tooltip ToolTip text
cbfunc Callback for XmNactivateCallback
cbdata Callback data
arglist Arguments for button
argcount Number of arguments in arglist
Widget MxCreateIconPushButtonExt ( Widget  pwidget,
int  iconhandle,
const char *  IconClass,
const char *  IconName,
const char *  LabelName,
XtCallbackProc  ,
void *  cbdata,
const Arg *  arglist,
int  argcount,
UINT32  flags 
)

Create PushButton widget with specified icon (extended version).

Returns:
Managed widget Flags:
  • MXICON_Stippled Create a "dimmed" version for use when widget is made insensitive
  • MXICON_Size16 Resize to 16x16 if smaller
  • MXICON_Size32 Resize to 32x32 if smaller Note that you must specify the MXICON_Stippled flag if you want to make the icon label insensitive. If you do not, the appearance will be the same as the "sensitive" mode. You may pass NULL for the LabelName and the widget will be assigned a generic resource name AND no ToolTip will be generated.
Parameters:
pwidget Parent widget
iconhandle **IGNORED**
IconClass Icon class used if icon object is not already open
IconName Icon name
LabelName Widget label name, also used for ToolTip
cbdata Callback data
arglist Arguments for button
argcount Number of arguments in arglist
flags MXICON_... flags
Widget MxCreateIconToggleButton ( Widget  pwidget,
int  iconhandle,
const char *  IconClass,
const char *  IconName,
const char *  LabelName,
void(*)(Widget, void *, XmToggleButtonCallbackStruct *)  ,
void *  cbdata,
const Arg *  arglist,
int  argcount 
)

Create ToggleButton widget with specified icon.

Returns:
Managed widget The ToggleButton will not have a separate "indicator". The entire button will appear pushed-in when selected. You may pass NULL for the LabelName and the widget will be assigned a generic resource name AND no ToolTip will be generated.
Parameters:
pwidget Parent widget
iconhandle **IGNORED**
IconClass Icon class used if icon object is not already open
IconName Icon name
LabelName Widget label name, also used for ToolTip
cbdata Callback for XmNactivateCallback Callback data
arglist Arguments for button
argcount Number of arguments in arglist
Widget MxCreateIconToggleButtonExt ( Widget  pwidget,
int  iconhandle,
const char *  IconClass,
const char *  UnselIconName,
const char *  SelectedIconName,
const char *  LabelName,
void(*)(Widget, void *, XmToggleButtonCallbackStruct *)  ,
void *  cbdata,
const Arg *  arglist,
int  argcount,
UINT32  flags 
)

Create ToggleButton widget with specified icon (extended version).

Returns:
Managed widget Flags:
  • MXICON_Stippled Create "dimmed" version for use when widget is made insensitive
  • MXICON_StippledSelected Create "dimmed" version for use when widget is "selected" and insensitive
  • MXICON_Size16 Resize to 16x16 if smaller
  • MXICON_Size32 Resize to 32x32 if smaller
  • MXICON_NoDarkenSelected Don't darken background of button when "selected" (icons must be different) Note that you must specify the MXICON_Stippled flag if you want to make the icon label insensitive. If you do not, the appearance will be the same as the "sensitive" mode. If a different appearance is desired when the ToggleButton is both "selected" and "insensitive" you must specify the MXICON_StippledSelected flag as well. The ToggleButton will not have a separate "indicator". The entire button will appear pushed-in when selected.
Parameters:
pwidget Parent widget
iconhandle **IGNORED**
IconClass Icon class used if icon object is not already open
UnselIconName Icon name to use for "unselected" state
SelectedIconName Icon name to use for "selected" state
LabelName Widget label name used for ToolTip
cbdata Callback for XmNactivateCallback Callback data
arglist Arguments for button
argcount Number of arguments in arglist
flags MXICON_... flags
int MxCreateImageFromWidget ( Widget  widget,
XImage **  ximage,
void **  buffer,
int  width,
int  height 
)

Create XImage from specified widget.

Returns:
Error < 0 This function will create a ZPixmap image using the depth and visual information from the widget provided. If a multi-line image is created each line will be 32-bit aligned.
Parameters:
widget Widget to create image from (NULL for toplevel)
ximage Image pointer returned
buffer Buffer allocated and returned
width Width of image
height Height of image
Widget MxCreateLabel ( Widget  parent,
const MISTRING &  label,
Arg *  arglist,
int  argcount 
)

End of extern "C".

Creates and manage XmLabel from MIUNICODE* string.

Returns:
XmLabel widget.
Parameters:
parent Parent widget
label String for label.
arglist Arguments
argcount Number of arguments
Widget MxCreateLabel ( Widget  parent,
const char *  name,
Arg *  arglist,
int  argcount 
)

Creates and manage XmLabel from char* string with resource lookup.

Returns:
XmLabel widget.
Parameters:
parent Parent widget
name Label name, will be used for resource lookup.
arglist Arguments
argcount Number of arguments
Widget MxCreateLabelFieldXe ( Widget  form,
const char *  name,
Widget *  xetext,
Widget *  label,
Arg *  arglist,
int  argcount 
)

Create button and XeText widget.

Returns:
Managed widget
Widget MxCreateLatLonFormatOptionMenu ( Widget  pwidget,
char *  label,
UINT32  dftfmt,
void(*)(Widget, void *, void *)  ,
void *  userdata,
Arg *  arglist,
int  argcount 
)

Create OptionMenu for selection Latitude-Longitude format.

Returns:
Managed OptionMenu widget The "format" will be passed to the callback as the callback data. Use MxGetUserData() to retrieve the specified "userdata" value from the callback widget.
Parameters:
pwidget Parent widget
label Label for OptionMenu
dftfmt Default format (DMSTYPE_...)
userdata OptionMenu callback Userdata attached to widget passed to callback
arglist Argument list
argcount Argument count
Widget MxCreateManualPopupMenu ( Widget  parent,
const char *  title,
const MENUITEM *  items,
Widget *  widget_list,
void *  data,
void *  udata 
)

Creates a popup menu without an event handler.

Returns:
Menu widget
Parameters:
parent Parent widget
title Title for menu
items Items for menu
Widget MxCreateMenuBar ( Widget  pwidget,
const MENUBARITEM *  menus,
void *  clientdata,
void *  userdata 
)

Create menubar with complete pull-down menu system.

Returns:
Unmanaged menu bar (RowColumn) widget The sides and top of the menubar are automatically attached to the parent
Parameters:
pwidget Parent widget, should be a Form or subclass thereof
menus Array defining meu bar items, last item must have label of NULL
clientdata Callback data to use if not specified in menu item
userdata Value to set "userData" resource to for each gadget in menu
Widget MxCreateOptionMenu ( Widget  pwidget,
const char *  title,
const MENUITEM *  items,
void *  userdata 
)

Create OptionMenu with Label and CascadeButton.

Returns:
Unmanaged OptionMenu widget This function will create an option menu. One (and only one) of the items in the item list should have the MxMENU_SELECTED flag set. This will be the deault value for the menu. When the user selects something off of the option menu, that item's callback funciton will be called and given its callback data. The userdata parameter allows you to attach something to the XmNuserData resource of all the items.
Parameters:
pwidget Parent widget
title Title for menu
items Items for option menu, last element must have label of NULL
userdata Value to set "userData" resource to for each gadget in menu
Widget MxCreateOptionMenuExt ( Widget  pwidget,
const char *  title,
const MENUITEM *  items,
void *  userdata,
const Arg *  arglist,
int  argcount 
)

Create OptionMenu with specified resources and manage it.

Returns:
Managed OptionMenu widget This funciton will create an option menu. One (and only one) of the items in the item list should have the MxMENU_SELECTED flag set. This will be the deault value for the menu. When the user selects something off of the option menu, that item's callback funciton will be called and given its callback data. The userdata parameter allows you to attach something to the XmNuserData resource of all the items.
Parameters:
pwidget Parent widget
title Title for menu
items Items for option menu, last element must have label of NULL
userdata Value to set "userData" resource to for each gadget in menu
arglist Arguments for resource settings
argcount Number of arguments in arglist
Widget MxCreatePopupMenu ( Widget  parent,
const char *  title,
const MENUITEM *  items,
Widget *  widget_list,
void *  data,
void *  udata 
)

Create a popup menu.

Returns:
Unmanaged widget This function creates a popup menu which is activated by pressing the right mouse button over the parent widget. Do not manage the widget returned yourself because that will cause the menu to pop up on its own.
Parameters:
parent Widget to check RMB event on
title No idea what this is for, fake it
items List of menu items
widget_list List of widgets created returned but the array is not allocated
data Callback data if not specified in the MENUITEM array
udata User data if not specified in the MENUITEM array
Widget MxCreatePulldownMenu ( Widget  parent,
const MIUNICODE *  label,
const MENUITEM *  items,
void *  cbdata,
void *  udata 
)

Create a pulldown menu.

Returns:
Unmanaged widget
Parameters:
parent Parent menu widget
label Menu label
items List of menu items
cbdata Callback data if not specified in the MENUITEM array
udata User data if not specified in the MENUITEM array
Widget MxCreatePushButton ( Widget  pwidget,
const char *  name,
XtCallbackProc  ,
void *  cbdata,
Arg *  arglist,
int  argcount 
)

Create and manage PushButton widget and add callback.

Returns:
Managed widget
Parameters:
pwidget Parent widget
name Widget name
cbdata Callback data
arglist Arguments for button
argcount Number of arguments in arglist
Widget MxCreateTextEncodingLB ( Widget  pwidget,
const char *  label,
CHAR_ENCODING &  encoding,
ENCODELIST_FLAGS  enclistflags,
Arg *  arglist,
int  argcount 
)

Create ListButton for selecting text character encoding (CHAR_ENCODING).

Returns:
Widget
Parameters:
pwidget Parent widget
label Label for button
encoding Encoding reference, value will be changed when selection made
enclistflags Flags specifying which encodings are allowed
arglist Parameters for attacment
argcount Number of arglist entries
Widget MxCreateToggleButton ( Widget  pwidget,
const char *  name,
void(*)(Widget, void *, XmToggleButtonCallbackStruct *)  ,
void *  cbdata,
Arg *  arglist,
int  argcount 
)

Create and manage ToggleButton widget and add callback.

Returns:
Managed widget
Parameters:
pwidget Parent widget
name Widget name
cbdata Callback for XmNvalueChangedCallback Callback data
arglist Arguments for button
argcount Number of arguments in arglist
XmString MxCreateXmStringUC ( const MIUNICODE *const   string,
MGD::INTERFACETEXTSTYLE  style = MGD::INTERFACETEXTSTYLE_Normal 
)

Create an XmString from Unicode.

Returns:
Converted string Creates an XmString for use in labels, buttons, XmLists, etc... Use this function instead of XmStringCreateXxx(). Call XmStringFree() to free the string. Automatically handles selecting fonts for I18N.
Parameters:
string String to convert
void MxDestroyPopupMenu ( Widget  parent,
Widget  popup 
)

Destroy a popup menu.

Parameters:
parent Parent widget
popup Popup menu to destroy
void MxDestroyTopLevel (  ) 

Destroy TopLevel widget.

void MxDisplayHelp ( Widget  parent,
const char *  helpid 
)

Display help for given ID.

Parameters:
parent Parent widget
helpid Help ID
void MxDisplayHelpByID ( Widget  parent,
HELPID  helpid 
)

Display help for given HELPID.

Parameters:
parent Parent widget
int MxEditBitmapCursor ( Widget  pwidget,
FILEPATH *  filename,
int  flags 
)

Allow user to edit X bitmaps.

Error < 0

int MxEditBitmapPattern ( Widget  pwidget,
const RVC::OBJITEM &  StyleObjItem,
INT32  pattnum,
const COLOR &  varcolor,
UINT32  flags 
)

Dialog allowing user to edit bitmap patterns.

Error < 0

Parameters:
pwidget Parent widget for dialog
pattnum Pattern number
varcolor Variable color value passed/returned
flags None currently defined
void MxEditButtonsAddCallbacks ( void *  handle,
Widget  textwidget 
)

Add callbacks for Cut/Copy/Paste/Find button row.

See MxEditButtonsCreate() for more information.

Parameters:
handle Handle returned from MxEditButtonsCreate()
textwidget The XeText widget to monitor.
const BUTTONITEM* MxEditButtonsCreate ( void **  handle,
MxEDITMENUFLAGS  flags = MxEDITMENUFLAG_None,
void(*)(Widget, void *)  undofunc = 0,
void *  undodata = 0 
)

Create a BUTTONITEM array for a Cut/Copy/Paste/Undo/Find button row.

This functions the same as MxEditMenuCreate() but it creates an array of BUTTONITEMS for an icon button row instead.

Parameters:
handle A pointer to the edit menu's private data (returned) It should be passed to MxEditMenuAddCallbacks() once the text widget has been created.
flags Flags, Possible values are:

  • MxEDITMENUFLAG_NoInsertFile Don't provide an "Insert File" menu item
  • MxEDITMENUFLAG_NoSearch Don't provide a "Find" menu item
  • MxEDITMENUFLAG_NoReplace Don't provide a "Replace" menu item
  • MxEDITMENUFLAG_None None of the above
undofunc Function to call when "undo" is selected. If 0, then the menu won't have an "undo" option.
undodata Passed to the undofunc as its second parameter
Returns:
array of MENUITEMS. Do not free this pointer.
See also:
MxEditMenuCreate()
int MxEditColor ( Widget  parent,
EDITCOLORINFO *  EditColorInfo,
int  numcolors,
UINT32  flags,
Widget *  notused 
)

Dialog allowing user to edit color levels for one or more colors.

Returns:
Error code if < 0 (EUserCancel if user cancels) or 0 if no error Flags:
  • EDITCOLOR_AllowTransp Allows transparency toggle.
  • EDITCOLOR_AllowTransPct Allows setting of transparency 0-100%
Parameters:
parent Parent widget
EditColorInfo List of color specifiecations (POINTER IS RETAINED FOR INTERNAL USE)
numcolors Number of colors in list
flags Flag bits
notused Obsolete
int MxEditHatchPattern ( Widget  pwidget,
const RVC::OBJITEM &  StyleObjItem,
INT32  pattnum,
COLOR *  varcolor,
UINT32  flags 
)

Dialog allowing user to edit hatch patterns.

Error < 0

Parameters:
pwidget Parent widget for dialog
StyleObjItem Location of style object to edit hatch patterns on
pattnum Pattern number
varcolor Variable color value passed/returned
flags None currently defined
void MxEditMenuAddCallbacks ( void *  handle,
Widget  textwidget 
)

Add callbacks to an Edit Menu.

See MxEditMenuCreate() for more information. Note, you can add EditMenu callbacks to multiple text widgets as long as they're in the same dialog. The menu's callbacks will operate on which ever text widget had focus last.

Parameters:
handle Handle returned from MxEditMenuCreate()
textwidget The XeText widget to monitor.
const MENUITEM* MxEditMenuCreate ( Widget  shell,
void **  handle,
MxEDITMENUFLAGS  flags = MxEDITMENUFLAG_None,
void(*)(Widget, void *)  undofunc = 0,
void *  undodata = 0 
)

Create a MENUITEM array for an edit menu.

Creating an edit menu is a two step process. First you call MxEditMenuCreate() to create the MENUITEM array which can be used to create the menu bar for a window. Then you call MxEditMenuAddCallbacks() to once the text widget has been created.

Parameters:
shell The shell which will contain the menubar. Actually, you can pass any widget within the shell. It will find the shell for you.
handle A pointer to the edit menu's private data (returned) It should be passed to MxEditMenuAddCallbacks() once the text widget has been created.
flags Flags, Possible values are:

  • MxEDITMENUFLAG_NoInsertFile Don't provide an "Insert File" menu item
  • MxEDITMENUFLAG_NoSearch Don't provide a "Find" menu item
  • MxEDITMENUFLAG_NoReplace Don't provide a "Replace" menu item
  • MxEDITMENUFLAG_None None of the above
undofunc Function to call when "undo" is selected. If 0, then the menu won't have an "undo" option.
undodata Passed to the undofunc as its second parameter
Returns:
array of MENUITEMS. Do not free this pointer.
See also:
MxEditButtonsCreate()
DEPRECATED const MENUITEM* MxEditMenuCreate ( void **  handle,
MxEDITMENUFLAGS  flags = MxEDITMENUFLAG_None,
void(*)(Widget, void *)  undofunc = 0,
void *  undodata = 0 
)

Create a MENUITEM array for an edit menu.

Creating an edit menu is a two step process. First you call MxEditMenuCreate() to create the MENUITEM array which can be used to create the menu bar for a window. Then you call MxEditMenuAddCallbacks() to once the text widget has been created.

Parameters:
handle A pointer to the edit menu's private data (returned) It should be passed to MxEditMenuAddCallbacks() once the text widget has been created.
flags Flags, Possible values are:

  • MxEDITMENUFLAG_NoInsertFile Don't provide an "Insert File" menu item
  • MxEDITMENUFLAG_NoSearch Don't provide a "Find" menu item
  • MxEDITMENUFLAG_NoReplace Don't provide a "Replace" menu item
  • MxEDITMENUFLAG_None None of the above
undofunc Function to call when "undo" is selected. If 0, then the menu won't have an "undo" option.
undodata Passed to the undofunc as its second parameter
Returns:
array of MENUITEMS. Do not free this pointer.
See also:
MxEditButtonsCreate()
Deprecated:
Use the version which takes a shell as the first parameter
int MxEditSymbol ( Widget  pwidget,
const RVC::OBJITEM &  StyleObjItem,
INT32  pattnum,
COLOR *  varcolor,
UINT32  flags 
)

Dialog allowing user to edit symbols.

Returns:
Error < 0
Parameters:
pwidget Parent widget for dialog
pattnum Pattern number
varcolor Variable color value passed/returned
flags None currently defined
void MxEnableMouseWheel ( Widget  owner,
Widget  scrollbar,
int  increment = 3 
)

Add mouse-wheel scroll support to an X widget.

The "owner" widget is the widget which will watch for mouse wheel events, and will scroll the given scroll bar. The increment parameter is the number of "units" to scroll by. If 0, it will scroll by about 90% of the scroll bar's page increment value.

Widget MxFindNamedChildWidget ( Widget  parent,
char *  name 
)

Find child widget with specified name.

Returns:
Child widget or NULL if none found
Parameters:
parent Parent widget
name Widget name to look for
void MxFixWindowSizeForAppleX11 ( Widget  mainform  ) 

Fix the size of a window to compensate for broken Apple X11 server.

The Apple X11 server incorrectly sizes some dialogs to be 22 pixels higher than they should be. This happens to be the height of the title bar. To compensate, call MxFixWindowSizeForAppleX11 just before managing the main form

void MxForceDialog ( Widget  w  ) 

Ensures the contents of a dialog window will become visible before returning.

Parameters:
w Any widget in the dialog (BulletinBoard child or a DialogShell)
void MxForceWindowOnScreen ( Widget  ,
int   
)

Force window to be entirely on screen.

This function in automatically invoked by MxWaitForUnmap() and MxMainLoopUntilExitSet(). If the widget is an ApplicationShell it should be called after the shell is realized.

Pixel MxGetColorPixel ( COLOR const &  color  ) 

Get pixel value corresponding to specified color.

Parameters:
color Color
Pixel MxGetColorPixelNoICM ( COLOR const &  color  ) 

Get pixel value corresponding to specified color.

This version ignores the display device's ICM profile, if any.

Parameters:
color Color
XmFontList MxGetDefaultFontList (  ) 

Get fontList resource as read from [xfontlist] in tntproc.ini.

Notes: Do not free the XmFontList that is returned. It is kept internally for global use. Requires a TopLevel to be present and MxInitProc() must have been called already. This fontList allows proper display of XmStr's for use in i18n.

const char* MxGetDefaultSystemXLFD (  ) 

Get XLFD for default system font to use if no other available.

const char* MxGetDefaultUIFont (  ) 

Get XLFD for default user interface font.

void MxGetDisplayInfo ( Widget  widget,
DISPLAYINFO *  displayinfo 
)

Fill in DISPLAYINFO structure from a widget.

Parameters:
widget Widget to use as reference (NULL to use toplevel)
displayinfo Information about display/scree/visual returned
void MxGetDrawingAreaSize ( Widget  dawidget,
INT16 &  width,
INT16 &  height 
)

Get dimensions of DrawingArea widget.

Parameters:
dawidget DrawingArea widget, if 0 will return sizes of 0
width Width in pixels returned
height Height in pixels returned
int MxGetFontStructFromWidget ( Widget  widget,
XFontStruct *  fontstruct 
)

Fill in XFontStruct structure from a widget.

Returns:
Error code < 0 or 0 if no error
Parameters:
widget Widget to use
fontstruct Font information structure to fill in
int MxGetMaxFontAscent ( bool  bForClipping = false  ) 

Return the maximum ascent of the fonts in the default font list.

Ascent is the part of the font above the baseline

Parameters:
bForClipping If true, the ascent may include bits of glyphs which normally extend past the design ascent. If false, it uses the ascent as specified by the font designer.
int MxGetMaxFontDescent ( bool  bForClipping = false  ) 

Return the maximum descent of the fonts in the default font list.

Descent is the part of the font below the baseline

Parameters:
bForClipping If true, the descent may include bits of glyphs which normally extend below the design descent. If false, it uses the descent as specified by the font designer.
int MxGetMaxFontHeight ( bool  bForClipping = false  ) 

Return the maximum height (ascent+descent) of the fonts in the default font list.

Parameters:
bForClipping If true, the height may include bits of glyphs which normally extend outside the design descent. If false, it uses the height as specified by the font designer.
int MxGetMaxFontWidth (  ) 

Return the maximum character width in the fonts in the default font list.

See also:
MxGetTypicalFontWidth()
void* MxGetNamedUserData ( Widget  widget,
const char *  name 
)

Get a tagged user data resource for a widget.

Returns:
Pointer to attached data or NULL if no match
Parameters:
widget Widget data is attached to
name String used as a tag
void MxGetScrollAreaSize ( Widget  ,
int *  width,
int *  height 
)

Get actual size of scrollable area in ScrolledWindow.

Parameters:
width Width returned (NULL if don't need)
height Height returned (NULL if don't need)
Widget MxGetShell ( Widget  widget  ) 

Traverses up widget tree to closest parent of class "Shell".

Returns:
Shell widget Used to get a shell widget when a parent is needed for creating pop-ups.
Parameters:
widget Widget to start traversal at
Pixel MxGetStdColorPixel ( int  index  ) 

Return pixel matching specified "standard color" index.

Returns:
Pixel value
Parameters:
index Standard color index (0 - NUMSTDCOLORS-1)
void MxGetStdColorPixels ( Pixel *  stdpixel  ) 

Fill in array of "standard" color pixels.

Parameters:
stdpixel Array to contain result, must have at least NUMSTDCOLORS entries
void MxGetStdColors ( COLOR  stdcolor[NUMSTDCOLORS]  ) 

Fill in COLOR array for "standard colors".

Parameters:
stdcolor Color array filled in
int MxGetSystemPreferences ( Widget  pwidget  ) 

Get main TNT system preferences.

Parameters:
pwidget Parent widget
Widget MxGetTopLevel ( Widget  widget  ) 

Traverses up widget tree to TopLevelShell.

Returns:
Shell widget Used to get a shell widget when a parent is needed for creating pop-ups.
Parameters:
widget Widget to start traversal at
Widget MxGetTopShell ( Widget  widget  ) 

Traverses up widget tree to WMShell.

Returns:
Shell widget Used to get a shell widget when a parent is needed for creating pop-ups.
Parameters:
widget Widget to start traversal at
int MxGetTypicalFontWidth (  ) 

Return the typical character width in the fonts in the default font list.

This will be the mean width of all glyphs font. In the case where the default font list contains multiple fonts, this will return the maximum typical width of all fonts. I.e., each font has a typical width of its own, and this will return the mean width of the widest font.

See also:
MxGetMaxFontWidth()
int MxGetTypicalFontWidth2 ( MGD::INTERFACETEXTSTYLE  style = MGD::INTERFACETEXTSTYLE_Normal  ) 

Same as MxGetTypicalFontWidth2, but only check fonts of a given style.

If no fonts of the requested style exist, returns typical "normal" width.

void* MxGetUserDataPtr ( Widget  widget  )  [inline]

Obtain value of userData resource attached to widget.

Parameters:
widget Widget to obtain userData for
MIUNICODE* MxGetWidgetLabelString ( Widget  widget  ) 

Return string for widget label.

Returns:
string This function will access the XmNlabekString resource for the specified widget and convert it to a text string.
Parameters:
widget Widget to return string for
void MxGetWidgetSize ( Widget  widget,
Dimension &  width,
Dimension &  height 
)

Get widget dimensions.

int MxGetWindowBorders ( Widget  widget,
int *  left,
int *  right,
int *  top,
int *  bottom 
)

Returns borders around window up to but not including root window.

This function computes the borders taking into account the size of all gadgets/decorations added by the window manager. It is useful for determing the size of a window needed to fill the entire screen.

Parameters:
widget Widget to use for borders
left Left border returned
right Right border returned
top Top border returned
bottom Bottom border returned
void MxGetWindowPosition ( Widget  w,
int *  px,
int *  py 
)

Returns the window position.

Parameters:
w Widget to find position for
px X coordinate returned
py Y coordinate returned
void MxIconAddDestroyCallback ( Widget  widget,
MICONSTRUCT *   
)

Add callback to free icon when widget destroyed.

This function should be used for every icon attached to a widget. It will be automatically called for the various MxCreateIcon... functions (eg. MxCreateIconPushButton).

Parameters:
widget Widget to add callback to
void MxIconDrawDimmed ( Display *  display,
Drawable  drawable,
GC  gc,
int  x,
int  y,
MICONSTRUCT *  icon 
)

Draw icon on X drawable in "dimmed" colors.

Note that if a "dimmed" pixmap is not available fr the icon the normal pixmap will be used.

Parameters:
display X display
drawable X drawable (Window or Pixmap)
gc X graphic context
x X coordinate
y Y coordinate
icon Icon to draw
void MxIconDrawNormal ( Display *  display,
Drawable  drawable,
GC  gc,
int  x,
int  y,
MICONSTRUCT *  icon 
)

Draw icon on X drawable in "normal" colors.

Parameters:
display X display
drawable X drawable (Window or Pixmap)
gc X graphic context
x X coordinate
y Y coordinate
icon Icon to draw
Pixmap MxIconGetPixmapDimmed ( const MICONSTRUCT *  icon  ) 

Get "dimmed" X pixmap for icon.

Returns:
X pixmap Note that if a dimmed pixmap is not available the normal pixmap will be returned.
Parameters:
icon Icon
Pixmap MxIconGetPixmapNormal ( const MICONSTRUCT *  icon  ) 

Get "normal" X pixmap for icon.

Returns:
X pixmap
Parameters:
icon Icon
int MxIsExitingProcess (  ) 

Determine if process exiting.

int MxIsTimeOutInMainLoop (  ) 

Determine if TimeOut callback invoked from main event loop.

Returns:
TRUE if in main event loop, FALSE if in modal dialog event loop
DEPRECATED Widget MxListButtonCreate ( Widget  pw,
const char *  label,
int  NumItems,
int  maxlen,
MIUNICODE *(*)(int, void *)  GetItemFunc,
void(*)(int, void *)  NotifyFunc,
void *  FuncData,
Arg *  arglist,
int  argcount 
)

Create composite widget containing button/text for selection from list.

Returns:
ButtonField (form) widget or NULL if out of memory MIUNICODE *GetItemFunc (itemnum, funcdata) int itemnum Item number (0 - NumItems-1) void *funcdata Hook data Returns ALLOCATED pointer to string (WILL be free()d) void NotifyFunc (newitem, funcdata) int newitem Item number selected void *funcdata Hook data
Deprecated:
Use MGUI::FORM_COMBOBOX
Parameters:
pw Parent widget
label resource name
NumItems Number of items in list
maxlen Maximum item length (characters)
NotifyFunc Function to retriece items for list
FuncData Function to notify application when item selected Hook data for functions
arglist Argument list for ButtonField creation
argcount Number of arguments
DEPRECATED void MxListButtonSetHelpID ( Widget  listbutton,
const char *  helpid 
)

Set help Id for "list button" pop-in dialog.

Deprecated:
Use MGUI::FORM_COMBOBOX
Parameters:
listbutton ListButton widget
helpid Help ID
DEPRECATED void MxListButtonSetItem ( Widget  listbutton,
int  itemnum,
int  notify 
)

Set current item for "list button".

Deprecated:
Use MGUI::FORM_COMBOBOX
Parameters:
listbutton ListButton widget
itemnum New item number
notify Set if NotifyFunc should be called
DEPRECATED void MxListButtonSetNumItems ( Widget  listbutton,
int  NumItems 
)

Set number of items for list button.

Deprecated:
Use MGUI::FORM_COMBOBOX
Parameters:
listbutton ListButton widget
NumItems New number of items
DEPRECATED void MxListButtonSetTitle ( Widget  listbutton,
const char *  title 
)

Set title for "list button" pop-in dialog.

Deprecated:
Use MGUI::FORM_COMBOBOX
Parameters:
listbutton ListButton widget
title Title for dialog
void MxListDisableKeySelect ( Widget  list  ) 

Disable keyboard selection of list entries.

This will remove the event handler which permits key selection. If no event handler is currently logged the request will be ignored.

Parameters:
list List widget
void MxListEnableKeySelect ( Widget  list,
int  start 
)

Enable keyboard selection of list entries.

This will add an event handler which permits rapid selection of entries in a list via the keyboard. When the user types a character the first entry in the list (beginning with the specifed start position) whose first nonblank character is greater than or equal to the typed character will be selected. This comparison in non-case-sensitive and assumes that the portion of the list to be searched is sorted in ascending non-case-sensitive order. This function may be called multiple times with no ill effects. The last specified "start" value will be used. MxListDisableKeySelect() does not need to be called between invocations unless desired.

Parameters:
list List widget
start Starting entry to begin search (first entry is 1 like in list)
void MxListEnableMouseWheel ( Widget  owner,
int  increment = 3 
)

Add mouse-wheel scroll support to an XmList widget.

This function is the same as MxEnableMouseWheel, except that it retrieves the XmNverticalScrollBar resource from the widget for you.

void MxLockWindowSize ( Widget  widget,
UINT32  flags = MxLOCKSIZE_MinMax 
)

Lock specified window minimum/maxumum sizes to current size.

Flags:

  • MxLOCKSIZE_MinHeight Set minimum height to current height
  • MxLOCKSIZE_MinWidth Set minimum height to current width
  • MxLOCKSIZE_MaxHeight Set maximum height to current height
  • MxLOCKSIZE_MaxWidth Set maximum height to current width
  • MxLOCKSIZE_Min Set minimum size to current size
  • MxLOCKSIZE_Max Set maximum size to current size
  • MxLOCKSIZE_MinMax Don't allow window to be resized at all

Note that this function MUST be invoked AFTER the window is managed or realized.

Parameters:
widget Widget (ancestor shell will be used if not shell itself)
flags Flags - MxLOCKSIZE_MinMax will be used if 0
void MxLockWindowSizeAbs ( Widget  widget,
int  height,
int  width,
UINT32  flags 
)

Lock specified window minimum/maximum sizes to an absolute size.

Flags:

  • MxLOCKSIZE_MinHeight Set minimum height to given height
  • MxLOCKSIZE_MinWidth Set minimum height to given width
  • MxLOCKSIZE_MaxHeight Set maximum height to given height
  • MxLOCKSIZE_MaxWidth Set maximum height to given width
  • MxLOCKSIZE_Min Set minimum size to given size
  • MxLOCKSIZE_Max Set maximum size to given size
  • MxLOCKSIZE_MinMax Don't allow window to be resized at all

Note that this function MUST be invoked AFTER the window is managed or realized.

Parameters:
widget Widget (ancestor shell will be used if not shell itself)
height Maximum/minimum height
width Maximum/minimum width
flags Flags - MxLOCKSIZE_MinMax will be used if 0
void MxLockWindowSizeRel ( Widget  widget,
int  dheight,
int  dwidth,
UINT32  flags 
)

Lock specified window minimum/maximum sizes relative to current size.

Flags:

  • MxLOCKSIZE_MinHeight Set minimum height to current height
  • MxLOCKSIZE_MinWidth Set minimum height to current width
  • MxLOCKSIZE_MaxHeight Set maximum height to current height
  • MxLOCKSIZE_MaxWidth Set maximum height to current width
  • MxLOCKSIZE_Min Set minimum size to current size
  • MxLOCKSIZE_Max Set maximum size to current size Note that this function MUST be invoked AFTER the window is managed or realized. This function will set the minimum or maximum sizes of the shell to be the current size plus dheight and dwidth.
Parameters:
widget Widget (ancestor shell will be used if not shell itself)
dheight Change in height
dwidth Change in width
flags Flags - MxLOCKSIZE_MinMax will be used if 0
void MxMainLoopUntilConditionMet ( DELEGATE_BOOL_NOPARMS  Delegate  ) 

Main loop until a delegate returns true.

void MxMainLoopUntilExitSet (  ) 

Perform "main" Xt event processing loop until MxSetExitProcess() is called.

This function is used instead of XtAppMainLoop() to handle event processing while allowing a nice exit from the program instead of forcing the programmer to use exit(). Example:

      static void CB_Exit (
         Widget w,
         void *clientdata,
         XmAnyCallbackStruct *cbdata
         ) {
            MxSetExitProcess();
            }

      main (
      int argc,
      char *argv[]
      ) {
      Widget toplevel;

      toplevel = MxInit(&argc,argv,FallbackList);

      ... create application widgets and such

      XtRealizeWidget(toplevel);
         MxMainLoopUntilExitSet();
      XtDestroyWidget(toplevel);
         MxMainLoopWhilePending();
      return(0);
      }
void MxMainLoopWhilePending (  ) 

Perform "main" Xt event processing while events are pending.

See MxMainLoopUntilExitSet() for details.

void MxMakeListPosCentered ( Widget  listw,
int  listitem 
)

Make list widget scroll to be centered on specified item position.

Parameters:
listw List widget
listitem Item to center on
void MxMakeListPosVisible ( Widget  listw,
int  listitem 
)

Make list widget position visible.

If 0 is passed for "listitem", the last item in the list will be made visible.

Parameters:
listw List widget
listitem Item to make visible
DEPRECATED void MxMakeObjectList ( Widget  list,
const RVC::OBJITEMLIST &  items 
)

Put list of file / object names in XmList.

Deprecated:
Use RVC::UI::FORM_OBJECT_LIST.
Parameters:
list XmList widget
items File / object name linked list
Widget MxMenuFileCreateIconPulldown ( Widget  pwidget,
const FILEPATH &  filepath,
XtCallbackProc  CB_Internal,
int  IconHandle,
const char *  IconGroup,
const char *  IconName,
const char *  LabelName,
const Arg *  arglist,
int  argcount 
)

Create icon pulldown menu with items read from file.

Returns:
Menu widget
Parameters:
pwidget Parent widget
CB_Internal Callback function
arglist Argument list
argcount Number of arguments
int MxMenuFileLoad ( Widget  pwidget,
const FILEPATH &  filepath,
XtCallbackProc  CB_Internal,
XtCallbackProc  CB_Executable = 0,
FastDelegate< void(Widget, const char *, int)>  DelegateAddSpecial = 0 
)

Load menu file, creating pulldown/cascading menus.

Parameters:
pwidget Parent widget
filepath Path to file to load
CB_Internal Function to call for "internal" options
CB_Executable Function to call for 'executable' options
int MxMenuGetNumItems ( const MENUITEM *  items  ) 

Count number of items in MENUITEM array including terminating item.

Returns:
number of items
void MxMenuInitSelectedByCallbackData ( MENUITEM *  menuitem,
void *  cbdata 
)

Initialize flags to MxMENU_SELECTED if item's callback_data matched given value.

Parameters:
menuitem Menu definition array
cbdata Callback data to match
void MxMenuInitSelectedByUserData ( MENUITEM *  menuitem,
void *  userdata 
)

Initialize flags to MxMENU_SELECTED if item's userdata matches given value.

Parameters:
menuitem Menu definition array
userdata User data to match
Widget MxMenuItemWidget ( Widget  menubar,
const char *  path 
)

Find and return the widget for a given menu item.

Returns:
Widget corresponding to menu item or NULL if cannot find This routine finds and returns the widget for a given menu item. This should be a string formatted as: "/file/open/..." If one of the menu entries has a "/" in it, another delimiter can be used as long as it is consistent.
Parameters:
menubar The menubar widget
path Path
void MxMsgLineClear ( Widget  msgline  ) 

Clear "message line".

Parameters:
msgline Message widget from MxMsgLineCreate()
Widget MxMsgLineCreate ( Widget  pwidget,
Arg *  arglist,
int  argcount 
)

Create "message line" at bottom of form for displaying messages.

Returns:
"Message Line" widget (XeText) The message widget will be attached to the bottom, left and right sides of the parent, assuming it is a Form widget. In addition, the offsets and highlightThickness will be set to 0. The message widget will not be editable. WARNING: Do not use XmTextSetString() on the message widget or your program will crash.
Parameters:
pwidget Parent widget
arglist Resource argument list
argcount Number of entries in arglist
void MxMsgLineSetError ( Widget  msgline,
ERRVALUE  errcode 
)

Set message using first line for given error code.

Parameters:
msgline Message widget from MxMsgLineCreate()
errcode Error code
void MxMsgLineSetText ( Widget  msgline,
const MISTRING &  string 
)

Set message line to specified text.

Parameters:
msgline Message widget from MxMsgLineCreate()
string Text to set (also allows TEXTID)
void MxMsgLineSetTimer ( Widget  msgline,
const MTIMER &  timer,
TEXTID  textid = TEXTID__None 
)

Set message using "timer".

Parameters:
msgline Message widget from MxMsgLineCreate()
timer Timer
textid Text resource ID, default is TEXTID_TimeTo_Process
void MxOptionMenuAppendItems ( Widget  omwidget,
const MENUITEM *  items,
void *  udata 
)

Append items to OptionMenu.

Parameters:
omwidget OptionMenu widget to append to
items Items to append
udata User data
Widget MxOptionMenuGetButton ( Widget  omwidget  ) 

Get the cascade button of an option menu.

You can use this to adjust the size, but don't depend on it actually being an XmCascadeButtonGadget, because it may change

Widget MxOptionMenuGetLabel ( Widget  omwidget  ) 

Get the label button of an option menu.

void MxOptionMenuRemoveLast ( Widget  omwidget  ) 

Remove last item from OptionMenu.

Parameters:
omwidget OptionMenu widget
void MxOptionMenuReplaceItems ( Widget  omwidget,
const MENUITEM *  newitems,
void *  userdata 
)

Replace all items in an OptionMenu with a new set of items.

This function is useful if the items in an OptionMenu must be changed, but attachments for the OptionMenu must be maintained.

Parameters:
omwidget OptionMenu widget returned by MxCreateOptionMenu
newitems New menu item list
userdata Userdata, if NULL will use value in MENUITEM field
Boolean MxOptionMenuSetItem ( Widget  omwidget,
int  itemnum 
)

Change currently selected item in an OptionMenu.

Returns:
True if successful, false if not This function will update the text shown in the OptionMenu button. The callback for that item will NOT be called.
Parameters:
omwidget OptionMenu widget returned by MxCreateOptionMenu
itemnum Item number from original MENUITEM array
Boolean MxOptionMenuSetItemByData ( Widget  widget,
const MENUITEM *  menuitem,
void *  callback_data 
)

Set selected item by matching callback_data in MENUITEM array.

Returns:
TRUE if successful, FALSE if not
Boolean MxOptionMenuSetItemSensitive ( Widget  omwidget,
int  itemnum,
Boolean  flag 
)

Set sensitivity for an OptionMenu item.

Returns:
True if successful, false if not This function will set the sensitivity in the OptionMenu for that item. The callback for that item will NOT be called.
Parameters:
omwidget Optionmenu widget returned by MxCreateOptionMenu
itemnum Item number from original MENUITEM array
flag TRUE/FALSE
void MxOptionMenuSetSensitive ( Widget  omwidget,
int  sensitive 
)

Set sensitivity for an OptionMenu.

int MxPixmapFromFillPattern ( Widget  pwidget,
Pixel  bgpixel,
const RVC::STYLEPATTERN_BITMAP &  Pattern,
Pixmap *  pixmap,
bool  bToGrayScale = false 
)

Create "normal" pixmap from fill pattern.

Returns:
error code
Parameters:
pwidget Parent widget
pixmap Pointer to pixmap to be created
bToGrayScale If true, convert to gray scale
Widget MxPolyfitCreateForm ( Widget  parent,
void(*)(void *)  action,
void *  userdata,
Arg *  arglist,
int  argcount 
)

Create for for polygom fitting parameters.

Returns:
Form widget or NULL
Parameters:
parent Parent widget
arglist Arguments for form
argcount Number of arguments in arglist
int MxPolyfitGetParm ( Widget  wPolyfit,
void *  vpf 
)

Get polygon fitting parameters.

Returns:
0 or EBadFuncParm
Parameters:
wPolyfit widget returned from MxPolyfitCreateForm
vpf passed/returned, actually internal structure will be copied to programmer supplied pointer
int MxPolyfitIniRead ( void *  vpf  ) 

Read values from .ini file.

Returns:
error code
Parameters:
vpf passed/returned
int MxPolyfitIniWrite ( void *  vpf  ) 

Write values to .ini file.

Returns:
error code
Parameters:
vpf passed/returned
int MxPolyfitSetParm ( Widget  wPolyfit,
void *  vpf 
)

Set polygon fitting parameters.

Parameters:
wPolyfit widget returned from MxPolyfitCreateForm
vpf passed/returned
void MxPopupMenuReplaceItems ( Widget  menupane,
const MENUITEM *  items,
void *  udata 
)

Replace all items in a Pulldown Menu with a new set of items.

Parameters:
menupane Menu to replace items
items New items
int MxPopupModalDialog ( Widget  dlgparent,
const char *  dlgname,
const char *  helpid,
Widget(*)(Widget, void *, Arg *, int)  CreateWidgetFunc,
void *  CreateWidgetData,
const BUTTONITEM *  extrabuttons = 0,
bool(*)(void *)  CheckOkFunc = 0 
)

Pop-up dialog with programmer-supplied form, optional buttons and OK/Cancel options. 

   		Widget CreateWidgetFunc (form, CreateWidgetData, arglist, argcount)
   			Widget form						Form to create widget in
   			void *CreateWidgetData		As specified above
   			Arg *arglist					Arguments for attachment
   			int argcount					Argument count
Returns:
0 for "OK", EUserCancel for "Cancel"
Parameters:
dlgparent Parent for dialog
dlgname Name used to generate dialog title
helpid Help ID, NULL if none
CreateWidgetData Function to create widget to go in dialog above separator Data to pass to CreateWidgetFunc
extrabuttons Extra buttons to place between "Cancel" and "Help" if desired
CheckOkFunc Function to check if OK to close dialog, will be called when user presses "OK" button
void MxPopupTransientMenu ( Widget  parent,
XButtonPressedEvent *  event,
const char *  title,
const MENUITEM *  items,
void *  cbdata = 0,
void *  udata = 0,
bool  waitforpopdown = false 
)

Popup transient menu which will automatically be destroyed when popped down.

Parameters:
parent Parent widget
event ButtonPress event which triggered popup, used for positioning
title Menu title
items Null-terminated array of menu items
cbdata Callback data to use if not specified in MENUITEM
udata Value for userData resource if not specified in MENUITEM
waitforpopdown 'true' to wait until menu is popped down before returning
void MxPositionWindowRel ( Widget  child,
Widget  base,
MxRELPOSN  relposn 
)

Position one window relative to another.

The relative position will overlap any previously placed windows. Also, if the shell the window is placed next to moves, the window will NOT move with it.

    MxRELPOSN_RightTop      
    MxRELPOSN_LeftTop       
    MxRELPOSN_RightCenter     TL TC TR
    MxRELPOSN_LeftCenter    LTSSSSSSSSRT
    MxRELPOSN_RightBottom     SWWWWWWS
    MxRELPOSN_LeftBottom      SW    WS
    MxRELPOSN_TopLeft       LCSW    WSRC
    MxRELPOSN_BottomLeft      SW    WS
    MxRELPOSN_TopCenter       SWWWWWWS
    MxRELPOSN_BottomCenter  LBSSSSSSSSRB
    MxRELPOSN_TopRight        BL BC BR
    MxRELPOSN_BottomRight
Parameters:
child Window to be position
base Window to position relative to
relposn Relative position
int MxPromptAddCallback ( Widget  prompt,
void(*)(MxPromptCallbackStruct *, void *)  cbfunc,
void *  cbdata,
UINT32  reasonmask 
)

Add callback to prompt callback list.

Returns:
Error < 0 void cbfunc (cbstruct, cbdata) MxPromptCallbackStruct *cbstruct Callback structure void *cbdata Data specified in MxPromptAddCallback() MxPromptCallbackStruct { UINT32 reason Callback reason Widget prompt Prompt widget } Callback reasons MxPromptCR_ValueChanged Pointed-to value for prompt has changed MxPromptCR_ValueChangeDrag User is dragging XmScale slider MxPromptCR_Activate User pressed <Enter> while in text widget
Parameters:
prompt Prompt widget
cbdata Callback function Callback data
reasonmask Requested callback reasons
void MxPromptClearValue ( Widget  prompt  ) 

Clear current prompt value.

This will set the prompt such that no default value is desplayed (blank string).

Parameters:
prompt Prompt widget
int MxPromptColorAddCallback ( Widget  prompt,
void(*)(MxPromptCallbackStruct *, void *)  cbfunc,
void *  cbdata,
UINT32  reasonmask 
)

Add callback to "Color Prompt" callback list.

Returns:
Error < 0 void cbfunc (cbstruct, cbdata) MxPromptCallbackStruct *cbstruct Callback structure void *cbdata Data specified in MxPromptAddCallback() MxPromptCallbackStruct { UINT32 reason Callback reason Widget prompt Prompt widget } Callback reasons MxPromptCR_ValueChanged Pointed-to value for prompt has changed
Parameters:
prompt Prompt widget
cbdata Callback function Callback data
reasonmask Requested callback reasons
Widget MxPromptColorCreate ( Widget  pwidget,
const char *  name,
COLOR *  color,
UINT32  flags,
Arg *  arglist,
int  argcount 
)

Create "Color Prompt".

flags: EDITCOLOR_AllowTransp Adds transparency toggle EDITCOLOR_AllowTransPct Allows setting of transparency 0-100%

Returns:
Color prompt widget
Parameters:
pwidget Parent widget
name Name for label
color Color to be updated by prompt
flags Flags to pass to MxEditColor
arglist Arguments for attachment
argcount Number of arguments
Widget MxPromptColorGetLabel ( Widget  prompt  ) 

Get label widget for "Color Prompt".

Returns:
Label widget (NULL if "name" was NULL when created)
Parameters:
prompt Prompt widget
void MxPromptColorUpdate ( Widget  prompt  ) 

Update "Color Prompt" for external change to color.

Parameters:
prompt Color prompt
Widget MxPromptCreateChar ( Widget  parent,
const char *  name,
char *  str,
const char *  help,
UINT32  flags,
Arg *  args,
int  numargs 
)

Exported API for creating prompt string widgets for a single, non-NULL-terminated char (char or MIUNICODE).

Returns:
Form or Text widget
Parameters:
parent Parent widget
name Name of widget
str Prompt string
help Help code (NULL for default)
flags Flags
args Arguments
numargs Number of arguments
Widget MxPromptCreateDouble ( Widget  parent,
const char *  name,
double *  ret,
double  dft,
double  min,
double  max,
int  places,
const char *  help,
UINT32  flags,
Arg *  args,
int  n 
)

Create form containing Label and Text widgets prompting for DOUBLE value.

Returns:
Form or Text widget Valid Flags:
  • GET_DftRet Use return value for default
  • GET_LabelTop Label on top of text widget (defaults to left)
  • GET_NoForm Don't create Form widget, just Text widget
  • GET_NoManage Don't "Manage" widget returned
  • GET_NoMin Ignore minimum
  • GET_NoMax Ignore maximum
  • GET_AddOne Add 1 to value for user, subtract 1 before return
  • GET_NoShowRange Don't show the range (GET_NoShowMin|GET_NoShowMax)
  • GET_NoShowMin Use the min but don't show it
  • GET_NoShowMax Use the max but don't show it
  • GET_NoDft There is no default value
  • GET_RightJustify Right-justify value in text widget (default)
  • GET_LeftJustify Left-justify value in text widget
  • GET_OutputOnly Prompt is "output-only"
  • GET_HasScale Add "Scale" widget to prompt (requires min/max settings)
  • GET_UseLogScale Use "logarithmic" scaling (must also specify GET_HasScale)
  • GET_BlankZero Show zero as blank
  • GET_ShowUnitLabel Show "unit" label
Logarithmically-scaled prompts will automatically adjust the range of the scale slider based on the current value within the limits set by MxPromptSetLogScaleRange() and the minimum and maximum (if any) allowed values of the prompt. In the case of log-scaled prompts, the minimum value must be greater than 0. Also, no maximum value is required. This is useful in cases where a scale is useful but the extent of the range is very large or has no upper bound. If GET_ShowUnitLabel is specified you must invoke MxPromptSetUnitConvCode() or set the unit name yourself, otherwise the units will show as '?????'.
Parameters:
parent Parent widget
name Name for Label widget (if any)
ret Location of return value
dft Default value
min Minimum value
max Maximum value
places Decimal places to show
help Help code (NULL for default)
flags Flags
args Argument list used for widget returned
n Number of entries in argument list
Widget MxPromptCreateFloat ( Widget  parent,
const char *  name,
float *  ret,
float  dft,
float  min,
float  max,
int  places,
const char *  help,
UINT32  flags,
Arg *  args,
int  n 
)

Create form containing Label and Text widgets prompting for FLOAT value.

Returns:
Form or Text widget Valid Flags:
  • GET_DftRet Use return value for default
  • GET_LabelTop Label on top of text widget (defaults to left)
  • GET_NoForm Don't create Form widget, just Text widget
  • GET_NoManage Don't "Manage" widget returned
  • GET_NoMin Ignore minimum
  • GET_NoMax Ignore maximum
  • GET_AddOne Add 1 to value for user, subtract 1 before return
  • GET_NoShowRange Don't show the range (GET_NoShowMin|GET_NoShowMax)
  • GET_NoShowMin Use the min but don't show it
  • GET_NoShowMax Use the max but don't show it
  • GET_NoDft There is no default value
  • GET_RightJustify Right-justify value in text widget (default)
  • GET_LeftJustify Left-justify value in text widget
  • GET_OutputOnly Prompt is "output-only"
  • GET_HasScale Add "Scale" widget to prompt (requires min/max settings)
  • GET_UseLogScale Use "logarithmic" scaling (must also specify GET_HasScale)
  • GET_BlankZero Show zero as blank
  • GET_ShowUnitLabel Show "unit" label
Parameters:
parent Parent widget
name Name for Label widget (if any)
ret Location of return value
dft Default value
min Minimum value
max Maximum value
places Decimal places to show
help Help code (NULL for default)
flags Flags
args Argument list used for widget returned
n Number of entries in argument list
Widget MxPromptCreateINT16 ( Widget  parent,
const char *  name,
INT16 *  ret,
INT16  dft,
INT16  min,
INT16  max,
const char *  help,
UINT32  flags,
Arg *  args,
int  numargs 
)

Create form containing Label and Text widgets prompting for INT16 value.

Returns:
Form or Text widget Valid Flags:
  • GET_DftRet Use return value for default
  • GET_LabelTop Label on top of text widget (defaults to left)
  • GET_NoForm Don't create Form widget, just Text widget
  • GET_NoManage Don't "Manage" widget returned
  • GET_NoMin Ignore minimum
  • GET_NoMax Ignore maximum
  • GET_AddOne Add 1 to value for user, subtract 1 before return
  • GET_NoShowRange Don't show the range (GET_NoShowMin|GET_NoShowMax)
  • GET_NoShowMin Use the min but don't show it
  • GET_NoShowMax Use the max but don't show it
  • GET_NoDft There is no default value
  • GET_RightJustify Right-justify value in text widget (default)
  • GET_LeftJustify Left-justify value in text widget
  • GET_OutputOnly Prompt is "output-only"
  • GET_HasScale Add "Scale" widget to prompt
  • GET_BlankZero Show zero as blank
Parameters:
parent Parent widget
name Name for Label widget (if any)
ret Location of return value
dft Default value
min Minimum value
max Maximum value
help Help code (NULL for default)
flags Flags
args Argument list used for widget returned
numargs Number of entries in argument list
Widget MxPromptCreateINT32 ( Widget  parent,
const char *  name,
INT32 *  ret,
INT32  dft,
INT32  min,
INT32  max,
const char *  help,
UINT32  flags,
Arg *  args,
int  n 
)

Create form containing Label and Text widgets prompting for INT32 value.

Returns:
Form or Text widget Valid Flags:
  • GET_DftRet Use return value for default
  • GET_LabelTop Label on top of text widget (defaults to left)
  • GET_NoForm Don't create Form widget, just Text widget
  • GET_NoManage Don't "Manage" widget returned
  • GET_NoMin Ignore minimum
  • GET_NoMax Ignore maximum
  • GET_AddOne Add 1 to value for user, subtract 1 before return
  • GET_NoShowRange Don't show the range (GET_NoShowMin|GET_NoShowMax)
  • GET_NoShowMin Use the min but don't show it
  • GET_NoShowMax Use the max but don't show it
  • GET_NoDft There is no default value
  • GET_RightJustify Right-justify value in text widget (default)
  • GET_LeftJustify Left-justify value in text widget
  • GET_OutputOnly Prompt is "output-only"
  • GET_HasScale Add "Scale" widget to prompt
  • GET_BlankZero Show zero as blank
Parameters:
parent Parent widget
name Name for Label widget (if any)
ret Location of return value
dft Default value
min Minimum value
max Maximum value
help Help code (NULL for default)
flags Flags
args Argument list used for widget returned
n Number of entries in argument list
Widget MxPromptCreateINT8 ( Widget  parent,
const char *  name,
INT8 *  ret,
INT8  dft,
INT8  min,
INT8  max,
const char *  help,
UINT32  flags,
Arg *  args,
int  n 
)

Create form containing Label and Text widgets prompting for INT8 value.

Returns:
Form or Text widget
Parameters:
parent Parent widget
name Name for Label widget (if any)
ret Location of return value
dft Default value
min Minimum value
max Maximum value
help Help code (NULL for default)
flags Flags
args Argument list used for widget returned
n Number of entries in argument list
Widget MxPromptCreateLatLon ( Widget  parent,
const char *  name,
double *  ret,
double  dft,
double  min,
double  max,
int  places,
const char *  help,
UINT32  flags,
Arg *  args,
int  n 
)

Create form containing Label and Text widgets prompting for LatLon value.

Returns:
Form or Text widget Valid Flags:
  • GET_DftRet Use return value for default
  • GET_LabelTop Label on top of text widget (defaults to left)
  • GET_NoForm Don't create Form widget, just Text widget
  • GET_NoManage Don't "Manage" widget returned
  • GET_NoMin Ignore minimum
  • GET_NoMax Ignore maximum
  • GET_NoShowRange Don't show the range (GET_NoShowMin|GET_NoShowMax)
  • GET_NoShowMin Use the min but don't show it
  • GET_NoShowMax Use the max but don't show it
  • GET_NoDft There is no default value
  • GET_DegsNS Coordinates are in Latitude
  • GET_DegsEW Coordinates are in Longitude
  • GET_DegsNoDir No direction for Lat/Lon value
  • GET_RightJustify Right-justify value in text widget (default)
  • GET_LeftJustify Left-justify value in text widget
  • GET_OutputOnly Prompt is "output-only"
Parameters:
parent Parent widget
name Name for Label widget (if any)
ret Location of return value
dft Default value
min Minimum value
max Maximum value
places Decimal places to show
help Help code (NULL for default)
flags Flags
args Argument list used for widget returned
n Number of entries in argument list
Widget MxPromptCreateNum ( Widget  parent,
const char *  name,
int  type,
void *  ret,
double  dft,
double  min,
double  max,
int  places,
const char *  help,
char **  comboitems,
UINT32  flags,
Arg *  args,
int  n 
)

Create numeric prompt field.

Returns:
Form or Text widget Prompt types:
  • MXPROMPT_DOUBLE 64-bit floating-point
  • MXPROMPT_FLOAT 32-bit floating-point
  • MXPROMPT_UINT32 Unsigned 32-bit number
  • MXPROMPT_INT32 Signed 32-bit number
  • MXPROMPT_UINT16 Unsigned 16-bit number
  • MXPROMPT_INT16 Signed 16-bit number
  • MXPROMPT_UINT8 Unsigned 8-bit number
  • MXPROMPT_INT8 Signed 8-bit number
Valid Flags:
  • GET_DftRet Use return value for default
  • GET_LabelTop Label on top of text widget (defaults to left)
  • GET_NoForm Don't create Form widget, just Text widget
  • GET_NoManage Don't "Manage" widget returned
  • GET_NoMin Ignore minimum
  • GET_NoMax Ignore maximum
  • GET_AddOne Add 1 to value for user, subtract 1 before return
  • GET_NoShowRange Don't show the range (GET_NoShowMin|GET_NoShowMax)
  • GET_NoShowMin Use the min but don't show it
  • GET_NoShowMax Use the max but don't show it
  • GET_NoDft There is no default value
  • GET_RightJustify Right-justify value in text widget (default)
  • GET_LeftJustify Left-justify value in text widget
  • GET_OutputOnly Prompt is "output-only"
  • GET_HasScale Add "Scale" widget to prompt (requires min/max settings)
  • GET_UseLogScale Use "logarithmic" scaling (must also specify GET_HasScale)
  • GET_BlankZero Show zero as blank
  • GET_ShowUnitLabel Show "unit" label
Parameters:
parent Parent widget
name Name for Label widget (if any)
type Prompt type (MXPROMPT_...)
ret Location of return value
dft Default value
min Minimum value
max Maximum value
places Decimal places to show
help Help code (NULL for default)
comboitems NULL-terminated array of items for combo-menu, NULL if no combo menu
flags Flags
args Argument list used for widget returned
n Number of entries in argument list
Widget MxPromptCreateString ( Widget  parent,
const char *  name,
char *  str,
int  maxlen,
const char *  help,
UINT32  flags,
Arg *  args,
int  numargs 
)

Create string prompt field.

Returns:
Form or Text widget Prompt types:
  • MXPROMPT_ASTRING ASCII string
  • MXPROMPT_USTRING Unicode string
Valid Flags:
  • GET_LabelTop Label on top of text widget (defaults to left)
  • GET_NoForm Don't create Form widget, just Text widget
  • GET_NoManage Don't "Manage" widget returned
  • GET_ToUpper Convert all characters typed to upper-case
  • GET_Unicode String is actually (MIUNICODE *)
  • GET_RightJustify Right-justify value in text widget
  • GET_LeftJustify Left-justify value in text widget (default)
Parameters:
parent Parent widget
name Name for Label widget (if any)
str Pointer to string
maxlen Maximum allowed length for string in characters
help Help code
flags Flags
args argument list used for widget returned
numargs Number of entries in argument list
Widget MxPromptCreateUINT16 ( Widget  parent,
const char *  name,
UINT16 *  ret,
UINT16  dft,
UINT16  min,
UINT16  max,
const char *  help,
UINT32  flags,
Arg *  args,
int  n 
)

Create form containing Label and Text widgets prompting for UINT16 value.

Returns:
Form or Text widget Valid Flags:
  • GET_DftRet Use return value for default
  • GET_LabelTop Label on top of text widget (defaults to left)
  • GET_NoForm Don't create Form widget, just Text widget
  • GET_NoManage Don't "Manage" widget returned
  • GET_NoMin Ignore minimum
  • GET_NoMax Ignore maximum
  • GET_AddOne Add 1 to value for user, subtract 1 before return
  • GET_NoShowRange Don't show the range (GET_NoShowMin|GET_NoShowMax)
  • GET_NoShowMin Use the min but don't show it
  • GET_NoShowMax Use the max but don't show it
  • GET_NoDft There is no default value
  • GET_RightJustify Right-justify value in text widget (default)
  • GET_LeftJustify Left-justify value in text widget
  • GET_OutputOnly Prompt is "output-only"
  • GET_HasScale Add "Scale" widget to prompt
  • GET_BlankZero Show zero as blank
Parameters:
parent Parent widget
name Name for Label widget (if any)
ret Location of return value
dft Default value
min Minimum value
max Maximum value
help Help code (NULL for default)
flags Flags
args Argument list used for widget returned
n Number of entries in argument list
Widget MxPromptCreateUINT32 ( Widget  parent,
const char *  name,
UINT32 *  ret,
UINT32  dft,
UINT32  min,
UINT32  max,
const char *  help,
UINT32  flags,
Arg *  args,
int  n 
)

Create form containing Label and Text widgets prompting for UINT32 value.

Returns:
Form or Text widget Valid Flags:
  • GET_DftRet Use return value for default
  • GET_LabelTop Label on top of text widget (defaults to left)
  • GET_NoForm Don't create Form widget, just Text widget
  • GET_NoManage Don't "Manage" widget returned
  • GET_NoMin Ignore minimum
  • GET_NoMax Ignore maximum
  • GET_AddOne Add 1 to value for user, subtract 1 before return
  • GET_NoShowRange Don't show the range (GET_NoShowMin|GET_NoShowMax)
  • GET_NoShowMin Use the min but don't show it
  • GET_NoShowMax Use the max but don't show it
  • GET_NoDft There is no default value
  • GET_RightJustify Right-justify value in text widget (default)
  • GET_LeftJustify Left-justify value in text widget
  • GET_OutputOnly Prompt is "output-only"
  • GET_HasScale Add "Scale" widget to prompt (requires min/max settings)
  • GET_BlankZero Show zero as blank
Parameters:
parent Parent widget
name Name for Label widget (if any)
ret Location of return value
dft Default value
min Minimum value
max Maximum value
help Help code (NULL for default)
flags Flags
args Argument list used for widget returned
n Number of entries in argument list
Widget MxPromptCreateUINT8 ( Widget  parent,
const char *  name,
UINT8 *  ret,
UINT8  dft,
UINT8  min,
UINT8  max,
const char *  help,
UINT32  flags,
Arg *  args,
int  n 
)

Create form containing Label and Text widgets prompting for UINT8 value.

Returns:
Form or Text widget
Parameters:
parent Parent widget
name Name for Label widget (if any)
ret Location of return value
dft Default value
min Minimum value
max Maximum value
help Help code (NULL for default)
flags Flags
args Argument list used for widget returned
n Number of entries in argument list
MDLGPARENT MxPromptCreateUnicode ( MDLGPARENT  parent,
const char *  name,
MIUNICODE *  str,
int  maxlen,
const char *  help,
UINT32  flags,
Arg *  args,
int  numargs 
)

Create form containing Label and Text widgets prompting for Unicode value.

Returns:
Form or Text widget
Parameters:
parent Parent widget
name Name for Label widget (if any)
str Locat
maxlen Maximum allowed length for string in characters
void MxPromptDisableTraversal ( Widget  prompt  ) 

Disable automatic traversal when user presses <Enter>.

Parameters:
prompt Prompt widget
int MxPromptDoubleToLatLon ( Widget  prompt  ) 

Convert double prompt to a lat/lon prompt.

This function allows conversion between double ane lat/lon values. Useful for projection queries.

Parameters:
prompt Widget to prompt to set value
Widget MxPromptGetLabel ( Widget  prompt  ) 

Get Label widget from composite form returned by MxPromptCreate.

..

Returns:
Label widget (NULL if GET_NoForm used when creating prompt)
Parameters:
prompt Prompt widget
void MxPromptGetMinMax ( Widget  widget,
double *  min,
double *  max 
)

Return current min/max range settings.

Parameters:
widget Prompt widget
min Minimum value returned
max Maximum value returned
Widget MxPromptGetScale ( Widget  prompt  ) 

Get Scale widget from composite form returned by MxPromptCreate.

..

Returns:
Scale widget, NULL if no Scale widget available
Parameters:
prompt Prompt widget
int MxPromptGetStdHeight ( void   ) 

Get height of standard prompt widget.

Returns:
height
Widget MxPromptGetUnitLabel ( Widget  widget  ) 

Return unit Label widget for prompt.

Returns:
Unit label
Parameters:
widget Prompt widget
void* MxPromptGetUserData ( Widget  prompt  ) 

Get UserData attached to the prompt.

Returns:
UserData, NULL if none available
Parameters:
prompt Prompt widget
int MxPromptGetValueDouble ( Widget  widget,
double *  pval 
)

Get the numeric value out of a numeric prompt.

Returns:
1 if successful, 0 if not
Parameters:
widget Prompt widget
pval Returned numeric value
int MxPromptGetValueUnicode ( Widget  widget,
MIUNICODE **  pval 
)

Get the string value out of a string prompt.

Returns:
1 if successful, 0 if not
Parameters:
widget Prompt widget
pval Returned string value
Widget MxPromptGetXeText ( Widget  widget  ) 

Get the text value out of a prompt.

Returns:
widget Same as old MxPromptGetText but named in such a way as to remind the programmer that it's an XeText widget.
int MxPromptHasValue ( Widget  prompt  ) 

Determine if value has been set for prompt.

Returns:
TRUE if value is set, FALSE if not
Parameters:
prompt Prompt widget
MENUITEM* MxPromptLatLonGetFormatMenu ( XtCallbackProc  cbfunc,
int  isoption 
)

Return pointer to MENUITEM array for supported lat-lon formats.

Returns:
MENUITEM array
Parameters:
cbfunc Callback function
isoption Set if for OptionMenu
void MxPromptLatLonSetFormat ( Widget  widget,
DEGTOSTRFLAGS  flags 
)

Set lat/lon format in prompt.

Parameters:
widget Widget to prompt to set format
flags Flags
int MxPromptLatLonSetValue ( Widget  prompt,
double  val 
)

Set lat/lon value in prompt.

Returns:
0
Parameters:
prompt Widget to prompt to set value
val Value to set it to
int MxPromptLatLonToDouble ( Widget  prompt  ) 

Convert lat/lon prompt to a double prompt.

This function allows conversion between double and lat/lon values. Useful for projection queries.

Parameters:
prompt Widget to prompt to set value
int MxPromptRemoveCallback ( Widget  prompt,
void(*)(MxPromptCallbackStruct *, void *)  cbfunc,
void *  cbdata,
UINT32  reasonmask 
)

Remove callback from prompt callback list.

Returns:
Error < 0 Callback reasons
  • MxPromptCR_ValueChanged Pointed-to value for prompt has changed
  • MxPromptCR_ValueChangeDrag User is dragging XmScale slider
  • MxPromptCR_Activate User pressed <Enter> while in text widget
Parameters:
prompt Prompt widget
cbdata Callback function Callback data
reasonmask Requested callback reasons
void MxPromptSetDecPlaces ( Widget  prompt,
int  places 
)

Set number of decimal places for floating-point prompt.

Parameters:
prompt Prompt widget
places Number of decimal places
void MxPromptSetEditable ( Widget  prompt,
int  editable 
)

Set "editable" status for prompt.

Parameters:
prompt Prompt widget
editable TRUE if prompt should be editable, FALSE if not
int MxPromptSetEncoding ( Widget  prompt,
char *  encoding,
UINT32  flags 
)

Set the encoding used by the prompt widget.

This function lets you set the character encoding of the data buffer used by the widget for a prompt created via MxPromptCreateString(). The encoding is any string returned from MucNumToName(). By default, the widget assumes the buffer is in ISO-2022 encoding (ISO-Latin-1 with escape sequences used to switch to other character sets).

Parameters:
prompt Prompt widget
encoding Encoding to use
flags Flags for future expansion
void MxPromptSetEnterCallback ( Widget  widget,
void(*)(Widget, void *)  func,
void *  cbdata 
)

Set function to be called when user presses <Enter> in prompt.

Parameters:
widget Prompt widget
cbdata Callback function Callback data
void MxPromptSetFormat ( Widget  prompt,
char *  format 
)

Override default format for prompt field.

Note: This has no effect on LatLon and String prompts (will be retained for LatLonToDouble though).

Parameters:
prompt Prompt widget
format New format string (printf style, max 40 characters)
void MxPromptSetLogScaleRange ( Widget  prompt,
double  min,
double  max 
)

Set minimum range for logarithmic scale.

This function is used for logarithmic-scale prompts to set the minimum range. The range will be from 10 ^ floor(log10(min)) to 10 ^ ceil(log10(max)) so it will probably be clearest to use powers of 10 for the min/max values.

Parameters:
prompt Prompt widget
min Minimum value (must be > 0.0)
max Maximum value (must be > min)
void MxPromptSetModifyCallback ( Widget  prompt,
void(*)(Widget, void *)  func,
void *  funcdata 
)

Set function to be called when prompt value is changed.

This function is obsolete and should be replaced by MxPromptAddCallback()

Parameters:
prompt Prompt widget
funcdata Function to call when value is changed Additional data to pass to function
void MxPromptSetRange ( Widget  prompt,
double  min,
double  max,
UINT32  flags 
)

Set new range for prompt, subject to limits by data type.

This function has no effect on the range displayed (if any).

Parameters:
prompt Prompt widget
min Minimum allowed value
max Maximum allowed value
flags Flags (GET_NoMin, GET_NoMax)
void MxPromptSetTraversal ( Widget  prompt,
Widget  traverseto,
XmTraversalDirection  traversedir 
)

Set traversal behavior for prompt.

Note that prompts will default to TRAVERSE_NEXT if GET_NoForm is specified on creation otherwise to TRAVERSE_NEXT_TAB_GROUP.

Parameters:
prompt Prompt widget
traverseto Widget to traverse to if traversedit is XmTRAVERSE_CURRENT
traversedir XmTRAVERSE...
void MxPromptSetUnitConv ( Widget  prompt,
const UNITCONV *  unitconv 
)

Set conversion to be performed for numeric fields.

Notes: This will override the GET_AddOne flag if set. This has no effect on LatLon and String prompts (will be retained for LatLonToDouble though). This function will NOT alter the stored data, only how it is displayed.

Parameters:
prompt Prompt widget
unitconv Conversion (from = internal, to = display)
void MxPromptSetUnitConvCode ( Widget  prompt,
int  unittype,
int  storedcode,
int  showncode 
)

Set unit conversion for numeric fields using unit code values.

Notes: This will override the GET_AddOne flag if set. This has no effect on LatLon and String prompts (will be retained for LatLonToDouble though). This function will NOT alter the stored data, only how it is displayed. If GET_ShowUnitLabel was specified when the prompt was created the label will be updated.

Parameters:
prompt Prompt widget
unittype Unit type (UNIT_TYPE_...)
storedcode Unit code for how the value is stored
showncode Unit code for how the value is displayed to the user
void MxPromptSetUnitConvExt ( Widget  widget,
const UNITCONV *  unitconv,
UINT32  flags 
)

Set conversion for numeric prompt.

This does not change the value of the prompt

Parameters:
widget Prompt widget
unitconv Conversion type
flags Flags
void MxPromptSetUserData ( Widget  prompt,
void *  data 
)

Attach UserData to the prompt.

Use MxPromptGetUserData() to get the data, not MxGetUserData()

Parameters:
prompt Prompt widget
data UserData to attach
void MxPromptSetValue ( Widget  widget,
double  wal,
int  hasvalue 
)

Set new value. Takes a double and updates any type of prompt.

Parameters:
widget Prompt widget
wal Value to set
hasvalue TRUE if valid value available, FALSE if not
int MxPromptSetValueDouble ( Widget  prompt,
double  val 
)

Set double value in prompt.

Returns:
0
Parameters:
prompt Widget to prompt to set value
val Value to set it to
int MxPromptSetValueFloat ( Widget  prompt,
float  val 
)

Set float value in prompt.

Returns:
0
Parameters:
prompt Widget to prompt to set value
val Value to set it to
int MxPromptSetValueINT16 ( Widget  prompt,
short  val 
)

Set short value in prompt.

Returns:
0
Parameters:
prompt Widget to prompt to set value
val Value to set it to
int MxPromptSetValueINT32 ( Widget  prompt,
INT32  val 
)

Set long value in prompt.

Returns:
0
Parameters:
prompt Widget to prompt to set value
val Value to set it to
void MxPromptSetValuePtr ( Widget  prompt,
void *  newptr,
int  hasvalue 
)

Set new pointer to prompt value.

Parameters:
prompt Prompt widget
newptr New value pointer to use
hasvalue TRUE if valid value available, FALSE if not
int MxPromptSetValueString ( Widget  prompt,
const char *  val 
)

Set string value in prompt.

Returns:
0
Parameters:
prompt Widget to prompt to set value
val New string value
int MxPromptSetValueUnicode ( Widget  prompt,
const MIUNICODE *  val 
)

Set a Unicode string value in prompt (must already be a Unicode prompt).

Returns:
0
Parameters:
prompt Widget to prompt to set value
val New string value
int MxPromptUpdateData ( Widget  prompt,
Boolean  notify 
)

Update the data "pointed-to" to reflect the contents of the prompt.

Returns:
1 if data modified, False if no change was needed This function updates the location in memory that the prompt points to. This is done automatically when the prompt loses focus, but sometimes it's necessary to do this while the prompt still has focus. For example, clicking on a scroll-bar won't cause the prompt to lose focus, but you might want to make sure the data is updated anyway. If "notify" is true and the data has changed, the prompt's modify callback will be called.
Parameters:
prompt Prompt widget
notify Call "modify" callback if value changed
void MxPromptUpdateValue ( Widget  prompt  ) 

Notify prompt widget that "pointed-to" value has changed.

Parameters:
prompt Prompt widget
void MxPulldownMenuReplaceItems ( Widget  parent,
const MENUITEM *  items,
void *  userdata 
)

Replace all items in a Pulldown Menu with a new set of items.

Parameters:
parent Parent widget, should be a CascadeButton
items Array of menu items, terminated by NULL item
userdata User data for items created if not specified in items
void MxRedrawWidget ( Widget  widget  ) 

Redraw widget by sending exposure notification.

Parameters:
widget Widget to redraw
int MxRgnGenSetupRasterTraceAreaV ( Widget  pwidget,
const RVC::OBJITEM &  VectObjItem,
RGNELEMLIST *  ElemList,
int  NumElemTypes,
void(*)(const REGION2D *, void *)  DispRegionFunc,
void *  DispRegionData 
)

Setup for tracing solid area in raster using vector elements.

Parameters:
DispRegionData Function to display region preview Data for region display function
int MxRgnGenSetupRasterTraceBoundaryV ( Widget  pwidget,
const RVC::OBJITEM &  VectObjItem,
RGNELEMLIST *  ElemList,
int  NumElemTypes,
void(*)(const REGION2D *, void *)  DispRegionFunc,
void *  DispRegionData 
)

Setup for tracing bounded area using vector elements.

Parameters:
DispRegionData Function to display region preview Data for region display function
Widget MxSashCreate ( Widget  pwidget,
Arg *  arglist,
int  argcount 
)

Create simple horizontal or vertical "sash" control in XmForm.

Returns:
Widget To set the orientation of the sash, set XmNorientation to XmVERTICAL or XmHORIZONTAL in the argument list. The default orientatation is vertical. When the user moves the sash, widgets attached to the sash or to which the sash is attached will be resized appropriately. These widgets must be resizable or the results are unpredictable. Currently does not support ATTACH_OPPOSITE_WIDGET attachments. Currently assumes widgets are attached to the form in the adjustment direction on the sides opposite the sash. This also means that only one sash per form is allowed.
Parameters:
pwidget Parent widget
arglist Arguments for attachment and orientation
argcount Number of arguments
int MxSaveSnapshotToRaster ( Widget  pwidget,
const DISPLAYINFO &  dispinfo,
Drawable  drawable 
)

Save "snapshot" of X drawable into a user-specified raster.

Returns:
Error code < 0 Saving "Window" drawables is not recommended unless you ensure that the window is not obscured.
Parameters:
pwidget Scrollbar widget
dispinfo Used to retrieve information about display
drawable Drawable (Window or Pixmap) to save from
void MxScrollBarGetValues ( Widget  w,
int *  value,
int *  sliderSize,
int *  increment,
int *  pageIncrement,
int *  minimum,
int *  maximum 
)

Return values for ScrollBar resources.

This function should be used instead of XmScrollBarGetValues() as that function has an error in Motif 1.2.3.

Parameters:
w ScrollBar widget
value Returned "value" resource (NULL if not needed)
sliderSize Returned "slidersize" resource (NULL if not needed)
increment Returned "increment" resource (NULL if not needed)
pageIncrement Returned "pageIncrement" resource (NULL if not needed)
minimum Returned "minimum" resource (NULL if not needed)
maximum Returned "maximum" resource (NULL if not needed)
int MxSelectIcon ( Widget  pwidget,
char *  dialogname,
char  IconClass[16],
char  IconName[16],
int  minsize,
int  maxsize,
UINT32  flags 
)

Pop in dialog allowing user to select an icon.

Returns:
1 if selected icon changed, 0 if not, < 0 if error
Parameters:
pwidget Parent for dialog
dialogname Name of dialog, will use "MxSelectIcon" if NULL
IconClass Icon class passed/returned
IconName Icon name passed/returned
minsize Minimum icon size, resizes smaller icons if SELICON_Resize flag set
maxsize Maximum icon size, 0 if no maximum
flags SELICON_... flags
int MxSelectRegion ( Widget  parent,
const RVC::OBJITEM &  ObjItem,
RVC::OBJTYPE  ObjType,
REGION2D &  region 
)

Select a rotated rectangle or a polygon, single region.

Parameters:
parent Parent dialog
void MxSetExitProcess (  ) 

Notify MxMainLoopUntilExitSet() that it should terminate.

See MxMainLoopUntilExitSet() for details

void MxSetFocusToWidget ( Widget  widget  ) 

Set keyboard focus to widget and pointer focus to window containing widget.

void MxSetHelpCallback ( Widget  widget,
const char *  helpstr 
) [inline]

Set help callback.

Parameters:
helpstr Help code
void MxSetMenuItemCallbackData ( MENUITEM *  mi,
void *  cbdata 
)

Set "callback_data" field for each entry MENUITEM array to specified value.

Parameters:
mi Menu item to set callback data for
cbdata Callback data
void MxSetMenuItemUserData ( MENUITEM *  mi,
void *  udata 
)

Set "userdata" field for each entry MENUITEM array to specified value.

Parameters:
mi Menu item to set user data for
udata User data
void MxSetNamedUserData ( Widget  w,
const char *  name,
void *  data 
)

Add, change, or remove a tagged user data resource for a widget.

This routine manages multiple userdata resources on a widget using a tag. To remove a resource, use MxSetNamedUserData(w, name, NULL)

Parameters:
w Widget to attach tagged user data to
name String to use as a tag (Must be less than 16 characters
data Data pointer to attach to widget
void MxSetNoExitProcess (  ) 

Set exitmainloop to 0.

void MxSetSensitive ( Widget  w,
int  sensitive 
)

Set widget sensitivity with test for NULL widget.

Parameters:
w Widget to set sensitivity for (NULL ok)
sensitive TRUE or FALSE
void MxSetTextEditable ( Widget  widget,
int  editable 
)

Set whether or not a Text widget is editable.

This sets the "editable, "cursorPositionVisible" and "traversalOn resources for the Text widget.

Parameters:
widget Text widget
editable TRUE if widget should be editable, FALSE if not
void MxSetToolTipFromObjItem ( Widget  widget,
const RVC::OBJITEM &  ObjItem 
)
int MxSetupBasinParms ( void *  form,
const RVC::OBJITEM &  SrcVectObjItem,
RGNELEMLIST *  ElemList,
int  NumElemTypes,
void(*)(const REGION2D *, void *)  dispreg,
void *  userdata 
)

Setup for region generation using "basin" method.

Parameters:
NumElemTypes Number of element types
int MxSetupBufferZoneParms ( void *  form,
const RVC::OBJITEM &  SrcObjItem,
RGNELEMLIST *  ElemList,
int  NumElemTypes,
void(*)(const REGION2D *, void *)  dispreg,
void *  userdata 
)

Setup buffer zone interface.

Parameters:
NumElemTypes Number of element types
int MxSetupClusterParms ( Widget  parent,
const RVC::OBJITEM &  SrcGeomObjItem,
RGNELEMLIST *  ElemList,
int  NumElemTypes,
void(*)(const REGION2D *, void *)  dispreg,
void *  userdata 
)

Setup clustering parameters for region generation.

Parameters:
parent Parent widget
NumElemTypes Number of element types
int MxSetupFloodParms ( void *  vparent,
const RVC::OBJITEM &  ObjItemVector,
INT32  ActiveType,
INT32  ActiveLine,
void(*)(const REGION2D *, void *)  dispreg,
void *  userdata 
)

Setup for region generation using "flood fill" method.

int MxSetupPolygonFitParms ( Widget  parent,
const RVC::OBJITEM &  SrcGeomObjItem,
RGNELEMLIST *  ElemList,
int  NumElemTypes,
void(*)(const REGION2D *, void *)  dispreg,
void *  userdata 
)

Setup polygon fitting parameters for region generation.

Parameters:
parent Parent widget
NumElemTypes Number of element types
int MxSetupRasterCellsParms ( MDLGPARENT  parent,
const RVC::OBJITEM &  VectObjItem,
RGNELEMLIST *  ElemList,
int  NumElemTypes,
void(*)(const REGION2D *, void *)  dispreg,
void *  userdata 
)

Setup for region generation using "raster cells" method.

int MxSetupRegionFromRangesParms ( Widget  parent,
const RVC::OBJITEM &  ObjItem,
void(*)(const REGION2D *, void *)  dispreg,
void *  userdata 
)

Setup range parameters for region generation.

Parameters:
parent Parent widget
int MxSetupRegionFromRastExpressParms ( Widget  parent,
const RVC::OBJITEM &  ObjItemRaster,
void(*)(const REGION2D *, void *)  dispreg,
void *  userdata 
)

Setup raster expression parameters for region generation.

Parameters:
parent Parent widget
int MxSetupTextureGrowthParms ( MDLGPARENT  parent,
const RVC::OBJITEM &  VectObjItem,
RGNELEMLIST *  ElemList,
int  NumElemTypes,
void(*)(const REGION2D *, void *)  dispreg,
void *  userdata 
)

Setup for region generation using "texture growth" method.

Parameters:
NumElemTypes Number of element types
int MxSetupViewshedParms ( MDLGPARENT  parent,
const RVC::OBJITEM &  VectObjItem,
UINT8 *  setdata,
INT32  NumEntries,
void(*)(const REGION2D *, void *)  dispreg,
void *  userdata 
)

Setup for region generation using viewshed method.

void MxSetWidgetColor ( Widget  widget,
COLOR const &  color 
)

Set widget foreground color to specified color.

Parameters:
widget Widget to set foreground color for
color Color value to set
void MxSetWindowFullScreen ( Widget  widget  ) 

Set window containing specified widget to full-screen size.

Parameters:
widget Widget contained in window to be sized to full-screen
int MxSetWindowPosition ( Widget  widget,
const char *  group,
const char *  field 
)

Read and set window position from .ini file, update when changed.

Returns:
Error code if < 0 or 0 if no error
Parameters:
widget Widget to be positioned (ancestor WMShell will actually be used)
group Major heading, (application name)
field Field name
int MxSetWindowPositionXY ( Widget  widget,
const char *  group,
const char *  field,
int  x,
int  y 
)

Set window position from tntmips.ini, update when changed.

Returns:
Error code if < 0 or 0 if no error
Parameters:
widget Widget to be positioned
group Major heading, (application name)
field Field name
int MxSetWindowSize ( Widget  widget,
const char *  group,
const char *  field,
int  dftwidth,
int  dftheight 
)

Read and set window size from .ini file, update when changed.

Returns:
Error code if < 0 or 0 if no error If the 'group' field is set to NULL, GetAppName() will be used to set it internally
Parameters:
widget Widget to be sized
group Major heading (application name)
field Field name
dftwidth Default width to use if none in .ini file
dftheight Default height to use
void MxSetXmLabelString ( Widget  text,
const MIUNICODE *const   string 
)

Set string in XmLabel widget from Unicode string.

Parameters:
text Text widget
string Unicode string
void MxShowWidget ( Widget  w,
bool  show = true 
)

Show or hide a widget with test for NULL widget.

Manages or unmanages the widget to show or hide it.

Parameters:
w Widget to show or hide (NULL ok)
show 'true' to Manage, 'false' to Unmanage
void MxStringDraw ( Display *  display,
Window  window,
GC  gc,
INT32  x,
INT32  y,
const MIUNICODE *  ucstr,
TEXTBASEORIGIN  origin,
MGD::INTERFACETEXTSTYLE  style = MGD::INTERFACETEXTSTYLE_Normal 
)

Draw MIUNICODE string on drawing area or other X "Window" using the default X fontlist.

The default fontlist is read from tntproc.ini (once at program startup). It can be modified by using Support / Setup / Fonts... in TNTmips

The string passed in is assumed to be in "logical" order. In other words, if the string has right-to-left text, the right-most character comes before the left-most character. The text will be flipped to visual order as it's rendered.

Note: This function is a replacement for XmStringDraw().

Parameters:
display X Display
window X Window
gc X GC
x x offset, upper edge of text box
y y offset, upper edge of text box
ucstr MIUNICODE string to display
void MxStringDrawVisual ( Display *  display,
Window  window,
GC  gc,
INT32  x,
INT32  y,
const MIUNICODE *  ucstr,
TEXTBASEORIGIN  origin,
MGD::INTERFACETEXTSTYLE  style = MGD::INTERFACETEXTSTYLE_Normal 
)

Draw MIUNICODE string on drawing area or other X "Window" using the default X fontlist.

This function is the same as MxStringDraw(), but assumes that the text passed in is already in "visual" order. You almost never want this function. Use MxStringDraw() instead. If there is no right-to-left text, it doesn't matter which order it's in (visual == logical for most languages). For Arabic, it has to flip from visual to logical, do glyph substitutions, and flip it back.

The default fontlist is read from tntproc.ini (once at program startup). It can be modified by using Support / Setup / Fonts... in TNTmips

Note: This function is a replacement for XmStringDraw(). It used to create an XmString and call XmStringDraw(), but now it just draws it itself.

See also:
MxStringDraw
Parameters:
display X Display
window X Window
gc X GC
x x offset, upper edge of text box
y y offset, upper edge of text box
ucstr MIUNICODE string to display
void MxStringExtents ( const MIUNICODE *const   ucstr,
UINT32 *  TextWidth,
UINT32 *  TextHeight,
UINT32 *  TextAscent,
bool  bHeightForClipping,
MGD::INTERFACETEXTSTYLE  style = MGD::INTERFACETEXTSTYLE_Normal 
)

Get width, height and ascent for a MIUNICODE string using the default X FontList.

The default fontlist is read from tntproc.ini (once at program startup). It can be modified by using Support / Setup / Fonts... in TNTmips

The width returned will include right bearing of the last letter which may be greater than the "width" of that letter. (See MxStringWidth() for explanation)

Note: This function is a replacement for XmStringExtents() and XmStringBaseline().

Used by MGD::CONTEXT::InterfaceTextGetExtents

Parameters:
ucstr MIUNICODE string to process
TextWidth Width of string, can be NULL
TextHeight Height of string, can be NULL
TextAscent Ascent of first line of string, can be NULL
bHeightForClipping If true, height may include glyph parts which normally extend outside the design extent. If false, it uses the height as specified by the font designer, which is more suitable for glyph positioning.
void MxStringMetrics ( const MIUNICODE *const   ucstr,
TEXTMETRICS &  metrics,
MGD::INTERFACETEXTSTYLE  style = MGD::INTERFACETEXTSTYLE_Normal 
)

Used by MGD::CONTEXT::InterfaceTextGetMetrics.

Parameters:
ucstr MIUNICODE string to process
int MxStringWidth ( const MIUNICODE *const   ucstr,
bool  bInkMetrics = false,
MGD::INTERFACETEXTSTYLE  style = MGD::INTERFACETEXTSTYLE_Normal 
)

Return the width of an string using the default X fontlist.

The default fontlist is read from tntproc.ini (once at program startup). It can be modified by using Support / Setup / Fonts... in TNTmips

By default, this function reports string width based on the advance width of characters only. This will give an accurate measurement for character placement. Some glyphs, however may draw to the right of their "width" so as to overlap the next glyph. To find this width, you need pass true for the bInkMetrics parameter. This would be more accurate for clipping.

Returns:
width in pixels
Parameters:
ucstr MIUNICODE string to process
int MxStringWidthVisual ( const MIUNICODE *const   ucstr,
bool  bInkMetrics = false,
MGD::INTERFACETEXTSTYLE  style = MGD::INTERFACETEXTSTYLE_Normal 
)

Return the width of an string using the default X fontlist.

This function is the same as MxStringWidth, but the string is assumed to already be in visual order.

Returns:
width in pixels
Parameters:
ucstr MIUNICODE string to process
Widget MxTabPagesCreate ( Widget  pwidget,
MxTABPAGEITEM *  items,
void *  userdata,
Arg *  arglist,
int  argcount 
)

Create form containing child forms for tabs.

Returns:
Unmanaged main TabPages form or NULL if error The format of the MxTABPAGEITEM structure is : typedef void (*TABPAGEFUNC) (void *wPage, int numPage, void* userdata); Widget wPage - Form widget for a page (item) / passed/ NOTE: this widget has individual user data attached to it, as specified in corresponding _MxTABPAGEITEM. int NumPage - page (item) number /passed/ void *userdata - global user data (same as passed to MxTabPagesCreate) typedef struct _MxTABPAGEITEM { char *label; ULONG flags; TABPAGEFUNC create; TABPAGEFUNC activate; TABPAGEFUNC deactivate; TABPAGEFUNC destroy; void *pageUserData; this is "page" user data and it is different from TabPages userdata } MxTABPAGEITEM; Available flags: MxTABPAGE_DISABLED TabPage is initially not "Sensitive"
Parameters:
pwidget Parent widget
items Irems for TabPages, last element must have label of NULL
userdata Value to set "userData" resource to for main TabPages form
arglist Arguments for resource settings
argcount Number of arguments in arglist
int MxTabPagesGetActiveItem ( Widget  tbwidget  ) 

Get currently selected item in a TabPages.

Returns:
currently selected item or less 0, if error
Parameters:
tbwidget TabPages widget returned by MxTabPagesCreate
int MxTabPagesGetUserData ( Widget  tbwidget,
void **  userdata 
)

Get UserData attached to the main TabPages form.

Returns:
0 if successful, less 0 if not
Parameters:
tbwidget TabPages widget returned by MxTabPagesCreate
int MxTabPagesSetActiveItem ( Widget  tbwidget,
int  itemnum 
)

Change currently selected item in a TabPages.

Returns:
previously selected item or less 0, if error
Parameters:
tbwidget TabPages widget returned by MxTabPagesCreate
itemnum Item number from original MxTABPAGEITEM array
int MxTabPagesSetSensitiveItem ( Widget  tbwidget,
int  itemnum,
int   
)

Set sensitivity for a TabPages item.

Returns:
TRUE if successful, FALSE if not
Parameters:
tbwidget TabPages widget returned by MxTabPagesCreate
itemnum Item number from original MxTABPAGEITEM array
void MxTextClearXe ( Widget  xetext  ) 

Clear text and tooltip.

Parameters:
xetext XeText widget
int MxTextEditBindXeText ( void *  vtehandle,
Widget  xetext 
)

Bind XeText widget to text editor.

Returns:
0
Parameters:
vtehandle Text editor handle
xetext XeText widget
int MxTextEditCheckSave ( void *  vtehandle  ) 

Check if changes made, if so ask user if want to save and save if user wants to.

Returns:
Cancel, error or "no"
Parameters:
vtehandle Text editor handle
int MxTextEditCreateHandle ( void **  vtehandle,
UINT32  flags 
)

Create text editor handle.

Returns:
0 or error < 0
Parameters:
vtehandle Text editor handle
flags Flags
Widget MxTextEditCreateXeText ( Widget  pwidget,
void *  vtehandle,
Arg *  arglist,
int  argcount 
)

Create scrolled XeText widget and bing to editor handle.

Returns:
XeText widget
Parameters:
pwidget Parent widget
vtehandle Text editor handle
const MENUITEM* MxTextEditGetMenuEdit ( void *  vtehandle  ) 

Get MENUITEM array for "Edit" menu.

Returns:
MENUITEM array
Parameters:
vtehandle Text editor handle
const MENUITEM* MxTextEditGetMenuFile ( void *  vtehandl,
UINT32  flags 
)

Get MENUITEM array for "File" menu.

Returns:
MENUITEM array
Parameters:
vtehandl Text editor handle
flags Flags
int MxTextEditLoadFile ( void *  vtehandle,
MIUNICODE *  filename 
)

Load file for text editor.

Parameters:
vtehandle Text editor handle
filename Name of file to load
void MxTextEditSetCloseFunc ( void *  vtehandle,
void(*)(void *)  CloseFunc,
void *  CloseData 
)

Set function call when close menu item selected.

Parameters:
vtehandle Text editor handle
CloseData Function call for close Data for function call
void MxTextEditSetDftExtn ( void *  vtehandle,
char *  dftextn 
)

Set default file extension used when saving.

Parameters:
vtehandle Text editor handle
dftextn Default file extension to set
void MxTextEditSetEncoding ( void *  vtehandle,
char *  encoding 
)

Set encoding used when saving.

Parameters:
vtehandle Text editor handle
encoding Encoding to set
void MxTextSetFilePathXe ( Widget  xetext,
const FILEPATH &  filepath 
)

Set XeText widget to show FILEPATH with ToolTip.

Parameters:
xetext XeText widget
filepath Filepath to show
void MxTextSetObjItemXe ( Widget  xetext,
const RVC::OBJITEM &  objitem 
)

Set XeText widget to show file/object info with ToolTip from RVC::OBJITEM.

Parameters:
xetext XeText widget
int MxThemeMapEdit ( Widget  pwidget,
const RVC::OBJITEM &  GeoObjItem,
ELEMTYPE  elemtype,
INT16 &  StyAsTableNum,
const UINT32  styletype = 0xFFFF 
)

Allow user to define theme map.

Returns:
Error code
Parameters:
pwidget Parent widget
elemtype Element type
StyAsTableNum Style-assignment table number passed/returned
styletype STYLETYPE_Empty = 0xFFFF
void MxTimeOutInMainLoopSet ( int  val  ) 

Set _TimeOutInMainLoop to val.

MIUNICODE* MxTitleGetString ( Widget  widget  ) 

Get window title as Unicode string.

Returns:
Title string, MmFree() when done The "update date" will be stripped from the title if necessary.
Parameters:
widget Widget (will find shell thereof)
void MxTitleSetString ( Widget  widget,
const MISTRING &  string,
bool  ShowProcessID 
)

extern "C"

Set window title to given string with option whether to show process ID.

Parameters:
widget Widget (will find shell thereof)
string String or TEXTID to use for title
ShowProcessID Show process ID in title
void MxTitleSetString ( Widget  widget,
const MISTRING &  string 
)

Set window title to given Unicode string.

Parameters:
widget Widget (will find shell thereof)
string String or TEXTID to use for title
void MxToggleButtonSetState ( Widget  tb,
Boolean  state,
Boolean  notify = FALSE 
) [inline]

extern "C"

Set XmToggleButton state with check for NULL.

Parameters:
tb ToggleButton (NULL allowed)
state State (TRUE or FALSE)
notify Invoke callbacks, optional, default=FALSE
Widget MxTopLevel ( void   ) 

Get top-level application shell.

Returns:
widget
int MxTTFSymbolSelect ( Widget  widget,
MISTRING &  fontname,
UINT16 *  GlyphIndex,
MIUNICODE *  UnicodeNum 
)

Create True type symbol selecting dialog.

Returns:
Error code < 0
Parameters:
widget Parent widget
fontname TrueType font name
GlyphIndex Internal Glyph index in TTF file (passed/returned)
UnicodeNum Corresponded MIUNICODE number of character (NULL if not needed)
void MxUngrabKeyboard ( Display *  display  ) 

Forcefully remobe a server keyboard grab.

Removes a server grab on the keyboard. See MxUngrabPointer() for details.

Parameters:
display The display to remove the grab from
void MxUngrabPointer ( Display *  display  ) 

Forcefull remove a server pointer grab.

This function removes a server grab on the pointer (mouse). If you have an event loop which throws out some events, it's a good idea to call this function afterwards. When a popup menu is created it registers a passive grab on its parent with Xt. When you click the right mouse button on the menu's parent widget, Xt calls XGrabPointer and expects the menu's event handler to ungrab the pointer. It's important to realize that this is done at a lower level than the event dispatcher -- you can't prevent it. If you throw out the right mouse button event, the grab never gets ungrabbed and you have a mess.

Parameters:
display The display to remove the grab from
void MxWaitForUnmap ( Widget  widget  ) 

Process X events until specified widget is "unmapped".

This is normally done in modal dialogs to process events until the dialog is closed.

void MxWaitForUnmapWithIdleDelegate ( Widget  widget,
DELEGATE_BOOL_UINT32  DelegateOnIdle 
)

Process X events until specified widget is "unmapped", calling delegate during idle processing.

This is normally done in modal dialogs to process events until the dialog is closed. While no events are pending, the delegate will be called repeatedly, incrementing the passed "count" parameter until the delegate returns 'false'. Once an event becomes pending, the "count" will be reset to 1 the next time the delegate is called.

Variable Documentation

int const char const char const char void const Arg int argcount

< Number of arguments in arglist

int const char const char const char void const Arg* arglist

Arguments for button.

int const char const char const char void* cbdata

Callback data.

int const char* IconClass

Icon class used if icon object is not already open.

int iconhandle

< Parent widget

**IGNORED**

int const char const char* IconName

Icon name.

int const char const char const char* LabelName

Widget label name, also used for ToolTip.

int const char const char const char XtCallbackProc

Callback for XmNactivateCallback.

Generated on Sun Oct 7 21:33:05 2012 for TNTsdk 2012 by  doxygen 1.6.1