mgui/shell.h

Go to the documentation of this file.

#ifndef  INC_MGUI_SHELL_H
#define  INC_MGUI_SHELL_H

#ifndef  INC_MI32_ICONID_H
#include <mi32/iconid.h>
#endif

#ifndef  INC_MGUI_LAYOUT_H
#include <mgui/layout.h>
#endif

#ifndef  INC_MI32_MISTRING_H
#include <mi32/mistring.h>
#endif

#ifndef  INC_MI32_RECT_H
#include <mi32/rect.h>
#endif

#ifndef  INC_MI32_MILIST_H
#include <mi32/milist.h>
#endif

#ifndef  INC_MI32_CRITSEC_H
#include <mi32/critsec.h>
#endif

#if !defined(INC_MI32_XBASE_H) && defined(X_NATIVE)
#include <mi32/xbase.h>
#endif

#if !defined(X_H) && defined(X_NATIVE)
#include <X11/X.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations.
class SERIALIZERITEM;
namespace MGUI {
   class CTRL_SEPARATOR;
   class CTRL_STATUSBAR;
   class DLGSHELL;
   class DLGWIZARD;
   class TOPSHELL;
   class MENU;
   }
#endif


namespace MGUI {

class SHELL {
   public:

      class PLACEMENT;

      #ifndef GENERATING_DOXYGEN_OUTPUT
      static SHELL* FindShell (
         Widget widget
         );
      #endif

      static const COLOR& GetDftBackgroundColor ();

      static MDLGPARENT GetDftDlgParent ();

      static void SetDftDlgParent (
         MDLGPARENT dlgparent
         ) { s_DftDlgParent = dlgparent; }

      void AddDelegateOnClose (
         DELEGATE_VOID_NOPARMS delegate
         );

      void AttachMenuBar (
         MENU& menubar,                
         bool AddSeparator = false     
         );

      void Destroy ();

      void DlgShowHelp (
         ) const;

      void ForceOnScreen (
         bool bResizeIfNecessary = false
         );

      MDLGPARENT GetDlgParent () const;

      HELPID GetHelpID (
         ) const { return (m_HelpID); }

      LAYOUT_PANE& GetMainPane (
         ) { return (m_MainPane); }

      void GetPlacement (
         PLACEMENT& placement
         ) const;

      LAYOUT_PANE_SHELL& GetShellPane (
         ) { return (m_ShellPane); }

      MGUI::LAYOUT_PANE& GetStatusBarPane ();

      bool IsCreated () const
         { return (m_shell != 0); }

      void NotifyActivate (
         bool activated
         );

      void SetAllowTitleProcessID (
         bool allow
         ) { m_AllowTitleProcessID = allow; }

      void SetIcon (
         ICONID iconid
         );

      bool SetPlacement (
         const PLACEMENT& placement,
         const char *PlacementKey = 0  
         );

      void SetPlacementByKey (
         const char *PlacementKey
         );

      void SetTitle (
         const MISTRING& title         
         );

      void Show ();

   protected:

      SHELL (
         HELPID helpid
         );

      virtual ~SHELL ();

      void CallOnCloseDelegates ();

      void CreateStatusBarPane (
         LAYOUT_ORIENTATION orientation = LAYOUT_ORIENTATION_Horizontal,
         LAYOUT_SIZEALIGN sizealign = LAYOUT_SIZEALIGN_FixedHeight
         );

      ICONID GetIcon (
         ) const { return m_IconID; }

      const char* GetPlacementKey (
         ) const { return (m_PlacementKey); }

      void UpdateTitle ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      friend class MGUI::TOPSHELL;
      friend class MGUI::DLGSHELL;
      friend class MGUI::DLGWIZARD;

      static MDLGPARENT s_DftDlgParent;
      static bool s_ShowPIDInTitle;
      static bool s_ShowSizeInTitle;
      static UINT16 s_TestMaxWidth;
      static UINT16 s_TestMaxHeight;

      Widget m_shell;
      LAYOUT_PANE m_MenuBarPane;
      CTRL_SEPARATOR *m_pMenuBarSeparator;
      LAYOUT_PANE_SHELL m_ShellPane;
      LAYOUT_PANE m_MainPane;
      LAYOUT_PANE m_StatusBarPane;
      HELPID m_HelpID;
      char *m_PlacementKey;
      bool m_AllowClose;
      bool m_AllowTitleProcessID;
      MISTRING m_Title;
      MENU *m_pMenuBar;
      ICONID m_IconID;
      bool m_bIconSent;
      MITHREAD::CRITICALSECTION m_CritSec;
      MILIST<DELEGATE_VOID_NOPARMS> m_DelegateListOnClose;
      MILIST<DELEGATE_VOID_NOPARMS> m_DelegateQueue;

      void AttachShell (Widget shell, bool AllowClose=true);
      void DetachShell ();
      void OnCloseRequest () { v_OnCloseRequest(); }
      static void OnNotifyXDelete (Widget, SHELL*, void*);
      static void OnNotifyXDestroy (Widget, SHELL*, void*);
      static void OnNotifyXEvent (Widget, SHELL*, XEvent*);

      // Unimplemented.
      SHELL (const SHELL&);
      SHELL& operator= (const SHELL&);

      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables

      virtual int v_CreateContent () = 0;

      virtual void v_Destroy () = 0;

      virtual void v_OnCloseRequest () = 0;

      virtual void v_OnActivate (
         bool activated                
         );

   };


class SHELL::PLACEMENT {
   public:

      static const SERIALIZERITEM* SerialGetItemDef (
         );

      PLACEMENT ();

      const LRECT2D& GetNormalPosition (
         ) const { return (m_NormalPosition); }

      bool HasNormalPosition (
         ) const { return (m_NormalPosition.IsValid() && m_NormalPosition.xinit >= 0 && m_NormalPosition.yinit >= 0); }

      bool HasNormalSize (
         ) const { return (m_NormalPosition.GetWidth() > 16 && m_NormalPosition.GetHeight() > 16); }

      void IniRead (
         INIHANDLE IniHandle,
         const char *IniGroup,
         const char *IniName
         );

      void IniWrite (
         INIHANDLE IniHandle,
         const char *IniGroup,
         const char *IniName
         ) const;

      bool IsMaximized (
         ) const { return (m_IsMaximized); };

      void SetMaximized (
         bool Maximized
         ) { m_IsMaximized = Maximized; }

      void SetNormalPosition (
         const LRECT2D& NormalPosition
         ) { m_NormalPosition = NormalPosition; }

      void SetPositionTopLeft (
         INT32 x,
         INT32 y
         ) { m_NormalPosition.Set(x,y,x,y); }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      bool m_IsMaximized;
      LRECT2D m_NormalPosition;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

}  // End namespace MGUI

#endif   // INC_MGUI_SHELL_H

---