/////////////////////////////////////////////////////////////////////////////
// Name: dialog.h
// Purpose: wxDialog class
-// Author: AUTHOR
+// Author: David Webster
// Modified by:
-// Created: ??/??/98
+// Created: 10/14/99
// RCS-ID: $Id$
-// Copyright: (c) AUTHOR
-// Licence: wxWindows licence
+// 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 char*) wxDialogNameStr;
+class WXDLLEXPORT wxDialogModalData;
+
+//
// Dialog boxes
+//
class WXDLLEXPORT wxDialog: public wxDialogBase
{
- DECLARE_DYNAMIC_CLASS(wxDialog)
public:
- wxDialog();
-
- // Constructor with a modal flag, but no window id - the old convention
- inline 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.
- inline wxDialog( wxWindow* parent
- ,wxWindowID id
- ,const wxString& title
- ,const wxPoint& pos = wxDefaultPosition
- ,const wxSize& size = wxDefaultSize
- ,long style = wxDEFAULT_DIALOG_STYLE
- ,const wxString& name = wxDialogNameStr
- )
+ // full ctor
+ wxDialog(wxWindow *parent, wxWindowID id,
+ const wxString& title,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxDEFAULT_DIALOG_STYLE,
+ const wxString& name = wxDialogNameStr)
{
- Create(parent, id, title, pos, size, style, name);
+ Init();
+
+ (void)Create(parent, id, title, pos, size, style, name);
}
- bool Create( wxWindow* parent
- ,wxWindowID id
- ,const wxString& title
- , // bool modal = FALSE, // TODO make this a window style?
- const wxPoint& pos = wxDefaultPosition
- ,const wxSize& size = wxDefaultSize
- ,long style = wxDEFAULT_DIALOG_STYLE
- ,const wxString& name = wxDialogNameStr
+ 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();
- ~wxDialog();
+ // return true if we're showing the dialog modally
+ virtual bool IsModal() const { return m_modalData != NULL; }
-// ---------------------------------------------------------------------------
-// Virtuals
-// ---------------------------------------------------------------------------
+ // show the dialog modally and return the value passed to EndModal()
+ virtual int ShowModal();
- virtual bool Destroy();
- virtual bool IsIconized() const;
- virtual void Centre(int direction = wxBOTH);
- virtual bool IsModal() const { return ((GetWindowStyleFlag() & wxDIALOG_MODAL) == wxDIALOG_MODAL); }
-
- virtual int ShowModal();
+ // may be called to terminate the dialog with the given return code
virtual void EndModal(int retCode);
- void SetClientSize(int width, int height) { wxWindow::DoSetClientSize(width, height); };
- void SetClientSize( const wxSize& size ) { wxWindow::DoSetClientSize(size.x, size.y); };
- void SetClientSize(const wxRect& rect) { SetClientSize( rect.width, rect.height ); };
-
- void GetPosition(int *x, int *y) const;
- bool Show(bool show);
- void Iconize(bool iconize);
-
- void Fit();
+ // implementation only from now on
+ // -------------------------------
- void SetTitle(const wxString& title);
- wxString GetTitle() const ;
+ // override some base class virtuals
+ virtual bool Show(bool show = true);
- void OnCharHook(wxKeyEvent& event);
- void OnCloseWindow(wxCloseEvent& event);
-
- void SetModal(bool flag);
+ //
+ // 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);
-
-DECLARE_EVENT_TABLE()
-};
+ //
+ void OnSysColourChanged(wxSysColourChangedEvent& rEvent);
+
+ //
+ // Callbacks
+ //
+ virtual MRESULT OS2WindowProc( WXUINT uMessage
+ ,WXWPARAM wParam
+ ,WXLPARAM lParam
+ );
+ // obsolete methods
+ // ----------------
+
+ // 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:
+ //
+ // 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:
+ wxWindow* m_pOldFocus;
+ bool m_endModalCalled; // allow for closing within InitDialog
+
+ // 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_