mstatusw.h

Go to the documentation of this file.

/**
 * \file mstatusw.h <mi32/mstatusw.h>
 * \brief Include file for "status display" functions that take Widgets
 *
 * \if NODOC
 * $Id: mstatusw.h_v 1.6 2003/09/15 13:49:56 fileserver!dwilliss Exp $
 *
 * $Log: mstatusw.h_v $
 * Revision 1.6  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.5  2000/06/27 18:35:18  sparsons
 * Genitor documentation.
 *
 * Revision 1.4  2000/06/26 20:43:01  mju
 * Include xdefns so compiles in isolation.
 *
 * Revision 1.3  1999/01/05 19:01:54  scowan
 * Swapped multiple keywords
 *
 * Revision 1.2  1998/12/18 22:42:09  mju
 * Move statusCreateDialog() to mstatus.h as macro.
 *
 * Revision 1.1  1998/09/02  21:18:33  scowan
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MI32_MSTATUSW_H
#define  INC_MI32_MSTATUSW_H
                                                             
#ifndef  INC_MI32_MSTATUS_H
#include <mi32/mstatus.h>
#endif

#ifndef  INC_MI32_XDEFNS_H
#include <mi32/xdefns.h>
#endif

#if defined(__cplusplus)
extern "C" {
#endif

//! Return XmForm widget of status dialog (to use as parent for other dialogs).
//!
//! @return XmForm widget.
//!
//! Do not place additional widgets in the form, it should only be used as a parent for other dialogs.
Widget MstatusDialogGetForm (
   MSTATUSHANDLE shandle               //!< Handle returned by MstatusDialogCreate() (will ignore if NULL)
   );

//! 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.
int MstatusFormCreate (
   Widget pwidget,                     //!< Parent widget for dialog (will use toplevel if NULL)
   MSTATUSHANDLE *shandle,             //!< Status handle returned
   MSTATUSCONTEXT *scontext,           //!< Initial status context returned (NULL if don't need one)
   UINT32 flags,                       //!< Flags
   Arg *arg,                           //!< Array of widget arguments
   int n                               //!< Number of arguments in arg
   );

//! 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().
#define           MstatusFormGetForm(shandle) MstatusDialogGetForm(shandle)

//! Get the XeText widget from a status form.
Widget MstatusFormGetText (
   MSTATUSHANDLE shandle               //!< Handle returned by MstatusFormCreate() (will ignore if NULL)
   );

//! 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().  
void MstatusSetCancelButton (
   MSTATUSHANDLE shandle,              //!< Handle returned by MstatusFormCreate() (will ignore if NULL)
   Widget button                       //!< The widget you wish to use as a cancel button
   );

#if defined(__cplusplus)
}
#endif

#endif   //!<  ifndef INC_MI32_MSTATUSW_H 

---