mstatus.h

Go to the documentation of this file.

/**
 * \file mstatus.h <mi32/mstatus.h>
 * \brief Include file for "status display" functions
 *
 * \if NODOC
 * $Id: mstatus.h_v 1.70 2004/10/29 16:26:00 scowan Exp $
 *
 * $Log: mstatus.h_v $
 * Revision 1.70  2004/10/29 16:26:00  scowan
 * *** empty log message ***
 *
 * Revision 1.69  2004/03/01 21:09:45  mju
 * Can't use 'interface' as Microsoft #defines it as 'struct'.
 *
 * Revision 1.68  2004/03/01 17:29:55  mju
 * Use inlines instead of macros and mark most legacy Mstatus functions as deprecated.
 *
 * Revision 1.67  2004/02/16 21:29:17  mju
 * Don't call deprecated item from inline as warns unnecessarily.
 *
 * Revision 1.66  2004/02/16 21:00:54  mju
 * Warn on deprecated usage.
 *
 * Revision 1.65  2003/12/18 14:19:20  mju
 * Remove deprecated textUpdateTimer method.
 *
 * Revision 1.64  2003/10/20 17:16:01  dwilliss
 * Added and immediately deprecated a method to get the handle from a dialog
 *
 * Revision 1.63  2003/10/10 15:21:26  mju
 * Add ReportDone and UpdateTimer methods using textid.
 *
 * Revision 1.62  2003/10/08 16:41:55  mju
 * Include mtimer header.
 *
 * Revision 1.61  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.60  2003/09/08 16:36:16  dwilliss
 * never mind.
 *
 * Revision 1.59  2003/08/13 20:18:45  scowan
 * Added bool value to disable cancel class.
 *
 * Revision 1.58  2003/07/21 17:04:01  mju
 * Add deprecate_groupkey for stuff using old msg group/ley.
 *
 * Revision 1.57  2003/05/21 22:19:06  dwilliss
 * Never mind.  Wrong version
 *
 * Revision 1.56  2003/05/21 14:43:33  dwilliss
 * Oops.  Accidently pasted the new method twice
 *
 * Revision 1.55  2003/05/21 14:40:22  dwilliss
 * Added STATUSDIALOG::SetSelfAsDefault()
 *
 * Revision 1.54  2003/03/04 17:01:44  dwilliss
 * *** empty log message ***
 *
 * Revision 1.53  2003/02/17 20:52:47  dwilliss
 * never mind
 *
 * Revision 1.52  2002/05/30 21:55:51  mju
 * Remove varargs defns.
 *
 * Revision 1.51  2002/05/06 15:21:18  mju
 * Deprecate var-arg statusinterface functions.
 *
 * Revision 1.50  2002/04/26 13:57:16  mju
 * Retire statuscontext::textupdatef.
 *
 * Revision 1.48  2002/03/28 17:24:01  mju
 * Add TextUpdate using TEXTID.
 *
 * Revision 1.47  2002/03/27 17:27:14  mju
 * Deprecate remaining varargs macros.
 *
 * Revision 1.46  2002/03/27 16:33:39  mju
 * Deprecate STATUSCONTEXT::TextUpdateF, Remove TextUpdateLineF.
 *
 * Revision 1.45  2002/03/20 17:49:59  mju
 * Add STATUSCONTEXT::Destroy() method.
 *
 * Revision 1.44  2002/02/20 18:06:07  mju
 * In CheckCancel check if context null before dereference.
 *
 * Revision 1.43  2001/06/21 22:34:30  scowan
 * Reinstate call to get the default handle.
 *
 * Revision 1.42  2001/05/15 14:30:50  scowan
 * Doc.
 *
 * Revision 1.41  2001/05/15 14:28:50  scowan
 * Added disable cancel class.
 *
 * Revision 1.40  2001/02/07 16:34:37  scowan
 * Check for status context == 0 defore enable / disable cancel button.
 *
 * Revision 1.39  2001/02/02 22:11:35  polson
 * changed ~STATUSDIALOG to check if already destroyed
 *
 * Revision 1.38  2000/11/20 17:20:54  scowan
 * Added a get handle method for legacy functions.
 *
 * Revision 1.37  2000/10/23 15:06:54  mju
 * Add STATUSDIALOG class.
 *
 * Revision 1.36  2000/08/31 14:51:52  mju
 * Add dft for line in BarUpdate.
 *
 * Revision 1.35  2000/06/26 20:42:09  mju
 * *** empty log message ***
 *
 * Revision 1.34  2000/06/26 19:42:55  sparsons
 * Genitor documentation.
 *
 * Revision 1.33  2000/06/01 16:48:02  scowan
 * Added capability to create a status context instance without creating a context
 * untill later with a create method.
 *
 * Revision 1.32  1999/11/19 17:19:01  mju
 * Use INT16 for line number to avoid warnings.
 *
 * Revision 1.31  1999/09/03  15:01:43  mju
 * Add STATUSCONTEXT class.
 *
 * Revision 1.30  1999/06/09  14:36:24  mju
 * Add win32-native prototypes.
 *
 * Revision 1.29  1999/05/19  14:48:45  mju
 * Use const for group/field parms.
 *
 * Revision 1.28  1999/05/07  21:20:01  mju
 * Header restruct.
 *
 * Revision 1.27  1999/01/05  19:12:44  scowan
 * Swapped multiple keywords
 *
 * Revision 1.26  1998/12/18 22:41:21  mju
 * Make most Mstatus... functions into macros reference public status interface so can pass to DLL.
 * Add rest of status functions to MSTATUSINTERFACE.
 *
 * Revision 1.23  1998/08/26  16:50:17  scowan
 * Move status interface code to here.
 *
 * Revision 1.22  1998/07/20  21:14:44  mju
 * Add MSTATUSFLAG_AllowFinish.
 *
 * Revision 1.21  1997/12/10  16:56:20  shovland
 * add a newline to end of file to make Digital UNIX (DrPepper) system happy
 *
 * Revision 1.20  1997/11/19  17:11:44  mju
 * Add MstatusTextUpdateFV().
 *
 * Revision 1.19  1997/10/17  16:15:34  mju
 * Change to use MTIMER.
 * Add MstatusTimerGet and MstatusTimerReset.
 *
 * Revision 1.18  1997/10/06  16:50:11  mju
 * Change prototype for MstatusTextUpdateTimer().
 *
 * Revision 1.17  1997/10/03  20:01:07  mju
 * Add MstatusTextUpdateString().
 *
 * Revision 1.16  1997/08/28  20:07:51  dwilliss
 * Added a field to STATUSLINEDATA
 *
 * Revision 1.15  1997/05/23  21:24:03  dwilliss
 * Added support for MSTATUS_DelayPopup
 *
 * Revision 1.14  1997/01/03  16:57:05  mju
 * Change MstatusClearBar to MstatusBarClear.  ditto for Text.
 *
 * Revision 1.13  1996/12/20  16:37:34  coffee!dwilliss
 * Added __cplusplus things
 *
 * Revision 1.12  1996/12/05  16:37:50  dwilliss
 * Added MstatusForm functions
 *
 * Revision 1.11  1996/12/03  18:34:58  mju
 * Add MstatusWaitForOK() and MstatusDialogGetForm().
 *
 * Revision 1.10  1996/11/25  23:13:03  mju
 * Allow multi-line text.
 *
 * Revision 1.9  1996/11/25  15:04:02  mju
 * Add MstatusTextUpdateF() prototype.
 *
 * Revision 1.8  1996/11/22  15:03:03  mju
 * Change Mstatus...Bar to MstatusBar...
 * Change Mstatus...Text to MstatusText...
 *
 * Revision 1.7  1996/11/21  22:59:47  mju
 * Add MstatusInitBar() and MstatusIncrementBar().
 *
 * Revision 1.6  1996/11/21  21:12:15  mju
 * Change MstatusUpdate... to return int (for cancelled status).
 *
 * Revision 1.5  1996/11/21  20:51:36  mju
 * MstatusDialogCreate() prototype changed.
 *
 * Revision 1.4  1996/11/21  18:33:42  mju
 * Include private definition if MSTATUS_LIB defined.
 *
 * Revision 1.3  1996/11/21  15:14:52  mju
 * Changed MstatusContextDestroy() to MstatusContextFree().
 *
 * Revision 1.2  1996/11/20  23:04:28  mju
 * Change cancelled from Boolean to int so works if xdefns not included.
 *
 * Revision 1.1  1996/11/20  14:45:23  mju
 * Initial revision
 *
 * Revision 1.1  1994/08/10  14:49:25  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MI32_MSTATUS_H
#define  INC_MI32_MSTATUS_H

#ifndef  INC_STDARG_H
   #include <stdarg.h>
   #define  INC_STDARG_H
#endif

#ifndef  INC_MI32_STDDEFNS_H
   #include <mi32/stddefns.h>
#endif

#if defined(MSTATUS_LIB) && !defined(INC_MI32_MIODEFNS_H)
   #include <mi32/miodefns.h>
#endif

#ifndef INC_MI32_MISTRING_H
#include <mi32/mistring.h>
#endif

#ifndef  INC_MI32_MTIMER_H
#include <mi32/mtimer.h>
#endif


#ifdef WIN32
#pragma warning (disable:4996)   // Disable warning about deprecated declaration within header
#endif

#ifdef RVCLOWDLL
   #define RVCLOWLIBEXPORT MI_DLLEXPORT
#else
   #define RVCLOWLIBEXPORT MI_DLLIMPORT
#endif



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

#define  MSTATUSFLAG_NoCancel    0x0001   //!<  Don't include "Cancel" button 
#define  MSTATUSFLAG_DelayPopup  0x0002   //!<  Don't popup until after a given time (read from Ini file) 
#define  MSTATUSFLAG_AllowFinish 0x0004   //!<  Include "Finish" button 

typedef struct _MSTATUSCONTEXT {
   struct _MSTATUSHANDLE *shandle;
   #ifdef MSTATUS_LIB
      /* Private members */
      struct _MSTATUSCONTEXT *nextcontext;
      INT16 firstline;
      INT16 lastline;
   #endif
   } *MSTATUSCONTEXT;

#ifdef MSTATUS_LIB
   typedef struct {
      UNICODE *text;                      //!<  NULL if no text for this line 
      UINT8 HasBar;                       //!<  Set if we have a progress bar for this line 
      UINT8 textrows;                     //!<  Number of text rows 
      UINT16 textwidth;                   //!<  Width of text in pixels 
      INT32 curval, maxval;                  //!<  Current and "maximum" values for progress bar 
      INT32 barupdatemodval;              //!<  Modulus value for actually updating bar 
      INT32 barcancelmodval;              //!<  Modulus value for checking for cancel during bar update 
      INT32 lastupdateval;                //!<  Last bar width (pixels) at which we updated status bar 
      } MSTATUSLINEDATA;
#endif

typedef struct _MSTATUSHANDLE {
   int cancelled;
   #ifdef MSTATUS_LIB
      /* Private members */
      int canceldisablecount;             //!<  Number of times cancel button has been disabled 
      int (*TestCancel)(struct _MSTATUSHANDLE *, void *);
      void *TestCancelData;
      MSTATUSLINEDATA *linedata;
      MSTATUSCONTEXT firstcontext;        //!<  First status context in linked-list 
      MSTATUSCONTEXT curcontext;
      MTIMER timer;
      struct _MSTATUSHANDLE *prevdfthandle;  //!<  Previous default status handle 
      void *privptr;                         //!<  Used by implementation 
   #endif
   } *MSTATUSHANDLE;


/**
*  Generic status interface structure
**/

typedef struct _MSTATUSINTERFACE {
   /* This structure is passed to multiple DLLs */
   /* To maintain compatibility, do not change or remove any existing members */
   /* New members must be added to the end */
   /* All functions must be initialized to non-NULL in mstatusi.c or ILLOPs will occur */
   INT32 size;
   void (*StatusBarClear)(MSTATUSCONTEXT, INT16);
   int (*StatusBarIncrement)(MSTATUSCONTEXT, INT16, INT32);
   int (*StatusBarInit)(MSTATUSCONTEXT, INT16, INT32);
   int (*StatusBarUpdate)(MSTATUSCONTEXT, INT16, INT32, INT32);
   void (*StatusClearAll)(MSTATUSCONTEXT);
   void (*StatusClearLine)(MSTATUSCONTEXT, INT16);
   int (*StatusCheckCancel)(MSTATUSHANDLE);
   MSTATUSCONTEXT (*StatusContextCreate)(MSTATUSHANDLE);
   void (*StatusContextFree)(MSTATUSCONTEXT);
   void (*StatusDisableCancel)(MSTATUSHANDLE);
   void (*StatusEnableCancel)(MSTATUSHANDLE);
   void (*StatusResetCancel)(MSTATUSHANDLE); /* Has default */
   void (*StatusTextClear)(MSTATUSCONTEXT, INT16);
   int (*StatusTextUpdate)(MSTATUSCONTEXT, INT16, const char*, const char*);  /* Has default */
   int (*StatusTextUpdateString)(MSTATUSCONTEXT, INT16, const UNICODE*);
   int (*REMOVED_StatusTextUpdateF)();
   MSTATUSHANDLE (*StatusGetDefaultHandle)(void);     //! Do not obsolete, needed to support multi-threading  SBC 21 Jun 01
   int (*StatusDialogCreate)(void*, MSTATUSHANDLE*, MSTATUSCONTEXT*, UINT32);
   void (*StatusDialogDestroy)(MSTATUSHANDLE);
   void (*StatusReportDone)(MSTATUSHANDLE, const char*, const char*);
   void (*StatusSetCancelFunc)(MSTATUSHANDLE, int(*)(MSTATUSHANDLE, void*), void*); /* Has default */
   int (*REMOVED_StatusTextUpdateFV)();
   int (*StatusTextUpdateTimer) (MSTATUSCONTEXT, INT16, const char*, const char*, MTIMER*);  /* Has default */
   MTIMER *(*StatusTimerGet)(MSTATUSHANDLE); /* Has default */
   void (*StatusTimerReset)(MSTATUSHANDLE);  /* Has default */
   void (*StatusWaitForOK)(MSTATUSHANDLE);
   MSTATUSHANDLE (*StatusSetDefaultHandle)(MSTATUSHANDLE);  /* Cannot override */
   MSTATUSHANDLE DefaultHandle;
   void (*ReportDone) (MSTATUSHANDLE, TEXTID);
   int (*TextUpdateTimer) (MSTATUSCONTEXT, INT16, TEXTID, MTIMER*);
   } *MSTATUSINTERFACE;


#if defined(MAC_OSX) && defined(RVCSYSDLL)
//! linker on Mac OS X exports all symbols and we get clashes if we use the
//! same name
#define DftStatusInterface DftStatusInterfaceRVCSYS
#endif

extern MSTATUSINTERFACE DftStatusInterface;

/* When implementing a DLL, DftStatusInterface must be defined as a public global */
/* in one of the DLL modules.  It must be initialized to the process' value when */
/* the DLL is initialized */


//=====================================================================================================================

//! Get the status.
RVCLOWLIBEXPORT MSTATUSINTERFACE MfStatusGet (void);

//! Set the status.
RVCLOWLIBEXPORT void MfStatusSet (
   MSTATUSINTERFACE status
   );

DEPRECATED inline void MstatusBarClear (
   MSTATUSCONTEXT c,
   INT16 ln
   ) { (*DftStatusInterface->StatusBarClear)(c,ln); }

DEPRECATED inline int MstatusBarIncrement (
   MSTATUSCONTEXT c,
   INT16 ln,
   INT32 inc
   ) { return ((*DftStatusInterface->StatusBarIncrement)(c,ln,inc)); }

DEPRECATED inline int MstatusBarInit (
   MSTATUSCONTEXT c,
   INT16 ln,
   INT32 max
   ) { return ((*DftStatusInterface->StatusBarInit)(c,ln,max)); }

DEPRECATED inline int MstatusBarUpdate (
   MSTATUSCONTEXT c,
   INT16 ln,
   INT32 val,
   INT32 max
   ) { return ((*DftStatusInterface->StatusBarUpdate)(c,ln,val,max)); }

DEPRECATED inline int MstatusCheckCancel (
   MSTATUSHANDLE h
   ) { return ((*DftStatusInterface->StatusCheckCancel)(h)); }

DEPRECATED inline void MstatusClearAll (
   MSTATUSCONTEXT c
   ) { (*DftStatusInterface->StatusClearAll)(c); }

DEPRECATED inline void MstatusClearLine (
   MSTATUSCONTEXT c,
   INT16 ln
   ) { (*DftStatusInterface->StatusClearLine)(c,ln); }

DEPRECATED inline MSTATUSCONTEXT MstatusContextCreate (
   MSTATUSHANDLE h
   ) { return ((*DftStatusInterface->StatusContextCreate)(h)); }

DEPRECATED inline void MstatusContextFree (
   MSTATUSCONTEXT c
   ) { (*DftStatusInterface->StatusContextFree)(c); }

DEPRECATED inline int MstatusDialogCreate (
   MDLGPARENT p,
   MSTATUSHANDLE *ph,
   MSTATUSCONTEXT *pc,
   UINT32 flags
   ) { return ((*DftStatusInterface->StatusDialogCreate)(p,ph,pc,flags)); }

DEPRECATED inline void MstatusDialogDestroy (
   MSTATUSHANDLE h
   ) { (*DftStatusInterface->StatusDialogDestroy)(h); }

DEPRECATED inline void MstatusDisableCancel (
   MSTATUSHANDLE h
   ) { (*DftStatusInterface->StatusDisableCancel)(h); }

DEPRECATED inline void MstatusEnableCancel (
   MSTATUSHANDLE h
   ) { (*DftStatusInterface->StatusEnableCancel)(h); }

inline MSTATUSHANDLE MstatusGetDefaultHandle (
   ) { return ((*DftStatusInterface->StatusGetDefaultHandle)()); }

inline MSTATUSINTERFACE& MstatusInterfaceGet (
   ) { return (DftStatusInterface); }

void MstatusInterfaceSet (
   MSTATUSINTERFACE StatusInterface
   );

#ifndef DEPRECATE_GROUPKEY
DEPRECATED inline void MstatusReportDone (
   MSTATUSHANDLE h,
   const char *mg,
   const char *mc
   ) { (*DftStatusInterface->StatusReportDone)(h,mg,mc); }
#endif

DEPRECATED inline void MstatusResetCancel (
   MSTATUSHANDLE h
   ) { (*DftStatusInterface->StatusResetCancel)(h); }

DEPRECATED inline void MstatusSetCancelFunc (
   MSTATUSHANDLE h,
   int (*f)(MSTATUSHANDLE, void*),
   void *d
   ) { (*DftStatusInterface->StatusSetCancelFunc)(h,f,d); }

DEPRECATED inline MSTATUSHANDLE MstatusSetDefaultHandle (
   MSTATUSHANDLE h
   ) { return ((*DftStatusInterface->StatusSetDefaultHandle)(h)); }

DEPRECATED inline void MstatusTextClear (
   MSTATUSCONTEXT c,
   INT16 ln
   ) { (*DftStatusInterface->StatusTextClear)(c,ln); }

DEPRECATED inline int MstatusTextUpdateString (
   MSTATUSCONTEXT c,
   INT16 ln,
   const UNICODE *s
   ) { return ((*DftStatusInterface->StatusTextUpdateString)(c,ln,s)); }

#ifndef DEPRECATE_GROUPKEY
DEPRECATED inline int MstatusTextUpdateTimer (
   MSTATUSCONTEXT c,
   INT16 ln,
   const char *mg,
   const char *mc,
   MTIMER *t
   ) { return ((*DftStatusInterface->StatusTextUpdateTimer)(c,ln,mg,mc,t)); }
#endif

DEPRECATED inline MTIMER* MstatusTimerGet (
   MSTATUSHANDLE h
   ) { return ((*DftStatusInterface->StatusTimerGet)(h)); }

DEPRECATED inline void MstatusTimerReset (
   MSTATUSHANDLE h
   ) { (*DftStatusInterface->StatusTimerReset)(h); }

DEPRECATED inline void MstatusWaitForOK (
   MSTATUSHANDLE h
   ) { (*DftStatusInterface->StatusWaitForOK)(h); }

#if defined(WIN32_NATIVE)

class CStatusBar;

//! Create and manage a single line status form.
int MstatusFormCreate (
   CStatusBar *pStatusBar,             //!< Parent widget for dialog (will use toplevel if NULL)
   MSTATUSHANDLE *rshandle,            //!< Status handle returned
   UINT32 flags                        //!< Flags
   );

//! Destroy and clear status form.
void MstatusFormDestroy (
   MSTATUSHANDLE shandle
   );

//! Initialize status interface to Windows functions.
void MstatusInterfaceInitWin (void);

#else    //!< X

//! Initialize status interface to X functions.
void MstatusInterfaceInitX (void);

#endif

#if defined(__cplusplus)
}
#endif


#ifndef  DEPRECATE_GROUPKEY
DEPRECATED inline ERRVALUE MstatusTextUpdate (
   MSTATUSCONTEXT c, 
   INT16 line,
   const char *msggroup,
   const char *msgkey
   ) { return ((*DftStatusInterface->StatusTextUpdate)(c,line,msggroup,msgkey)); }
#endif

inline ERRVALUE MstatusTextUpdate (
   MSTATUSCONTEXT c, 
   INT16 line,
   TEXTID textid
   ) { return ((*DftStatusInterface->StatusTextUpdateString)(c,line,MISTRING(textid))); }



//! Status dialog.
class STATUSDIALOG {
   public:

      enum FLAGS {
         FLAG_NoCancel =      MSTATUSFLAG_NoCancel,
         FLAG_DelayPopup =    MSTATUSFLAG_DelayPopup,
         FLAG_AllowFinish =   MSTATUSFLAG_AllowFinish,
         FLAG_None =          0
         };

      //! Constructor, performs initialization only, does not create dialog itself.
      STATUSDIALOG (
         ): m_shandle(0) { }

      //! Destructor, will destroy dialog if exists.
      ~STATUSDIALOG (
         ) { if (m_shandle != 0) MstatusDialogDestroy(m_shandle); }

      //! Check if 'Cancel' button has been pressed.
      //! @return EUserCancel if pressed or 0 if not.
      ERRVALUE CheckCancel (
         ) const { return (MstatusCheckCancel(m_shandle)); }

      //! Create the actual dialog.
      ERRVALUE Create (
         MDLGPARENT dlgparent,               //!< Parent for dialog
         FLAGS flags = FLAG_None
         ) { return (MstatusDialogCreate(dlgparent,&m_shandle,0,flags)); }

      //! Destroy dialog without destroying class instance.
      void Destroy (
         ) { MstatusDialogDestroy(m_shandle); m_shandle = 0; }

      //! Disable the 'Cancel' button on the dialog (if any).
      void DisableCancel (
         ) const { MstatusDisableCancel(m_shandle); }

      //! Enable the 'Cancel' button on the dialog (if any).
      void EnableCancel (
         ) const { MstatusEnableCancel(m_shandle); }

      //! Get the MSTATUSHANDLE for the dialog.
      //! \deprecated No new code should be written to take an MSTATUSHANDLE
      //!   directly, however this method is still necessary for calling some
      //!   old code.
      MSTATUSHANDLE GetHandle (
         ) const {
         return (m_shandle);
         }

      //! Get timer associated with status dialog.
      MTIMER* GetTimer (
         ) const { return (MstatusTimerGet(m_shandle)); }

      //! Report that process is finished with time.
      //! This will change the 'Cancel' button to 'OK' wait for the user to press.
      //! If the TEXTID__None is specified a generic 'time to process' message will be shown.
      void ReportDone (
         TEXTID textid = TEXTID__None
         ) const { (*DftStatusInterface->ReportDone)(m_shandle,textid); }

   #ifndef DEPRECATE_GROUPKEY
      //! Report that process is finished.
      //! This will change the 'Cancel' button to 'OK' and is normally
      //! followed by WaitForOK().
      DEPRECATED void ReportDone (
         const char *msggroup,
         const char *msgkey
         ) const { (*DftStatusInterface->StatusReportDone)(m_shandle,msggroup,msgkey); }
   #endif

      //! Reset the 'Cancel' button on the dialog (if any).
      void ResetCancel (
         ) const { MstatusResetCancel(m_shandle); }

      //! Reset timer associated with status dialog.
      void ResetTimer (
         ) const { MstatusTimerReset(m_shandle); }
      
      //! Sets this dialog to be the default status handle.  
      //! Useful when calling functions that don't play nice and set the
      //! default back to 0 when they exit.
      MSTATUSHANDLE SetSelfAsDefault (
         ) { return (MstatusSetDefaultHandle(m_shandle)); }

      //! Wait for user to press 'OK' button.
      void WaitForOK (
         ) const { MstatusWaitForOK(m_shandle); }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      MSTATUSHANDLE m_shandle;

      STATUSDIALOG (const STATUSDIALOG&);
      STATUSDIALOG& operator= (const STATUSDIALOG&);

      friend class STATUSCONTEXT;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };
DEFINE_ENUM_OPERATORS(STATUSDIALOG::FLAGS);


//! Status context.
class STATUSCONTEXT {
   public:

      //! Constructor using default status dialog.
      explicit STATUSCONTEXT (            
         MSTATUSHANDLE shandle = 0,
         bool CreateContext = true
         ) :
         m_scontext(0)
         { if (CreateContext) Create(shandle); }

      //! Construct context in STATUSDIALOG.
      explicit STATUSCONTEXT (
         STATUSDIALOG& sdialog
         ):
         m_scontext(0)
         { if (sdialog.m_shandle != 0) Create(sdialog.m_shandle); }

      //! Destructor.
      ~STATUSCONTEXT (                    
         ) { Destroy(); }

      //! Clear the status bar.
      void BarClear (
         INT16 line = 0
         ) { MstatusBarClear(m_scontext,line); }

      //! Increment progress indicator bar position.
      int BarIncrement (
         INT32 increment = 1,             //!< Amount to increment by 
         INT16 line = 0                   //!< Line number within context
         ) { return (MstatusBarIncrement(m_scontext,line,increment)); }

      //! Initialize or reset progress bar.
      int BarInit (
         INT32 maximum,                   //!< Maximum expected number of calls to MstatusBarIncrement()
         INT16 line = 0                   //!< Line number within context
         ) { return (MstatusBarInit(m_scontext,line,maximum)); }
            
      //! Update progress indicator bar position. 
      int BarUpdate (
         INT32 value,                     //!< Current bar position
         INT32 maximum,                   //!< Maximum bar position
         INT16 line = 0                   //!< Line number within context
         ) { return (MstatusBarUpdate(m_scontext,line,value,maximum)); }

      //! Check if cancel button has been pressed.
      int CheckCancel (
         ) { return ((m_scontext != 0) ? MstatusCheckCancel(m_scontext->shandle) : 0); }

      //! Clear all lines in status context.
      void Clear (
         ) { MstatusClearAll(m_scontext); }

      //! Clear both text and indicator bar in context.
      void ClearLine (
         INT16 line = 0
         ) { MstatusClearLine(m_scontext,line); }
         
      //! Create a status context.
      void Create (
         MSTATUSHANDLE shandle = 0
         ) { m_scontext = MstatusContextCreate(shandle); }

      //! Destroy status context.
      //! Automatically called by destructor.
      void Destroy (
         ) { MstatusContextFree(m_scontext); m_scontext = 0; }

      //! Disable cancel button.
      void DisableCancel (
         ) { if (m_scontext != 0) MstatusDisableCancel(m_scontext->shandle); }

      //! Enable cancel button.
      void EnableCancel (
         ) { if (m_scontext != 0) MstatusEnableCancel(m_scontext->shandle); }

      //! Obtain internal handle for legacy functions    
      MSTATUSCONTEXT GetHandle (
         ) const { return (m_scontext); }

   #ifndef  DEPRECATE_GROUPKEY
      //! Update text line using a message.
      //! \deprecated
      DEPRECATED int TextUpdate (
         const char *MsgGroup,
         const char *MsgName,
         INT16 line = 0
         ) { return ((*DftStatusInterface->StatusTextUpdate)(m_scontext,line,MsgGroup,MsgName)); }
   #endif

      //! Update text line using a string.
      int TextUpdate (
         const MISTRING& string,             //!< Text string (also implies TEXTID)
         INT16 line = 0
         ) { return (MstatusTextUpdateString(m_scontext,line,string)); }

      //! Update text line using status timer and description.
      int TextUpdateTimer (
         TEXTID textid,
         INT16 line = 0
         ) { return ((*DftStatusInterface->TextUpdateTimer)(m_scontext,line,textid,NULL)); }

      //! Update text line using specified timer and description.
      int TextUpdateTimer (
         TEXTID textid,
         MTIMER& timer,
         INT16 line = 0
         ) { return ((*DftStatusInterface->TextUpdateTimer)(m_scontext,line,textid,&timer)); }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      MSTATUSCONTEXT m_scontext;

      STATUSCONTEXT (const STATUSCONTEXT&);
      STATUSCONTEXT& operator= (const STATUSCONTEXT&);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };
   

//! Class to disable status "Cancel" button when an instance is created and reenable the button when the instance is destroyed   
class STATUSDISABLECANCEL {
   public:

      //! Constructor.
      STATUSDISABLECANCEL (
         MSTATUSHANDLE sdh = 0,
         bool Enable = true
         ) :
         m_msh(sdh)
         {
         if (Enable) {
            if (m_msh == 0) m_msh = MstatusGetDefaultHandle();
            if (m_msh != 0) MstatusDisableCancel(m_msh);
            }
         else {
            m_msh = 0;
            }
         }

      //! Destructor.
      ~STATUSDISABLECANCEL (
         ) { if (m_msh != 0) MstatusEnableCancel(m_msh); }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      MSTATUSHANDLE m_msh;

      STATUSDISABLECANCEL (const STATUSDISABLECANCEL&);
      STATUSDISABLECANCEL& operator=(const STATUSDISABLECANCEL&);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

#ifdef WIN32
#pragma warning (default:4996)   // Restore warning about deprecated declaration
#endif

#endif   // INC_MI32_MSTATUS_H 

---