document that SetValue() accepts values in 0..GetRange interval, inclusive

[wxWidgets.git] / src / generic / vlbox.cpp

diff --git a/src/generic/vlbox.cpp b/src/generic/vlbox.cpp
index fedb4496a4ce98c060cd04fe213859c9c3bc63cf..d9d03f063f23418679d86c1dc78600b3eda8d09a 100644 (file)
--- a/src/generic/vlbox.cpp
+++ b/src/generic/vlbox.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        generic/vlbox.cpp
+// Name:        src/generic/vlbox.cpp

 // Purpose:     implementation of wxVListBox
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     implementation of wxVListBox
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -24,13 +24,19 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_LISTBOX
+
+#include "wx/vlbox.h"
+

 #ifndef WX_PRECOMP
     #include "wx/settings.h"
     #include "wx/dcclient.h"
 #ifndef WX_PRECOMP
     #include "wx/settings.h"
     #include "wx/dcclient.h"

+    #include "wx/listbox.h"

 #endif //WX_PRECOMP
 
 #endif //WX_PRECOMP
 

-#include "wx/vlbox.h"
+#include "wx/dcbuffer.h"

 #include "wx/selstore.h"
 #include "wx/selstore.h"

+#include "wx/renderer.h"

 
 // ----------------------------------------------------------------------------
 // event tables
 
 // ----------------------------------------------------------------------------
 // event tables


@@ -42,12 +48,17 @@ BEGIN_EVENT_TABLE(wxVListBox, wxVScrolledWindow)
     EVT_KEY_DOWN(wxVListBox::OnKeyDown)
     EVT_LEFT_DOWN(wxVListBox::OnLeftDown)
     EVT_LEFT_DCLICK(wxVListBox::OnLeftDClick)
     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
 // ============================================================================
 
 END_EVENT_TABLE()
 
 // ============================================================================
 // implementation
 // ============================================================================
 

+IMPLEMENT_ABSTRACT_CLASS(wxVListBox, wxVScrolledWindow)
+

 // ----------------------------------------------------------------------------
 // wxVListBox creation
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxVListBox creation
 // ----------------------------------------------------------------------------


@@ -66,14 +77,23 @@ bool wxVListBox::Create(wxWindow *parent,
                         long style,
                         const wxString& name)
 {
                         long style,
                         const wxString& name)
 {

+    style |= wxWANTS_CHARS | wxFULL_REPAINT_ON_RESIZE;

     if ( !wxVScrolledWindow::Create(parent, id, pos, size, style, name) )
         return false;
 
     if ( style & wxLB_MULTIPLE )
         m_selStore = new wxSelectionStore;
 
     if ( !wxVScrolledWindow::Create(parent, id, pos, size, style, name) )
         return false;
 
     if ( style & wxLB_MULTIPLE )
         m_selStore = new wxSelectionStore;
 

-    SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_LISTBOX));
-    m_colBgSel = wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT);
+    // 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;
 }
 
     return true;
 }


@@ -91,7 +111,7 @@ void wxVListBox::SetItemCount(size_t count)
         m_selStore->SetItemCount(count);
     }
 
         m_selStore->SetItemCount(count);
     }
 

-    SetLineCount(count);
+    SetRowCount(count);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -115,7 +135,7 @@ bool wxVListBox::Select(size_t item, bool select)
     if ( changed )
     {
         // selection really changed
     if ( changed )
     {
         // selection really changed

-        RefreshLine(item);
+        RefreshRow(item);

     }
 
     DoSetCurrent(item);
     }
 
     DoSetCurrent(item);


@@ -144,7 +164,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
     {
         // 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
     {
     }
     else // we've got the indices of the changed items
     {


@@ -158,7 +178,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++ )
         {
         // refresh just the lines which have really changed
         for ( size_t n = 0; n < count; n++ )
         {

-            RefreshLine(changed[n]);
+            RefreshRow(changed[n]);

         }
     }
 
         }
     }
 


@@ -201,7 +221,7 @@ bool wxVListBox::DoSetCurrent(int current)
     }
 
     if ( m_current != wxNOT_FOUND )
     }
 
     if ( m_current != wxNOT_FOUND )

-        RefreshLine(m_current);
+        RefreshRow(m_current);

 
     m_current = current;
 
 
     m_current = current;
 


@@ -211,20 +231,18 @@ bool wxVListBox::DoSetCurrent(int current)
         // don't need to refresh it -- it will be redrawn anyhow
         if ( !IsVisible(m_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
         }
         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
 
             // 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);

         }
     }
 
         }
     }
 


@@ -238,7 +256,7 @@ void wxVListBox::SendSelectedEvent()
 
     wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, GetId());
     event.SetEventObject(this);
 
     wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, GetId());
     event.SetEventObject(this);

-    event.m_commandInt = m_current;
+    event.SetInt(m_current);

 
     (void)GetEventHandler()->ProcessEvent(event);
 }
 
     (void)GetEventHandler()->ProcessEvent(event);
 }


@@ -251,7 +269,10 @@ void wxVListBox::SetSelection(int selection)
 
     if ( HasMultipleSelection() )
     {
 
     if ( HasMultipleSelection() )
     {

-        Select(selection);
+        if (selection != wxNOT_FOUND)
+            Select(selection);
+        else
+            DeselectAll();

         m_anchor = selection;
     }
 
         m_anchor = selection;
     }
 


@@ -285,6 +306,16 @@ int wxVListBox::GetNextSelected(unsigned long& cookie) const
     return wxNOT_FOUND;
 }
 
     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 appearance parameters
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxVListBox appearance parameters
 // ----------------------------------------------------------------------------


@@ -308,7 +339,7 @@ void wxVListBox::SetSelectionBackground(const wxColour& col)
 // wxVListBox painting
 // ----------------------------------------------------------------------------
 
 // wxVListBox painting
 // ----------------------------------------------------------------------------
 

-wxCoord wxVListBox::OnGetLineHeight(size_t line) const
+wxCoord wxVListBox::OnGetRowHeight(size_t line) const

 {
     return OnMeasureItem(line) + 2*m_ptMargins.y;
 }
 {
     return OnMeasureItem(line) + 2*m_ptMargins.y;
 }


@@ -321,53 +352,73 @@ void wxVListBox::OnDrawSeparator(wxDC& WXUNUSED(dc),
 
 void wxVListBox::OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const
 {
 
 void wxVListBox::OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const
 {

-    // we need to render selected and current items differently
-    const bool isSelected = IsSelected(n),
-               isCurrent = IsCurrent(n);
-    if ( isSelected || isCurrent )
+    if ( m_colBgSel.IsOk() )

     {
     {

-        if ( isSelected )
-        {
-            dc.SetBrush(wxBrush(m_colBgSel, wxSOLID));
-        }
-        else // !selected
+        // we need to render selected and current items differently
+        const bool isSelected = IsSelected(n),
+                   isCurrent = IsCurrent(n);
+        if ( isSelected || isCurrent )

         {
         {

-            dc.SetBrush(*wxTRANSPARENT_BRUSH);
+            if ( isSelected )
+            {
+                dc.SetBrush(wxBrush(m_colBgSel, wxSOLID));
+            }
+            else // !selected
+            {
+                dc.SetBrush(*wxTRANSPARENT_BRUSH);
+            }
+            dc.SetPen(*(isCurrent ? wxBLACK_PEN : wxTRANSPARENT_PEN));
+            dc.DrawRectangle(rect);

         }
         }

-
-        dc.SetPen(*(isCurrent ? wxBLACK_PEN : wxTRANSPARENT_PEN));
-
-        dc.DrawRectangle(rect);
+        //else: do nothing for the normal items
+    }
+    else // use wxRendererNative for a more native look&feel:
+    {
+        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);

     }
     }

-    //else: do nothing for the normal items

 }
 
 void wxVListBox::OnPaint(wxPaintEvent& WXUNUSED(event))
 {
 }
 
 void wxVListBox::OnPaint(wxPaintEvent& WXUNUSED(event))
 {

-    wxPaintDC dc(this);
+    wxSize clientSize = GetClientSize();
+
+    wxAutoBufferedPaintDC dc(this);

 
     // the update rectangle
     wxRect rectUpdate = GetUpdateClientRect();
 
 
     // the update rectangle
     wxRect rectUpdate = GetUpdateClientRect();
 

+    // fill it with background colour
+    dc.SetBackground(GetBackgroundColour());
+    dc.Clear();
+

     // the bounding rectangle of the current line
     // the bounding rectangle of the current line

-    wxRect rectLine;
-    rectLine.width = GetClientSize().x;
+    wxRect rectRow;
+    rectRow.width = clientSize.x;

 
     // iterate over all visible lines
 
     // 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
 
         // 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
         {
             // don't allow drawing outside of the lines rectangle

-            wxDCClipper clip(dc, rectLine);
+            wxDCClipper clip(dc, rectRow);

 
 

-            wxRect rect = rectLine;
+            wxRect rect = rectRow;

             OnDrawBackground(dc, rect, line);
 
             OnDrawSeparator(dc, rect, line);
             OnDrawBackground(dc, rect, line);
 
             OnDrawSeparator(dc, rect, line);


@@ -377,7 +428,7 @@ void wxVListBox::OnPaint(wxPaintEvent& WXUNUSED(event))
         }
         else // no intersection
         {
         }
         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
             {
                 // we are already below the update rect, no need to continue
                 // further


@@ -386,10 +437,19 @@ void wxVListBox::OnPaint(wxPaintEvent& WXUNUSED(event))
             //else: the next line may intersect the update rect
         }
 
             //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
 // ============================================================================
 // ============================================================================
 // wxVListBox keyboard/mouse handling
 // ============================================================================


@@ -484,7 +544,7 @@ void wxVListBox::OnKeyDown(wxKeyEvent& event)
     // flags for DoHandleItemClick()
     int flags = ItemClick_Kbd;
 
     // flags for DoHandleItemClick()
     int flags = ItemClick_Kbd;
 

-    int current = 0; // just to silent the stupid compiler warnings
+    int current;

     switch ( event.GetKeyCode() )
     {
         case WXK_HOME:
     switch ( event.GetKeyCode() )
     {
         case WXK_HOME:


@@ -492,11 +552,11 @@ void wxVListBox::OnKeyDown(wxKeyEvent& event)
             break;
 
         case WXK_END:
             break;
 
         case WXK_END:

-            current = GetLineCount() - 1;
+            current = GetRowCount() - 1;

             break;
 
         case WXK_DOWN:
             break;
 
         case WXK_DOWN:

-            if ( m_current == (int)GetLineCount() - 1 )
+            if ( m_current == (int)GetRowCount() - 1 )

                 return;
 
             current = m_current + 1;
                 return;
 
             current = m_current + 1;


@@ -504,7 +564,7 @@ void wxVListBox::OnKeyDown(wxKeyEvent& event)
 
         case WXK_UP:
             if ( m_current == wxNOT_FOUND )
 
         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
             else if ( m_current != 0 )
                 current = m_current - 1;
             else // m_current == 0


@@ -512,19 +572,17 @@ void wxVListBox::OnKeyDown(wxKeyEvent& event)
             break;
 
         case WXK_PAGEDOWN:
             break;
 
         case WXK_PAGEDOWN:

-        case WXK_NEXT:

             PageDown();
             PageDown();

-            current = GetFirstVisibleLine();
+            current = GetVisibleBegin();

             break;
 
         case WXK_PAGEUP:
             break;
 
         case WXK_PAGEUP:

-        case WXK_PRIOR:
-            if ( m_current == (int)GetFirstVisibleLine() )
+            if ( m_current == (int)GetVisibleBegin() )

             {
                 PageUp();
             }
 
             {
                 PageUp();
             }
 

-            current = GetFirstVisibleLine();
+            current = GetVisibleBegin();

             break;
 
         case WXK_SPACE:
             break;
 
         case WXK_SPACE:


@@ -535,8 +593,23 @@ void wxVListBox::OnKeyDown(wxKeyEvent& event)
             current = m_current;
             break;
 
             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
+            {
+                wxNavigationKeyEvent ne;
+                ne.SetDirection(!event.ShiftDown());
+                ne.SetCurrentFocus(this);
+                ne.SetEventObject(this);
+                GetParent()->GetEventHandler()->ProcessEvent(ne);
+            }
+            // fall through to default
+#endif

         default:
             event.Skip();
         default:
             event.Skip();

+            current = 0; // just to silent the stupid compiler warnings
+            wxUnusedVar(current);

             return;
     }
 
             return;
     }
 


@@ -554,6 +627,8 @@ void wxVListBox::OnKeyDown(wxKeyEvent& event)
 
 void wxVListBox::OnLeftDown(wxMouseEvent& event)
 {
 
 void wxVListBox::OnLeftDown(wxMouseEvent& event)
 {

+    SetFocus();
+

     int item = HitTest(event.GetPosition());
 
     if ( item != wxNOT_FOUND )
     int item = HitTest(event.GetPosition());
 
     if ( item != wxNOT_FOUND )


@@ -575,16 +650,40 @@ void wxVListBox::OnLeftDown(wxMouseEvent& event)
     }
 }
 
     }
 }
 

-void wxVListBox::OnLeftDClick(wxMouseEvent& event)
+void wxVListBox::OnLeftDClick(wxMouseEvent& eventMouse)

 {
 {

-    int item = HitTest(event.GetPosition());
+    int item = HitTest(eventMouse.GetPosition());

     if ( item != wxNOT_FOUND )
     {
     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