mstatusw.h File Reference

<mi32/mstatusw.h> Include file for "status display" functions that take Widgets More...

#include <mi32/mstatus.h>
#include <mi32/xdefns.h>

Include dependency graph for mstatusw.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	MstatusFormGetForm(shandle)   MstatusDialogGetForm(shandle)
Functions
Widget	MstatusDialogGetForm (MSTATUSHANDLE shandle)
int	MstatusFormCreate (Widget pwidget, MSTATUSHANDLE *shandle, MSTATUSCONTEXT *scontext, UINT32 flags, Arg *arg, int n)
Widget	MstatusFormGetText (MSTATUSHANDLE shandle)
void	MstatusSetCancelButton (MSTATUSHANDLE shandle, Widget button)

---

Detailed Description

<mi32/mstatusw.h> Include file for "status display" functions that take Widgets

Definition in file mstatusw.h.

---

Define Documentation

#define MstatusFormGetForm (  shandle   )     MstatusDialogGetForm(shandle)

Get the XmForm widget of status form (to use for attachments). Do not place additional widgets in the form, it should only be used as a parent for other dialogs or to attach other widgets to. Note that this is really just a macro that calls MstatusDialogGetForm(). Definition at line 78 of file mstatusw.h.

---

Function Documentation

Widget MstatusDialogGetForm (  MSTATUSHANDLE  shandle  )

Return XmForm widget of status dialog (to use as parent for other dialogs). Returns: XmForm widget. Do not place additional widgets in the form, it should only be used as a parent for other dialogs. Parameters: shandle  Handle returned by MstatusDialogCreate() (will ignore if NULL)

int MstatusFormCreate (  Widget  pwidget, MSTATUSHANDLE *  shandle, MSTATUSCONTEXT *  scontext, UINT32  flags, Arg *  arg, int  n )

Create and manage a single line status form. Flags: MSTATUSFLAG_NoCancel No cancel button (supply your own with MstatusSetCancelButton()) This function automatically clears and starts timer 7 which is used by MstatusReportDone(). Note that this function does not return a widget. If you want the form to use for attachments to other widgets, you can call MstatusFormGetForm(). The form created will have a single XeText widget for displaying the one line of status, A short status bar, and an optional cancel button. For an example of this in use, see the status line in SML. Parameters: pwidget  Parent widget for dialog (will use toplevel if NULL) shandle  Status handle returned scontext  Initial status context returned (NULL if don't need one) flags  Flags arg  Array of widget arguments n  Number of arguments in arg

Widget MstatusFormGetText (  MSTATUSHANDLE  shandle  )

Get the XeText widget from a status form. Parameters: shandle  Handle returned by MstatusFormCreate() (will ignore if NULL)

void MstatusSetCancelButton (  MSTATUSHANDLE  shandle, Widget  button )

Set the cancel button for a status form. This function allows you to set the cancel button for a status form (don't try it with a status dialog). The button doesn't have to be in the form, it could be part of a toolbar elsewhere on the dialog. If you want to use your own cancel checking function, call MstatusSetCancelFunc(). Parameters: shandle  Handle returned by MstatusFormCreate() (will ignore if NULL) button  The widget you wish to use as a cancel button

---