mi32/mstatus.h

Go to the documentation of this file.

#ifdef WIN32
#pragma message(__FILE__ "(2) : warning C9999: Use of mstatus.h is deprecated, use mgui/dlgstatus.h or mi32/mistatus.h instead.")
#endif

#if !defined(INC_MI32_MSTATUS_H) && !defined(NODLLLINKAGE)
#define  INC_MI32_MSTATUS_H

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

#ifndef INC_MI32_MISTATUS_H
#include <mi32/mistatus.h>
#endif

#ifndef  INC_MGUI_DLGSTATUS_H
#include <mgui/dlgstatus.h>
#endif


#ifdef WIN32
#pragma warning (push)
#pragma warning (disable:4100)   // Disable warning that this needs a DLL interface
#pragma warning (disable:4996)   // Disable warning about deprecated declaration within header
#endif


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

#ifdef USE_MGUI
DEPRECATED class STATUSDIALOG {
   public:

      enum FLAGS {
         FLAG_NoCancel =      MGUI::DLG_STATUS::DLGSTYLE_DisableCancel,
         FLAG_DelayPopup =    MGUI::DLG_STATUS::DLGSTYLE_DelayPopup,
         FLAG_None =          MGUI::DLG_STATUS::DLGSTYLE_Default
         };

      STATUSDIALOG (
         ): m_pDlgStatus(0) { }

      ~STATUSDIALOG (
         ) { delete m_pDlgStatus; }

      ERRVALUE CheckCancel (
         ) const { return ((m_pDlgStatus != 0 && m_pDlgStatus->IsCancelled()) ? EUserCancel : 0); }

      ERRVALUE Create (
         MDLGPARENT dlgparent,               
         FLAGS flags = FLAG_None
         ) { m_pDlgStatus = new MGUI::DLG_STATUS; m_pDlgStatus->Create(dlgparent,static_cast<MGUI::DLG_STATUS::DLGSTYLE>(flags)); return (0); }

      void Destroy (
         ) { delete m_pDlgStatus; m_pDlgStatus = 0; }

      void DisableCancel (
         ) const { if (m_pDlgStatus != 0) m_pDlgStatus->SetCancelEnabled(false); }

      void EnableCancel (
         ) const { if (m_pDlgStatus != 0) m_pDlgStatus->SetCancelEnabled(true); }

      MISTATUSMANAGER* GetHandle (
         ) const { return (m_pDlgStatus); }

      MTIMER* GetTimer (
         ) { return (&m_pDlgStatus->GetTimer()); }

      void ReportDone (
         TEXTID textid = TEXTID__None
         ) const { if (m_pDlgStatus != 0) m_pDlgStatus->ReportDone(textid); }

      void ResetCancel (
         ) const { if (m_pDlgStatus != 0) m_pDlgStatus->ResetCancelled(); }

      MISTATUSMANAGER* SetSelfAsDefault (
         ) { return (MISTATUSMANAGER::SetActiveManager(m_pDlgStatus)); }

      void WaitForOK (
         ) const { /*if (m_pDlgStatus != 0) m_pDlgStatus->WaitForClose();*/ }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      MGUI::DLG_STATUS *m_pDlgStatus;

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

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

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

DEPRECATED class STATUSCONTEXT {
   public:

      explicit STATUSCONTEXT (            
         MISTATUSMANAGER *pStatusMgr = 0,
         bool CreateContext = true
         ) :
         m_pStatusContext(0)
         { if (CreateContext) Create(pStatusMgr); }

   #ifdef USE_MGUI
      explicit STATUSCONTEXT (
         STATUSDIALOG& sdialog
         ):
         m_pStatusContext(0)
         { if (sdialog.GetHandle() != 0) Create(sdialog.GetHandle()); }
   #endif

      ~STATUSCONTEXT (                    
         ) { Destroy(); }

      void BarClear (
         ) { if (m_pStatusContext != 0) m_pStatusContext->ReportProgress(0); }

      int BarIncrement (
         INT32 increment = 1,             
         int line = 0 // line number no longer supported
         ) {
         if (m_pStatusContext == 0) return (0);
         return (m_pStatusContext->ReportProgressIncrement(increment));
         }

      int BarInit (
         INT32 maximum,                   
         int line = 0 // line number no longer supported
         ) {
         if (m_pStatusContext == 0) return (0);
         return (m_pStatusContext->ReportProgressBegin(static_cast<UINT32>(maximum)));
         }
            
      int BarUpdate (
         INT32 value,                     
         INT32 maximum,                   
         int line = 0 // line number no longer supported
         ) {
         if (m_pStatusContext == 0) return (0);
         return (m_pStatusContext->ReportProgress(100.0*value/maximum));
         }

      int CheckCancel (
         ) { return ((m_pStatusContext != 0 && m_pStatusContext->IsCancelled()) ? EUserCancel : 0); }

      void Clear (
         ) { if (m_pStatusContext != 0) { m_pStatusContext->ReportProgress(0); m_pStatusContext->ReportMessage(TEXTID__None); } }

      void ClearLine (
         ) { Clear(); }
         
      void ClearLine (
         int // line number no longer supported
         ) { Clear(); }
         
      void Create (
         MISTATUSMANAGER* pStatusMgr = 0
         ) { m_pStatusContext = (pStatusMgr != 0) ? new MISTATUSCONTEXT(pStatusMgr,TEXTID__None) : new MISTATUSCONTEXT(TEXTID__None); }

      void Destroy (
         ) { delete m_pStatusContext; m_pStatusContext = 0; }

   #ifndef NO_DEPRECATED
      void DisableCancel (
         ) { }
   #endif

   #ifndef NO_DEPRECATED
      void EnableCancel (
         ) { }
   #endif

   #ifndef NO_DEPRECATED
      MISTATUSCONTEXT *GetHandle (
         ) const { return (m_pStatusContext); }
   #endif

      int TextUpdate (
         const MISTRING& string,             
         int line = 0 // line number no longer supported
         ) {
         if (m_pStatusContext == 0) return (0);
         if (m_pStatusContext->IsCancelled()) return (EUserCancel);
         m_pStatusContext->ReportMessage(string);
         return (0);
         }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      MISTATUSCONTEXT *m_pStatusContext;

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

DEPRECATED class STATUSDISABLECANCEL {
   public:

      STATUSDISABLECANCEL (
         MISTATUSMANAGER* pStatusMgr = 0,
         bool Enable = true
         ) :
         m_pStatusContext(0)
         {
         if (Enable) {
            if (pStatusMgr == 0) pStatusMgr = MISTATUSMANAGER::GetActiveManager();
            if (pStatusMgr != 0) m_pStatusContext = new MISTATUSCONTEXT(pStatusMgr,TEXTID__None,false);
            }
         }

      ~STATUSDISABLECANCEL (
         ) { delete m_pStatusContext; }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      MISTATUSCONTEXT *m_pStatusContext;

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

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

#ifdef WIN32
#pragma warning (pop)
#endif

#endif   // INC_MI32_MSTATUS_H 

---