mgui/dlgwizard.h

Go to the documentation of this file.

#ifndef  INC_MGUI_DLGWIZARD_H
#define  INC_MGUI_DLGWIZARD_H

#ifndef  INC_MGUI_SHELL_H
#include <mgui/shell.h>
#endif

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


namespace MGUI {

class LAYOUT_WIZARD_PAGE;

class DLGWIZARD : public MGUI::SHELL {
   public:

      enum BTNFLAGS {
         BTNFLAG_None = 0x00,
         BTNFLAG_Next = 0x01,
         BTNFLAG_Back = 0x02,
         BTNFLAG_Finish = 0x04,
         BTNFLAG_DisabledFinish = 0x08
         };

      enum DLGSTYLE {
         DLGSTYLE_Default =         0x0000,     
         DLGSTYLE_Resizable =       0x0001,     
         };

      virtual ~DLGWIZARD (
         ) = 0;

      ERRVALUE DoModal (
         MDLGPARENT dlgparent                   
         );

      int GetActiveIndex (
         ) const;

      int GetNumPages (
         ) const;

      void SetActiveIndex (
         int index                              
         );
         
      void SetWizardButtons (
         BTNFLAGS flags
         );

   protected:

      DLGWIZARD (
         const MISTRING& title,                 
         HELPID HelpID,                         
         DLGSTYLE style = DLGSTYLE_Default      
         );
         
      void NotifyCancel (
         ) { v_OnCancel(); }

      void SetReturnValue (
         int RetValue
         ) { m_RetValue = RetValue; }

      void SetRootMargin (
         int RootMargin
         ) { m_RootMargin = RootMargin; }

      void SetRootSpacing (
         int RootSpacing
         ) { m_RootSpacing = RootSpacing; }

      void SetStyle (
         DLGSTYLE style
         ) { m_Style = style; }

      // Overridables that may be called from derived classes.

      virtual void v_OnCancel ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      typedef DLGWIZARD THISCLASS;

      DLGSTYLE m_Style;
      ERRVALUE m_RetValue;
      int m_RootSpacing;
      int m_RootMargin;

      SIMPLE_ARRAY<LAYOUT_WIZARD_PAGE*> m_PagePtrs;
      int m_ActiveIndex;
      LAYOUT_PANE m_ButtonPane;
      CTRL_PUSHBUTTON m_BtnBack;
      CTRL_PUSHBUTTON m_BtnNext;
      CTRL_PUSHBUTTON m_BtnFinish;
      CTRL_PUSHBUTTON m_BtnCancel;
      CTRL_PUSHBUTTON m_BtnHelp;

      void Close (bool notify = true);

      ERRVALUE CreateDlg (
         MDLGPARENT dlgparent
         );

      void OnCmdBack ();
      void OnCmdFinish ();
      void OnCmdNext ();

      DLGWIZARD (const DLGWIZARD&);
      DLGWIZARD& operator= (const DLGWIZARD&);

      // Overrides from SHELL.
      void v_Destroy ();
      int v_CreateContent ();
      void v_OnCloseRequest ();

      friend class LAYOUT_WIZARD_PAGE;
      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables.

      virtual void v_OnClose ();

      virtual void v_OnDestroy ();

      virtual void v_OnOpen ();

   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(DLGWIZARD::DLGSTYLE)
DEFINE_ENUM_OP_BITWISE(DLGWIZARD::BTNFLAGS)
#endif


class LAYOUT_WIZARD_PAGE : public MGUI::LAYOUT_PANE_ROOT {
   public:

      enum PAGE {
         PAGE_Same = -2,
         PAGE_Next = -1,
         PAGE_Back = PAGE_Next
         };

      LAYOUT_WIZARD_PAGE (
         );

      virtual ~LAYOUT_WIZARD_PAGE (
         );

      int Create (
         MGUI::DLGWIZARD& wizard,               
         MGUI::LAYOUT_ORIENTATION orientation = MGUI::LAYOUT_ORIENTATION_Vertical
         );

      int GetPageIndex (
         ) const { return (m_index); }

      bool IsActive (
         ) const;

      void SetEnabled (
         bool enabled = true
         );

      void SetNextEnabled (
         bool enabled,                 
         bool ForceToFinish = false    
         );

   protected:

      void SetIgnoreNonVisible (
         bool IgnoreNonVisible = true
         ) { m_IgnoreNonVisible = IgnoreNonVisible; }

      void SetNoSpaceExpanding (
         bool NoSpaceExpanding = true
         ) { m_NoSpaceExpanding = NoSpaceExpanding; }

      virtual void v_OnWizardFinish ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      DLGWIZARD *m_pWizard;
      MGUI::LAYOUT_ORIENTATION m_Orientation;
      int m_index;
      bool m_IgnoreNonVisible;
      bool m_NoSpaceExpanding;

      LAYOUT_WIZARD_PAGE (const LAYOUT_WIZARD_PAGE&);
      LAYOUT_WIZARD_PAGE& operator= (const LAYOUT_WIZARD_PAGE&);
      
      void InitPageX (Widget form);

      friend class DLGWIZARD;
      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables.

      virtual void v_OnInitPage () = 0;

      virtual void v_OnSetActive ();

      virtual void v_OnSetInactive ();

      virtual int v_OnWizardBack ();

      virtual int v_OnWizardNext ();

   };


}  // End namespace MGUI


#endif   // INC_MGUI_DLGWIZARD_H

---