include/wx/os2/frame.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        frame.h
   3 // Purpose:     wxFrame class
   4 // Author:      David Webster
   5 // Modified by:
   6 // Created:     10/27/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) David Webster
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_FRAME_H_
  13 #define _WX_FRAME_H_
  14
  15 //
  16 // Get the default resource ID's for frames
  17 //
  18 #include "wx/os2/wxrsc.h"
  19
  20 class WXDLLEXPORT wxFrame : public wxFrameBase
  21 {
  22 public:
  23     // construction
  24     wxFrame() { Init(); }
  25     wxFrame( wxWindow*       pParent
  26                ,wxWindowID      vId
  27                ,const wxString& rsTitle
  28                ,const wxPoint&  rPos = wxDefaultPosition
  29                ,const wxSize&   rSize = wxDefaultSize
  30                ,long            lStyle = wxDEFAULT_FRAME_STYLE
  31                ,const wxString& rsName = wxFrameNameStr
  32               )
  33     {
  34         Init();
  35
  36         Create(pParent, vId, rsTitle, rPos, rSize, lStyle, rsName);
  37     }
  38
  39     bool Create( wxWindow*       pParent
  40                 ,wxWindowID      vId
  41                 ,const wxString& rsTitle
  42                 ,const wxPoint&  rPos = wxDefaultPosition
  43                 ,const wxSize&   rSize = wxDefaultSize
  44                 ,long            lStyle = wxDEFAULT_FRAME_STYLE
  45                 ,const wxString& rsName = wxFrameNameStr
  46                );
  47
  48     virtual ~wxFrame();
  49
  50     // implement base class pure virtuals
  51 #if wxUSE_MENUS_NATIVE
  52     virtual void SetMenuBar(wxMenuBar* pMenubar);
  53 #endif
  54     virtual bool ShowFullScreen( bool bShow
  55                                 ,long lStyle = wxFULLSCREEN_ALL
  56                                );
  57
  58
  59     // implementation only from now on
  60     // -------------------------------
  61
  62     virtual void Raise(void);
  63
  64     // event handlers
  65     void OnSysColourChanged(wxSysColourChangedEvent& rEvent);
  66
  67     // Toolbar
  68 #if wxUSE_TOOLBAR
  69     virtual wxToolBar* CreateToolBar( long            lStyle = wxNO_BORDER | wxTB_HORIZONTAL | wxTB_FLAT
  70                                      ,wxWindowID      vId = -1
  71                                      ,const wxString& rsName = wxToolBarNameStr
  72                                     );
  73
  74     virtual void       PositionToolBar(void);
  75 #endif // wxUSE_TOOLBAR
  76
  77     // Status bar
  78 #if wxUSE_STATUSBAR
  79     virtual wxStatusBar* OnCreateStatusBar( int             nNumber = 1
  80                                            ,long            lStyle = wxST_SIZEGRIP
  81                                            ,wxWindowID      vId = 0
  82                                            ,const wxString& rsName = wxStatusLineNameStr
  83                                           );
  84     virtual void PositionStatusBar(void);
  85
  86     // Hint to tell framework which status bar to use: the default is to use
  87     // native one for the platforms which support it (Win32), the generic one
  88     // otherwise
  89
  90     // TODO: should this go into a wxFrameworkSettings class perhaps?
  91     static void UseNativeStatusBar(bool bUseNative)
  92         { m_bUseNativeStatusBar = bUseNative; };
  93     static bool UsesNativeStatusBar()
  94         { return m_bUseNativeStatusBar; };
  95 #endif // wxUSE_STATUSBAR
  96
  97     WXHMENU GetWinMenu() const { return m_hMenu; }
  98
  99     // Returns the origin of client area (may be different from (0,0) if the
 100     // frame has a toolbar)
 101     virtual wxPoint GetClientAreaOrigin() const;
 102
 103     // event handlers
 104     bool HandlePaint(void);
 105     bool HandleSize( int    nX
 106                     ,int    nY
 107                     ,WXUINT uFlag
 108                    );
 109     bool HandleCommand( WXWORD wId
 110                        ,WXWORD wCmd
 111                        ,WXHWND wControl
 112                       );
 113     bool HandleMenuSelect( WXWORD  wItem
 114                           ,WXWORD  wFlags
 115                           ,WXHMENU hMenu
 116                          );
 117
 118     // tooltip management
 119 #if wxUSE_TOOLTIPS
 120     WXHWND GetToolTipCtrl(void) const { return m_hWndToolTip; }
 121     void   SetToolTipCtrl(WXHWND hHwndTT) { m_hWndToolTip = hHwndTT; }
 122 #endif // tooltips
 123
 124     void      SetClient(WXHWND    c_Hwnd);
 125     void      SetClient(wxWindow* c_Window);
 126     wxWindow *GetClient();
 127
 128  friend MRESULT EXPENTRY wxFrameWndProc(HWND  hWnd,ULONG ulMsg, MPARAM wParam, MPARAM lParam);
 129  friend MRESULT EXPENTRY wxFrameMainWndProc(HWND  hWnd,ULONG ulMsg, MPARAM wParam, MPARAM lParam);
 130
 131 protected:
 132     // common part of all ctors
 133     void         Init(void);
 134
 135     virtual WXHICON GetDefaultIcon(void) const;
 136     // override base class virtuals
 137     virtual void DoGetClientSize( int* pWidth
 138                                  ,int* pHeight
 139                                 ) const;
 140     virtual void DoSetClientSize( int nWidth
 141                                  ,int nWeight
 142                                 );
 143     inline virtual bool IsMDIChild(void) const { return FALSE; }
 144
 145 #if wxUSE_MENUS_NATIVE
 146     // helper
 147     void         DetachMenuBar(void);
 148     // perform MSW-specific action when menubar is changed
 149     virtual void AttachMenuBar(wxMenuBar* pMenubar);
 150     // a plug in for MDI frame classes which need to do something special when
 151     // the menubar is set
 152     virtual void InternalSetMenuBar(void);
 153 #endif
 154     // propagate our state change to all child frames
 155     void IconizeChildFrames(bool bIconize);
 156
 157     // we add menu bar accel processing
 158     bool OS2TranslateMessage(WXMSG* pMsg);
 159
 160     // window proc for the frames
 161     MRESULT OS2WindowProc( WXUINT   uMessage
 162                           ,WXWPARAM wParam
 163                           ,WXLPARAM lParam
 164                          );
 165
 166     bool                            m_bIconized;
 167     WXHICON                         m_hDefaultIcon;
 168
 169 #if wxUSE_STATUSBAR
 170     static bool                     m_bUseNativeStatusBar;
 171 #endif // wxUSE_STATUSBAR
 172
 173     // Data to save/restore when calling ShowFullScreen
 174     long                            m_lFsStyle;           // Passed to ShowFullScreen
 175     wxRect                          m_vFsOldSize;
 176     long                            m_lFsOldWindowStyle;
 177     int                             m_nFsStatusBarFields; // 0 for no status bar
 178     int                             m_nFsStatusBarHeight;
 179     int                             m_nFsToolBarHeight;
 180     bool                            m_bFsIsMaximized;
 181     bool                            m_bFsIsShowing;
 182     bool                            m_bWasMinimized;
 183     bool                            m_bIsShown;
 184
 185 private:
 186 #if wxUSE_TOOLTIPS
 187     WXHWND                          m_hWndToolTip;
 188 #endif // tooltips
 189
 190     //
 191     // Handles to child windows of the Frame, and the frame itself,
 192     // that we don't have child objects for (m_hWnd in wxWindow is the
 193     // handle of the Frame's client window!
 194     //
 195     WXHWND                          m_hTitleBar;
 196     WXHWND                          m_hHScroll;
 197     WXHWND                          m_hVScroll;
 198
 199     //
 200     // Swp structures for various client data
 201     // DW: Better off in attached RefData?
 202     //
 203     SWP                             m_vSwpTitleBar;
 204     SWP                             m_vSwpMenuBar;
 205     SWP                             m_vSwpHScroll;
 206     SWP                             m_vSwpVScroll;
 207     SWP                             m_vSwpStatusBar;
 208     SWP                             m_vSwpToolBar;
 209
 210     DECLARE_EVENT_TABLE()
 211     DECLARE_DYNAMIC_CLASS(wxFrame)
 212 };
 213
 214 #endif
 215     // _WX_FRAME_H_
 216