mgui/statusbar.h

Go to the documentation of this file.

#ifndef  INC_MGUI_STATUSBAR_H
#define  INC_MGUI_STATUSBAR_H

#ifndef  INC_MGUI_CTRL_H
#include <mgui/ctrl.h>
#endif

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

#ifndef GENERATING_DOXYGEN_OUTPUT
struct MTIMER;
#endif


namespace MGUI {

//===================================================================================================================
class CTRL_STATUSBAR : public MGUI::CTRL, public MISTATUSLOGGER {
   public:

      enum STYLE {
         STYLE_Default =         0,
         STYLE_HasCancelButton = 0x01,    
         STYLE_NoProgressBar =   0x02,    
         STYLE_NoElapsedTime =   0x04,    
         STYLE_EnableToolTips =  0x08,
         STYLE_EnableThreading = 0x10,    
         };

      enum PANEUSAGE {
         PANEUSAGE_Main,                  
         PANEUSAGE_ElapsedTime,           
         PANEUSAGE_ProgressBar,           
         PANEUSAGE_Icon,                  
         PANEUSAGE_Text,                  
         PANEUSAGE_Mixed,                 
         };

      enum PANESTYLE {
         PANESTYLE_Normal        = 0x00,
         PANESTYLE_NoSeparator   = 0x01,  
         PANESTYLE_Stretch       = 0x02,  
         };

      CTRL_STATUSBAR ();

      virtual ~CTRL_STATUSBAR ();

      int AddPane (
         PANEUSAGE usage,                    
         PANESTYLE style,                    
         int cxWidth,                        
         ID id = 0                           
         );

      void AttachCancelButton (
         CTRL_PUSHBUTTON& button
         );

      void AttachCancelButton (
         CTRL_TOOLBAR& toolbar,        
         ID id                         
         );

   #ifdef X_NATIVE
      DEPRECATED void AttachCancelButtonWidget (
         Widget widget
         );
   #endif

      void ClearBar (
         );

      void ClearPane (
         int PaneIndex
         );

      void ClearPaneElapsedTime (
         );

      void ClearText (
         );

      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,       
         STYLE style = STYLE_Default
         );

      void SetPaneDelegateOnToolTipRequest (
         int PaneIndex,                      
         DELEGATE_ONTOOLTIPREQUEST delegate
         );
      
      void SetPaneEnabled (
         int PaneIndex,                      
         bool enabled                        
         );

      void SetPaneIcon (
         int PaneIndex,                      
         ICONID iconid                       
         );

      void SetPaneText (
         int PaneIndex,                      
         const MISTRING& string              
         );

      void SetPaneToolTipString (
         int PaneIndex,                      
         const MISTRING& string              
         );
      
      void SetPaneVisible (
         int PaneIndex,                      
         bool visible                        
         );

      void SetText (
         const MISTRING& string              
         );

      void SetTextError (
         ERRVALUE err
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      typedef CTRL BASECLASS;
      typedef CTRL_STATUSBAR THISCLASS;

      class PRIV;
      PRIV *m_pPriv;

      void OnToolBarCancel (MGUI::ID, bool);

      // CTRL overrides.
      virtual void v_OnDestroyWidget ();

      // MISTATUSMANAGER/LOGGER overrides.
      virtual CONTEXT_PRIV* v_ContextPrivCreate (MISTATUSCONTEXT& Context);
      virtual bool v_IsCancelled ();
      virtual void v_ReportMessage (MISTATUSCONTEXT& context, const MISTRING& msgstr);
      virtual void v_ReportProgress (MISTATUSCONTEXT& context, double pctdone);
      virtual void v_ReportTimerValue (const MTIMER& timer);
      virtual void v_SetCancelEnabled (bool enabled);
      virtual void v_UpdateUI ();

      CTRL_STATUSBAR (const CTRL_STATUSBAR&);
      CTRL_STATUSBAR& operator= (const CTRL_STATUSBAR&);
      #endif // GENERATING_DOXYGEN_OUTPUT

   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(CTRL_STATUSBAR::STYLE)
DEFINE_ENUM_OP_BITWISE(CTRL_STATUSBAR::PANESTYLE)
#endif

//===================================================================================================================
}  // End namespace MGUI


#endif   // INC_MGUI_STATUSBAR_H

---