1 ///////////////////////////////////////////////////////////////////////////////
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin (owner drawn stuff)
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows license
10 ///////////////////////////////////////////////////////////////////////////////
13 #pragma implementation "listbox.h"
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
24 #include "wx/listbox.h"
25 #include "wx/settings.h"
28 #include "wx/msw/private.h"
34 #include <wx/msw/gnuwin32/extra.h>
42 #include "wx/ownerdrw.h"
45 #include "wx/dynarray.h"
48 #if !USE_SHARED_LIBRARY
49 IMPLEMENT_DYNAMIC_CLASS(wxListBox
, wxControl
)
52 // ============================================================================
53 // list box item declaration and implementation
54 // ============================================================================
58 class wxListBoxItem
: public wxOwnerDrawn
61 wxListBoxItem(const wxString
& str
= "");
64 wxListBoxItem::wxListBoxItem(const wxString
& str
) : wxOwnerDrawn(str
, FALSE
)
66 // no bitmaps/checkmarks
70 wxOwnerDrawn
*wxListBox::CreateItem(size_t n
)
72 return new wxListBoxItem();
75 #endif //USE_OWNER_DRAWN
77 // ============================================================================
78 // list box control implementation
79 // ============================================================================
81 // this macro is dangerous but still better than tons of (HWND)GetHWND()
82 #define hwnd (HWND)GetHWND()
84 bool wxListBox::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
87 if (param == LBN_SELCANCEL)
89 event.extraLong = FALSE;
92 if (param
== LBN_SELCHANGE
)
94 wxCommandEvent
event(wxEVT_COMMAND_LISTBOX_SELECTED
, m_windowId
);
95 wxArrayInt aSelections
;
96 int count
= GetSelections(aSelections
);
99 event
.m_commandInt
= aSelections
[0] ;
100 event
.m_clientData
= GetClientData(event
.m_commandInt
);
101 wxString
str(GetString(event
.m_commandInt
));
103 event
.m_commandString
= copystring((char *)(const char *)str
);
107 event
.m_commandInt
= -1 ;
108 event
.m_commandString
= copystring("") ;
111 event
.SetEventObject( this );
112 ProcessCommand(event
);
113 if (event
.m_commandString
)
114 delete[] event
.m_commandString
;
117 else if (param
== LBN_DBLCLK
)
119 wxCommandEvent
event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, m_windowId
);
120 event
.SetEventObject( this );
121 GetEventHandler()->ProcessEvent(event
) ;
125 #if WXWIN_COMPATIBILITY
126 wxWindow *parent = (wxWindow *)GetParent();
128 parent->GetEventHandler()->OnDefaultAction(this);
138 wxListBox::wxListBox(void)
144 bool wxListBox::Create(wxWindow
*parent
, wxWindowID id
,
147 int n
, const wxString choices
[],
149 const wxValidator
& validator
,
150 const wxString
& name
)
157 SetValidator(validator
);
159 if (parent
) parent
->AddChild(this);
161 wxSystemSettings settings
;
162 SetBackgroundColour(settings
.GetSystemColour(wxSYS_COLOUR_WINDOW
));
163 SetForegroundColour(parent
->GetForegroundColour());
165 m_windowId
= ( id
== -1 ) ? (int)NewControlId() : id
;
171 m_windowStyle
= style
;
173 DWORD wstyle
= WS_VSCROLL
| WS_TABSTOP
| LBS_NOTIFY
| LBS_HASSTRINGS
;
174 if (m_windowStyle
& wxLB_MULTIPLE
)
175 wstyle
|= LBS_MULTIPLESEL
;
176 else if (m_windowStyle
& wxLB_EXTENDED
)
177 wstyle
|= LBS_EXTENDEDSEL
;
179 if (m_windowStyle
& wxLB_ALWAYS_SB
)
180 wstyle
|= LBS_DISABLENOSCROLL
;
181 if (m_windowStyle
& wxLB_HSCROLL
)
182 wstyle
|= WS_HSCROLL
;
183 if (m_windowStyle
& wxLB_SORT
)
186 #if wxUSE_OWNER_DRAWN
187 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
188 // we don't support LBS_OWNERDRAWVARIABLE yet
189 wstyle
|= LBS_OWNERDRAWFIXED
;
192 // Without this style, you get unexpected heights, so e.g. constraint layout
193 // doesn't work properly
194 wstyle
|= LBS_NOINTEGRALHEIGHT
;
197 WXDWORD exStyle
= Determine3DEffects(WS_EX_CLIENTEDGE
, &want3D
) ;
199 // Even with extended styles, need to combine with WS_BORDER
200 // for them to look right.
201 if ( want3D
|| wxStyleHasBorder(m_windowStyle
) )
206 m_hWnd
= (WXHWND
)::CreateWindowEx(exStyle
, "LISTBOX", NULL
,
209 (HWND
)parent
->GetHWND(), (HMENU
)m_windowId
,
210 wxGetInstance(), NULL
);
212 wxCHECK_MSG( m_hWnd
, FALSE
, "Failed to create listbox" );
217 Ctl3dSubclassCtl(hwnd
);
222 // Subclass again to catch messages
226 for (ui
= 0; ui
< (size_t)n
; ui
++) {
230 /* Not needed -- done in Append
231 #if wxUSE_OWNER_DRAWN
232 if ( m_windowStyle & wxLB_OWNERDRAW ) {
233 for (ui = 0; ui < (size_t)n; ui++) {
234 // create new item which will process WM_{DRAW|MEASURE}ITEM messages
235 wxOwnerDrawn *pNewItem = CreateItem(ui);
236 pNewItem->SetName(choices[ui]);
237 m_aItems.Add(pNewItem);
238 ListBox_SetItemData(hwnd, ui, pNewItem);
244 if ( (m_windowStyle
& wxLB_MULTIPLE
) == 0 )
245 SendMessage(hwnd
, LB_SETCURSEL
, 0, 0);
247 SetFont(parent
->GetFont());
249 SetSize(x
, y
, width
, height
);
256 wxListBox::~wxListBox(void)
258 #if wxUSE_OWNER_DRAWN
259 size_t uiCount
= m_aItems
.Count();
260 while ( uiCount
-- != 0 ) {
261 delete m_aItems
[uiCount
];
266 void wxListBox::SetupColours(void)
268 SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW
));
269 SetForegroundColour(GetParent()->GetForegroundColour());
272 void wxListBox::SetFirstItem(int N
)
274 SendMessage(hwnd
,LB_SETTOPINDEX
,(WPARAM
)N
,(LPARAM
)0) ;
277 void wxListBox::SetFirstItem(const wxString
& s
)
279 int N
= FindString(s
) ;
285 void wxListBox::Delete(int N
)
287 SendMessage(hwnd
, LB_DELETESTRING
, N
, 0);
289 SetHorizontalExtent("");
292 void wxListBox::Append(const wxString
& item
)
294 int index
= ListBox_AddString(hwnd
, item
);
297 #if wxUSE_OWNER_DRAWN
298 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
299 wxOwnerDrawn
*pNewItem
= CreateItem(index
); // dummy argument
300 pNewItem
->SetName(item
);
301 m_aItems
.Add(pNewItem
);
302 ListBox_SetItemData(hwnd
, index
, pNewItem
);
306 SetHorizontalExtent(item
);
309 void wxListBox::Append(const wxString
& item
, char *Client_data
)
311 int index
= ListBox_AddString(hwnd
, item
);
314 #if wxUSE_OWNER_DRAWN
315 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
316 // client data must be pointer to wxOwnerDrawn, otherwise we would crash
317 // in OnMeasure/OnDraw.
318 wxFAIL_MSG("Can't use client data with owner-drawn listboxes");
322 ListBox_SetItemData(hwnd
, index
, Client_data
);
324 SetHorizontalExtent(item
);
327 void wxListBox::Set(int n
, const wxString
*choices
, char** clientData
)
329 ShowWindow(hwnd
, SW_HIDE
);
330 ListBox_ResetContent(hwnd
);
332 for (i
= 0; i
< n
; i
++)
334 ListBox_AddString(hwnd
, choices
[i
]);
336 ListBox_SetItemData(hwnd
, i
, clientData
[i
]);
340 #if wxUSE_OWNER_DRAWN
341 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
342 // first delete old items
343 size_t ui
= m_aItems
.Count();
344 while ( ui
-- != 0 ) {
349 // then create new ones
350 for (ui
= 0; ui
< (size_t)n
; ui
++) {
351 wxOwnerDrawn
*pNewItem
= CreateItem(ui
);
352 pNewItem
->SetName(choices
[ui
]);
353 m_aItems
.Add(pNewItem
);
354 ListBox_SetItemData(hwnd
, ui
, pNewItem
);
356 wxASSERT_MSG(clientData
[ui
] == NULL
,
357 "Can't use client data with owner-drawn listboxes");
362 SetHorizontalExtent("");
363 ShowWindow(hwnd
, SW_SHOW
);
366 int wxListBox::FindString(const wxString
& s
) const
368 int pos
= ListBox_FindStringExact(hwnd
, (WPARAM
)-1, s
);
375 void wxListBox::Clear(void)
377 ListBox_ResetContent(hwnd
);
380 ListBox_GetHorizontalExtent(hwnd
);
383 void wxListBox::SetSelection(int N
, bool select
)
385 if ((m_windowStyle
& wxLB_MULTIPLE
) || (m_windowStyle
& wxLB_EXTENDED
))
386 SendMessage(hwnd
, LB_SETSEL
, select
, N
);
392 SendMessage(hwnd
, LB_SETCURSEL
, N1
, 0);
396 bool wxListBox::Selected(int N
) const
398 return SendMessage(hwnd
, LB_GETSEL
, N
, 0) == 0 ? FALSE
: TRUE
;
401 void wxListBox::Deselect(int N
)
403 if ((m_windowStyle
& wxLB_MULTIPLE
) || (m_windowStyle
& wxLB_EXTENDED
))
404 SendMessage(hwnd
, LB_SETSEL
, FALSE
, N
);
407 char *wxListBox::GetClientData(int N
) const
409 return (char *)SendMessage(hwnd
, LB_GETITEMDATA
, N
, 0);
412 void wxListBox::SetClientData(int N
, char *Client_data
)
414 if ( ListBox_SetItemData(hwnd
, N
, Client_data
) == LB_ERR
)
415 wxLogDebug("LB_SETITEMDATA failed");
418 // Return number of selections and an array of selected integers
419 int wxListBox::GetSelections(wxArrayInt
& aSelections
) const
423 if ((m_windowStyle
& wxLB_MULTIPLE
) || (m_windowStyle
& wxLB_EXTENDED
))
425 int no_sel
= ListBox_GetSelCount(hwnd
);
427 int *selections
= new int[no_sel
];
428 if ( ListBox_GetSelItems(hwnd
, no_sel
, selections
) == LB_ERR
) {
429 wxFAIL_MSG("This listbox can't have single-selection style!");
432 aSelections
.Alloc(no_sel
);
433 for ( int n
= 0; n
< no_sel
; n
++ )
434 aSelections
.Add(selections
[n
]);
436 delete [] selections
;
441 else // single-selection listbox
443 aSelections
.Add(ListBox_GetCurSel(hwnd
));
449 // Get single selection, for single choice list items
450 int wxListBox::GetSelection() const
452 wxCHECK_MSG( !(m_windowStyle
& wxLB_MULTIPLE
) &&
453 !(m_windowStyle
& wxLB_EXTENDED
),
455 "GetSelection() can't be used with multiple-selection "
456 "listboxes, use GetSelections() instead." );
458 return ListBox_GetCurSel(hwnd
);
461 // Find string for position
462 wxString
wxListBox::GetString(int N
) const
464 if (N
< 0 || N
> m_noItems
)
467 int len
= (int)SendMessage(hwnd
, LB_GETTEXT
, N
, (LONG
)wxBuffer
);
469 return wxString(wxBuffer
);
472 void wxListBox::SetSize(int x
, int y
, int width
, int height
, int sizeFlags
)
474 int currentX
, currentY
;
475 GetPosition(¤tX
, ¤tY
);
482 if (x
== -1 || (sizeFlags
& wxSIZE_ALLOW_MINUS_ONE
))
484 if (y
== -1 || (sizeFlags
& wxSIZE_ALLOW_MINUS_ONE
))
487 AdjustForParentClientOrigin(x1
, y1
, sizeFlags
);
489 // If we're prepared to use the existing size, then...
490 if (width
== -1 && height
== -1 && ((sizeFlags
& wxSIZE_AUTO
) != wxSIZE_AUTO
))
495 int cx
; // button font dimensions
498 wxGetCharSize(GetHWND(), &cx
, &cy
, & GetFont());
500 float control_width
, control_height
, control_x
, control_y
;
502 // Deal with default size (using -1 values)
504 w1
= DEFAULT_ITEM_WIDTH
;
507 h1
= DEFAULT_ITEM_HEIGHT
;
509 control_x
= (float)x1
;
510 control_y
= (float)y1
;
511 control_width
= (float)w1
;
512 control_height
= (float)h1
;
514 // Calculations may have made size too small
515 if (control_height
<= 0)
516 control_height
= (float)DEFAULT_ITEM_HEIGHT
;
518 if (control_width
<= 0)
519 control_width
= (float)DEFAULT_ITEM_WIDTH
;
521 // wxDebugMsg("About to set the listbox height to %d", (int)control_height);
522 MoveWindow(hwnd
, (int)control_x
, (int)control_y
,
523 (int)control_width
, (int)control_height
, TRUE
);
527 // Windows-specific code to set the horizontal extent of
528 // the listbox, if necessary. If s is non-NULL, it's
529 // used to calculate the horizontal extent.
530 // Otherwise, all strings are used.
531 void wxListBox::SetHorizontalExtent(const wxString
& s
)
533 // Only necessary if we want a horizontal scrollbar
534 if (!(m_windowStyle
& wxHSCROLL
))
536 TEXTMETRIC lpTextMetric
;
540 int existingExtent
= (int)SendMessage(hwnd
, LB_GETHORIZONTALEXTENT
, 0, 0L);
541 HDC dc
= GetWindowDC(hwnd
);
543 if (GetFont().Ok() && GetFont().GetResourceHandle())
544 oldFont
= (HFONT
) ::SelectObject(dc
, (HFONT
) GetFont().GetResourceHandle());
546 GetTextMetrics(dc
, &lpTextMetric
);
548 ::GetTextExtentPoint(dc
, (LPSTR
) (const char *)s
, s
.Length(), &extentXY
);
549 int extentX
= (int)(extentXY
.cx
+ lpTextMetric
.tmAveCharWidth
);
552 ::SelectObject(dc
, oldFont
);
555 if (extentX
> existingExtent
)
556 SendMessage(hwnd
, LB_SETHORIZONTALEXTENT
, LOWORD(extentX
), 0L);
561 int largestExtent
= 0;
562 HDC dc
= GetWindowDC(hwnd
);
564 if (GetFont().Ok() && GetFont().GetResourceHandle())
565 oldFont
= (HFONT
) ::SelectObject(dc
, (HFONT
) GetFont().GetResourceHandle());
567 GetTextMetrics(dc
, &lpTextMetric
);
569 for (i
= 0; i
< m_noItems
; i
++)
571 int len
= (int)SendMessage(hwnd
, LB_GETTEXT
, i
, (LONG
)wxBuffer
);
574 ::GetTextExtentPoint(dc
, (LPSTR
)wxBuffer
, len
, &extentXY
);
575 int extentX
= (int)(extentXY
.cx
+ lpTextMetric
.tmAveCharWidth
);
576 if (extentX
> largestExtent
)
577 largestExtent
= extentX
;
580 ::SelectObject(dc
, oldFont
);
583 SendMessage(hwnd
, LB_SETHORIZONTALEXTENT
, LOWORD(largestExtent
), 0L);
588 wxListBox::InsertItems(int nItems
, const wxString items
[], int pos
)
591 for (i
= 0; i
< nItems
; i
++)
592 ListBox_InsertString(hwnd
, i
+ pos
, items
[i
]);
595 #if wxUSE_OWNER_DRAWN
596 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
597 for ( i
= 0; i
< nItems
; i
++ ) {
598 wxOwnerDrawn
*pNewItem
= CreateItem((size_t)(pos
+ i
));
599 pNewItem
->SetName(items
[i
]);
600 m_aItems
.Insert(pNewItem
, (size_t)(pos
+ i
));
601 ListBox_SetItemData(hwnd
, i
, pNewItem
);
606 SetHorizontalExtent("");
609 void wxListBox::SetString(int N
, const wxString
& s
)
612 if (!(m_windowStyle
& wxLB_MULTIPLE
) && !(m_windowStyle
& wxLB_EXTENDED
))
613 sel
= GetSelection();
615 char *oldData
= (char *)wxListBox::GetClientData(N
);
617 SendMessage(hwnd
, LB_DELETESTRING
, N
, 0);
620 if (N
== (m_noItems
- 1))
623 SendMessage(hwnd
, LB_INSERTSTRING
, newN
, (LPARAM
) (const char *)s
);
625 wxListBox::SetClientData(N
, oldData
);
627 // Selection may have changed
631 #if wxUSE_OWNER_DRAWN
632 if ( m_windowStyle
& wxLB_OWNERDRAW
)
633 // update item's text
634 m_aItems
[N
]->SetName(s
);
635 #endif //USE_OWNER_DRAWN
638 int wxListBox::Number (void) const
643 // For single selection items only
644 wxString
wxListBox::GetStringSelection (void) const
646 int sel
= GetSelection ();
648 return this->GetString (sel
);
653 bool wxListBox::SetStringSelection (const wxString
& s
, bool flag
)
655 int sel
= FindString (s
);
658 SetSelection (sel
, flag
);
665 // Is this the right thing? Won't setselection generate a command
666 // event too? No! It'll just generate a setselection event.
667 // But we still can't have this being called whenever a real command
668 // is generated, because it sets the selection, which will already
669 // have been done! (Unless we have an optional argument for calling
670 // by the actual window system, or a separate function, ProcessCommand)
671 void wxListBox::Command (wxCommandEvent
& event
)
673 if (event
.m_extraLong
)
674 SetSelection (event
.m_commandInt
);
677 Deselect (event
.m_commandInt
);
680 ProcessCommand (event
);
683 WXHBRUSH
wxListBox::OnCtlColor(WXHDC pDC
, WXHWND pWnd
, WXUINT nCtlColor
,
684 WXUINT message
, WXWPARAM wParam
, WXLPARAM lParam
)
689 HBRUSH hbrush
= Ctl3dCtlColorEx(message
, wParam
, lParam
);
690 return (WXHBRUSH
) hbrush
;
694 if (GetParent()->GetTransparentBackground())
695 SetBkMode((HDC
) pDC
, TRANSPARENT
);
697 SetBkMode((HDC
) pDC
, OPAQUE
);
699 ::SetBkColor((HDC
) pDC
, RGB(GetBackgroundColour().Red(), GetBackgroundColour().Green(), GetBackgroundColour().Blue()));
700 ::SetTextColor((HDC
) pDC
, RGB(GetForegroundColour().Red(), GetForegroundColour().Green(), GetForegroundColour().Blue()));
702 wxBrush
*backgroundBrush
= wxTheBrushList
->FindOrCreateBrush(GetBackgroundColour(), wxSOLID
);
704 // Note that this will be cleaned up in wxApp::OnIdle, if backgroundBrush
705 // has a zero usage count.
706 backgroundBrush
->RealizeResource();
707 return (WXHBRUSH
) backgroundBrush
->GetResourceHandle();
710 long wxListBox::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
721 case WM_QUERYDRAGICON
:
725 case WM_RBUTTONDBLCLK
:
728 case WM_MBUTTONDBLCLK
:
731 case WM_LBUTTONDBLCLK
:
737 case WM_INITMENUPOPUP
:
742 case WM_CHAR
: // Always an ASCII character
747 case WM_CTLCOLORLISTBOX
:
748 case WM_CTLCOLORMSGBOX
:
749 case WM_CTLCOLORSCROLLBAR
:
750 case WM_CTLCOLORSTATIC
:
751 case WM_CTLCOLOREDIT
:
752 case WM_SYSCOLORCHANGE
:
756 case WM_QUERYENDSESSION
:
758 case WM_GETMINMAXINFO
:
760 return MSWDefWindowProc(nMsg
, wParam
, lParam
);
764 return wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
767 #if wxUSE_OWNER_DRAWN
772 // space beneath/above each row in pixels
773 // "standard" checklistbox use 1 here, some might prefer 2. 0 is ugly.
774 #define OWNER_DRAWN_LISTBOX_EXTRA_SPACE (1)
776 // the height is the same for all items
777 // ## should be changed for LBS_OWNERDRAWVARIABLE style listboxes
778 // NB: can't forward this to wxListBoxItem because LB_SETITEMDATA
779 // message is not yet sent when we get here!
780 bool wxListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT
*item
)
782 // only owner-drawn control should receive this message
783 wxCHECK( ((m_windowStyle
& wxLB_OWNERDRAW
) == wxLB_OWNERDRAW
), FALSE
);
785 MEASUREITEMSTRUCT
*pStruct
= (MEASUREITEMSTRUCT
*)item
;
788 dc
.SetHDC((WXHDC
)CreateIC("DISPLAY", NULL
, NULL
, 0));
789 dc
.SetFont(wxSystemSettings::GetSystemFont(wxSYS_ANSI_VAR_FONT
));
791 pStruct
->itemHeight
= dc
.GetCharHeight() + 2*OWNER_DRAWN_LISTBOX_EXTRA_SPACE
;
792 pStruct
->itemWidth
= dc
.GetCharWidth();
797 // forward the message to the appropriate item
798 bool wxListBox::MSWOnDraw(WXDRAWITEMSTRUCT
*item
)
800 // only owner-drawn control should receive this message
801 wxCHECK( ((m_windowStyle
& wxLB_OWNERDRAW
) == wxLB_OWNERDRAW
), FALSE
);
803 DRAWITEMSTRUCT
*pStruct
= (DRAWITEMSTRUCT
*)item
;
804 wxListBoxItem
*pItem
= (wxListBoxItem
*)SendMessage(hwnd
, LB_GETITEMDATA
,
807 wxCHECK( (int)pItem
!= LB_ERR
, FALSE
);
810 dc
.SetHDC((WXHDC
)pStruct
->hDC
, FALSE
);
811 wxRect
rect(pStruct
->rcItem
.left
, pStruct
->rcItem
.top
,
812 pStruct
->rcItem
.right
- pStruct
->rcItem
.left
,
813 pStruct
->rcItem
.bottom
- pStruct
->rcItem
.top
);
815 return pItem
->OnDrawItem(dc
, rect
,
816 (wxOwnerDrawn::wxODAction
)pStruct
->itemAction
,
817 (wxOwnerDrawn::wxODStatus
)pStruct
->itemState
);