Fix broken and missing DataView interface items for Phoenix
[wxWidgets.git] / src / msw / radiobut.cpp
index 42bbdc43e558bbcaa6cced7eeb8ca2fa4f6b52fa..6c8ed13480bc2be2400abf20d79ba4d3d977a3c3 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        msw/radiobut.cpp
+// Name:        src/msw/radiobut.cpp
 // Purpose:     wxRadioButton
 // Author:      Julian Smart
 // Modified by:
 
 #if wxUSE_RADIOBTN
 
+#include "wx/radiobut.h"
+
 #ifndef WX_PRECOMP
-    #include "wx/radiobut.h"
     #include "wx/settings.h"
     #include "wx/dcscreen.h"
+    #include "wx/toplevel.h"
 #endif
 
 #include "wx/msw/private.h"
 // wxRadioButton creation
 // ----------------------------------------------------------------------------
 
-
-#if wxUSE_EXTENDED_RTTI
-WX_DEFINE_FLAGS( wxRadioButtonStyle )
-
-wxBEGIN_FLAGS( wxRadioButtonStyle )
-    // new style border flags, we put them first to
-    // use them for streaming out
-    wxFLAGS_MEMBER(wxBORDER_SIMPLE)
-    wxFLAGS_MEMBER(wxBORDER_SUNKEN)
-    wxFLAGS_MEMBER(wxBORDER_DOUBLE)
-    wxFLAGS_MEMBER(wxBORDER_RAISED)
-    wxFLAGS_MEMBER(wxBORDER_STATIC)
-    wxFLAGS_MEMBER(wxBORDER_NONE)
-
-    // old style border flags
-    wxFLAGS_MEMBER(wxSIMPLE_BORDER)
-    wxFLAGS_MEMBER(wxSUNKEN_BORDER)
-    wxFLAGS_MEMBER(wxDOUBLE_BORDER)
-    wxFLAGS_MEMBER(wxRAISED_BORDER)
-    wxFLAGS_MEMBER(wxSTATIC_BORDER)
-    wxFLAGS_MEMBER(wxBORDER)
-
-    // standard window styles
-    wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
-    wxFLAGS_MEMBER(wxCLIP_CHILDREN)
-    wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
-    wxFLAGS_MEMBER(wxWANTS_CHARS)
-    wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
-    wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
-    wxFLAGS_MEMBER(wxVSCROLL)
-    wxFLAGS_MEMBER(wxHSCROLL)
-
-    wxFLAGS_MEMBER(wxRB_GROUP)
-
-wxEND_FLAGS( wxRadioButtonStyle )
-
-IMPLEMENT_DYNAMIC_CLASS_XTI(wxRadioButton, wxControl,"wx/radiobut.h")
-
-wxBEGIN_PROPERTIES_TABLE(wxRadioButton)
-    wxEVENT_PROPERTY( Click , wxEVT_COMMAND_RADIOBUTTON_SELECTED , wxCommandEvent )
-    wxPROPERTY( Font , wxFont , SetFont , GetFont  , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
-    wxPROPERTY( Label,wxString, SetLabel, GetLabel, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
-    wxPROPERTY( Value ,bool, SetValue, GetValue, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
-    wxPROPERTY_FLAGS( WindowStyle , wxRadioButtonStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
-wxEND_PROPERTIES_TABLE()
-
-wxBEGIN_HANDLERS_TABLE(wxRadioButton)
-wxEND_HANDLERS_TABLE()
-
-wxCONSTRUCTOR_6( wxRadioButton , wxWindow* , Parent , wxWindowID , Id , wxString , Label , wxPoint , Position , wxSize , Size , long , WindowStyle )
-
-#else
-IMPLEMENT_DYNAMIC_CLASS(wxRadioButton, wxControl)
-#endif
-
-
 void wxRadioButton::Init()
 {
     m_isChecked = false;
@@ -115,34 +61,15 @@ bool wxRadioButton::Create(wxWindow *parent,
     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
         return false;
 
-    long msStyle = WS_TABSTOP;
-    if ( HasFlag(wxRB_GROUP) )
-        msStyle |= WS_GROUP;
-
-    /*
-       wxRB_SINGLE is a temporary workaround for the following problem: if you
-       have 2 radiobuttons in the same group but which are not consecutive in
-       the dialog, Windows can enter an infinite loop! The simplest way to
-       reproduce it is to create radio button, then a panel and then another
-       radio button: then checking the last button hangs the app.
-
-       Ideally, we'd detect (and avoid) such situation automatically but for
-       now, as I don't know how to do it, just allow the user to create
-       BS_RADIOBUTTON buttons for such situations.
-     */
-    msStyle |= HasFlag(wxRB_SINGLE) ? BS_RADIOBUTTON : BS_AUTORADIOBUTTON;
-
-    if ( HasFlag(wxCLIP_SIBLINGS) )
-        msStyle |= WS_CLIPSIBLINGS;
-    if ( HasFlag(wxALIGN_RIGHT) )
-        msStyle |= BS_LEFTTEXT | BS_RIGHT;
+    WXDWORD exstyle = 0;
+    WXDWORD msStyle = MSWGetStyle(style, &exstyle);
 
-    if ( !MSWCreateControl(_T("BUTTON"), msStyle, pos, size, label, 0) )
+    if ( !MSWCreateControl(wxT("BUTTON"), msStyle, pos, size, label, exstyle) )
         return false;
 
     // for compatibility with wxGTK, the first radio button in a group is
     // always checked (this makes sense anyhow as you need to ensure that at
-    // least one button in the group is checked and this is the simlpest way to
+    // least one button in the group is checked and this is the simplest way to
     // do it)
     if ( HasFlag(wxRB_GROUP) )
         SetValue(true);
@@ -156,89 +83,115 @@ bool wxRadioButton::Create(wxWindow *parent,
 
 void wxRadioButton::SetValue(bool value)
 {
-    (void)::SendMessage(GetHwnd(), BM_SETCHECK, (value?BST_CHECKED:BST_UNCHECKED), 0L);
+    ::SendMessage(GetHwnd(), BM_SETCHECK,
+                  value ? BST_CHECKED : BST_UNCHECKED, 0);
 
     m_isChecked = value;
 
+    if ( !value )
+        return;
+
     // if we set the value of one radio button we also must clear all the other
     // buttons in the same group: Windows doesn't do it automatically
-    if ( m_isChecked )
+    //
+    // moreover, if another radiobutton in the group currently has the focus,
+    // we have to set it to this radiobutton, else the old radiobutton will be
+    // reselected automatically, if a parent window loses the focus and regains
+    // it.
+    wxWindow * const focus = FindFocus();
+    wxTopLevelWindow * const
+        tlw = wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow);
+    wxCHECK_RET( tlw, wxT("radio button outside of TLW?") );
+    wxWindow * const focusInTLW = tlw->GetLastFocus();
+
+    const wxWindowList& siblings = GetParent()->GetChildren();
+    wxWindowList::compatibility_iterator nodeThis = siblings.Find(this);
+    wxCHECK_RET( nodeThis, wxT("radio button not a child of its parent?") );
+
+    // this will be set to true in the code below if the focus is in our TLW
+    // and belongs to one of the other buttons in the same group
+    bool shouldSetFocus = false;
+
+    // this will be set to true if the focus is outside of our TLW currently
+    // but the remembered focus of this TLW is one of the other buttons in the
+    // same group
+    bool shouldSetTLWFocus = false;
+
+    // if it's not the first item of the group ...
+    if ( !HasFlag(wxRB_GROUP) )
     {
-        // If another radiobutton in the group currently has the focus, we have to 
-        // set it to this radiobutton, else the old readiobutton will be reselected
-        // automatically, if a parent window loses the focus and regains it.
-        bool shouldSetFocus = false;
-        wxWindow* pFocusWnd = FindFocus();
-
-        const wxWindowList& siblings = GetParent()->GetChildren();
-        wxWindowList::compatibility_iterator nodeThis = siblings.Find(this);
-        wxCHECK_RET( nodeThis, _T("radio button not a child of its parent?") );
-
-        // if it's not the first item of the group ...
-        if ( !HasFlag(wxRB_GROUP) )
+        // ... turn off all radio buttons before it
+        for ( wxWindowList::compatibility_iterator nodeBefore = nodeThis->GetPrevious();
+              nodeBefore;
+              nodeBefore = nodeBefore->GetPrevious() )
         {
-            // ... turn off all radio buttons before it
-            for ( wxWindowList::compatibility_iterator nodeBefore = nodeThis->GetPrevious();
-                  nodeBefore;
-                  nodeBefore = nodeBefore->GetPrevious() )
+            wxRadioButton *btn = wxDynamicCast(nodeBefore->GetData(),
+                                               wxRadioButton);
+            if ( !btn )
             {
-                wxRadioButton *btn = wxDynamicCast(nodeBefore->GetData(),
-                                                   wxRadioButton);
-                if ( btn && btn->HasFlag(wxRB_SINGLE) )
+                // don't stop on non radio buttons, we could have intermixed
+                // buttons and e.g. static labels
+                continue;
+            }
+
+            if ( btn->HasFlag(wxRB_SINGLE) )
                 {
                     // A wxRB_SINGLE button isn't part of this group
                     break;
                 }
-                
-                if (btn)
-                {
-                    if (btn == pFocusWnd)
-                        shouldSetFocus = true;
-
-                    btn->SetValue(false);
 
-                    if ( btn->HasFlag(wxRB_GROUP) )
-                    {
-                        // even if there are other radio buttons before this one,
-                        // they're not in the same group with us
-                        break;
-                    }
-                }
-            }
-        }
+            if ( btn == focus )
+                shouldSetFocus = true;
+            else if ( btn == focusInTLW )
+                shouldSetTLWFocus = true;
 
-        // ... and also turn off all buttons after this one
-        for ( wxWindowList::compatibility_iterator nodeAfter = nodeThis->GetNext();
-              nodeAfter;
-              nodeAfter = nodeAfter->GetNext() )
-        {
-            wxRadioButton *btn = wxDynamicCast(nodeAfter->GetData(),
-                                               wxRadioButton);
+            btn->SetValue(false);
 
-            if ( btn && (btn->HasFlag(wxRB_GROUP) || btn->HasFlag(wxRB_SINGLE) ) )
+            if ( btn->HasFlag(wxRB_GROUP) )
             {
-                // no more buttons or the first button of the next group
+                // even if there are other radio buttons before this one,
+                // they're not in the same group with us
                 break;
             }
+        }
+    }
 
-            if (btn)
-            {
-                if (btn == pFocusWnd)
-                        shouldSetFocus = true;
+    // ... and also turn off all buttons after this one
+    for ( wxWindowList::compatibility_iterator nodeAfter = nodeThis->GetNext();
+          nodeAfter;
+          nodeAfter = nodeAfter->GetNext() )
+    {
+        wxRadioButton *btn = wxDynamicCast(nodeAfter->GetData(),
+                                           wxRadioButton);
 
-                btn->SetValue(false);
-            }
+        if ( !btn )
+            continue;
+
+        if ( btn->HasFlag(wxRB_GROUP | wxRB_SINGLE) )
+        {
+            // no more buttons or the first button of the next group
+            break;
         }
-        if (shouldSetFocus)
-            SetFocus();
+
+        if ( btn == focus )
+            shouldSetFocus = true;
+        else if ( btn == focusInTLW )
+            shouldSetTLWFocus = true;
+
+        btn->SetValue(false);
     }
+
+    if ( shouldSetFocus )
+        SetFocus();
+    else if ( shouldSetTLWFocus )
+        tlw->SetLastFocus(this);
 }
 
 bool wxRadioButton::GetValue() const
 {
     wxASSERT_MSG( m_isChecked ==
                     (::SendMessage(GetHwnd(), BM_GETCHECK, 0, 0L) != 0),
-                  _T("wxRadioButton::m_isChecked is out of sync?") );
+                  wxT("wxRadioButton::m_isChecked is out of sync?") );
 
     return m_isChecked;
 }
@@ -260,9 +213,8 @@ bool wxRadioButton::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 
     if ( !m_isChecked )
     {
-        // we have to do this for BS_RADIOBUTTON anyhow and, strangely enough,
-        // sometimes this is needed even for BS_AUTORADIOBUTTON (when we
-        // receive focus the button gets BN_CLICKED but stays unchecked!)
+        // we need to manually update the button state as we use BS_RADIOBUTTON
+        // and not BS_AUTORADIOBUTTON
         SetValue(true);
 
         wxCommandEvent event(wxEVT_COMMAND_RADIOBUTTON_SELECTED, GetId());
@@ -289,6 +241,13 @@ wxSize wxRadioButton::DoGetBestSize() const
         dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
 
         s_radioSize = dc.GetCharHeight();
+
+        // radio button bitmap size under CE is bigger than the font height,
+        // adding just one pixel seems to work fine for the default font but it
+        // would be nice to find some better way to find the correct height
+#ifdef __WXWINCE__
+        s_radioSize++;
+#endif // __WXWINCE__
     }
 
     wxString str = GetLabel();
@@ -296,7 +255,7 @@ wxSize wxRadioButton::DoGetBestSize() const
     int wRadio, hRadio;
     if ( !str.empty() )
     {
-        GetTextExtent(wxStripMenuCodes(str), &wRadio, &hRadio);
+        GetTextExtent(GetLabelText(str), &wRadio, &hRadio);
         wRadio += s_radioSize + GetCharWidth();
 
         if ( hRadio < s_radioSize )
@@ -313,5 +272,29 @@ wxSize wxRadioButton::DoGetBestSize() const
     return best;
 }
 
-#endif // wxUSE_RADIOBTN
+WXDWORD wxRadioButton::MSWGetStyle(long style, WXDWORD *exstyle) const
+{
+    WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
 
+    if ( HasFlag(wxRB_GROUP) )
+        msStyle |= WS_GROUP;
+
+    // we use BS_RADIOBUTTON and not BS_AUTORADIOBUTTON because the use of the
+    // latter can easily result in the application entering an infinite loop
+    // inside IsDialogMessage()
+    //
+    // we used to use BS_RADIOBUTTON only for wxRB_SINGLE buttons but there
+    // doesn't seem to be any harm to always use it and it prevents some hangs,
+    // see #9786
+    msStyle |= BS_RADIOBUTTON;
+
+    if ( style & wxCLIP_SIBLINGS )
+        msStyle |= WS_CLIPSIBLINGS;
+    if ( style & wxALIGN_RIGHT )
+        msStyle |= BS_LEFTTEXT | BS_RIGHT;
+
+
+    return msStyle;
+}
+
+#endif // wxUSE_RADIOBTN