shell.h

Go to the documentation of this file.

/**
 * \file mgui/shell.h
 * \brief MGUI::SHELL definitions
 *
 * \if NODOC
 * $Id: shell.h_v 1.8 2004/03/04 18:30:57 mju Exp $
 *
 * $Log: shell.h_v $
 * Revision 1.8  2004/03/04 18:30:57  mju
 * Make copy ctor/op= private and unimplemented.
 * Make dtor virtual.
 *
 * Revision 1.7  2003/12/15 21:31:19  mju
 * Fix comment.
 *
 * Revision 1.6  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.5  2003/10/01 22:32:34  dwilliss
 * doxygen
 *
 * Revision 1.4  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.3  2003/08/29 16:43:51  mju
 * Change SetTitle to just take mistring ref.
 *
 * Revision 1.2  2003/06/04 15:36:53  scowan
 * Made the v_Cmd router virtual.
 *
 * Revision 1.1  2003/05/28 16:08:35  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MGUI_SHELL_H
#define  INC_MGUI_SHELL_H

#ifndef  INC_MI32_STDDEFNS_H
#include <mi32/stddefns.h>
#endif

#ifndef  INC_MI32_HELPID_H
#include <mi32/helpid.h>
#endif

#ifndef  INC_MGUI_COMMAND_H
#include <mgui/command.h>
#endif

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

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


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations.
class CWnd;
namespace MGUI {
class CTRL_STATUSBAR;
class DLGSHELL;
class TOPSHELL;
}
#endif // GENERATING_DOXYGEN_OUTPUT


namespace MGUI {

//! Base class for 'shell' windows (application windows and dialogs).
class SHELL {
   public:

      class PLACEMENT;

      //! Get MDLGPARENT for use as parent for child dialogs.
      MDLGPARENT GetDlgParent (
         ) const;

      //! Destroy the shell.
      void Destroy ();

      //! Get Help ID.
      HELPID GetHelpID (
         ) const { return (m_HelpID); }

      //! Get main layout pane.
      LAYOUT_PANE_MAIN& GetMainPane (
         ) { return (v_GetMainPane()); }

      //! Get shell 'placement' on screen.
      void GetPlacement (
         PLACEMENT& placement
         ) const;

      //! Determine if shell has been 'created' yet.
      bool IsCreated (
         ) const {
         #ifdef WIN32_MFC
            return (m_pWnd != 0);
         #else
            return (m_shell != 0);
         #endif
         }

      //! Set shell 'placement' on screen.
      //! Return 'true' if successful, 'false' if not.
      bool SetPlacement (
         const PLACEMENT& placement
         );

      //! Set Ini/Registry key for automatic shell placement.
      //! This will automatically load the placement and subsequently
      //! record any changes later made to the placement by the user.
      void SetPlacementByKey (
         const char *PlacementKey
         );

      //! Set title.
      void SetTitle (
         const MISTRING& title         //!< Title string (can be TEXTID also)
         );

   protected:

      //! Constructor.
      SHELL (
         HELPID helpid
         );

      //! Destructor.
      virtual ~SHELL ();

      //! Get "command router" for shell.
      MGUI::COMMAND_ROUTER* GetCmdRouter (
         ) const {
      #ifdef X_NATIVE
         return (0);
      #else
         return (v_GetCmdRouter());
      #endif
         }

      void SetMenuBar (
         const MGUI::MENU& menu
         );

      //! Set status bar.
      void SetStatusBar (
         MGUI::CTRL_STATUSBAR& StatusBar
         ) { m_pStatusBar = &StatusBar; }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

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

   #ifdef WIN32_MFC
      CWnd *m_pWnd;
   #endif
   #ifdef X_NATIVE
      Widget m_shell;
      LAYOUT_PANE_MAIN m_MainPane;
   #endif
      HELPID m_HelpID;
      CTRL_STATUSBAR *m_pStatusBar;
      char *m_PlacementKey;
      bool m_AllowClose;
      MISTRING m_Title;

   #ifdef X_NATIVE
      void AttachShell (Widget shell, bool AllowClose=true);
   #endif
      void OnCloseRequest () { v_OnCloseRequest(); }
   #ifdef X_NATIVE
      static void OnNotifyXDelete (Widget, SHELL*, void*);
   #endif

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

      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables

      //! Create shell contents.
      //! For details see MGUI::TOPSHELL or MGUI::DLGSHELL.
      virtual int v_CreateContent () = 0;

      //! Destroy the shell.
      virtual void v_Destroy () = 0;

   #ifdef WIN32_MFC
      //! Get command router (MFC only).
      virtual MGUI::COMMAND_ROUTER* v_GetCmdRouter () const = 0;
   #endif

      //! Get main layout pane.
      virtual LAYOUT_PANE_MAIN& v_GetMainPane () = 0;

      //! Called when user requests that shell be 'closed'.
      //! Usually results from an OS or Window Manager notification.
      virtual void v_OnCloseRequest () = 0;

   };


//! Container to encapsulate shell 'placement' for save/restore.
class SHELL::PLACEMENT {
   public:

      //! Constructor.
      PLACEMENT ();

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

      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; }

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

}  // End namespace MGUI

#endif   // INC_MGUI_SHELL_H

---