]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/vlbox.cpp
initial native implementation of wxCalendarCtrl for MSW
[wxWidgets.git] / src / generic / vlbox.cpp
index e15de81c6a40a8b7284bc25b12ee8987ff711f92..f30f2d9db3827362c5037775f99968800e235253 100644 (file)
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        generic/vlbox.cpp
+// Name:        src/generic/vlbox.cpp
 // Purpose:     implementation of wxVListBox
 // Author:      Vadim Zeitlin
 // Modified by:
     #pragma hdrstop
 #endif
 
+#if wxUSE_LISTBOX
+
+#include "wx/vlbox.h"
+
 #ifndef WX_PRECOMP
     #include "wx/settings.h"
     #include "wx/dcclient.h"
+    #include "wx/listbox.h"
 #endif //WX_PRECOMP
 
-#include "wx/vlbox.h"
+#include "wx/dcbuffer.h"
 #include "wx/selstore.h"
+#include "wx/renderer.h"
 
 // ----------------------------------------------------------------------------
 // event tables
@@ -42,19 +48,25 @@ BEGIN_EVENT_TABLE(wxVListBox, wxVScrolledWindow)
     EVT_KEY_DOWN(wxVListBox::OnKeyDown)
     EVT_LEFT_DOWN(wxVListBox::OnLeftDown)
     EVT_LEFT_DCLICK(wxVListBox::OnLeftDClick)
+
+    EVT_SET_FOCUS(wxVListBox::OnSetOrKillFocus)
+    EVT_KILL_FOCUS(wxVListBox::OnSetOrKillFocus)
 END_EVENT_TABLE()
 
 // ============================================================================
 // implementation
 // ============================================================================
 
+IMPLEMENT_ABSTRACT_CLASS(wxVListBox, wxVScrolledWindow)
+
 // ----------------------------------------------------------------------------
 // wxVListBox creation
 // ----------------------------------------------------------------------------
 
 void wxVListBox::Init()
 {
-    m_current = wxNOT_FOUND;
+    m_current =
+    m_anchor = wxNOT_FOUND;
     m_selStore = NULL;
 }
 
@@ -65,14 +77,29 @@ bool wxVListBox::Create(wxWindow *parent,
                         long style,
                         const wxString& name)
 {
+#ifdef __WXMSW__
+       if ((style & wxBORDER_MASK) == wxDEFAULT)
+               style |= wxBORDER_THEME;
+#endif
+
+    style |= wxWANTS_CHARS | wxFULL_REPAINT_ON_RESIZE;
     if ( !wxVScrolledWindow::Create(parent, id, pos, size, style, name) )
         return false;
 
-    SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_LISTBOX));
-
     if ( style & wxLB_MULTIPLE )
         m_selStore = new wxSelectionStore;
 
+    // make sure the native widget has the right colour since we do
+    // transparent drawing by default
+    SetBackgroundColour(GetBackgroundColour());
+
+    // leave m_colBgSel in an invalid state: it means for OnDrawBackground()
+    // to use wxRendererNative instead of painting selection bg ourselves
+    m_colBgSel = wxNullColour;
+
+    // flicker-free drawing requires this
+    SetBackgroundStyle(wxBG_STYLE_CUSTOM);
+
     return true;
 }
 
@@ -89,7 +116,7 @@ void wxVListBox::SetItemCount(size_t count)
         m_selStore->SetItemCount(count);
     }
 
-    SetLineCount(count);
+    SetRowCount(count);
 }
 
 // ----------------------------------------------------------------------------
@@ -113,7 +140,7 @@ bool wxVListBox::Select(size_t item, bool select)
     if ( changed )
     {
         // selection really changed
-        RefreshLine(item);
+        RefreshRow(item);
     }
 
     DoSetCurrent(item);
@@ -142,7 +169,7 @@ bool wxVListBox::SelectRange(size_t from, size_t to)
     {
         // too many items have changed, we didn't record them in changed array
         // so we have no choice but to refresh everything between from and to
-        RefreshLines(from, to);
+        RefreshRows(from, to);
     }
     else // we've got the indices of the changed items
     {
@@ -156,7 +183,7 @@ bool wxVListBox::SelectRange(size_t from, size_t to)
         // refresh just the lines which have really changed
         for ( size_t n = 0; n < count; n++ )
         {
-            RefreshLine(changed[n]);
+            RefreshRow(changed[n]);
         }
     }
 
@@ -188,6 +215,10 @@ bool wxVListBox::DoSelectAll(bool select)
 
 bool wxVListBox::DoSetCurrent(int current)
 {
+    wxASSERT_MSG( current == wxNOT_FOUND ||
+                    (current >= 0 && (size_t)current < GetItemCount()),
+                  _T("wxVListBox::DoSetCurrent(): invalid item index") );
+
     if ( current == m_current )
     {
         // nothing to do
@@ -195,7 +226,7 @@ bool wxVListBox::DoSetCurrent(int current)
     }
 
     if ( m_current != wxNOT_FOUND )
-        RefreshLine(m_current);
+        RefreshRow(m_current);
 
     m_current = current;
 
@@ -205,20 +236,18 @@ bool wxVListBox::DoSetCurrent(int current)
         // don't need to refresh it -- it will be redrawn anyhow
         if ( !IsVisible(m_current) )
         {
-            ScrollToLine(m_current);
+            ScrollToRow(m_current);
         }
         else // line is at least partly visible
         {
             // it is, indeed, only partly visible, so scroll it into view to
             // make it entirely visible
-            if ( (size_t)m_current == GetLastVisibleLine() )
-            {
-                ScrollToLine(m_current);
-            }
+            while ( (size_t)m_current + 1 == GetVisibleRowsEnd() &&
+                    ScrollToRow(GetVisibleBegin() + 1) ) ;
 
             // but in any case refresh it as even if it was only partly visible
             // before we need to redraw it entirely as its background changed
-            RefreshLine(m_current);
+            RefreshRow(m_current);
         }
     }
 
@@ -232,15 +261,25 @@ void wxVListBox::SendSelectedEvent()
 
     wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, GetId());
     event.SetEventObject(this);
-    event.m_commandInt = m_current;
+    event.SetInt(m_current);
 
     (void)GetEventHandler()->ProcessEvent(event);
 }
 
 void wxVListBox::SetSelection(int selection)
 {
-    wxASSERT_MSG( !HasMultipleSelection(),
-                  _T("SetSelection() is invalid with multiselection listbox") );
+    wxCHECK_RET( selection == wxNOT_FOUND ||
+                  (selection >= 0 && (size_t)selection < GetItemCount()),
+                  _T("wxVListBox::SetSelection(): invalid item index") );
+
+    if ( HasMultipleSelection() )
+    {
+        if (selection != wxNOT_FOUND)
+            Select(selection);
+        else
+            DeselectAll();
+        m_anchor = selection;
+    }
 
     DoSetCurrent(selection);
 }
@@ -272,8 +311,18 @@ int wxVListBox::GetNextSelected(unsigned long& cookie) const
     return wxNOT_FOUND;
 }
 
+void wxVListBox::RefreshSelected()
+{
+    // only refresh those items which are currently visible and selected:
+    for ( size_t n = GetVisibleBegin(), end = GetVisibleEnd(); n < end; n++ )
+    {
+        if ( IsSelected(n) )
+            RefreshRow(n);
+    }
+}
+
 // ----------------------------------------------------------------------------
-// wxVListBox painting
+// wxVListBox appearance parameters
 // ----------------------------------------------------------------------------
 
 void wxVListBox::SetMargins(const wxPoint& pt)
@@ -286,7 +335,16 @@ void wxVListBox::SetMargins(const wxPoint& pt)
     }
 }
 
-wxCoord wxVListBox::OnGetLineHeight(size_t line) const
+void wxVListBox::SetSelectionBackground(const wxColour& col)
+{
+    m_colBgSel = col;
+}
+
+// ----------------------------------------------------------------------------
+// wxVListBox painting
+// ----------------------------------------------------------------------------
+
+wxCoord wxVListBox::OnGetRowHeight(size_t line) const
 {
     return OnMeasureItem(line) + 2*m_ptMargins.y;
 }
@@ -297,53 +355,88 @@ void wxVListBox::OnDrawSeparator(wxDC& WXUNUSED(dc),
 {
 }
 
-void wxVListBox::OnPaint(wxPaintEvent& event)
+bool
+wxVListBox::DoDrawSolidBackground(const wxColour& col,
+                                  wxDC& dc,
+                                  const wxRect& rect,
+                                  size_t n) const
+{
+    if ( !col.IsOk() )
+        return false;
+
+    // we need to render selected and current items differently
+    const bool isSelected = IsSelected(n),
+               isCurrent = IsCurrent(n);
+    if ( isSelected || isCurrent )
+    {
+        if ( isSelected )
+        {
+            dc.SetBrush(wxBrush(col, wxBRUSHSTYLE_SOLID));
+        }
+        else // !selected
+        {
+            dc.SetBrush(*wxTRANSPARENT_BRUSH);
+        }
+        dc.SetPen(*(isCurrent ? wxBLACK_PEN : wxTRANSPARENT_PEN));
+        dc.DrawRectangle(rect);
+    }
+    //else: do nothing for the normal items
+
+    return true;
+}
+
+void wxVListBox::OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const
+{
+    // use wxRendererNative for more native look unless we use custom bg colour
+    if ( !DoDrawSolidBackground(m_colBgSel, dc, rect, n) )
+    {
+        int flags = 0;
+        if ( IsSelected(n) )
+            flags |= wxCONTROL_SELECTED;
+        if ( IsCurrent(n) )
+            flags |= wxCONTROL_CURRENT;
+        if ( wxWindow::FindFocus() == wx_const_cast(wxVListBox*, this) )
+            flags |= wxCONTROL_FOCUSED;
+
+        wxRendererNative::Get().DrawItemSelectionRect(
+            wx_const_cast(wxVListBox *, this), dc, rect, flags);
+    }
+}
+
+void wxVListBox::OnPaint(wxPaintEvent& WXUNUSED(event))
 {
-    wxPaintDC dc(this);
+    wxSize clientSize = GetClientSize();
+
+    wxAutoBufferedPaintDC dc(this);
 
     // the update rectangle
     wxRect rectUpdate = GetUpdateClientRect();
 
+    // fill it with background colour
+    dc.SetBackground(GetBackgroundColour());
+    dc.Clear();
+
     // the bounding rectangle of the current line
-    wxRect rectLine;
-    rectLine.width = GetClientSize().x;
+    wxRect rectRow;
+    rectRow.width = clientSize.x;
 
     // iterate over all visible lines
-    const size_t lineMax = GetLastVisibleLine();
-    for ( size_t line = GetFirstVisibleLine(); line <= lineMax; line++ )
+    const size_t lineMax = GetVisibleEnd();
+    for ( size_t line = GetVisibleBegin(); line < lineMax; line++ )
     {
-        const wxCoord hLine = OnGetLineHeight(line);
+        const wxCoord hRow = OnGetRowHeight(line);
 
-        rectLine.height = hLine;
+        rectRow.height = hRow;
 
         // and draw the ones which intersect the update rect
-        if ( rectLine.Intersects(rectUpdate) )
+        if ( rectRow.Intersects(rectUpdate) )
         {
             // don't allow drawing outside of the lines rectangle
-            wxDCClipper clip(dc, rectLine);
+            wxDCClipper clip(dc, rectRow);
 
-            // we need to render selected and current items differently
-            const bool isSelected = IsSelected(line);
-            if ( isSelected || IsCurrent(line) )
-            {
-                if ( isSelected )
-                {
-                    wxBrush brush(wxSystemSettings::
-                                    GetColour(wxSYS_COLOUR_HIGHLIGHT),
-                                    wxSOLID);
-                    dc.SetBrush(brush);
-                }
-                else // !selected
-                {
-                    dc.SetBrush(*wxTRANSPARENT_BRUSH);
-                }
-
-                dc.SetPen(*(IsCurrent(line) ? wxBLACK_PEN : wxTRANSPARENT_PEN));
-
-                dc.DrawRectangle(rectLine);
-            }
+            wxRect rect = rectRow;
+            OnDrawBackground(dc, rect, line);
 
-            wxRect rect = rectLine;
             OnDrawSeparator(dc, rect, line);
 
             rect.Deflate(m_ptMargins.x, m_ptMargins.y);
@@ -351,7 +444,7 @@ void wxVListBox::OnPaint(wxPaintEvent& event)
         }
         else // no intersection
         {
-            if ( rectLine.GetTop() > rectUpdate.GetBottom() )
+            if ( rectRow.GetTop() > rectUpdate.GetBottom() )
             {
                 // we are already below the update rect, no need to continue
                 // further
@@ -360,15 +453,24 @@ void wxVListBox::OnPaint(wxPaintEvent& event)
             //else: the next line may intersect the update rect
         }
 
-        rectLine.y += hLine;
+        rectRow.y += hRow;
     }
 }
 
+void wxVListBox::OnSetOrKillFocus(wxFocusEvent& WXUNUSED(event))
+{
+    // we need to repaint the selection when we get the focus since
+    // wxRendererNative in general draws the focused selection differently
+    // from the unfocused selection (see OnDrawItem):
+    RefreshSelected();
+}
+
+
 // ============================================================================
 // wxVListBox keyboard/mouse handling
 // ============================================================================
 
-void wxVListBox::DoHandleItemClick(int item, bool shiftDown, bool ctrlDown)
+void wxVListBox::DoHandleItemClick(int item, int flags)
 {
     // has anything worth telling the client code about happened?
     bool notify = false;
@@ -381,32 +483,44 @@ void wxVListBox::DoHandleItemClick(int item, bool shiftDown, bool ctrlDown)
         // NB: the keyboard interface we implement here corresponds to
         //     wxLB_EXTENDED rather than wxLB_MULTIPLE but this one makes more
         //     sense IMHO
-        if ( shiftDown )
+        if ( flags & ItemClick_Shift )
         {
             if ( m_current != wxNOT_FOUND )
             {
+                if ( m_anchor == wxNOT_FOUND )
+                    m_anchor = m_current;
+
                 select = false;
 
-                // only the range from old m_current to new m_current must be
-                // selected
+                // only the range from the selection anchor to new m_current
+                // must be selected
                 if ( DeselectAll() )
                     notify = true;
 
-                if ( SelectRange(m_current, item) )
+                if ( SelectRange(m_anchor, item) )
                     notify = true;
             }
             //else: treat it as ordinary click/keypress
         }
-        else if ( ctrlDown )
+        else // Shift not pressed
         {
-            select = false;
+            m_anchor = item;
 
-            Toggle(item);
+            if ( flags & ItemClick_Ctrl )
+            {
+                select = false;
 
-            // the status of the item has definitely changed
-            notify = true;
+                if ( !(flags & ItemClick_Kbd) )
+                {
+                    Toggle(item);
+
+                    // the status of the item has definitely changed
+                    notify = true;
+                }
+                //else: Ctrl-arrow pressed, don't change selection
+            }
+            //else: behave as in single selection case
         }
-        //else: behave as in single selection case
 
         if ( select )
         {
@@ -443,7 +557,10 @@ void wxVListBox::DoHandleItemClick(int item, bool shiftDown, bool ctrlDown)
 
 void wxVListBox::OnKeyDown(wxKeyEvent& event)
 {
-    int current = 0; // just to silent the stupid compiler warnings
+    // flags for DoHandleItemClick()
+    int flags = ItemClick_Kbd;
+
+    int current;
     switch ( event.GetKeyCode() )
     {
         case WXK_HOME:
@@ -451,11 +568,11 @@ void wxVListBox::OnKeyDown(wxKeyEvent& event)
             break;
 
         case WXK_END:
-            current = GetLineCount() - 1;
+            current = GetRowCount() - 1;
             break;
 
         case WXK_DOWN:
-            if ( m_current == (int)GetLineCount() - 1 )
+            if ( m_current == (int)GetRowCount() - 1 )
                 return;
 
             current = m_current + 1;
@@ -463,7 +580,7 @@ void wxVListBox::OnKeyDown(wxKeyEvent& event)
 
         case WXK_UP:
             if ( m_current == wxNOT_FOUND )
-                current = GetLineCount() - 1;
+                current = GetRowCount() - 1;
             else if ( m_current != 0 )
                 current = m_current - 1;
             else // m_current == 0
@@ -471,27 +588,47 @@ void wxVListBox::OnKeyDown(wxKeyEvent& event)
             break;
 
         case WXK_PAGEDOWN:
-        case WXK_NEXT:
             PageDown();
-            current = GetFirstVisibleLine();
+            current = GetVisibleBegin();
             break;
 
         case WXK_PAGEUP:
-        case WXK_PRIOR:
-            if ( m_current == (int)GetFirstVisibleLine() )
+            if ( m_current == (int)GetVisibleBegin() )
             {
                 PageUp();
             }
 
-            current = GetFirstVisibleLine();
+            current = GetVisibleBegin();
             break;
 
+        case WXK_SPACE:
+            // hack: pressing space should work like a mouse click rather than
+            // like a keyboard arrow press, so trick DoHandleItemClick() in
+            // thinking we were clicked
+            flags &= ~ItemClick_Kbd;
+            current = m_current;
+            break;
+
+#ifdef __WXMSW__
+        case WXK_TAB:
+            // Since we are using wxWANTS_CHARS we need to send navigation
+            // events for the tabs on MSW
+            HandleAsNavigationKey(event);
+            // fall through to default
+#endif
         default:
             event.Skip();
+            current = 0; // just to silent the stupid compiler warnings
+            wxUnusedVar(current);
             return;
     }
 
-    DoHandleItemClick(current, event.ShiftDown(), event.ControlDown());
+    if ( event.ShiftDown() )
+       flags |= ItemClick_Shift;
+    if ( event.ControlDown() )
+        flags |= ItemClick_Ctrl;
+
+    DoHandleItemClick(current, flags);
 }
 
 // ----------------------------------------------------------------------------
@@ -500,27 +637,63 @@ void wxVListBox::OnKeyDown(wxKeyEvent& event)
 
 void wxVListBox::OnLeftDown(wxMouseEvent& event)
 {
-    int item = HitTest(event.GetPosition());
+    SetFocus();
+
+    int item = VirtualHitTest(event.GetPosition().y);
+
+    if ( item != wxNOT_FOUND )
+    {
+        int flags = 0;
+        if ( event.ShiftDown() )
+           flags |= ItemClick_Shift;
 
-    DoHandleItemClick(item, event.ShiftDown(),
+        // under Mac Apple-click is used in the same way as Ctrl-click
+        // elsewhere
 #ifdef __WXMAC__
-                            event.MetaDown()
+        if ( event.MetaDown() )
 #else
-                            event.ControlDown()
+        if ( event.ControlDown() )
 #endif
-                     );
+            flags |= ItemClick_Ctrl;
+
+        DoHandleItemClick(item, flags);
+    }
 }
 
-void wxVListBox::OnLeftDClick(wxMouseEvent& event)
+void wxVListBox::OnLeftDClick(wxMouseEvent& eventMouse)
 {
-    int item = HitTest(event.GetPosition());
+    int item = VirtualHitTest(eventMouse.GetPosition().y);
     if ( item != wxNOT_FOUND )
     {
-        wxCommandEvent event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, GetId());
-        event.SetEventObject(this);
-        event.m_commandInt = item;
 
-        (void)GetEventHandler()->ProcessEvent(event);
+        // if item double-clicked was not yet selected, then treat
+        // this event as a left-click instead
+        if ( item == m_current )
+        {
+            wxCommandEvent event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, GetId());
+            event.SetEventObject(this);
+            event.SetInt(item);
+
+            (void)GetEventHandler()->ProcessEvent(event);
+        }
+        else
+        {
+            OnLeftDown(eventMouse);
+        }
+
     }
 }
 
+
+// ----------------------------------------------------------------------------
+// use the same default attributes as wxListBox
+// ----------------------------------------------------------------------------
+
+//static
+wxVisualAttributes
+wxVListBox::GetClassDefaultAttributes(wxWindowVariant variant)
+{
+    return wxListBox::GetClassDefaultAttributes(variant);
+}
+
+#endif