Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef VCL_QUICKSELECTIONENGINE_HXX
      21             : #define VCL_QUICKSELECTIONENGINE_HXX
      22             : 
      23             : #include "dllapi.h"
      24             : 
      25             : #include <tools/string.hxx>
      26             : 
      27             : #include <memory>
      28             : 
      29             : class KeyEvent;
      30             : 
      31             : //........................................................................
      32             : namespace vcl
      33             : {
      34             : //........................................................................
      35             : 
      36             :     typedef const void* StringEntryIdentifier;
      37             : 
      38             :     //====================================================================
      39             :     //= ISearchableStringList
      40             :     //====================================================================
      41             :     // TODO: consolidate this with ::vcl::IMnemonicEntryList
      42           0 :     class SAL_NO_VTABLE VCL_DLLPUBLIC ISearchableStringList
      43             :     {
      44             :     public:
      45             :         /** returns the current entry in the list of searchable strings.
      46             : 
      47             :             Search operations will start with this entry.
      48             :         */
      49             :         virtual StringEntryIdentifier   CurrentEntry( String& _out_entryText ) const = 0;
      50             : 
      51             :         /** returns the next entry in the list.
      52             : 
      53             :             The implementation is expected to wrap around. That is, if the given entry denotes the last
      54             :             entry in the list, then NextEntry should return the first entry.
      55             :         */
      56             :         virtual StringEntryIdentifier   NextEntry( StringEntryIdentifier _currentEntry, String& _out_entryText ) const = 0;
      57             : 
      58             :         /** selects a given entry
      59             :         */
      60             :         virtual void                    SelectEntry( StringEntryIdentifier _entry ) = 0;
      61             : 
      62             :     protected:
      63           0 :         ~ISearchableStringList() {}
      64             :     };
      65             : 
      66             :     //====================================================================
      67             :     //= QuickSelectionEngine
      68             :     //====================================================================
      69             :     struct QuickSelectionEngine_Data;
      70             :     class VCL_DLLPUBLIC QuickSelectionEngine
      71             :     {
      72             :     public:
      73             :         QuickSelectionEngine( ISearchableStringList& _entryList );
      74             :         ~QuickSelectionEngine();
      75             : 
      76             :         bool    HandleKeyEvent( const KeyEvent& _rKEvt );
      77             :         void    Reset();
      78             : 
      79             :     private:
      80             :         ::std::auto_ptr< QuickSelectionEngine_Data >    m_pData;
      81             : 
      82             :     private:
      83             :         QuickSelectionEngine();                                         // never implemented
      84             :         QuickSelectionEngine( const QuickSelectionEngine& );            // never implemented
      85             :         QuickSelectionEngine& operator=( const QuickSelectionEngine& ); // never implemented
      86             :     };
      87             : 
      88             : //........................................................................
      89             : } // namespace vcl
      90             : //........................................................................
      91             : 
      92             : #endif // VCL_QUICKSELECTIONENGINE_HXX
      93             : 
      94             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */