mgui/topshell.h

Go to the documentation of this file.

#ifndef  INC_MGUI_TOPSHELL_H
#define  INC_MGUI_TOPSHELL_H

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

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


namespace MGUI {

enum DOCKEDGE {
   DOCKEDGE_Left =         0x1000,
   DOCKEDGE_Top =          0x2000,
   DOCKEDGE_Right =        0x4000,
   DOCKEDGE_Bottom =       0x8000,
   DOCKEDGE_Any =          0xF000
   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(DOCKEDGE)
#endif


class TOPSHELL : public MGUI::SHELL {
   public:

      enum BUTTONS {
         BUTTON_RunJob =      0x02,    
         BUTTON_SaveJob =     0x04,    
         BUTTON_Close =       0x08,    
         BUTTON_Help =        0x10,    
         BUTTON_Run =         0x20,    
         BUTTON_Exit =        0x40,    
         BUTTONS_Default =    0x00     
         };

      enum STYLE {
         STYLE_Default =      0x0000,
         STYLE_NoClose =      0x0001,
         STYLE_NoMinimize =   0x0002,
         STYLE_NoMaximize =   0x0004,
         STYLE_NoResize =     0x0008,     
         STYLE_RightAlignButtons = 0x0010,
         };

      TOPSHELL (
         HELPID helpid
         );

      virtual ~TOPSHELL ();

      void Create (
         const char *PlacementKey = 0,             
         TEXTID TitleID = TEXTID__None,            
         STYLE style = TOPSHELL::STYLE_Default,    
         ICONID WindowIcon = ICONID_TITLE_TNTMIPS  
         );

      void EnableDocking (
         DOCKEDGE dockedges = DOCKEDGE_Any         
         );

      bool IsVisible () const;

      void SetVisible (
         bool visible = true
         );

   protected:

      MGUI::CTRL_PUSHBUTTON& CreateButton (
         BUTTONS button                         
         );

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

      void CreateButton (
         MGUI::CTRL_PUSHBUTTON& Button,
         const MISTRING& label
         );

      void CreateButtons (
         BUTTONS buttons = BUTTONS_Default      
         );

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

      void SetRootSpacing (
         int RootSpacing,
         int RootBorder = 0
         ) { m_RootSpacing = RootSpacing; m_RootBorder = RootBorder; }

      void SetRunEnabled (
         bool enabled = true
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      Widget m_form;
      bool m_IgnoreNonVisible;
      int m_RootSpacing;
      int m_RootBorder;
      STYLE m_Style;

      LAYOUT_PANE m_ButtonPane;
      CTRL_PUSHBUTTON m_RunJobPB;
      CTRL_PUSHBUTTON m_SaveJobPB;
      CTRL_PUSHBUTTON m_RunPB;
      CTRL_PUSHBUTTON m_ExitPB;
      CTRL_PUSHBUTTON m_HelpPB;
      LAYOUT_EQUALIZER *m_Equalizer;   // Only allocated and used if custom buttons are added
      
      MGUI::LAYOUT_PANE& GetButtonPane (
         bool AddSpace = true                   
         );

      void EqualizeButtons ();

      // Overrides from SHELL.
      void v_Destroy ();

      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables

      virtual int v_CreateContent () = 0;

      virtual void v_OnClose ();

      virtual void v_OnCloseRequest () = 0;

      virtual void v_OnOpen ();

      virtual void v_OnRun ();

      virtual void v_OnRunJob ();

      virtual void v_OnSaveJob ();
   };

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

}  // End namespace MGUI

#endif   // INC_MGUI_TOPSHELL_H

---