Some improvements to accessibility behaviour

[wxWidgets.git] / src / msw / dialog.cpp

diff --git a/src/msw/dialog.cpp b/src/msw/dialog.cpp
index bbd4c9f3342355ed1f9871fe15af76a6d199e0e0..214bfb1dd4cb19a6e9c9438c2f84f8fcb11c371f 100644 (file)
--- a/src/msw/dialog.cpp
+++ b/src/msw/dialog.cpp
@@ -41,7 +41,7 @@
 #include "wx/msw/private.h"
 #include "wx/log.h"
 
 #include "wx/msw/private.h"
 #include "wx/log.h"
 

-#if wxUSE_COMMON_DIALOGS
+#if wxUSE_COMMON_DIALOGS && !defined(__WXMICROWIN__)

     #include <commdlg.h>
 #endif
 
     #include <commdlg.h>
 #endif
 


@@ -61,12 +61,6 @@
 // globals
 // ----------------------------------------------------------------------------
 
 // globals
 // ----------------------------------------------------------------------------
 

-// all objects to be deleted during next idle processing - from window.cpp
-extern wxList WXDLLEXPORT wxPendingDelete;
-
-// all frames and modeless dialogs - not static, used in frame.cpp, mdi.cpp &c
-wxWindowList wxModelessWindows;
-

 // all modal dialogs currently shown
 static wxWindowList wxModalDialogs;
 
 // all modal dialogs currently shown
 static wxWindowList wxModalDialogs;
 


@@ -74,9 +68,9 @@ static wxWindowList wxModalDialogs;
 // wxWin macros
 // ----------------------------------------------------------------------------
 
 // wxWin macros
 // ----------------------------------------------------------------------------
 

-IMPLEMENT_DYNAMIC_CLASS(wxDialog, wxPanel)
+IMPLEMENT_DYNAMIC_CLASS(wxDialog, wxTopLevelWindow)

 
 

-BEGIN_EVENT_TABLE(wxDialog, wxPanel)
+BEGIN_EVENT_TABLE(wxDialog, wxDialogBase)

     EVT_BUTTON(wxID_OK, wxDialog::OnOK)
     EVT_BUTTON(wxID_APPLY, wxDialog::OnApply)
     EVT_BUTTON(wxID_CANCEL, wxDialog::OnCancel)
     EVT_BUTTON(wxID_OK, wxDialog::OnOK)
     EVT_BUTTON(wxID_APPLY, wxDialog::OnApply)
     EVT_BUTTON(wxID_CANCEL, wxDialog::OnCancel)


@@ -96,93 +90,39 @@ END_EVENT_TABLE()
 // wxDialog construction
 // ----------------------------------------------------------------------------
 
 // wxDialog construction
 // ----------------------------------------------------------------------------
 

-wxDialog::wxDialog()
+void wxDialog::Init()

 {
     m_oldFocus = (wxWindow *)NULL;
 {
     m_oldFocus = (wxWindow *)NULL;

+

     m_isShown = FALSE;
 
     m_isShown = FALSE;
 

-    SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
+    m_windowDisabler = (wxWindowDisabler *)NULL;
+
+    SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));

 }
 
 }
 

-bool wxDialog::Create(wxWindow *parent, wxWindowID id,
+bool wxDialog::Create(wxWindow *parent,
+                      wxWindowID id,

                       const wxString& title,
                       const wxPoint& pos,
                       const wxSize& size,
                       long style,
                       const wxString& name)
 {
                       const wxString& title,
                       const wxPoint& pos,
                       const wxSize& size,
                       long style,
                       const wxString& name)
 {

-    m_oldFocus = FindFocus();
-
-    SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
-    SetName(name);
-
-    if (!parent)
-        wxTopLevelWindows.Append(this);
+    Init();

 
 

-    //  windowFont = wxTheFontList->FindOrCreateFont(11, wxSWISS, wxNORMAL, wxNORMAL);
+    SetExtraStyle(GetExtraStyle() | wxTOPLEVEL_EX_DIALOG);

 
 

-    if (parent) parent->AddChild(this);
-
-    if ( id == -1 )
-        m_windowId = (int)NewControlId();
-    else
-        m_windowId = id;
-
-    int x = pos.x;
-    int y = pos.y;
-    int width = size.x;
-    int height = size.y;
-
-    if (x < 0)
-        x = wxDIALOG_DEFAULT_X;
-    if (y < 0)
-        y = wxDIALOG_DEFAULT_Y;
-
-    m_windowStyle = style;
-
-    m_isShown = FALSE;
-
-    if (width < 0)
-        width = wxDIALOG_DEFAULT_WIDTH;
-    if (height < 0)
-        height = wxDIALOG_DEFAULT_HEIGHT;
+    // save focus before doing anything which can potentially change it
+    m_oldFocus = FindFocus();

 
     // All dialogs should really have this style
 
     // All dialogs should really have this style

-    m_windowStyle |= wxTAB_TRAVERSAL;
-
-    WXDWORD extendedStyle = MakeExtendedStyle(m_windowStyle);
-    if (m_windowStyle & wxSTAY_ON_TOP)
-        extendedStyle |= WS_EX_TOPMOST;
-
-    // Allows creation of dialogs with & without captions under MSWindows,
-    // resizeable or not (but a resizeable dialog always has caption -
-    // otherwise it would look too strange)
-    const wxChar *dlg;
-    if ( style & wxRESIZE_BORDER )
-        dlg = wxT("wxResizeableDialog");
-    else if ( style & wxCAPTION )
-        dlg = wxT("wxCaptionDialog");
-    else
-        dlg = wxT("wxNoCaptionDialog");
-    MSWCreate(m_windowId, parent, NULL, this, NULL,
-              x, y, width, height,
-              0, // style is not used if we have dlg template
-              dlg,
-              extendedStyle);
-
-    HWND hwnd = (HWND)GetHWND();
-
-    if ( !hwnd )
-    {
-        wxLogError(_("Failed to create dialog."));
+    style |= wxTAB_TRAVERSAL;

 
 

+    if ( !wxTopLevelWindow::Create(parent, id, title, pos, size, style, name) )

         return FALSE;
         return FALSE;

-    }

 
 

-    SubclassWin(GetHWND());
-
-    SetWindowText(hwnd, title);
-    SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
+    SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));

 
     return TRUE;
 }
 
     return TRUE;
 }


@@ -207,25 +147,8 @@ wxDialog::~wxDialog()
 {
     m_isBeingDeleted = TRUE;
 
 {
     m_isBeingDeleted = TRUE;
 

-    wxTopLevelWindows.DeleteObject(this);
-
-    // this will call BringWindowToTop() if necessary to bring back our parent
-    // window to top
+    // this will also reenable all the other windows for a modal dialog

     Show(FALSE);
     Show(FALSE);

-
-    if ( !IsModal() )
-        wxModelessWindows.DeleteObject(this);
-
-    // If this is the last top-level window, exit.
-    if ( wxTheApp && (wxTopLevelWindows.Number() == 0) )
-    {
-        wxTheApp->SetTopWindow(NULL);
-
-        if ( wxTheApp->GetExitOnFrameDelete() )
-        {
-            ::PostQuitMessage(0);
-        }
-    }

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -235,74 +158,26 @@ wxDialog::~wxDialog()
 // By default, pressing escape cancels the dialog
 void wxDialog::OnCharHook(wxKeyEvent& event)
 {
 // By default, pressing escape cancels the dialog
 void wxDialog::OnCharHook(wxKeyEvent& event)
 {

-  if (GetHWND())
-  {
-    if (event.m_keyCode == WXK_ESCAPE)
+    if (GetHWND())

     {
     {

-        // Behaviour changed in 2.0: we'll send a Cancel message
-        // to the dialog instead of Close.
-        wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
-        cancelEvent.SetEventObject( this );
-        GetEventHandler()->ProcessEvent(cancelEvent);
-
-        // ensure that there is another message for this window so the
-        // ShowModal loop will exit and won't get stuck in GetMessage().
-        ::PostMessage(GetHwnd(), WM_NULL, 0, 0);
-        return;
-    }
-  }
-  // We didn't process this event.
-  event.Skip();
-}
-
-// ----------------------------------------------------------------------------
-// Windows dialog boxes can't be iconized
-// ----------------------------------------------------------------------------
-
-void wxDialog::Iconize(bool WXUNUSED(iconize))
-{
-}
-
-bool wxDialog::IsIconized() const
-{
-    return FALSE;
-}
-
-// ----------------------------------------------------------------------------
-// size/position handling
-// ----------------------------------------------------------------------------
-
-void wxDialog::DoSetClientSize(int width, int height)
-{
-    HWND hWnd = (HWND) GetHWND();
-    RECT rect;
-    ::GetClientRect(hWnd, &rect);
-
-    RECT rect2;
-    GetWindowRect(hWnd, &rect2);
-
-    // Find the difference between the entire window (title bar and all)
-    // and the client area; add this to the new client size to move the
-    // window
-    int actual_width = rect2.right - rect2.left - rect.right + width;
-    int actual_height = rect2.bottom - rect2.top - rect.bottom + height;
-
-    MoveWindow(hWnd, rect2.left, rect2.top, actual_width, actual_height, TRUE);
+        // "Esc" works as an accelerator for the "Cancel" button, but it
+        // shouldn't close the dialog which doesn't have any cancel button
+        if ( (event.m_keyCode == WXK_ESCAPE) && FindWindow(wxID_CANCEL) )
+        {
+            wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
+            cancelEvent.SetEventObject( this );
+            GetEventHandler()->ProcessEvent(cancelEvent);

 
 

-    wxSizeEvent event(wxSize(actual_width, actual_height), m_windowId);
-    event.SetEventObject( this );
-    GetEventHandler()->ProcessEvent(event);
-}
+            // ensure that there is another message for this window so the
+            // ShowModal loop will exit and won't get stuck in GetMessage().
+            ::PostMessage(GetHwnd(), WM_NULL, 0, 0);

 
 

-void wxDialog::DoGetPosition(int *x, int *y) const
-{
-    RECT rect;
-    GetWindowRect(GetHwnd(), &rect);
+            return;
+        }
+    }

 
 

-    if ( x )
-        *x = rect.left;
-    if ( y )
-        *y = rect.top;
+    // We didn't process this event.
+    event.Skip();

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -319,30 +194,64 @@ bool wxDialog::IsModalShowing() const
     return wxModalDialogs.Find((wxDialog *)this) != NULL; // const_cast
 }
 
     return wxModalDialogs.Find((wxDialog *)this) != NULL; // const_cast
 }
 

+wxWindow *wxDialog::FindSuitableParent() const
+{
+    // first try to use the currently active window
+    HWND hwndFg = ::GetForegroundWindow();
+    wxWindow *parent = hwndFg ? wxFindWinFromHandle((WXHWND)hwndFg)
+                              : NULL;
+    if ( !parent )
+    {
+        // next try the main app window
+        parent = wxTheApp->GetTopWindow();
+    }
+
+    // finally, check if the parent we found is really suitable
+    if ( !parent || parent == (wxWindow *)this || !parent->IsShown() )
+    {
+        // don't use this one
+        parent = NULL;
+    }
+
+    return parent;
+}
+

 void wxDialog::DoShowModal()
 {
     wxCHECK_RET( !IsModalShowing(), _T("DoShowModal() called twice") );
 void wxDialog::DoShowModal()
 {
     wxCHECK_RET( !IsModalShowing(), _T("DoShowModal() called twice") );

+    wxCHECK_RET( IsModal(), _T("can't DoShowModal() modeless dialog") );

 
     wxModalDialogs.Append(this);
 
     wxWindow *parent = GetParent();
 
 
     wxModalDialogs.Append(this);
 
     wxWindow *parent = GetParent();
 

+    wxWindow* oldFocus = m_oldFocus;
+
+    // We have to remember the HWND because we need to check
+    // the HWND still exists (oldFocus can be garbage when the dialog
+    // exits, if it has been destroyed)
+    HWND hwndOldFocus = 0;
+    if (oldFocus)
+        hwndOldFocus = (HWND) oldFocus->GetHWND();
+

     // remember where the focus was
     // remember where the focus was

-    if ( !m_oldFocus )
+    if ( !oldFocus )

     {
     {

-        m_oldFocus = parent;
-    }
-    if ( !m_oldFocus )
-    {
-        m_oldFocus = wxTheApp->GetTopWindow();
+        oldFocus = parent;
+        if ( parent )
+            hwndOldFocus = GetHwndOf(parent);

     }
 
     }
 

-    // disable the parent window first
-    HWND hwndParent = parent ? GetHwndOf(parent) : (HWND)NULL;
-    if ( hwndParent )
-    {
-        ::EnableWindow(hwndParent, FALSE);
-    }
+    // disable all other app windows
+    wxASSERT_MSG( !m_windowDisabler, _T("disabling windows twice?") );
+
+    m_windowDisabler = new wxWindowDisabler(this);
+
+    // before entering the modal loop, reset the "is in OnIdle()" flag (see
+    // comment in app.cpp)
+    extern bool wxIsInOnIdleFlag;
+    bool wasInOnIdle = wxIsInOnIdleFlag;
+    wxIsInOnIdleFlag = FALSE;

 
     // enter the modal loop
     while ( IsModalShowing() )
 
     // enter the modal loop
     while ( IsModalShowing() )


@@ -358,31 +267,31 @@ void wxDialog::DoShowModal()
         wxTheApp->DoMessage();
     }
 
         wxTheApp->DoMessage();
     }
 

-    // reenable the parent window if any
-    if ( hwndParent )
-    {
-        ::EnableWindow(hwndParent, TRUE);
-    }
+    wxIsInOnIdleFlag = wasInOnIdle;

 
     // and restore focus
 
     // and restore focus

-    if ( m_oldFocus && (m_oldFocus != this) )
+    // Note that this code MUST NOT access the dialog object's data
+    // in case the object has been deleted (which will be the case
+    // for a modal dialog that has been destroyed before calling EndModal).
+    if ( oldFocus && (oldFocus != this) && ::IsWindow(hwndOldFocus))

     {
     {

-        m_oldFocus->SetFocus();
+        // This is likely to prove that the object still exists
+        if (wxFindWinFromHandle((WXHWND) hwndOldFocus) == oldFocus)
+            oldFocus->SetFocus();

     }
 }
 
 bool wxDialog::Show(bool show)
 {
     }
 }
 
 bool wxDialog::Show(bool show)
 {

-    // The following is required when the parent has been disabled, (modal
-    // dialogs, or modeless dialogs with disabling such as wxProgressDialog).
-    // Otherwise the parent disappears behind other windows when the dialog is
-    // hidden.

     if ( !show )
     {
     if ( !show )
     {

-        wxWindow *parent = GetParent();
-        if ( parent )
+        // if we had disabled other app windows, reenable them back now because
+        // if they stay disabled Windows will activate another window (one
+        // which is enabled, anyhow) and we will lose activation
+        if ( m_windowDisabler )

         {
         {

-            ::BringWindowToTop(GetHwndOf(parent));
+            delete m_windowDisabler;
+            m_windowDisabler = NULL;

         }
     }
 
         }
     }
 


@@ -395,6 +304,14 @@ bool wxDialog::Show(bool show)
 
     if ( show )
     {
 
     if ( show )
     {

+        // dialogs don't get WM_SIZE message after creation unlike most (all?)
+        // other windows and so could start their life non laid out correctly
+        // if we didn't call Layout() from here
+        //
+        // NB: normally we should call it just the first time but doing it
+        //     every time is simpler than keeping a flag
+        Layout();
+

         // usually will result in TransferDataToWindow() being called
         InitDialog();
     }
         // usually will result in TransferDataToWindow() being called
         InitDialog();
     }


@@ -403,6 +320,12 @@ bool wxDialog::Show(bool show)
     {
         if ( show )
         {
     {
         if ( show )
         {

+            // modal dialog needs a parent window, so try to find one
+            if ( !GetParent() )
+            {
+                m_parent = FindSuitableParent();
+            }
+

             DoShowModal();
         }
         else // end of modal dialog
             DoShowModal();
         }
         else // end of modal dialog


@@ -416,32 +339,16 @@ bool wxDialog::Show(bool show)
     return TRUE;
 }
 
     return TRUE;
 }
 

-// Replacement for Show(TRUE) for modal dialogs - returns return code
+// a special version for Show(TRUE) for modal dialogs which returns return code

 int wxDialog::ShowModal()
 {
 int wxDialog::ShowModal()
 {

-    // modal dialog needs a parent window, so try to find one
-    if ( !GetParent() )
-    {
-        wxWindow *parent = wxTheApp->GetTopWindow();
-        if ( parent && parent != this )
-        {
-            // use it
-            m_parent = parent;
-        }
-    }
-
-    wxWindowDisabler *wd = (wxWindowDisabler *)NULL;
-    if ( !GetParent() )
+    if ( !IsModal() )

     {
     {

-        // still no parent? make the dialog app modal by disabling all windows
-        wd = new wxWindowDisabler(this);
+        SetModal(TRUE);

     }
 
     }
 

-    m_windowStyle |= wxDIALOG_MODAL;

     Show(TRUE);
 
     Show(TRUE);
 

-    delete wd;
-

     return GetReturnCode();
 }
 
     return GetReturnCode();
 }
 


@@ -459,7 +366,7 @@ void wxDialog::EndModal(int retCode)
 // ----------------------------------------------------------------------------
 
 // Standard buttons
 // ----------------------------------------------------------------------------
 
 // Standard buttons

-void wxDialog::OnOK(wxCommandEvent& event)
+void wxDialog::OnOK(wxCommandEvent& WXUNUSED(event))

 {
   if ( Validate() && TransferDataFromWindow() )
   {
 {
   if ( Validate() && TransferDataFromWindow() )
   {


@@ -467,7 +374,7 @@ void wxDialog::OnOK(wxCommandEvent& event)
   }
 }
 
   }
 }
 

-void wxDialog::OnApply(wxCommandEvent& event)
+void wxDialog::OnApply(wxCommandEvent& WXUNUSED(event))

 {
     if ( Validate() )
         TransferDataFromWindow();
 {
     if ( Validate() )
         TransferDataFromWindow();


@@ -475,12 +382,12 @@ void wxDialog::OnApply(wxCommandEvent& event)
     // TODO probably need to disable the Apply button until things change again
 }
 
     // TODO probably need to disable the Apply button until things change again
 }
 

-void wxDialog::OnCancel(wxCommandEvent& event)
+void wxDialog::OnCancel(wxCommandEvent& WXUNUSED(event))

 {
     EndModal(wxID_CANCEL);
 }
 
 {
     EndModal(wxID_CANCEL);
 }
 

-void wxDialog::OnCloseWindow(wxCloseEvent& event)
+void wxDialog::OnCloseWindow(wxCloseEvent& WXUNUSED(event))

 {
     // We'll send a Cancel message by default, which may close the dialog.
     // Check for looping if the Cancel event handler calls Close().
 {
     // We'll send a Cancel message by default, which may close the dialog.
     // Check for looping if the Cancel event handler calls Close().


@@ -510,23 +417,12 @@ void wxDialog::OnCloseWindow(wxCloseEvent& event)
     closing.DeleteObject(this);
 }
 
     closing.DeleteObject(this);
 }
 

-// Destroy the window (delayed, if a managed window)
-bool wxDialog::Destroy()
-{
-    wxCHECK_MSG( !wxPendingDelete.Member(this), FALSE,
-                 _T("wxDialog destroyed twice") );
-
-    wxPendingDelete.Append(this);
-
-    return TRUE;
-}
-
-void wxDialog::OnSysColourChanged(wxSysColourChangedEvent& event)
+void wxDialog::OnSysColourChanged(wxSysColourChangedEvent& WXUNUSED(event))

 {
 #if wxUSE_CTL3D
     Ctl3dColorChange();
 #else
 {
 #if wxUSE_CTL3D
     Ctl3dColorChange();
 #else

-    SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
+    SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));

     Refresh();
 #endif
 }
     Refresh();
 #endif
 }


@@ -542,39 +438,28 @@ long wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
 
     switch ( message )
     {
 
     switch ( message )
     {

-        case WM_ACTIVATE:
-            switch ( LOWORD(wParam) )
-            {
-                case WA_ACTIVE:
-                case WA_CLICKACTIVE:
-                    if ( IsModalShowing() && GetParent() )
-                    {
-                        // bring the owner window to top as the standard dialog
-                        // boxes do
-                        if ( !::SetWindowPos
-                                (
-                                    GetHwndOf(GetParent()),
-                                    GetHwnd(),
-                                    0, 0,
-                                    0, 0,
-                                    SWP_NOACTIVATE |
-                                    SWP_NOMOVE |
-                                    SWP_NOSIZE
-                                ) )
-                        {
-                            wxLogLastError("SetWindowPos(SWP_NOACTIVATE)");
-                        }
-                    }
-                    // fall through to process it normally as well
-            }
-            break;
-

         case WM_CLOSE:
             // if we can't close, tell the system that we processed the
             // message - otherwise it would close us
             processed = !Close();
             break;
 
         case WM_CLOSE:
             // if we can't close, tell the system that we processed the
             // message - otherwise it would close us
             processed = !Close();
             break;
 

+        case WM_SIZE:
+            // the Windows dialogs unfortunately are not meant to be resizeable
+            // at all and their standard class doesn't include CS_[VH]REDRAW
+            // styles which means that the window is not refreshed properly
+            // after the resize and no amount of WS_CLIPCHILDREN/SIBLINGS can
+            // help with it - so we have to refresh it manually which certainly
+            // creates flicker but at least doesn't show garbage on the screen
+            rc = wxWindow::MSWWindowProc(message, wParam, lParam);
+            processed = TRUE;
+            if ( !HasFlag(wxNO_FULL_REPAINT_ON_RESIZE) )
+            {
+                ::InvalidateRect(GetHwnd(), NULL, FALSE /* erase bg */);
+            }
+            break;
+
+#ifndef __WXMICROWIN__

         case WM_SETCURSOR:
             // we want to override the busy cursor for modal dialogs:
             // typically, wxBeginBusyCursor() is called and then a modal dialog
         case WM_SETCURSOR:
             // we want to override the busy cursor for modal dialogs:
             // typically, wxBeginBusyCursor() is called and then a modal dialog


@@ -600,6 +485,7 @@ long wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
                 rc = FALSE;
             }
             break;
                 rc = FALSE;
             }
             break;

+#endif // __WXMICROWIN__

     }
 
     if ( !processed )
     }
 
     if ( !processed )