1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/radiobox.cpp
3 // Purpose: wxRadioBox implementation
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ===========================================================================
14 // ===========================================================================
16 // ---------------------------------------------------------------------------
18 // ---------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
29 #include "wx/radiobox.h"
32 #include "wx/bitmap.h"
34 #include "wx/settings.h"
38 #include "wx/msw/subwin.h"
41 #include "wx/tooltip.h"
42 #endif // wxUSE_TOOLTIPS
44 // TODO: wxCONSTRUCTOR
45 #if 0 // wxUSE_EXTENDED_RTTI
46 WX_DEFINE_FLAGS( wxRadioBoxStyle
)
48 wxBEGIN_FLAGS( wxRadioBoxStyle
)
49 // new style border flags, we put them first to
50 // use them for streaming out
51 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
52 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
53 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
54 wxFLAGS_MEMBER(wxBORDER_RAISED
)
55 wxFLAGS_MEMBER(wxBORDER_STATIC
)
56 wxFLAGS_MEMBER(wxBORDER_NONE
)
58 // old style border flags
59 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
60 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
61 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
62 wxFLAGS_MEMBER(wxRAISED_BORDER
)
63 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
64 wxFLAGS_MEMBER(wxBORDER
)
66 // standard window styles
67 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
68 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
69 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
70 wxFLAGS_MEMBER(wxWANTS_CHARS
)
71 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
72 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
73 wxFLAGS_MEMBER(wxVSCROLL
)
74 wxFLAGS_MEMBER(wxHSCROLL
)
76 wxFLAGS_MEMBER(wxRA_SPECIFY_COLS
)
77 wxFLAGS_MEMBER(wxRA_HORIZONTAL
)
78 wxFLAGS_MEMBER(wxRA_SPECIFY_ROWS
)
79 wxFLAGS_MEMBER(wxRA_VERTICAL
)
81 wxEND_FLAGS( wxRadioBoxStyle
)
83 IMPLEMENT_DYNAMIC_CLASS_XTI(wxRadioBox
, wxControl
,"wx/radiobox.h")
85 wxBEGIN_PROPERTIES_TABLE(wxRadioBox
)
86 wxEVENT_PROPERTY( Select
, wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
)
87 wxPROPERTY_FLAGS( WindowStyle
, wxRadioBoxStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
88 wxEND_PROPERTIES_TABLE()
91 IMPLEMENT_DYNAMIC_CLASS(wxRadioBox
, wxControl
)
102 // ---------------------------------------------------------------------------
104 // ---------------------------------------------------------------------------
106 // wnd proc for radio buttons
107 LRESULT APIENTRY _EXPORT
wxRadioBtnWndProc(HWND hWnd
,
112 // ---------------------------------------------------------------------------
114 // ---------------------------------------------------------------------------
116 // the pointer to standard radio button wnd proc
117 static WXFARPROC s_wndprocRadioBtn
= (WXFARPROC
)NULL
;
119 // ===========================================================================
121 // ===========================================================================
123 // ---------------------------------------------------------------------------
124 // wxRadioBox creation
125 // ---------------------------------------------------------------------------
128 void wxRadioBox::Init()
130 m_selectedButton
= wxNOT_FOUND
;
131 m_radioButtons
= NULL
;
133 m_radioHeight
= NULL
;
136 bool wxRadioBox::Create(wxWindow
*parent
,
138 const wxString
& title
,
142 const wxString choices
[],
145 const wxValidator
& val
,
146 const wxString
& name
)
148 // common initialization
149 if ( !wxStaticBox::Create(parent
, id
, title
, pos
, size
, style
, name
) )
156 #endif // wxUSE_VALIDATORS/!wxUSE_VALIDATORS
158 m_radioButtons
= new wxSubwindows(n
);
159 m_radioWidth
= new int[n
];
160 m_radioHeight
= new int[n
];
162 for ( int i
= 0; i
< n
; i
++ )
165 m_radioHeight
[i
] = wxDefaultCoord
;
166 long styleBtn
= BS_AUTORADIOBUTTON
| WS_TABSTOP
| WS_CHILD
| WS_VISIBLE
;
168 styleBtn
|= WS_GROUP
;
170 long newId
= NewControlId();
172 HWND hwndBtn
= ::CreateWindow(_T("BUTTON"),
175 0, 0, 0, 0, // will be set in SetSize()
183 wxLogLastError(wxT("CreateWindow(radio btn)"));
188 (*m_radioButtons
)[i
] = hwndBtn
;
190 SubclassRadioButton((WXHWND
)hwndBtn
);
192 m_subControls
.Add(newId
);
195 // Create a dummy radio control to end the group.
196 (void)::CreateWindow(_T("BUTTON"),
198 WS_GROUP
| BS_AUTORADIOBUTTON
| WS_CHILD
,
199 0, 0, 0, 0, GetHwndOf(parent
),
200 (HMENU
)NewControlId(), wxGetInstance(), NULL
);
202 m_radioButtons
->SetFont(GetFont());
205 // Set the z-order correctly
206 SetWindowPos(GetHwnd(), HWND_BOTTOM
, 0, 0, 0, 0, SWP_NOMOVE
|SWP_NOSIZE
);
209 SetMajorDim(majorDim
== 0 ? n
: majorDim
, style
);
211 SetSize(pos
.x
, pos
.y
, size
.x
, size
.y
);
213 // Now that we have items determine what is the best size and set it.
214 SetInitialSize(size
);
219 bool wxRadioBox::Create(wxWindow
*parent
,
221 const wxString
& title
,
224 const wxArrayString
& choices
,
227 const wxValidator
& val
,
228 const wxString
& name
)
230 wxCArrayString
chs(choices
);
231 return Create(parent
, id
, title
, pos
, size
, chs
.GetCount(),
232 chs
.GetStrings(), majorDim
, style
, val
, name
);
235 wxRadioBox::~wxRadioBox()
237 m_isBeingDeleted
= true;
239 delete m_radioButtons
;
240 delete[] m_radioWidth
;
241 delete[] m_radioHeight
;
244 // NB: if this code is changed, wxGetWindowForHWND() which relies on having the
245 // radiobox pointer in GWL_USERDATA for radio buttons must be updated too!
246 void wxRadioBox::SubclassRadioButton(WXHWND hWndBtn
)
248 HWND hwndBtn
= (HWND
)hWndBtn
;
250 if ( !s_wndprocRadioBtn
)
251 s_wndprocRadioBtn
= (WXFARPROC
)wxGetWindowProc(hwndBtn
);
253 wxSetWindowProc(hwndBtn
, wxRadioBtnWndProc
);
254 wxSetWindowUserData(hwndBtn
, this);
257 // ----------------------------------------------------------------------------
259 // ----------------------------------------------------------------------------
261 bool wxRadioBox::MSWCommand(WXUINT cmd
, WXWORD id
)
263 if ( cmd
== BN_CLICKED
)
268 int selectedButton
= wxNOT_FOUND
;
270 const unsigned int count
= GetCount();
271 for ( unsigned int i
= 0; i
< count
; i
++ )
273 const HWND hwndBtn
= (*m_radioButtons
)[i
];
274 if ( id
== wxGetWindowId(hwndBtn
) )
276 // we can get BN_CLICKED for a button which just became focused
277 // but it may not be checked, in which case we shouldn't
278 // generate a radiobox selection changed event for it
279 if ( ::SendMessage(hwndBtn
, BM_GETCHECK
, 0, 0) == BST_CHECKED
)
286 if ( selectedButton
== wxNOT_FOUND
)
288 // just ignore it - due to a hack with WM_NCHITTEST handling in our
289 // wnd proc, we can receive dummy click messages when we click near
290 // the radiobox edge (this is ugly but Julian wouldn't let me get
295 if ( selectedButton
!= m_selectedButton
)
297 m_selectedButton
= selectedButton
;
299 SendNotificationEvent();
301 //else: don't generate events when the selection doesn't change
309 void wxRadioBox::Command(wxCommandEvent
& event
)
311 SetSelection (event
.GetInt());
313 ProcessCommand(event
);
316 void wxRadioBox::SendNotificationEvent()
318 wxCommandEvent
event(wxEVT_COMMAND_RADIOBOX_SELECTED
, m_windowId
);
319 event
.SetInt( m_selectedButton
);
320 event
.SetString(GetString(m_selectedButton
));
321 event
.SetEventObject( this );
322 ProcessCommand(event
);
325 // ----------------------------------------------------------------------------
327 // ----------------------------------------------------------------------------
329 unsigned int wxRadioBox::GetCount() const
331 return m_radioButtons
? m_radioButtons
->GetCount() : 0u;
334 void wxRadioBox::SetString(unsigned int item
, const wxString
& label
)
336 wxCHECK_RET( IsValid(item
), wxT("invalid radiobox index") );
339 m_radioHeight
[item
] = wxDefaultCoord
;
341 ::SetWindowText((*m_radioButtons
)[item
], label
.c_str());
343 InvalidateBestSize();
346 void wxRadioBox::SetSelection(int N
)
348 wxCHECK_RET( IsValid(N
), wxT("invalid radiobox index") );
350 // unselect the old button
351 if ( m_selectedButton
!= wxNOT_FOUND
)
352 ::SendMessage((*m_radioButtons
)[m_selectedButton
], BM_SETCHECK
, 0, 0L);
354 // and select the new one
355 ::SendMessage((*m_radioButtons
)[N
], BM_SETCHECK
, 1, 0L);
357 m_selectedButton
= N
;
360 // Find string for position
361 wxString
wxRadioBox::GetString(unsigned int item
) const
363 wxCHECK_MSG( IsValid(item
), wxEmptyString
,
364 wxT("invalid radiobox index") );
366 return wxGetWindowText((*m_radioButtons
)[item
]);
369 void wxRadioBox::SetFocus()
371 if ( GetCount() > 0 )
373 ::SetFocus((*m_radioButtons
)[m_selectedButton
== wxNOT_FOUND
375 : m_selectedButton
]);
379 // Enable a specific button
380 bool wxRadioBox::Enable(unsigned int item
, bool enable
)
382 wxCHECK_MSG( IsValid(item
), false,
383 wxT("invalid item in wxRadioBox::Enable()") );
385 BOOL ret
= ::EnableWindow((*m_radioButtons
)[item
], enable
);
387 return (ret
== 0) != enable
;
390 bool wxRadioBox::IsItemEnabled(unsigned int item
) const
392 wxCHECK_MSG( IsValid(item
), false,
393 wxT("invalid item in wxRadioBox::IsItemEnabled()") );
395 return ::IsWindowEnabled((*m_radioButtons
)[item
]) != 0;
398 // Show a specific button
399 bool wxRadioBox::Show(unsigned int item
, bool show
)
401 wxCHECK_MSG( IsValid(item
), false,
402 wxT("invalid item in wxRadioBox::Show()") );
404 BOOL ret
= ::ShowWindow((*m_radioButtons
)[item
], show
? SW_SHOW
: SW_HIDE
);
406 bool changed
= (ret
!= 0) != show
;
409 InvalidateBestSize();
415 bool wxRadioBox::IsItemShown(unsigned int item
) const
417 wxCHECK_MSG( IsValid(item
), false,
418 wxT("invalid item in wxRadioBox::IsItemShown()") );
420 // don't use IsWindowVisible() here because it would return false if the
421 // radiobox itself is hidden while we want to only return false if this
422 // button specifically is hidden
423 return (::GetWindowLong((*m_radioButtons
)[item
],
424 GWL_STYLE
) & WS_VISIBLE
) != 0;
429 bool wxRadioBox::HasToolTips() const
431 return wxStaticBox::HasToolTips() || wxRadioBoxBase::HasItemToolTips();
434 void wxRadioBox::DoSetItemToolTip(unsigned int item
, wxToolTip
*tooltip
)
436 // we have already checked for the item to be valid in wxRadioBoxBase
437 const HWND hwndRbtn
= (*m_radioButtons
)[item
];
438 if ( tooltip
!= NULL
)
439 tooltip
->Add(hwndRbtn
);
440 else // unset the tooltip
441 wxToolTip::Remove(hwndRbtn
);
444 #endif // wxUSE_TOOLTIPS
446 WX_FORWARD_STD_METHODS_TO_SUBWINDOWS(wxRadioBox
, wxStaticBox
, m_radioButtons
)
448 // ----------------------------------------------------------------------------
450 // ----------------------------------------------------------------------------
452 wxSize
wxRadioBox::GetMaxButtonSize() const
454 // calculate the max button size
457 const unsigned int count
= GetCount();
458 for ( unsigned int i
= 0 ; i
< count
; i
++ )
461 if ( m_radioWidth
[i
] < 0 )
463 GetTextExtent(wxGetWindowText((*m_radioButtons
)[i
]), &width
, &height
);
465 // adjust the size to take into account the radio box itself
466 // FIXME this is totally bogus!
473 width
= m_radioWidth
[i
];
474 height
= m_radioHeight
[i
];
477 if ( widthMax
< width
)
479 if ( heightMax
< height
)
483 return wxSize(widthMax
, heightMax
);
486 wxSize
wxRadioBox::GetTotalButtonSize(const wxSize
& sizeBtn
) const
488 // the radiobox should be big enough for its buttons
490 wxGetCharSize(m_hWnd
, &cx1
, &cy1
, GetFont());
492 int extraHeight
= cy1
;
494 int height
= GetRowCount() * sizeBtn
.y
+ cy1
/2 + extraHeight
;
495 int width
= GetColumnCount() * (sizeBtn
.x
+ cx1
) + cx1
;
497 // Add extra space under the label, if it exists.
498 if (!wxControl::GetLabel().empty())
501 // and also wide enough for its label
503 GetTextExtent(GetLabelText(), &widthLabel
, NULL
);
504 widthLabel
+= RADIO_SIZE
; // FIXME this is bogus too
505 if ( widthLabel
> width
)
508 return wxSize(width
, height
);
511 wxSize
wxRadioBox::DoGetBestSize() const
513 if ( !m_radioButtons
)
515 // if we're not fully initialized yet, we can't meaningfully compute
516 // our best size, we'll do it later
520 wxSize best
= GetTotalButtonSize(GetMaxButtonSize());
525 // Restored old code.
526 void wxRadioBox::DoSetSize(int x
, int y
, int width
, int height
, int sizeFlags
)
528 int currentX
, currentY
;
529 GetPosition(¤tX
, ¤tY
);
530 int widthOld
, heightOld
;
531 GetSize(&widthOld
, &heightOld
);
536 if (x
== wxDefaultCoord
&& !(sizeFlags
& wxSIZE_ALLOW_MINUS_ONE
))
538 if (y
== wxDefaultCoord
&& !(sizeFlags
& wxSIZE_ALLOW_MINUS_ONE
))
545 wxGetCharSize(m_hWnd
, &cx1
, &cy1
, GetFont());
547 // Attempt to have a look coherent with other platforms: We compute the
548 // biggest toggle dim, then we align all items according this value.
549 wxSize maxSize
= GetMaxButtonSize();
550 int maxWidth
= maxSize
.x
,
551 maxHeight
= maxSize
.y
;
553 wxSize totSize
= GetTotalButtonSize(maxSize
);
554 int totWidth
= totSize
.x
,
555 totHeight
= totSize
.y
;
557 // only change our width/height if asked for
558 if ( width
== wxDefaultCoord
)
560 if ( sizeFlags
& wxSIZE_AUTO_WIDTH
)
566 if ( height
== wxDefaultCoord
)
568 if ( sizeFlags
& wxSIZE_AUTO_HEIGHT
)
574 DoMoveWindow(xx
, yy
, width
, height
);
576 // Now position all the buttons: the current button will be put at
577 // wxPoint(x_offset, y_offset) and the new row/column will start at
578 // startX/startY. The size of all buttons will be the same wxSize(maxWidth,
579 // maxHeight) except for the buttons in the last column which should extend
580 // to the right border of radiobox and thus can be wider than this.
582 // Also, remember that wxRA_SPECIFY_COLS means that we arrange buttons in
583 // left to right order and GetMajorDim() is the number of columns while
584 // wxRA_SPECIFY_ROWS means that the buttons are arranged top to bottom and
585 // GetMajorDim() is the number of rows.
590 // Add extra space under the label, if it exists.
591 if (!wxControl::GetLabel().empty())
594 int startX
= x_offset
;
595 int startY
= y_offset
;
597 const unsigned int count
= GetCount();
598 for (unsigned int i
= 0; i
< count
; i
++)
600 // the last button in the row may be wider than the other ones as the
601 // radiobox may be wider than the sum of the button widths (as it
602 // happens, for example, when the radiobox label is very long)
604 if ( m_windowStyle
& wxRA_SPECIFY_COLS
)
606 // item is the last in its row if it is a multiple of the number of
607 // columns or if it is just the last item
608 unsigned int n
= i
+ 1;
609 isLastInTheRow
= ((n
% GetMajorDim()) == 0) || (n
== count
);
611 else // wxRA_SPECIFY_ROWS
613 // item is the last in the row if it is in the last columns
614 isLastInTheRow
= i
>= (count
/GetMajorDim())*GetMajorDim();
617 // is this the start of new row/column?
618 if ( i
&& (i
% GetMajorDim() == 0) )
620 if ( m_windowStyle
& wxRA_SPECIFY_ROWS
)
622 // start of new column
624 x_offset
+= maxWidth
+ cx1
;
626 else // start of new row
629 y_offset
+= maxHeight
;
630 if (m_radioWidth
[0]>0)
636 if ( isLastInTheRow
)
638 // make the button go to the end of radio box
639 widthBtn
= startX
+ width
- x_offset
- 2*cx1
;
640 if ( widthBtn
< maxWidth
)
645 // normal button, always of the same size
649 // make all buttons of the same, maximal size - like this they cover
650 // the radiobox entirely and the radiobox tooltips are always shown
651 // (otherwise they are not when the mouse pointer is in the radiobox
652 // part not belonging to any radiobutton)
653 DoMoveSibling((*m_radioButtons
)[i
], x_offset
, y_offset
, widthBtn
, maxHeight
);
655 // where do we put the next button?
656 if ( m_windowStyle
& wxRA_SPECIFY_ROWS
)
659 y_offset
+= maxHeight
;
660 if (m_radioWidth
[0]>0)
665 // to the right of this one
666 x_offset
+= widthBtn
+ cx1
;
671 int wxRadioBox::GetItemFromPoint(const wxPoint
& pt
) const
673 const unsigned int count
= GetCount();
674 for ( unsigned int i
= 0; i
< count
; i
++ )
676 RECT rect
= wxGetWindowRect((*m_radioButtons
)[i
]);
678 if ( rect
.left
<= pt
.x
&& pt
.x
< rect
.right
&&
679 rect
.top
<= pt
.y
&& pt
.y
< rect
.bottom
)
688 // ----------------------------------------------------------------------------
690 // ----------------------------------------------------------------------------
694 WXHRGN
wxRadioBox::MSWGetRegionWithoutChildren()
697 ::GetWindowRect(GetHwnd(), &rc
);
698 HRGN hrgn
= ::CreateRectRgn(rc
.left
, rc
.top
, rc
.right
+ 1, rc
.bottom
+ 1);
700 const unsigned int count
= GetCount();
701 for ( unsigned int i
= 0; i
< count
; ++i
)
703 // don't clip out hidden children
704 if ( !IsItemShown(i
) )
707 ::GetWindowRect((*m_radioButtons
)[i
], &rc
);
708 AutoHRGN
hrgnchild(::CreateRectRgnIndirect(&rc
));
709 ::CombineRgn(hrgn
, hrgn
, hrgnchild
, RGN_DIFF
);
715 #endif // __WXWINCE__
717 // ---------------------------------------------------------------------------
718 // window proc for radio buttons
719 // ---------------------------------------------------------------------------
721 LRESULT APIENTRY _EXPORT
wxRadioBtnWndProc(HWND hwnd
,
729 // we must tell IsDialogMessage()/our kbd processing code that we
730 // want to process arrows ourselves because neither of them is
731 // smart enough to handle arrows properly for us
733 long lDlgCode
= ::CallWindowProc(CASTWNDPROC s_wndprocRadioBtn
, hwnd
,
734 message
, wParam
, lParam
);
736 return lDlgCode
| DLGC_WANTARROWS
;
741 wxRadioBox
*radiobox
= (wxRadioBox
*)wxGetWindowUserData(hwnd
);
743 wxCHECK_MSG( radiobox
, 0, wxT("radio button without radio box?") );
745 bool processed
= true;
769 // just to suppress the compiler warning
775 int selOld
= radiobox
->GetSelection();
776 int selNew
= radiobox
->GetNextItem
780 radiobox
->GetWindowStyle()
783 if ( selNew
!= selOld
)
785 radiobox
->SetSelection(selNew
);
786 radiobox
->SetFocus();
788 // emulate the button click
789 radiobox
->SendNotificationEvent();
800 wxRadioBox
*radiobox
= (wxRadioBox
*)wxGetWindowUserData(hwnd
);
802 wxCHECK_MSG( radiobox
, 0, wxT("radio button without radio box?") );
804 // if we don't do this, no focus events are generated for the
805 // radiobox and, besides, we need to notify the parent about
806 // the focus change, otherwise the focus handling logic in
807 // wxControlContainer doesn't work
808 if ( message
== WM_SETFOCUS
)
809 radiobox
->HandleSetFocus((WXHWND
)wParam
);
811 radiobox
->HandleKillFocus((WXHWND
)wParam
);
818 wxRadioBox
*radiobox
= (wxRadioBox
*)wxGetWindowUserData(hwnd
);
820 wxCHECK_MSG( radiobox
, 0, wxT("radio button without radio box?") );
822 bool processed
= false;
824 wxEvtHandler
* const handler
= radiobox
->GetEventHandler();
826 HELPINFO
* info
= (HELPINFO
*) lParam
;
827 if ( info
->iContextType
== HELPINFO_WINDOW
)
829 for ( wxWindow
* subjectOfHelp
= radiobox
;
831 subjectOfHelp
= subjectOfHelp
->GetParent() )
833 wxHelpEvent
helpEvent(wxEVT_HELP
,
834 subjectOfHelp
->GetId(),
835 wxPoint(info
->MousePos
.x
,
837 helpEvent
.SetEventObject(radiobox
);
838 if ( handler
->ProcessEvent(helpEvent
) )
845 else if (info
->iContextType
== HELPINFO_MENUITEM
)
847 wxHelpEvent
helpEvent(wxEVT_HELP
, info
->iCtrlId
);
848 helpEvent
.SetEventObject(radiobox
);
849 processed
= handler
->ProcessEvent(helpEvent
);
856 #endif // !__WXWINCE__
859 return ::CallWindowProc(CASTWNDPROC s_wndprocRadioBtn
, hwnd
, message
, wParam
, lParam
);
862 #endif // wxUSE_RADIOBOX