vcl/source/window/mnemonicengine.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: mnemonicengine.cxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_vcl.hxx"
  33 #include <vcl/mnemonicengine.hxx>
  34
  35 #include <vcl/i18nhelp.hxx>
  36 #include <vcl/svapp.hxx>
  37 #include <vcl/event.hxx>
  38
  39 //........................................................................
  40 namespace vcl
  41 {
  42 //........................................................................
  43
  44     //====================================================================
  45     //= MnemonicEngine_Data
  46     //====================================================================
  47     struct MnemonicEngine_Data
  48     {
  49         IMnemonicEntryList& rEntryList;
  50
  51         MnemonicEngine_Data( IMnemonicEntryList& _rEntryList )
  52             :rEntryList( _rEntryList )
  53         {
  54         }
  55     };
  56
  57     //--------------------------------------------------------------------
  58     namespace
  59     {
  60         const void* lcl_getEntryForMnemonic( IMnemonicEntryList& _rEntryList, sal_Unicode _cMnemonic, bool& _rbAmbiguous )
  61         {
  62             _rbAmbiguous = false;
  63
  64             const vcl::I18nHelper& rI18nHelper = Application::GetSettings().GetUILocaleI18nHelper();
  65
  66             String sEntryText;
  67             const void* pSearchEntry = _rEntryList.FirstSearchEntry( sEntryText );
  68
  69             const void* pFirstFoundEntry = NULL;
  70             bool bCheckingAmbiguity = false;
  71             const void* pStartedWith = pSearchEntry;
  72             while ( pSearchEntry )
  73             {
  74                 if ( rI18nHelper.MatchMnemonic( sEntryText, _cMnemonic ) )
  75                 {
  76                     if ( bCheckingAmbiguity )
  77                     {
  78                         // that's the second (at least) entry with this mnemonic
  79                         _rbAmbiguous = true;
  80                         return pFirstFoundEntry;
  81                     }
  82
  83                     pFirstFoundEntry = pSearchEntry;
  84                     bCheckingAmbiguity = true;
  85                 }
  86
  87                 pSearchEntry = _rEntryList.NextSearchEntry( pSearchEntry, sEntryText );
  88                 if ( pSearchEntry == pStartedWith )
  89                     break;
  90             }
  91
  92             return pFirstFoundEntry;
  93         }
  94     }
  95
  96     //====================================================================
  97     //= MnemonicEngine
  98     //====================================================================
  99     //--------------------------------------------------------------------
 100     MnemonicEngine::MnemonicEngine( IMnemonicEntryList& _rEntryList )
 101         :m_pData( new MnemonicEngine_Data( _rEntryList ) )
 102     {
 103     }
 104
 105     //--------------------------------------------------------------------
 106     bool MnemonicEngine::HandleKeyEvent( const KeyEvent& _rKEvt )
 107     {
 108         BOOL bAccelKey = _rKEvt.GetKeyCode().IsMod2();
 109         if ( !bAccelKey )
 110             return false;
 111
 112         sal_Unicode cChar = _rKEvt.GetCharCode();
 113         bool bAmbiguous = false;
 114         const void* pEntry = lcl_getEntryForMnemonic( m_pData->rEntryList, cChar, bAmbiguous );
 115         if ( !pEntry )
 116             return false;
 117
 118         m_pData->rEntryList.SelectSearchEntry( pEntry );
 119         if ( !bAmbiguous )
 120             m_pData->rEntryList.ExecuteSearchEntry( pEntry );
 121
 122         // handled
 123         return true;
 124     }
 125
 126     //--------------------------------------------------------------------
 127     MnemonicEngine::~MnemonicEngine()
 128     {
 129     }
 130
 131 //........................................................................
 132 } // namespace vcl
 133 //........................................................................