]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/os2/dialog.h
clear up wxStringBuffer docs a bit
[wxWidgets.git] / include / wx / os2 / dialog.h
index 917667ed4f75969d05daaad11ffa45d879819c94..5a5a49a3212e721e42b2af5d501dcd146146b630 100644 (file)
@@ -1,46 +1,33 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dialog.h
 // Purpose:     wxDialog class
-// Author:      Julian Smart
+// Author:      David Webster
 // Modified by:
-// Created:     01/02/97
+// Created:     10/14/99
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) David Webster
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DIALOG_H_
 #define _WX_DIALOG_H_
 
-#ifdef __GNUG__
-    #pragma interface "dialog.h"
-#endif
-
 #include "wx/panel.h"
 
-WXDLLEXPORT_DATA(extern const wxChar*) wxDialogNameStr;
+WXDLLEXPORT_DATA(extern const char*) wxDialogNameStr;
+
+class WXDLLEXPORT wxDialogModalData;
 
+//
 // Dialog boxes
-class WXDLLEXPORT wxDialog : public wxDialogBase
+//
+class WXDLLEXPORT wxDialog: public wxDialogBase
 {
-    DECLARE_DYNAMIC_CLASS(wxDialog)
-
 public:
-    wxDialog();
 
-    // Constructor with a modal flag, but no window id - the old convention
-    wxDialog(wxWindow *parent,
-             const wxString& title, bool modal,
-             int x = -1, int y= -1, int width = 500, int height = 500,
-             long style = wxDEFAULT_DIALOG_STYLE,
-             const wxString& name = wxDialogNameStr)
-    {
-        long modalStyle = modal ? wxDIALOG_MODAL : wxDIALOG_MODELESS ;
-        Create(parent, -1, title, wxPoint(x, y), wxSize(width, height),
-               style | modalStyle, name);
-    }
+  inline wxDialog() { Init(); }
 
-    // Constructor with no modal flag - the new convention.
+    // full ctor
     wxDialog(wxWindow *parent, wxWindowID id,
              const wxString& title,
              const wxPoint& pos = wxDefaultPosition,
@@ -48,90 +35,116 @@ public:
              long style = wxDEFAULT_DIALOG_STYLE,
              const wxString& name = wxDialogNameStr)
     {
-        Create(parent, id, title, pos, size, style, name);
-    }
-
-    bool Create(wxWindow *parent, wxWindowID id,
-                const wxString& title,
-                const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                long style = wxDEFAULT_DIALOG_STYLE,
-                const wxString& name = wxDialogNameStr);
-
-    ~wxDialog();
-
-    virtual bool Destroy();
-
-    virtual void DoSetClientSize(int width, int height);
-
-    virtual void GetPosition(int *x, int *y) const;
+        Init();
 
-    bool Show(bool show);
-    bool IsShown() const;
-    void Iconize(bool iconize);
+        (void)Create(parent, id, title, pos, size, style, name);
+    }
 
-#if WXWIN_COMPATIBILITY
-    bool Iconized() const { return IsIconized(); };
-#endif
+    bool Create( wxWindow*       pParent
+                ,wxWindowID      vId
+                ,const wxString& rsTitle
+                ,const wxPoint&  rPos = wxDefaultPosition
+                ,const wxSize&   rSize = wxDefaultSize
+                ,long            lStyle = wxDEFAULT_DIALOG_STYLE
+                ,const wxString& rsName = wxDialogNameStr
+               );
+    virtual ~wxDialog();
 
-    virtual bool IsIconized() const;
-    void Fit();
+    // return true if we're showing the dialog modally
+    virtual bool IsModal() const { return m_modalData != NULL; }
 
-    void SetTitle(const wxString& title);
-    wxString GetTitle() const ;
+    // show the dialog modally and return the value passed to EndModal()
+    virtual int ShowModal();
 
-    void OnSize(wxSizeEvent& event);
-    bool OnClose();
-    void OnCharHook(wxKeyEvent& event);
-    void OnPaint(wxPaintEvent& event);
-    void OnCloseWindow(wxCloseEvent& event);
+    // may be called to terminate the dialog with the given return code
+    virtual void EndModal(int retCode);
 
-    void SetModal(bool flag);
+    // implementation only from now on
+    // -------------------------------
 
-    virtual void Centre(int direction = wxBOTH);
-    virtual bool IsModal() const
-        { return ((GetWindowStyleFlag() & wxDIALOG_MODAL) == wxDIALOG_MODAL); }
+    // override some base class virtuals
+    virtual bool Show(bool show = true);
 
-    // For now, same as Show(TRUE) but returns return code
-    virtual int ShowModal();
-    virtual void EndModal(int retCode);
+    //
+    // Event handlers
+    //
+    void OnCharHook(wxKeyEvent& rEvent);
+    void OnCloseWindow(wxCloseEvent& rEvent);
 
+    //
     // Standard buttons
-    void OnOK(wxCommandEvent& event);
-    void OnApply(wxCommandEvent& event);
-    void OnCancel(wxCommandEvent& event);
+    //
+    void     OnOK(wxCommandEvent& rEvent);
+    void     OnApply(wxCommandEvent& rEvent);
+    void     OnCancel(wxCommandEvent& rEvent);
 
+    //
     // Responds to colour changes
-    void OnSysColourChanged(wxSysColourChangedEvent& event);
-
-    // implementation
-    // --------------
-
-    long MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
-
-    virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
-                                WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
+    //
+    void     OnSysColourChanged(wxSysColourChangedEvent& rEvent);
+
+    //
+    // Callbacks
+    //
+    virtual MRESULT OS2WindowProc( WXUINT   uMessage
+                                  ,WXWPARAM wParam
+                                  ,WXLPARAM lParam
+                                 );
+    // obsolete methods
+    // ----------------
 
-    bool IsModalShowing() const { return m_modalShowing; }
-
-  // tooltip management
-#if wxUSE_TOOLTIPS
-    WXHWND GetToolTipCtrl() const { return m_hwndToolTip; }
-    void SetToolTipCtrl(WXHWND hwndTT) { m_hwndToolTip = hwndTT; }
-#endif // tooltips
+    // Constructor with a modal flag, but no window id - the old convention
+    wxDEPRECATED( wxDialog( wxWindow*       pParent
+                           ,const wxString& rsTitle
+                           ,bool            bModal
+                           ,int             nX = -1
+                           ,int             nY = -1
+                           ,int             nWidth = 500
+                           ,int             nHeight = 500
+                           ,long            lStyle = wxDEFAULT_DIALOG_STYLE
+                           ,const wxString& rsName = wxDialogNameStr
+                          ) );
+
+    // just call Show() or ShowModal()
+    wxDEPRECATED( void SetModal(bool bFlag) );
+
+    // use IsModal()
+    wxDEPRECATED( bool IsModalShowing() const );
 
 protected:
-    bool   m_modalShowing;
-    WXHWND m_hwndOldFocus;  // the window which had focus before we were shown
+    //
+    // find the window to use as parent for this dialog if none has been
+    // specified explicitly by the user
+    //
+    // may return NULL
+    //
+    wxWindow *FindSuitableParent() const;
+
+    //
+    // Common part of all ctors
+    //
+    void Init(void);
+
+    // end either modal or modeless dialog
+    void EndDialog(int rc);
 
 private:
-#if wxUSE_TOOLTIPS
-    WXHWND                m_hwndToolTip;
-#endif // tooltips
+    wxWindow*                       m_pOldFocus;
+    bool        m_endModalCalled; // allow for closing within InitDialog
 
-private:
+    // this pointer is non-NULL only while the modal event loop is running
+    wxDialogModalData *m_modalData;
+
+    //
+    // While we are showing a modal dialog we disable the other windows using
+    // this object
+    //
+    class wxWindowDisabler*         m_pWindowDisabler;
+
+    DECLARE_DYNAMIC_CLASS(wxDialog)
     DECLARE_EVENT_TABLE()
-};
+    DECLARE_NO_COPY_CLASS(wxDialog)
+}; // end of CLASS wxDialog
+
+#endif // _WX_DIALOG_H_
 
-#endif
-    // _WX_DIALOG_H_