added SetHoverBitmap() and implemented it under wxMSW; extended the docs

[wxWidgets.git] / include / wx / msw / dialog.h

diff --git a/include/wx/msw/dialog.h b/include/wx/msw/dialog.h
index d4a19e94e83e1d69a9fb12d2f0b6c22d80ed71e7..91dd0fc5640433cf2b819478a14e9da791343109 100644 (file)
--- a/include/wx/msw/dialog.h
+++ b/include/wx/msw/dialog.h
@@ -1,120 +1,164 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        dialog.h
+// Name:        wx/msw/dialog.h

 // Purpose:     wxDialog class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     wxDialog class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DIALOG_H_
 #define _WX_DIALOG_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DIALOG_H_
 #define _WX_DIALOG_H_
 

-#ifdef __GNUG__
-#pragma interface "dialog.h"
-#endif
-

 #include "wx/panel.h"
 
 #include "wx/panel.h"
 

-WXDLLEXPORT_DATA(extern const char*) wxDialogNameStr;
+extern WXDLLEXPORT_DATA(const wxChar*) wxDialogNameStr;
+
+class WXDLLEXPORT wxDialogModalData;
+
+#if wxUSE_TOOLBAR && (defined(__SMARTPHONE__) || defined(__POCKETPC__))
+class WXDLLEXPORT wxToolBar;
+extern WXDLLEXPORT_DATA(const wxChar*) wxToolBarNameStr;
+#endif

 
 // Dialog boxes
 
 // Dialog boxes

-class WXDLLEXPORT wxDialog: public wxPanel
+class WXDLLEXPORT wxDialog : public wxDialogBase

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxDialog)
- protected:
-  bool m_modalShowing;

 public:
 public:

-
-  wxDialog(void);
-
-  // 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);
-  }
-
-  // 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)
-  {
-      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);
-
-  ~wxDialog(void);
-
-  virtual bool Destroy(void);
-  void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
-  void SetClientSize(int width, int height);
-  void GetPosition(int *x, int *y) const;
-  bool Show(bool show);
-  bool IsShown(void) const ;
-  void Iconize(bool iconize);
-
-#if WXWIN_COMPATIBILITY
-  inline bool Iconized(void) const { return IsIconized(); };
+    wxDialog() { Init(); }
+
+    // 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)
+    {
+        Init();
+
+        (void)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);
+
+    virtual ~wxDialog();
+
+    // return true if we're showing the dialog modally
+    virtual bool IsModal() const { return m_modalData != NULL; }
+
+    // show the dialog modally and return the value passed to EndModal()
+    virtual int ShowModal();
+
+    // may be called to terminate the dialog with the given return code
+    virtual void EndModal(int retCode);
+
+
+    // we treat dialog toolbars specially under Windows CE
+#if wxUSE_TOOLBAR && defined(__POCKETPC__)
+    // create main toolbar by calling OnCreateToolBar()
+    virtual wxToolBar* CreateToolBar(long style = -1,
+                                     wxWindowID winid = wxID_ANY,
+                                     const wxString& name = wxToolBarNameStr);
+    // return a new toolbar
+    virtual wxToolBar *OnCreateToolBar(long style,
+                                       wxWindowID winid,
+                                       const wxString& name );
+
+    // get the main toolbar
+    wxToolBar *GetToolBar() const { return m_dialogToolBar; }
+#endif // wxUSE_TOOLBAR && __POCKETPC__
+
+
+    // implementation only from now on
+    // -------------------------------
+
+    // override some base class virtuals
+    virtual bool Show(bool show = true);
+
+    virtual void Raise();
+
+    // event handlers
+    void OnCharHook(wxKeyEvent& event);
+    void OnCloseWindow(wxCloseEvent& event);
+
+    // Standard buttons
+    void OnOK(wxCommandEvent& event);
+    void OnApply(wxCommandEvent& event);
+    void OnCancel(wxCommandEvent& event);
+
+    // Responds to colour changes
+    void OnSysColourChanged(wxSysColourChangedEvent& event);
+
+#ifdef __POCKETPC__
+    // Responds to the OK button in a PocketPC titlebar. This
+    // can be overridden, or you can change the id used for
+    // sending the event with SetAffirmativeId. Returns false
+    // if the event was not processed.
+    virtual bool DoOK();

 #endif
 
 #endif
 

-  virtual bool IsIconized(void) const;
-  void Fit(void);
+    // Windows callbacks
+    WXLRESULT MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);

 
 

-  void SetTitle(const wxString& title);
-  wxString GetTitle(void) const ;
+    // obsolete methods
+    // ----------------

 
 

-  bool OnClose(void);
-  void OnCharHook(wxKeyEvent& event);
-  void OnPaint(wxPaintEvent& event);
-  void OnCloseWindow(wxCloseEvent& event);
+    // use the other ctor
+    wxDEPRECATED( wxDialog(wxWindow *parent,
+             const wxString& title, bool modal,
+             int x = wxDefaultCoord, int y = wxDefaultCoord, int width = 500, int height = 500,
+             long style = wxDEFAULT_DIALOG_STYLE,
+             const wxString& name = wxDialogNameStr) );

 
 

-  void SetModal(bool flag);
+    // just call Show() or ShowModal()
+    wxDEPRECATED( void SetModal(bool flag) );

 
 

-  virtual void Centre(int direction = wxBOTH);
-  virtual bool IsModal(void) const { return ((GetWindowStyleFlag() & wxDIALOG_MODAL) == wxDIALOG_MODAL); }
+    // use IsModal()
+    wxDEPRECATED( bool IsModalShowing() const );

 
 

-  // For now, same as Show(TRUE) but returns return code
-  virtual int ShowModal(void);
-  virtual void EndModal(int retCode);
+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;

 
 

-  // Standard buttons
-  void OnOK(wxCommandEvent& event);
-  void OnApply(wxCommandEvent& event);
-  void OnCancel(wxCommandEvent& event);
+    // common part of all ctors
+    void Init();

 
 

-  // Responds to colour changes
-  void OnSysColourChanged(wxSysColourChangedEvent& event);
+    // end either modal or modeless dialog
+    void EndDialog(int rc);

 
 

-  // IMPLEMENTATION
-  virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
-  virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
-  virtual bool MSWProcessMessage(WXMSG* pMsg);
-//  virtual bool MSWOnEraseBkgnd(WXHDC pDC);
-  virtual bool MSWOnClose(void);
-  inline bool IsModalShowing() const { return m_modalShowing ; }
-  virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
-                       WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
+    // emulate click of a button with the given id if it's present in the dialog
+    //
+    // return true if button was "clicked" or false if we don't have it
+    bool EmulateButtonClickIfPresent(int id);

 
 

-protected:
-  WXHWND m_hwndOldFocus;  // the window which had focus before we were shown
+    // handle Escape here
+    virtual bool MSWProcessMessage(WXMSG* pMsg);
+
+private:
+    wxWindow*   m_oldFocus;
+    bool        m_endModalCalled; // allow for closing within InitDialog
+
+#if wxUSE_TOOLBAR && defined(__POCKETPC__)
+    wxToolBar*  m_dialogToolBar;
+#endif
+
+    // this pointer is non-NULL only while the modal event loop is running
+    wxDialogModalData *m_modalData;

 
 

-DECLARE_EVENT_TABLE()
+    DECLARE_DYNAMIC_CLASS(wxDialog)
+    DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxDialog)

 };
 
 #endif
 };
 
 #endif