mgui/dlgshell.h

Go to the documentation of this file.

#ifndef  INC_MGUI_DLGSHELL_H
#define  INC_MGUI_DLGSHELL_H

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

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


namespace MGUI {

class DLGSHELL : public MGUI::SHELL {
   public:

      enum STYLE {
         STYLE_Default =         0x0000,     
         STYLE_Resizable =    0x0001,     
         STYLE_ContextHelp =     0x0002,     
         STYLE_AllowMinimize =   0x0004,     
         STYLE_AllowMaximize =   0x0008,     
         STYLE_CenterOnScreen =  0x0010,     
         STYLE_CenterOnMouse =   0x0020,     
         STYLE_DeleteOnClose =   0x0040,     
         STYLE_ToolWindow =      0x0080,     
         STYLE_AllowMenuBar = 0x0100,     
         STYLE_NoDestroyModal =  0x0200,     
         STYLE_KeepOnTop = 0x0400,           
         };

      enum BUTTONS {
         BUTTONS_Default =    0x00,       
         BUTTON_OK =          0x01,
         BUTTON_Cancel =         0x02,
         BUTTON_Apply =       0x04,
         BUTTON_Close =       0x08,
         BUTTON_Help =        0x10
         };

      virtual ~DLGSHELL (
         ) = 0;

      operator MDLGPARENT (
         ) const { return (GetDlgParent()); }

      void Close (
         bool notify = true                     
         );

      ERRVALUE CreateModeless (
         MDLGPARENT dlgparent,                  
         bool AllowMinimize = false             
         );

      ERRVALUE DoModal (
         MDLGPARENT dlgparent                   
         );

      bool GetKeepOnTop (
         ) const;

      bool IsOpen (
         ) const;

      ERRVALUE Open (
         );

      void SetApplyEnabled (
         bool enabled = true
         ) { m_ApplyPB.SetEnabled(enabled); }

      void SetDeleteOnClose (
         bool DeleteOnClose = true
         );

      void SetKeepOnTop (
         bool KeepOnTop = true
         );

      void SetOkEnabled (
         bool enabled = true
         ) { m_OkPB.SetEnabled(enabled); }

   protected:

      DLGSHELL (
         const MISTRING& title,                 
         HELPID HelpID,                         
         STYLE style = STYLE_Default            
         );

      MGUI::CTRL_PUSHBUTTON& CreateButton (
         BUTTONS button                         
         );

      MGUI::CTRL_PUSHBUTTON& CreateButton (
         BUTTONS button,                        
         const MISTRING& label
         );

      void CreateButtons (
         BUTTONS buttons = BUTTONS_Default      
         );

      bool IsModal (
         ) const { return (m_IsModal); }

      MGUI::LAYOUT_PANE& GetButtonPane (
         bool AddSpace = true                   
         );

      ERRVALUE OpenModal (
         MDLGPARENT dlgparent
         );

      void NotifyCancel (
         ) { v_OnCancel(); }

      void NotifyOK (
         ) { v_OnOK(); }

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

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

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

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

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

      DEPRECATED void UpdateLayout (
         ) { }

      ERRVALUE WaitForClose ();

      // Overridables which may be called from derived classes.

      virtual void v_OnCancel ();

      virtual void v_OnOK ();

   private:

      #ifndef GENERATING_DOXYGEN_OUTPUT

      STYLE m_Style;
      bool m_IsModal;
      bool m_IgnoreNonVisible;
      ERRVALUE m_RetValue;
      int m_RootSpacing;
      int m_RootMargin;

      LAYOUT_PANE m_ButtonPane;
      CTRL_PUSHBUTTON m_OkPB;
      CTRL_PUSHBUTTON m_CancelPB;
      CTRL_PUSHBUTTON m_ApplyPB;
      CTRL_PUSHBUTTON m_HelpPB;

      ERRVALUE CreateDlg (
         MDLGPARENT dlgparent,                  
         bool modal = false,                    
         bool AllowMinimize = false
         );

      void OnOpen () { v_OnOpen(); }

      DLGSHELL (const DLGSHELL&);
      DLGSHELL& operator= (const DLGSHELL&);

      // Overrides from SHELL.

      void v_Destroy ();

      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables.

      virtual ERRVALUE v_CreateContent () = 0;

      virtual void v_OnApply ();

      virtual void v_OnClose ();

      virtual void v_OnCloseRequest ();

      virtual void v_OnDestroy ();

      virtual void v_OnOpen ();

   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(DLGSHELL::BUTTONS)
DEFINE_ENUM_OP_BITWISE(DLGSHELL::STYLE)
#endif

}  // End namespace MGUI


#endif   // INC_MGUI_DLGSHELL_H

---