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"
30 #include "wx/bitmap.h"
32 #include "wx/radiobox.h"
33 #include "wx/settings.h"
37 #include "wx/msw/subwin.h"
40 #if !defined(__GNUWIN32_OLD__) || defined(__CYGWIN10__)
43 #include "wx/tooltip.h"
44 #endif // wxUSE_TOOLTIPS
46 // TODO: wxCONSTRUCTOR
47 #if 0 // wxUSE_EXTENDED_RTTI
48 WX_DEFINE_FLAGS( wxRadioBoxStyle
)
50 wxBEGIN_FLAGS( wxRadioBoxStyle
)
51 // new style border flags, we put them first to
52 // use them for streaming out
53 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
54 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
55 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
56 wxFLAGS_MEMBER(wxBORDER_RAISED
)
57 wxFLAGS_MEMBER(wxBORDER_STATIC
)
58 wxFLAGS_MEMBER(wxBORDER_NONE
)
60 // old style border flags
61 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
62 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
63 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
64 wxFLAGS_MEMBER(wxRAISED_BORDER
)
65 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
66 wxFLAGS_MEMBER(wxBORDER
)
68 // standard window styles
69 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
70 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
71 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
72 wxFLAGS_MEMBER(wxWANTS_CHARS
)
73 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
74 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
75 wxFLAGS_MEMBER(wxVSCROLL
)
76 wxFLAGS_MEMBER(wxHSCROLL
)
78 wxFLAGS_MEMBER(wxRA_SPECIFY_COLS
)
79 wxFLAGS_MEMBER(wxRA_HORIZONTAL
)
80 wxFLAGS_MEMBER(wxRA_SPECIFY_ROWS
)
81 wxFLAGS_MEMBER(wxRA_VERTICAL
)
83 wxEND_FLAGS( wxRadioBoxStyle
)
85 IMPLEMENT_DYNAMIC_CLASS_XTI(wxRadioBox
, wxControl
,"wx/radiobox.h")
87 wxBEGIN_PROPERTIES_TABLE(wxRadioBox
)
88 wxEVENT_PROPERTY( Select
, wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
)
89 wxPROPERTY_FLAGS( WindowStyle
, wxRadioBoxStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
90 wxEND_PROPERTIES_TABLE()
93 IMPLEMENT_DYNAMIC_CLASS(wxRadioBox
, wxControl
)
104 // ---------------------------------------------------------------------------
106 // ---------------------------------------------------------------------------
108 // wnd proc for radio buttons
109 LRESULT APIENTRY _EXPORT
wxRadioBtnWndProc(HWND hWnd
,
114 // ---------------------------------------------------------------------------
116 // ---------------------------------------------------------------------------
118 // the pointer to standard radio button wnd proc
119 static WXFARPROC s_wndprocRadioBtn
= (WXFARPROC
)NULL
;
121 // ===========================================================================
123 // ===========================================================================
125 // ---------------------------------------------------------------------------
126 // wxRadioBox creation
127 // ---------------------------------------------------------------------------
130 void wxRadioBox::Init()
132 m_selectedButton
= wxNOT_FOUND
;
133 m_radioButtons
= NULL
;
135 m_radioHeight
= NULL
;
138 bool wxRadioBox::Create(wxWindow
*parent
,
140 const wxString
& title
,
144 const wxString choices
[],
147 const wxValidator
& val
,
148 const wxString
& name
)
150 // initialize members
151 SetMajorDim(majorDim
== 0 ? n
: majorDim
, style
);
153 // common initialization
154 if ( !wxStaticBox::Create(parent
, id
, title
, pos
, size
, style
, name
) )
161 #endif // wxUSE_VALIDATORS/!wxUSE_VALIDATORS
163 m_radioButtons
= new wxSubwindows(n
);
164 m_radioWidth
= new int[n
];
165 m_radioHeight
= new int[n
];
167 for ( int i
= 0; i
< n
; i
++ )
170 m_radioHeight
[i
] = wxDefaultCoord
;
171 long styleBtn
= BS_AUTORADIOBUTTON
| WS_TABSTOP
| WS_CHILD
| WS_VISIBLE
;
173 styleBtn
|= WS_GROUP
;
175 long newId
= NewControlId();
177 HWND hwndBtn
= ::CreateWindow(_T("BUTTON"),
180 0, 0, 0, 0, // will be set in SetSize()
188 wxLogLastError(wxT("CreateWindow(radio btn)"));
193 (*m_radioButtons
)[i
] = hwndBtn
;
195 SubclassRadioButton((WXHWND
)hwndBtn
);
197 m_subControls
.Add(newId
);
200 // Create a dummy radio control to end the group.
201 (void)::CreateWindow(_T("BUTTON"),
203 WS_GROUP
| BS_AUTORADIOBUTTON
| WS_CHILD
,
204 0, 0, 0, 0, GetHwnd(),
205 (HMENU
)NewControlId(), wxGetInstance(), NULL
);
207 m_radioButtons
->SetFont(GetFont());
210 // Set the z-order correctly
211 SetWindowPos(GetHwnd(), HWND_BOTTOM
, 0, 0, 0, 0, SWP_NOMOVE
|SWP_NOSIZE
);
215 SetSize(pos
.x
, pos
.y
, size
.x
, size
.y
);
217 // Now that we have items determine what is the best size and set it.
223 bool wxRadioBox::Create(wxWindow
*parent
,
225 const wxString
& title
,
228 const wxArrayString
& choices
,
231 const wxValidator
& val
,
232 const wxString
& name
)
234 wxCArrayString
chs(choices
);
235 return Create(parent
, id
, title
, pos
, size
, chs
.GetCount(),
236 chs
.GetStrings(), majorDim
, style
, val
, name
);
239 wxRadioBox::~wxRadioBox()
241 m_isBeingDeleted
= true;
243 delete m_radioButtons
;
244 delete[] m_radioWidth
;
245 delete[] m_radioHeight
;
248 // NB: if this code is changed, wxGetWindowForHWND() which relies on having the
249 // radiobox pointer in GWL_USERDATA for radio buttons must be updated too!
250 void wxRadioBox::SubclassRadioButton(WXHWND hWndBtn
)
252 HWND hwndBtn
= (HWND
)hWndBtn
;
254 if ( !s_wndprocRadioBtn
)
255 s_wndprocRadioBtn
= (WXFARPROC
)wxGetWindowProc(hwndBtn
);
257 wxSetWindowProc(hwndBtn
, wxRadioBtnWndProc
);
258 wxSetWindowUserData(hwndBtn
, this);
261 // ----------------------------------------------------------------------------
263 // ----------------------------------------------------------------------------
265 bool wxRadioBox::MSWCommand(WXUINT cmd
, WXWORD id
)
267 if ( cmd
== BN_CLICKED
)
272 int selectedButton
= wxNOT_FOUND
;
274 int count
= GetCount();
275 for ( int i
= 0; i
< count
; i
++ )
277 if ( id
== wxGetWindowId((*m_radioButtons
)[i
]) )
285 if ( selectedButton
== wxNOT_FOUND
)
287 // just ignore it - due to a hack with WM_NCHITTEST handling in our
288 // wnd proc, we can receive dummy click messages when we click near
289 // the radiobox edge (this is ugly but Julian wouldn't let me get
294 if ( selectedButton
!= m_selectedButton
)
296 m_selectedButton
= selectedButton
;
298 SendNotificationEvent();
300 //else: don't generate events when the selection doesn't change
308 void wxRadioBox::Command(wxCommandEvent
& event
)
310 SetSelection (event
.GetInt());
312 ProcessCommand(event
);
315 void wxRadioBox::SendNotificationEvent()
317 wxCommandEvent
event(wxEVT_COMMAND_RADIOBOX_SELECTED
, m_windowId
);
318 event
.SetInt( m_selectedButton
);
319 event
.SetString( GetString(m_selectedButton
) );
320 event
.SetEventObject( this );
321 ProcessCommand(event
);
324 // ----------------------------------------------------------------------------
326 // ----------------------------------------------------------------------------
328 int wxRadioBox::GetCount() const
330 return m_radioButtons
->GetCount();
333 void wxRadioBox::SetString(int item
, const wxString
& label
)
335 wxCHECK_RET( IsValid(item
), wxT("invalid radiobox index") );
338 m_radioHeight
[item
] = wxDefaultCoord
;
340 ::SetWindowText((*m_radioButtons
)[item
], label
.c_str());
342 InvalidateBestSize();
345 void wxRadioBox::SetSelection(int N
)
347 wxCHECK_RET( IsValid(N
), wxT("invalid radiobox index") );
349 // unselect the old button
350 if ( m_selectedButton
!= wxNOT_FOUND
)
351 ::SendMessage((*m_radioButtons
)[m_selectedButton
], BM_SETCHECK
, 0, 0L);
353 // and select the new one
354 ::SendMessage((*m_radioButtons
)[N
], BM_SETCHECK
, 1, 0L);
356 m_selectedButton
= N
;
359 // Find string for position
360 wxString
wxRadioBox::GetString(int item
) const
362 wxCHECK_MSG( IsValid(item
), wxEmptyString
,
363 wxT("invalid radiobox index") );
365 return wxGetWindowText((*m_radioButtons
)[item
]);
368 void wxRadioBox::SetFocus()
370 if ( GetCount() > 0 )
372 ::SetFocus((*m_radioButtons
)[m_selectedButton
== wxNOT_FOUND
374 : m_selectedButton
]);
378 // Enable a specific button
379 bool wxRadioBox::Enable(int item
, bool enable
)
381 wxCHECK_MSG( IsValid(item
), false,
382 wxT("invalid item in wxRadioBox::Enable()") );
384 BOOL ret
= ::EnableWindow((*m_radioButtons
)[item
], enable
);
386 return (ret
== 0) != enable
;
389 bool wxRadioBox::IsItemEnabled(int item
) const
391 wxCHECK_MSG( IsValid(item
), false,
392 wxT("invalid item in wxRadioBox::Enable()") );
394 return ::IsWindowEnabled((*m_radioButtons
)[item
]) != 0;
397 // Show a specific button
398 bool wxRadioBox::Show(int item
, bool show
)
400 wxCHECK_MSG( IsValid(item
), false,
401 wxT("invalid item in wxRadioBox::Show()") );
403 BOOL ret
= ::ShowWindow((*m_radioButtons
)[item
], show
? SW_SHOW
: SW_HIDE
);
405 bool changed
= (ret
!= 0) != show
;
408 InvalidateBestSize();
414 bool wxRadioBox::IsItemShown(int item
) const
416 wxCHECK_MSG( IsValid(item
), false,
417 wxT("invalid item in wxRadioBox::Enable()") );
419 // don't use IsWindowVisible() here because it would return false if the
420 // radiobox itself is hidden while we want to only return false if this
421 // button specifically is hidden
422 return (::GetWindowLong((*m_radioButtons
)[item
],
423 GWL_STYLE
) & WS_VISIBLE
) != 0;
426 WX_FORWARD_STD_METHODS_TO_SUBWINDOWS(wxRadioBox
, wxStaticBox
, m_radioButtons
)
428 // ----------------------------------------------------------------------------
430 // ----------------------------------------------------------------------------
432 wxSize
wxRadioBox::GetMaxButtonSize() const
434 // calculate the max button size
437 const int count
= GetCount();
438 for ( int i
= 0 ; i
< count
; i
++ )
441 if ( m_radioWidth
[i
] < 0 )
443 GetTextExtent(wxGetWindowText((*m_radioButtons
)[i
]), &width
, &height
);
445 // adjust the size to take into account the radio box itself
446 // FIXME this is totally bogus!
453 width
= m_radioWidth
[i
];
454 height
= m_radioHeight
[i
];
457 if ( widthMax
< width
)
459 if ( heightMax
< height
)
463 return wxSize(widthMax
, heightMax
);
466 wxSize
wxRadioBox::GetTotalButtonSize(const wxSize
& sizeBtn
) const
468 // the radiobox should be big enough for its buttons
470 wxGetCharSize(m_hWnd
, &cx1
, &cy1
, GetFont());
472 int extraHeight
= cy1
;
474 int height
= GetRowCount() * sizeBtn
.y
+ cy1
/2 + extraHeight
;
475 int width
= GetColumnCount() * (sizeBtn
.x
+ cx1
) + cx1
;
477 // Add extra space under the label, if it exists.
478 if (!wxControl::GetLabel().empty())
481 // and also wide enough for its label
483 GetTextExtent(GetLabel(), &widthLabel
, NULL
);
484 widthLabel
+= RADIO_SIZE
; // FIXME this is bogus too
485 if ( widthLabel
> width
)
488 return wxSize(width
, height
);
491 wxSize
wxRadioBox::DoGetBestSize() const
493 wxSize best
= GetTotalButtonSize(GetMaxButtonSize());
498 // Restored old code.
499 void wxRadioBox::DoSetSize(int x
, int y
, int width
, int height
, int sizeFlags
)
501 int currentX
, currentY
;
502 GetPosition(¤tX
, ¤tY
);
503 int widthOld
, heightOld
;
504 GetSize(&widthOld
, &heightOld
);
509 if (x
== wxDefaultCoord
&& !(sizeFlags
& wxSIZE_ALLOW_MINUS_ONE
))
511 if (y
== wxDefaultCoord
&& !(sizeFlags
& wxSIZE_ALLOW_MINUS_ONE
))
518 wxGetCharSize(m_hWnd
, &cx1
, &cy1
, GetFont());
520 // Attempt to have a look coherent with other platforms: We compute the
521 // biggest toggle dim, then we align all items according this value.
522 wxSize maxSize
= GetMaxButtonSize();
523 int maxWidth
= maxSize
.x
,
524 maxHeight
= maxSize
.y
;
526 wxSize totSize
= GetTotalButtonSize(maxSize
);
527 int totWidth
= totSize
.x
,
528 totHeight
= totSize
.y
;
530 // only change our width/height if asked for
531 if ( width
== wxDefaultCoord
)
533 if ( sizeFlags
& wxSIZE_AUTO_WIDTH
)
539 if ( height
== wxDefaultCoord
)
541 if ( sizeFlags
& wxSIZE_AUTO_HEIGHT
)
547 DoMoveWindow(xx
, yy
, width
, height
);
549 // Now position all the buttons: the current button will be put at
550 // wxPoint(x_offset, y_offset) and the new row/column will start at
551 // startX/startY. The size of all buttons will be the same wxSize(maxWidth,
552 // maxHeight) except for the buttons in the last column which should extend
553 // to the right border of radiobox and thus can be wider than this.
555 // Also, remember that wxRA_SPECIFY_COLS means that we arrange buttons in
556 // left to right order and GetMajorDim() is the number of columns while
557 // wxRA_SPECIFY_ROWS means that the buttons are arranged top to bottom and
558 // GetMajorDim() is the number of rows.
563 // Add extra space under the label, if it exists.
564 if (!wxControl::GetLabel().empty())
567 int startX
= x_offset
;
568 int startY
= y_offset
;
570 const int count
= GetCount();
571 for ( int i
= 0; i
< count
; i
++ )
573 // the last button in the row may be wider than the other ones as the
574 // radiobox may be wider than the sum of the button widths (as it
575 // happens, for example, when the radiobox label is very long)
577 if ( m_windowStyle
& wxRA_SPECIFY_COLS
)
579 // item is the last in its row if it is a multiple of the number of
580 // columns or if it is just the last item
582 isLastInTheRow
= ((n
% GetMajorDim()) == 0) || (n
== count
);
584 else // wxRA_SPECIFY_ROWS
586 // item is the last in the row if it is in the last columns
587 isLastInTheRow
= i
>= (count
/GetMajorDim())*GetMajorDim();
590 // is this the start of new row/column?
591 if ( i
&& (i
% GetMajorDim() == 0) )
593 if ( m_windowStyle
& wxRA_SPECIFY_ROWS
)
595 // start of new column
597 x_offset
+= maxWidth
+ cx1
;
599 else // start of new row
602 y_offset
+= maxHeight
;
603 if (m_radioWidth
[0]>0)
609 if ( isLastInTheRow
)
611 // make the button go to the end of radio box
612 widthBtn
= startX
+ width
- x_offset
- 2*cx1
;
613 if ( widthBtn
< maxWidth
)
618 // normal button, always of the same size
622 // make all buttons of the same, maximal size - like this they cover
623 // the radiobox entirely and the radiobox tooltips are always shown
624 // (otherwise they are not when the mouse pointer is in the radiobox
625 // part not belonging to any radiobutton)
626 ::MoveWindow((*m_radioButtons
)[i
],
627 x_offset
, y_offset
, widthBtn
, maxHeight
,
630 // where do we put the next button?
631 if ( m_windowStyle
& wxRA_SPECIFY_ROWS
)
634 y_offset
+= maxHeight
;
635 if (m_radioWidth
[0]>0)
640 // to the right of this one
641 x_offset
+= widthBtn
+ cx1
;
646 // ----------------------------------------------------------------------------
648 // ----------------------------------------------------------------------------
652 WXHRGN
wxRadioBox::MSWGetRegionWithoutChildren()
655 ::GetWindowRect(GetHwnd(), &rc
);
656 HRGN hrgn
= ::CreateRectRgn(rc
.left
, rc
.top
, rc
.right
+ 1, rc
.bottom
+ 1);
658 const size_t count
= GetCount();
659 for ( size_t i
= 0; i
< count
; ++i
)
661 // don't clip out hidden children
662 if ( !IsItemShown(i
) )
665 ::GetWindowRect((*m_radioButtons
)[i
], &rc
);
666 AutoHRGN
hrgnchild(::CreateRectRgnIndirect(&rc
));
667 ::CombineRgn(hrgn
, hrgn
, hrgnchild
, RGN_DIFF
);
674 wxRadioBox::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
676 // FIXME: Without this, the radiobox corrupts other controls as it moves
677 // in a dynamic layout. Refreshing causes flicker, but it's better than
678 // leaving droppings. Note that for some reason, wxStaticBox doesn't need
679 // this (perhaps because it has no real children?)
680 if ( nMsg
== WM_MOVE
)
682 WXLRESULT res
= wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
683 wxRect rect
= GetRect();
684 GetParent()->Refresh(true, & rect
);
688 return wxStaticBox::MSWWindowProc(nMsg
, wParam
, lParam
);
691 #endif // __WXWINCE__
693 // ---------------------------------------------------------------------------
694 // window proc for radio buttons
695 // ---------------------------------------------------------------------------
697 LRESULT APIENTRY _EXPORT
wxRadioBtnWndProc(HWND hwnd
,
705 // we must tell IsDialogMessage()/our kbd processing code that we
706 // want to process arrows ourselves because neither of them is
707 // smart enough to handle arrows properly for us
709 long lDlgCode
= ::CallWindowProc(CASTWNDPROC s_wndprocRadioBtn
, hwnd
,
710 message
, wParam
, lParam
);
712 return lDlgCode
| DLGC_WANTARROWS
;
718 NMHDR
* hdr
= (NMHDR
*)lParam
;
719 if ( hdr
->code
== TTN_NEEDTEXT
)
722 radiobox
= (wxRadioBox
*)wxGetWindowUserData(hwnd
);
724 wxCHECK_MSG( radiobox
, 0,
725 wxT("radio button without radio box?") );
727 wxToolTip
*tooltip
= radiobox
->GetToolTip();
730 TOOLTIPTEXT
*ttt
= (TOOLTIPTEXT
*)lParam
;
731 ttt
->lpszText
= (wxChar
*)tooltip
->GetTip().c_str();
739 #endif // wxUSE_TOOLTIPS
743 wxRadioBox
*radiobox
= (wxRadioBox
*)wxGetWindowUserData(hwnd
);
745 wxCHECK_MSG( radiobox
, 0, wxT("radio button without radio box?") );
747 bool processed
= true;
771 // just to suppress the compiler warning
777 int selOld
= radiobox
->GetSelection();
778 int selNew
= radiobox
->GetNextItem
782 radiobox
->GetWindowStyle()
785 if ( selNew
!= selOld
)
787 radiobox
->SetSelection(selNew
);
788 radiobox
->SetFocus();
790 // emulate the button click
791 radiobox
->SendNotificationEvent();
802 wxRadioBox
*radiobox
= (wxRadioBox
*)wxGetWindowUserData(hwnd
);
804 wxCHECK_MSG( radiobox
, 0, wxT("radio button without radio box?") );
806 // if we don't do this, no focus events are generated for the
807 // radiobox and, besides, we need to notify the parent about
808 // the focus change, otherwise the focus handling logic in
809 // wxControlContainer doesn't work
810 if ( message
== WM_SETFOCUS
)
811 radiobox
->HandleSetFocus((WXHWND
)wParam
);
813 radiobox
->HandleKillFocus((WXHWND
)wParam
);
820 wxRadioBox
*radiobox
= (wxRadioBox
*)wxGetWindowUserData(hwnd
);
822 wxCHECK_MSG( radiobox
, 0, wxT("radio button without radio box?") );
824 bool processed
= false;
826 wxEvtHandler
* const handler
= radiobox
->GetEventHandler();
828 HELPINFO
* info
= (HELPINFO
*) lParam
;
829 if ( info
->iContextType
== HELPINFO_WINDOW
)
831 for ( wxWindow
* subjectOfHelp
= radiobox
;
833 subjectOfHelp
= subjectOfHelp
->GetParent() )
835 wxHelpEvent
helpEvent(wxEVT_HELP
,
836 subjectOfHelp
->GetId(),
837 wxPoint(info
->MousePos
.x
,
839 helpEvent
.SetEventObject(radiobox
);
840 if ( handler
->ProcessEvent(helpEvent
) )
847 else if (info
->iContextType
== HELPINFO_MENUITEM
)
849 wxHelpEvent
helpEvent(wxEVT_HELP
, info
->iCtrlId
);
850 helpEvent
.SetEventObject(radiobox
);
851 processed
= handler
->ProcessEvent(helpEvent
);
858 #endif // !__WXWINCE__
861 return ::CallWindowProc(CASTWNDPROC s_wndprocRadioBtn
, hwnd
, message
, wParam
, lParam
);
864 #endif // wxUSE_RADIOBOX