dba34a: #i31275# allow 'select as you type' aka 'quick selection' for tree list boxes (SvLBox derivees, to be precise), and enable this for Base main window, and the stylist

3 files changed, 268 insertions, 61 deletions

diff --git a/vcl/source/control/ilstbox.cxx b/vcl/source/control/ilstbox.cxx
index 02c8d2b5fcb3..505f3ae779ed 100644
--- a/vcl/source/control/ilstbox.cxx
+++ b/vcl/source/control/ilstbox.cxx
@@ -529,7 +529,8 @@ USHORT ImplEntryList::FindFirstSelectable( USHORT nPos, bool bForward /* = true
 // =======================================================================
 
 ImplListBoxWindow::ImplListBoxWindow( Window* pParent, WinBits nWinStyle ) :
-    Control( pParent, 0 )
+    Control( pParent, 0 ),
+    maQuickSelectionEngine( *this )
 {
     mpEntryList         = new ImplEntryList( this );
 
@@ -568,9 +569,6 @@ ImplListBoxWindow::ImplListBoxWindow( Window* pParent, WinBits nWinStyle ) :
     SetTextFillColor();
     SetBackground( Wallpaper( GetSettings().GetStyleSettings().GetFieldColor() ) );
 
-    maSearchTimeout.SetTimeout( 2500 );
-    maSearchTimeout.SetTimeoutHdl( LINK( this, ImplListBoxWindow, SearchStringTimeout ) );
-
     ImplInitSettings( TRUE, TRUE, TRUE );
     ImplCalcMetrics();
 }
@@ -579,7 +577,6 @@ ImplListBoxWindow::ImplListBoxWindow( Window* pParent, WinBits nWinStyle ) :
 
 ImplListBoxWindow::~ImplListBoxWindow()
 {
-    maSearchTimeout.Stop();
     delete mpEntryList;
 }
 
@@ -624,14 +621,6 @@ void ImplListBoxWindow::ImplCalcMetrics()
 
 // -----------------------------------------------------------------------
 
-IMPL_LINK( ImplListBoxWindow, SearchStringTimeout, Timer*, EMPTYARG )
-{
-    maSearchStr.Erase();
-    return 1;
-}
-
-// -----------------------------------------------------------------------
-
 void ImplListBoxWindow::Clear()
 {
     mpEntryList->Clear();
@@ -648,6 +637,7 @@ void ImplListBoxWindow::Clear()
     ImplClearLayoutData();
 
     mnCurrentPos = LISTBOX_ENTRY_NOTFOUND;
+    maQuickSelectionEngine.Reset();
 
     Invalidate();
 }
@@ -918,7 +908,7 @@ USHORT ImplListBoxWindow::GetLastVisibleEntry() const
 void ImplListBoxWindow::MouseButtonDown( const MouseEvent& rMEvt )
 {
     mbMouseMoveSelect = FALSE;  // Nur bis zum ersten MouseButtonDown
-    maSearchStr.Erase();
+    maQuickSelectionEngine.Reset();
 
     if ( !IsReadOnly() )
     {
@@ -1465,7 +1455,7 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
 
                 bDone = TRUE;
             }
-            maSearchStr.Erase();
+            maQuickSelectionEngine.Reset();
         }
         break;
 
@@ -1492,7 +1482,7 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
 
                 bDone = TRUE;
             }
-            maSearchStr.Erase();
+            maQuickSelectionEngine.Reset();
         }
         break;
 
@@ -1523,7 +1513,7 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
                 }
                 bDone = TRUE;
             }
-            maSearchStr.Erase();
+            maQuickSelectionEngine.Reset();
         }
         break;
 
@@ -1557,7 +1547,7 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
                 }
                 bDone = TRUE;
             }
-            maSearchStr.Erase();
+            maQuickSelectionEngine.Reset();
         }
         break;
 
@@ -1578,7 +1568,7 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
                     bDone = TRUE;
                 }
             }
-            maSearchStr.Erase();
+            maQuickSelectionEngine.Reset();
         }
         break;
 
@@ -1604,7 +1594,7 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
                 }
                 bDone = TRUE;
             }
-            maSearchStr.Erase();
+            maQuickSelectionEngine.Reset();
         }
         break;
 
@@ -1615,7 +1605,7 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
                 ScrollHorz( -HORZ_SCROLL );
                 bDone = TRUE;
             }
-            maSearchStr.Erase();
+            maQuickSelectionEngine.Reset();
         }
         break;
 
@@ -1626,7 +1616,7 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
                 ScrollHorz( HORZ_SCROLL );
                 bDone = TRUE;
             }
-            maSearchStr.Erase();
+            maQuickSelectionEngine.Reset();
         }
         break;
 
@@ -1638,7 +1628,7 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
                 ImplCallSelect();
                 bDone = FALSE;  // RETURN nicht abfangen.
             }
-            maSearchStr.Erase();
+            maQuickSelectionEngine.Reset();
         }
         break;
 
@@ -1653,7 +1643,7 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
                 }
                 bDone = TRUE;
             }
-            maSearchStr.Erase();
+            maQuickSelectionEngine.Reset();
         }
         break;
 
@@ -1673,7 +1663,7 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
                 SetUpdateMode( bUpdates );
                 Invalidate();
 
-                maSearchStr.Erase();
+                maQuickSelectionEngine.Reset();
 
                 bDone = TRUE;
                 break;
@@ -1682,43 +1672,12 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
         // fall through intentional
         default:
         {
-            xub_Unicode c = rKEvt.GetCharCode();
-
-            if ( !IsReadOnly() && (c >= 32) && (c != 127) && !rKEvt.GetKeyCode().IsMod2() )
+            if ( !IsReadOnly() )
             {
-                maSearchStr += c;
-                XubString aTmpSearch( maSearchStr );
-
-                nSelect = mpEntryList->FindMatchingEntry( aTmpSearch, mnCurrentPos );
-                if ( (nSelect == LISTBOX_ENTRY_NOTFOUND) && (aTmpSearch.Len() > 1) )
-                {
-                    // Wenn alles die gleichen Buchstaben, dann anderer Such-Modus
-                    BOOL bAllEqual = TRUE;
-                    for ( USHORT n = aTmpSearch.Len(); n && bAllEqual; )
-                        bAllEqual = aTmpSearch.GetChar( --n ) == c;
-                    if ( bAllEqual )
-                    {
-                        aTmpSearch = c;
-                        nSelect = mpEntryList->FindMatchingEntry( aTmpSearch, mnCurrentPos+1 );
-                    }
-                }
-                if ( nSelect == LISTBOX_ENTRY_NOTFOUND )
-                    nSelect = mpEntryList->FindMatchingEntry( aTmpSearch, 0 );
-
-                if ( nSelect != LISTBOX_ENTRY_NOTFOUND )
-                {
-                    ShowProminentEntry( nSelect );
-
-                    if ( mpEntryList->IsEntryPosSelected( nSelect ) )
-                        nSelect = LISTBOX_ENTRY_NOTFOUND;
-
-                    maSearchTimeout.Start();
-                }
-                else
-                    maSearchStr.Erase();
-                bDone = TRUE;
+                bDone = maQuickSelectionEngine.HandleKeyEvent( rKEvt );
             }
-        }
+          }
+        break;
     }
 
     if  (   ( nSelect != LISTBOX_ENTRY_NOTFOUND )
@@ -1744,6 +1703,72 @@ BOOL ImplListBoxWindow::ProcessKeyInput( const KeyEvent& rKEvt )
 }
 
 // -----------------------------------------------------------------------
+namespace
+{
+    static ::vcl::StringEntryIdentifier lcl_getEntry( const ImplEntryList& _rList, USHORT _nPos, String& _out_entryText )
+    {
+        OSL_PRECOND( ( _nPos != LISTBOX_ENTRY_NOTFOUND ) && ( _nPos >= 0 ), "lcl_getEntry: invalid position!" );
+        USHORT nEntryCount( _rList.GetEntryCount() );
+        if ( _nPos >= nEntryCount )
+            _nPos = 0;
+        _out_entryText = _rList.GetEntryText( _nPos );
+
+        // ::vcl::StringEntryIdentifier does not allow for 0 values, but our position is 0-based
+        // => normalize
+        return reinterpret_cast< ::vcl::StringEntryIdentifier >( _nPos + 1 );
+    }
+
+    static USHORT lcl_getEntryPos( ::vcl::StringEntryIdentifier _entry )
+    {
+        // our pos is 0-based, but StringEntryIdentifier does not allow for a NULL
+        return static_cast< USHORT >( reinterpret_cast< sal_Int64 >( _entry ) ) - 1;
+    }
+}
+
+// -----------------------------------------------------------------------
+::vcl::StringEntryIdentifier ImplListBoxWindow::CurrentEntry( String& _out_entryText ) const
+{
+    return lcl_getEntry( *GetEntryList(), ( mnCurrentPos == LISTBOX_ENTRY_NOTFOUND ) ? 0 : mnCurrentPos + 1, _out_entryText );
+}
+
+// -----------------------------------------------------------------------
+::vcl::StringEntryIdentifier ImplListBoxWindow::NextEntry( ::vcl::StringEntryIdentifier _currentEntry, String& _out_entryText ) const
+{
+    USHORT nNextPos = lcl_getEntryPos( _currentEntry ) + 1;
+    return lcl_getEntry( *GetEntryList(), nNextPos, _out_entryText );
+}
+
+// -----------------------------------------------------------------------
+void ImplListBoxWindow::SelectEntry( ::vcl::StringEntryIdentifier _entry )
+{
+    USHORT nSelect = lcl_getEntryPos( _entry );
+    if ( mpEntryList->IsEntryPosSelected( nSelect ) )
+    {
+        // ignore that. This method is a callback from the QuickSelectionEngine, which means the user attempted
+        // to select the given entry by typing its starting letters. No need to act.
+        return;
+    }
+
+    // normalize
+    OSL_ENSURE( nSelect < mpEntryList->GetEntryCount(), "ImplListBoxWindow::SelectEntry: how that?" );
+    if( nSelect >= mpEntryList->GetEntryCount() )
+        nSelect = mpEntryList->GetEntryCount()-1;
+
+    // make visible
+    ShowProminentEntry( nSelect );
+
+    // actually select
+    mnCurrentPos = nSelect;
+    if ( SelectEntries( nSelect, LET_KEYMOVE, FALSE, FALSE ) )
+    {
+        mbTravelSelect = TRUE;
+        mnSelectModifier = 0;
+        ImplCallSelect();
+        mbTravelSelect = FALSE;
+    }
+}
+
+// -----------------------------------------------------------------------
 
 void ImplListBoxWindow::ImplPaint( USHORT nPos, BOOL bErase, bool bLayout )
 {
diff --git a/vcl/source/control/makefile.mk b/vcl/source/control/makefile.mk
index a2553333246d..b1644e58ccd9 100644
--- a/vcl/source/control/makefile.mk
+++ b/vcl/source/control/makefile.mk
@@ -62,7 +62,8 @@ SLOFILES=	$(SLO)$/button.obj		\
             $(SLO)$/slider.obj		\
             $(SLO)$/spinfld.obj 	\
             $(SLO)$/spinbtn.obj 	\
-            $(SLO)$/tabctrl.obj
+            $(SLO)$/tabctrl.obj     \
+            $(SLO)$/quickselectionengine.obj
 
 EXCEPTIONSFILES=					\
             $(SLO)$/button.obj		\
diff --git a/vcl/source/control/quickselectionengine.cxx b/vcl/source/control/quickselectionengine.cxx
new file mode 100644
index 000000000000..beb6e499794c
--- /dev/null
+++ b/vcl/source/control/quickselectionengine.cxx
@@ -0,0 +1,181 @@
+/*************************************************************************
+* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+*
+* Copyright 2009 by Sun Microsystems, Inc.
+*
+* OpenOffice.org - a multi-platform office productivity suite
+*
+* This file is part of OpenOffice.org.
+*
+* OpenOffice.org is free software: you can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License version 3
+* only, as published by the Free Software Foundation.
+*
+* OpenOffice.org is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU Lesser General Public License version 3 for more details
+* (a copy is included in the LICENSE file that accompanied this code).
+*
+* You should have received a copy of the GNU Lesser General Public License
+* version 3 along with OpenOffice.org.  If not, see
+* <http://www.openoffice.org/license.html>
+* for a copy of the LGPLv3 License.
+************************************************************************/
+
+// MARKER(update_precomp.py): autogen include statement, do not remove
+#include "precompiled_vcl.hxx"
+
+#include "vcl/quickselectionengine.hxx"
+#include "vcl/event.hxx"
+#include "vcl/timer.hxx"
+#include "vcl/i18nhelp.hxx"
+#include "vcl/svapp.hxx"
+
+#include <boost/optional.hpp>
+
+//........................................................................
+namespace vcl
+{
+//........................................................................
+
+    //====================================================================
+    //= QuickSelectionEngine_Data
+    //====================================================================
+    struct QuickSelectionEngine_Data
+    {
+        ISearchableStringList&              rEntryList;
+        String                              sCurrentSearchString;
+        ::boost::optional< sal_Unicode >    aSingleSearchChar;
+        Timer                               aSearchTimeout;
+
+        QuickSelectionEngine_Data( ISearchableStringList& _entryList )
+            :rEntryList( _entryList )
+            ,sCurrentSearchString()
+            ,aSingleSearchChar()
+            ,aSearchTimeout()
+        {
+            aSearchTimeout.SetTimeout( 2500 );
+            aSearchTimeout.SetTimeoutHdl( LINK( this, QuickSelectionEngine_Data, SearchStringTimeout ) );
+        }
+
+        ~QuickSelectionEngine_Data()
+        {
+            aSearchTimeout.Stop();
+        }
+
+        DECL_LINK( SearchStringTimeout, Timer* );
+    };
+
+    //--------------------------------------------------------------------
+    namespace
+    {
+        static void lcl_reset( QuickSelectionEngine_Data& _data )
+        {
+            _data.sCurrentSearchString.Erase();
+            _data.aSingleSearchChar.reset();
+            _data.aSearchTimeout.Stop();
+        }
+    }
+
+    //--------------------------------------------------------------------
+    IMPL_LINK( QuickSelectionEngine_Data, SearchStringTimeout, Timer*, /*EMPTYARG*/ )
+    {
+        lcl_reset( *this );
+        return 1;
+    }
+
+    //--------------------------------------------------------------------
+    static StringEntryIdentifier findMatchingEntry( const String& _searchString, QuickSelectionEngine_Data& _engineData )
+    {
+        StringEntryIdentifier foundEntry( NULL );
+
+        const vcl::I18nHelper& rI18nHelper = Application::GetSettings().GetLocaleI18nHelper();
+            // TODO: do we really need the Window's settings here? The original code used it ...
+
+        String sEntryText;
+        StringEntryIdentifier pSearchEntry = _engineData.rEntryList.CurrentEntry( sEntryText );
+        StringEntryIdentifier pStartedWith = pSearchEntry;
+        while ( pSearchEntry )
+        {
+            if ( rI18nHelper.MatchString( _searchString, sEntryText ) != 0 )
+                break;
+
+            pSearchEntry = _engineData.rEntryList.NextEntry( pSearchEntry, sEntryText );
+            if ( pSearchEntry == pStartedWith )
+                pSearchEntry = NULL;
+        }
+
+        return pSearchEntry;
+    }
+
+    //====================================================================
+    //= QuickSelectionEngine
+    //====================================================================
+    //--------------------------------------------------------------------
+    QuickSelectionEngine::QuickSelectionEngine( ISearchableStringList& _entryList )
+        :m_pData( new QuickSelectionEngine_Data( _entryList ) )
+    {
+    }
+
+    //--------------------------------------------------------------------
+    QuickSelectionEngine::~QuickSelectionEngine()
+    {
+    }
+
+    //--------------------------------------------------------------------
+    bool QuickSelectionEngine::HandleKeyEvent( const KeyEvent& _keyEvent )
+    {
+        xub_Unicode c = _keyEvent.GetCharCode();
+
+        if ( ( c >= 32 ) && ( c != 127 ) && !_keyEvent.GetKeyCode().IsMod2() )
+        {
+            m_pData->sCurrentSearchString += c;
+            OSL_TRACE( "QuickSelectionEngine::HandleKeyEvent: searching for %s", ByteString( m_pData->sCurrentSearchString, RTL_TEXTENCODING_UTF8 ).GetBuffer() );
+
+            if ( m_pData->sCurrentSearchString.Len() == 1 )
+            {   // first character in the search -> remmeber
+                m_pData->aSingleSearchChar.reset( c );
+            }
+            else if ( m_pData->sCurrentSearchString.Len() > 1 )
+            {
+                if ( !!m_pData->aSingleSearchChar && ( *m_pData->aSingleSearchChar != c ) )
+                    // we already have a "single char", but the current one is different -> reset
+                    m_pData->aSingleSearchChar.reset();
+            }
+
+            XubString aSearchTemp( m_pData->sCurrentSearchString );
+
+            StringEntryIdentifier pMatchingEntry = findMatchingEntry( aSearchTemp, *m_pData );
+            OSL_TRACE( "QuickSelectionEngine::HandleKeyEvent: found %p", pMatchingEntry );
+            if ( !pMatchingEntry && ( aSearchTemp.Len() > 1 ) && !!m_pData->aSingleSearchChar )
+            {
+                // if there's only one letter in the search string, use a different search mode
+                aSearchTemp = *m_pData->aSingleSearchChar;
+                pMatchingEntry = findMatchingEntry( aSearchTemp, *m_pData );
+            }
+
+            if ( pMatchingEntry )
+            {
+                m_pData->rEntryList.SelectEntry( pMatchingEntry );
+                m_pData->aSearchTimeout.Start();
+            }
+            else
+            {
+                lcl_reset( *m_pData );
+            }
+
+            return true;
+        }
+        return false;
+    }
+
+    //--------------------------------------------------------------------
+    void QuickSelectionEngine::Reset()
+    {
+        lcl_reset( *m_pData );
+    }
+
+//........................................................................
+} // namespace vcl
+//........................................................................