]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/os2/frame.h
some wxArtProv docs
[wxWidgets.git] / include / wx / os2 / frame.h
index 408d6bc1a693a9df6b368416ceefdc5bf1b4903a..88cac74d0fa8c712f37764bc2e629ac5b9f9cded 100644 (file)
 /////////////////////////////////////////////////////////////////////////////
 // Name:        frame.h
 // Purpose:     wxFrame class
-// Author:      AUTHOR
+// Author:      David Webster
 // Modified by:
-// Created:     ??/??/98
+// Created:     10/27/99
 // RCS-ID:      $Id$
-// Copyright:   (c) AUTHOR
-// Licence:    wxWindows licence
+// Copyright:   (c) David Webster
+// Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_FRAME_H_
 #define _WX_FRAME_H_
 
-#ifdef __GNUG__
-#pragma interface "frame.h"
-#endif
-
-#include "wx/window.h"
-#include "wx/toolbar.h"
-#include "wx/accel.h"
-#include "wx/icon.h"
-
-WXDLLEXPORT_DATA(extern const char*) wxFrameNameStr;
-WXDLLEXPORT_DATA(extern const char*) wxToolBarNameStr;
-
-class WXDLLEXPORT wxMenuBar;
-class WXDLLEXPORT wxStatusBar;
-
-class WXDLLEXPORT wxFrame: public wxWindow {
-
-  DECLARE_DYNAMIC_CLASS(wxFrame)
+//
+// Get the default resource ID's for frames
+//
+#include "wx/os2/wxrsc.h"
 
+class WXDLLEXPORT wxFrame : public wxFrameBase
+{
 public:
-  wxFrame();
-  inline wxFrame(wxWindow *parent,
-           wxWindowID id,
-           const wxString& title,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           long style = wxDEFAULT_FRAME_STYLE,
-           const wxString& name = wxFrameNameStr)
-  {
-      Create(parent, id, title, pos, size, style, name);
-  }
-
-  ~wxFrame();
-
-  bool Create(wxWindow *parent,
-           wxWindowID id,
-           const wxString& title,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           long style = wxDEFAULT_FRAME_STYLE,
-           const wxString& name = wxFrameNameStr);
-
-  virtual bool Destroy();
-  void SetClientSize(int width, int height);
-  void GetClientSize(int *width, int *height) const;
-
-  void GetSize(int *width, int *height) const ;
-  void GetPosition(int *x, int *y) const ;
-  void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
-  void ClientToScreen(int *x, int *y) const;
-  void ScreenToClient(int *x, int *y) const;
-
-  void OnSize(wxSizeEvent& event);
-  void OnMenuHighlight(wxMenuEvent& event);
-  void OnActivate(wxActivateEvent& event);
-  void OnIdle(wxIdleEvent& event);
-  void OnCloseWindow(wxCloseEvent& event);
-
-  bool Show(bool show);
-
-  // Set menu bar
-  void SetMenuBar(wxMenuBar *menu_bar);
-  virtual wxMenuBar *GetMenuBar() const ;
-
-  // Set title
-  void SetTitle(const wxString& title);
-  wxString GetTitle() const ;
-
-  void Centre(int direction = wxBOTH);
-
-  // Call this to simulate a menu command
-  virtual void Command(int id);
-  virtual void ProcessCommand(int id);
-
-  // Set icon
-  virtual void SetIcon(const wxIcon& icon);
-
-  // Create status line
-  virtual wxStatusBar* CreateStatusBar(int number=1, long style = wxST_SIZEGRIP, wxWindowID id = 0,
-    const wxString& name = "statusBar");
-  inline wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
-  virtual void PositionStatusBar();
-  virtual wxStatusBar *OnCreateStatusBar(int number, long style, wxWindowID id,
-    const wxString& name);
-
-  // Create toolbar
-  virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER|wxTB_HORIZONTAL, wxWindowID id = -1, const wxString& name = wxToolBarNameStr);
-  virtual wxToolBar *OnCreateToolBar(long style, wxWindowID id, const wxString& name);
-  // If made known to the frame, the frame will manage it automatically.
-  virtual inline void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
-  virtual inline wxToolBar *GetToolBar() const { return m_frameToolBar; }
-  virtual void PositionToolBar();
-
-  // Set status line text
-  virtual void SetStatusText(const wxString& text, int number = 0);
-
-  // Set status line widths
-  virtual void SetStatusWidths(int n, const int widths_field[]);
-
-  // Hint to tell framework which status bar to use
-  // TODO: should this go into a wxFrameworkSettings class perhaps?
-  static void UseNativeStatusBar(bool useNative) { m_useNativeStatusBar = useNative; };
-  static bool UsesNativeStatusBar() { return m_useNativeStatusBar; };
-
-  // Fit frame around subwindows
-  virtual void Fit();
-
-  // Iconize
-  virtual void Iconize(bool iconize);
-
-  virtual bool IsIconized() const ;
-
-  // Compatibility
-  inline bool Iconized() const { return IsIconized(); }
-
-  // Is the frame maximized?
-  virtual bool IsMaximized(void) const ;
-
-  virtual void Maximize(bool maximize);
-
-  // Responds to colour changes
-  void OnSysColourChanged(wxSysColourChangedEvent& event);
-
-  // Query app for menu item updates (called from OnIdle)
-  void DoMenuUpdates();
-  void DoMenuUpdates(wxMenu* menu, wxWindow* focusWin);
-
-  // Checks if there is a toolbar, and returns the first free client position
-  virtual wxPoint GetClientAreaOrigin() const;
+    // construction
+    wxFrame() { Init(); }
+    wxFrame( wxWindow*       pParent
+               ,wxWindowID      vId
+               ,const wxString& rsTitle
+               ,const wxPoint&  rPos = wxDefaultPosition
+               ,const wxSize&   rSize = wxDefaultSize
+               ,long            lStyle = wxDEFAULT_FRAME_STYLE
+               ,const wxString& rsName = wxFrameNameStr
+              )
+    {
+        Init();
+
+        Create(pParent, vId, rsTitle, rPos, rSize, lStyle, rsName);
+    }
+
+    bool Create( wxWindow*       pParent
+                ,wxWindowID      vId
+                ,const wxString& rsTitle
+                ,const wxPoint&  rPos = wxDefaultPosition
+                ,const wxSize&   rSize = wxDefaultSize
+                ,long            lStyle = wxDEFAULT_FRAME_STYLE
+                ,const wxString& rsName = wxFrameNameStr
+               );
+
+    virtual ~wxFrame();
+
+    // implement base class pure virtuals
+#if wxUSE_MENUS_NATIVE
+    virtual void SetMenuBar(wxMenuBar* pMenubar);
+#endif
+    virtual bool ShowFullScreen( bool bShow
+                                ,long lStyle = wxFULLSCREEN_ALL
+                               );
+
+
+    // implementation only from now on
+    // -------------------------------
+
+    virtual void Raise(void);
+
+    // event handlers
+    void OnActivate(wxActivateEvent& rEvent);
+    void OnSysColourChanged(wxSysColourChangedEvent& rEvent);
+
+    // Toolbar
+#if wxUSE_TOOLBAR
+    virtual wxToolBar* CreateToolBar( long            lStyle = wxNO_BORDER | wxTB_HORIZONTAL | wxTB_FLAT
+                                     ,wxWindowID      vId = -1
+                                     ,const wxString& rsName = wxToolBarNameStr
+                                    );
+
+    virtual void       PositionToolBar(void);
+#endif // wxUSE_TOOLBAR
+
+    // Status bar
+#if wxUSE_STATUSBAR
+    virtual wxStatusBar* OnCreateStatusBar( int             nNumber = 1
+                                           ,long            lStyle = wxST_SIZEGRIP
+                                           ,wxWindowID      vId = 0
+                                           ,const wxString& rsName = wxStatusLineNameStr
+                                          );
+    virtual void PositionStatusBar(void);
+
+    // Hint to tell framework which status bar to use: the default is to use
+    // native one for the platforms which support it (Win32), the generic one
+    // otherwise
+
+    // TODO: should this go into a wxFrameworkSettings class perhaps?
+    static void UseNativeStatusBar(bool bUseNative)
+        { m_bUseNativeStatusBar = bUseNative; };
+    static bool UsesNativeStatusBar()
+        { return m_bUseNativeStatusBar; };
+#endif // wxUSE_STATUSBAR
+
+    WXHMENU GetWinMenu() const { return m_hMenu; }
+
+    // Returns the origin of client area (may be different from (0,0) if the
+    // frame has a toolbar)
+    virtual wxPoint GetClientAreaOrigin() const;
+
+    // event handlers
+    bool HandlePaint(void);
+    bool HandleSize( int    nX
+                    ,int    nY
+                    ,WXUINT uFlag
+                   );
+    bool HandleCommand( WXWORD wId
+                       ,WXWORD wCmd
+                       ,WXHWND wControl
+                      );
+    bool HandleMenuSelect( WXWORD  wItem
+                          ,WXWORD  wFlags
+                          ,WXHMENU hMenu
+                         );
+
+    // tooltip management
+#if wxUSE_TOOLTIPS
+    WXHWND GetToolTipCtrl(void) const { return m_hWndToolTip; }
+    void   SetToolTipCtrl(WXHWND hHwndTT) { m_hWndToolTip = hHwndTT; }
+#endif // tooltips
+
+    //
+    // Called by wxWindow whenever it gets focus
+    //
+    void SetLastFocus(wxWindow* pWin) { m_pWinLastFocused = pWin; }
+    wxWindow *GetLastFocus(void) const { return m_pWinLastFocused; }
+
+    void      SetClient(WXHWND    c_Hwnd);
+    void      SetClient(wxWindow* c_Window);
+    wxWindow *GetClient();
+
+ friend MRESULT EXPENTRY wxFrameWndProc(HWND  hWnd,ULONG ulMsg, MPARAM wParam, MPARAM lParam);
+ friend MRESULT EXPENTRY wxFrameMainWndProc(HWND  hWnd,ULONG ulMsg, MPARAM wParam, MPARAM lParam);
 
 protected:
-  wxMenuBar *           m_frameMenuBar;
-  wxStatusBar *         m_frameStatusBar;
-  wxIcon                m_icon;
-  bool                  m_iconized;
-  static bool           m_useNativeStatusBar;
-  wxToolBar *           m_frameToolBar ;
-
-  DECLARE_EVENT_TABLE()
+    // common part of all ctors
+    void         Init(void);
+
+    virtual WXHICON GetDefaultIcon(void) const;
+    // override base class virtuals
+    virtual void DoGetClientSize( int* pWidth
+                                 ,int* pHeight
+                                ) const;
+    virtual void DoSetClientSize( int nWidth
+                                 ,int nWeight
+                                );
+    inline virtual bool IsMDIChild(void) const { return FALSE; }
+
+#if wxUSE_MENUS_NATIVE
+    // helper
+    void         DetachMenuBar(void);
+    // perform MSW-specific action when menubar is changed
+    virtual void AttachMenuBar(wxMenuBar* pMenubar);
+    // a plug in for MDI frame classes which need to do something special when
+    // the menubar is set
+    virtual void InternalSetMenuBar(void);
+#endif
+    // propagate our state change to all child frames
+    void IconizeChildFrames(bool bIconize);
+
+    // we add menu bar accel processing
+    bool OS2TranslateMessage(WXMSG* pMsg);
+
+    // window proc for the frames
+    MRESULT OS2WindowProc( WXUINT   uMessage
+                          ,WXWPARAM wParam
+                          ,WXLPARAM lParam
+                         );
+
+    bool                            m_bIconized;
+    WXHICON                         m_hDefaultIcon;
+
+#if wxUSE_STATUSBAR
+    static bool                     m_bUseNativeStatusBar;
+#endif // wxUSE_STATUSBAR
+
+    // Data to save/restore when calling ShowFullScreen
+    long                            m_lFsStyle;           // Passed to ShowFullScreen
+    wxRect                          m_vFsOldSize;
+    long                            m_lFsOldWindowStyle;
+    int                             m_nFsStatusBarFields; // 0 for no status bar
+    int                             m_nFsStatusBarHeight;
+    int                             m_nFsToolBarHeight;
+    bool                            m_bFsIsMaximized;
+    bool                            m_bFsIsShowing;
+    bool                            m_bWasMinimized;
+    bool                            m_bIsShown;
+    wxWindow*                       m_pWinLastFocused;
+
+private:
+#if wxUSE_TOOLTIPS
+    WXHWND                          m_hWndToolTip;
+#endif // tooltips
+
+    //
+    // Handles to child windows of the Frame, and the frame itself,
+    // that we don't have child objects for (m_hWnd in wxWindow is the
+    // handle of the Frame's client window!
+    //
+    WXHWND                          m_hTitleBar;
+    WXHWND                          m_hHScroll;
+    WXHWND                          m_hVScroll;
+
+    //
+    // Swp structures for various client data
+    // DW: Better off in attached RefData?
+    //
+    SWP                             m_vSwpTitleBar;
+    SWP                             m_vSwpMenuBar;
+    SWP                             m_vSwpHScroll;
+    SWP                             m_vSwpVScroll;
+    SWP                             m_vSwpStatusBar;
+    SWP                             m_vSwpToolBar;
+
+    DECLARE_EVENT_TABLE()
+    DECLARE_DYNAMIC_CLASS(wxFrame)
 };
 
 #endif
     // _WX_FRAME_H_
+