mgui/topshell.h

Go to the documentation of this file.

/**
 * \file mgui/topshell.h
 * \brief MGUI::TOPSHELL definitions
 *
 * \if NODOC
 * $Id: topshell.h_v 1.3 2003/10/03 19:58:19 linux32build!build Exp $
 *
 * $Log: topshell.h_v $
 * Revision 1.3  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.2  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.1  2003/05/28 16:08:43  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MGUI_TOPSHELL_H
#define  INC_MGUI_TOPSHELL_H

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

#ifdef WIN32_MFC
class CFrameWnd;
#endif


namespace MGUI {

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


//! Base class for 'top level' application shells.
//! Top-level shells are windows whose parent is the 'desktop'.
class TOPSHELL : public MGUI::SHELL {
   public:

      enum STYLE {
         STYLE_Default =      0x0000,
         STYLE_NoClose =      0x0001,
         STYLE_NoMinimize =   0x0002,
         STYLE_NoMaximize =   0x0004,
         STYLE_NoResize =     0x0008,     //!< Don't allow resizing, implies NoMaximize also
         };

      //! Constructor.
      TOPSHELL (
         HELPID helpid
         );

      //! Destructor.
      virtual ~TOPSHELL ();

      //! Create the actual shell graphical object.
      void Create (
         const char *PlacementKey = 0,             //!< Ini/Registry key for automatic placement management
         TEXTID TitleID = TEXTID__None,            //!< Text ID for title
         STYLE style = TOPSHELL::STYLE_Default     //!< Shell style
         );

      //! Enable edges of shell for control bar docking.
      //! If not specified and control bars are created for the shell then all edges are
      //! assumed to be enabled for docking.
      void EnableDocking (
         DOCKEDGE dockedges = DOCKEDGE_Any         //!< Sides of shell enabled for docking of control bars
         );

      //! Set whether shell is visible or not.
      void SetVisible (
         bool visible = true
         );

   protected:

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

   #ifdef WIN32_MFC
      CFrameWnd *m_pFrame;
   #endif
   #ifdef X_NATIVE
      Widget m_form;
   #endif

   #ifdef X_NATIVE
      void AdjustAttachments ();
   #endif

      // Overrides from SHELL.
      virtual LAYOUT_PANE_MAIN& v_GetMainPane ();
      virtual void v_Destroy ();

      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables

      //! Create shell contents.
      //! Derived class MUST implement this.  Function must return TRUE to show shell immediately,
      //! FALSE to not show the shell, or an error code < 0.  This will be called by the shell
      //! creation code and thus must not be called directly.  This is normally overridden only by
      //! the specific shell implementation and not by the code that actually uses that shell implementation.
      //! The implementation should call GetMainPane() to determine the pane to create the controls in.
      virtual int v_CreateContent () = 0;

      //! Called when shell gets hidden or closed.
      virtual void v_OnClose ();

      //! Called when user requests that shell be 'closed'.
      //! Usually results from an OS or Window Manager notification.
      //! To honor request and close the shell, override and call Destroy().
      virtual void v_OnCloseRequest () = 0;

      //! Called after shell is actually displayed.
      virtual void v_OnOpen ();

   };
DEFINE_ENUM_OP_BITWISE(TOPSHELL::STYLE);

}  // End namespace MGUI

#endif   // INC_MGUI_TOPSHELL_H

---