include/wx/os2/dialog.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dialog.h
   3 // Purpose:     wxDialog class
   4 // Author:      David Webster
   5 // Modified by:
   6 // Created:     10/14/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) David Webster
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_DIALOG_H_
  13 #define _WX_DIALOG_H_
  14
  15 #include "wx/panel.h"
  16
  17 WXDLLEXPORT_DATA(extern const wxChar) wxDialogNameStr[];
  18
  19 class WXDLLEXPORT wxDialogModalData;
  20
  21 //
  22 // Dialog boxes
  23 //
  24 class WXDLLEXPORT wxDialog: public wxDialogBase
  25 {
  26 public:
  27
  28   inline wxDialog() { Init(); }
  29
  30     // full ctor
  31     wxDialog(wxWindow *parent, wxWindowID id,
  32              const wxString& title,
  33              const wxPoint& pos = wxDefaultPosition,
  34              const wxSize& size = wxDefaultSize,
  35              long style = wxDEFAULT_DIALOG_STYLE,
  36              const wxString& name = wxDialogNameStr)
  37     {
  38         Init();
  39
  40         (void)Create(parent, id, title, pos, size, style, name);
  41     }
  42
  43     bool Create( wxWindow*       pParent
  44                 ,wxWindowID      vId
  45                 ,const wxString& rsTitle
  46                 ,const wxPoint&  rPos = wxDefaultPosition
  47                 ,const wxSize&   rSize = wxDefaultSize
  48                 ,long            lStyle = wxDEFAULT_DIALOG_STYLE
  49                 ,const wxString& rsName = wxDialogNameStr
  50                );
  51     virtual ~wxDialog();
  52
  53     // return true if we're showing the dialog modally
  54     virtual bool IsModal() const { return m_modalData != NULL; }
  55
  56     // show the dialog modally and return the value passed to EndModal()
  57     virtual int ShowModal();
  58
  59     // may be called to terminate the dialog with the given return code
  60     virtual void EndModal(int retCode);
  61
  62     // implementation only from now on
  63     // -------------------------------
  64
  65     // override some base class virtuals
  66     virtual bool Show(bool show = true);
  67
  68     //
  69     // Event handlers
  70     //
  71     void OnCharHook(wxKeyEvent& rEvent);
  72     void OnCloseWindow(wxCloseEvent& rEvent);
  73
  74     //
  75     // Standard buttons
  76     //
  77     void     OnOK(wxCommandEvent& rEvent);
  78     void     OnApply(wxCommandEvent& rEvent);
  79     void     OnCancel(wxCommandEvent& rEvent);
  80
  81     //
  82     // Responds to colour changes
  83     //
  84     void     OnSysColourChanged(wxSysColourChangedEvent& rEvent);
  85
  86     //
  87     // Callbacks
  88     //
  89     virtual MRESULT OS2WindowProc( WXUINT   uMessage
  90                                   ,WXWPARAM wParam
  91                                   ,WXLPARAM lParam
  92                                  );
  93     // obsolete methods
  94     // ----------------
  95
  96     // Constructor with a modal flag, but no window id - the old convention
  97     wxDEPRECATED( wxDialog( wxWindow*       pParent
  98                            ,const wxString& rsTitle
  99                            ,bool            bModal
 100                            ,int             nX = -1
 101                            ,int             nY = -1
 102                            ,int             nWidth = 500
 103                            ,int             nHeight = 500
 104                            ,long            lStyle = wxDEFAULT_DIALOG_STYLE
 105                            ,const wxString& rsName = wxDialogNameStr
 106                           ) );
 107
 108     // just call Show() or ShowModal()
 109     wxDEPRECATED( void SetModal(bool bFlag) );
 110
 111     // use IsModal()
 112     wxDEPRECATED( bool IsModalShowing() const );
 113
 114 protected:
 115     //
 116     // find the window to use as parent for this dialog if none has been
 117     // specified explicitly by the user
 118     //
 119     // may return NULL
 120     //
 121     wxWindow *FindSuitableParent() const;
 122
 123     //
 124     // Common part of all ctors
 125     //
 126     void Init(void);
 127
 128     // end either modal or modeless dialog
 129     void EndDialog(int rc);
 130
 131 private:
 132     wxWindow*                       m_pOldFocus;
 133     bool        m_endModalCalled; // allow for closing within InitDialog
 134
 135     // this pointer is non-NULL only while the modal event loop is running
 136     wxDialogModalData *m_modalData;
 137
 138     //
 139     // While we are showing a modal dialog we disable the other windows using
 140     // this object
 141     //
 142     class wxWindowDisabler*         m_pWindowDisabler;
 143
 144     DECLARE_DYNAMIC_CLASS(wxDialog)
 145     DECLARE_EVENT_TABLE()
 146     DECLARE_NO_COPY_CLASS(wxDialog)
 147 }; // end of CLASS wxDialog
 148
 149 #endif // _WX_DIALOG_H_
 150