vcl/source/window/accmgr.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29
  30 #include <tools/debug.hxx>
  31
  32 #include <accel.h>
  33 #include <vcl/accel.hxx>
  34 #include <accmgr.hxx>
  35
  36 // =======================================================================
  37
  38 DBG_NAMEEX( Accelerator )
  39
  40 // =======================================================================
  41
  42 ImplAccelManager::~ImplAccelManager()
  43 {
  44     delete mpAccelList;
  45     delete mpSequenceList;
  46 }
  47
  48 // -----------------------------------------------------------------------
  49
  50 sal_Bool ImplAccelManager::InsertAccel( Accelerator* pAccel )
  51 {
  52     if ( !mpAccelList ) {
  53         mpAccelList = new ImplAccelList;
  54     } else {
  55         for ( size_t i = 0, n = mpAccelList->size(); i < n; ++i ) {
  56             if ( (*mpAccelList)[ i ] == pAccel ) {
  57                 return sal_False;
  58             }
  59         }
  60     }
  61
  62     mpAccelList->insert( mpAccelList->begin(), pAccel );
  63     return sal_True;
  64 }
  65
  66 // -----------------------------------------------------------------------
  67
  68 void ImplAccelManager::RemoveAccel( Accelerator* pAccel )
  69 {
  70     // do we have a list ?
  71     if ( !mpAccelList )
  72         return;
  73
  74     //e.g. #i90599#. Someone starts typing a sequence in a dialog, but doesn't
  75     //end it, and then closes the dialog, deleting the accelerators. So if
  76     //we're removing an accelerator that a sub-accelerator which is in the
  77     //sequence list, throw away the entire sequence
  78     if ( mpSequenceList ) {
  79         for (sal_uInt16 i = 0; i < pAccel->GetItemCount(); ++i) {
  80             Accelerator* pSubAccel = pAccel->GetAccel( pAccel->GetItemId(i) );
  81             for ( size_t j = 0, n = mpSequenceList->size(); j < n; ++j ) {
  82                 if ( (*mpSequenceList)[ j ] == pSubAccel ) {
  83                     EndSequence( true );
  84                     i = pAccel->GetItemCount();
  85                     break;
  86                 }
  87             }
  88         }
  89     }
  90
  91     // throw it away
  92     for ( ImplAccelList::iterator it = mpAccelList->begin();
  93           it != mpAccelList->end();
  94           ++it
  95     ) {
  96         if ( *it == pAccel ) {
  97             mpAccelList->erase( it );
  98             break;
  99         }
 100     }
 101 }
 102
 103 // -----------------------------------------------------------------------
 104
 105 void ImplAccelManager::EndSequence( sal_Bool bCancel )
 106 {
 107     // are we in a list ?
 108     if ( !mpSequenceList )
 109         return;
 110
 111     // call all deactivate-handler of the accelerators in the list
 112     for ( size_t i = 0, n = mpSequenceList->size(); i < n; ++i )
 113     {
 114         Accelerator* pTempAccel = (*mpSequenceList)[ i ];
 115         sal_Bool bDel = sal_False;
 116         pTempAccel->mbIsCancel = bCancel;
 117         pTempAccel->mpDel = &bDel;
 118         pTempAccel->Deactivate();
 119         if ( !bDel )
 120         {
 121             pTempAccel->mbIsCancel = sal_False;
 122             pTempAccel->mpDel = NULL;
 123         }
 124     }
 125
 126     // delete sequence-list
 127     delete mpSequenceList;
 128     mpSequenceList = NULL;
 129 }
 130
 131 // -----------------------------------------------------------------------
 132
 133 sal_Bool ImplAccelManager::IsAccelKey( const KeyCode& rKeyCode, sal_uInt16 nRepeat )
 134 {
 135     Accelerator* pAccel;
 136
 137     // do we have accelerators ??
 138     if ( !mpAccelList )
 139         return sal_False;
 140     if ( mpAccelList->empty() )
 141         return sal_False;
 142
 143     // are we in a sequence ?
 144     if ( mpSequenceList )
 145     {
 146         pAccel = mpSequenceList->empty() ? NULL : (*mpSequenceList)[ 0 ];
 147         DBG_CHKOBJ( pAccel, Accelerator, NULL );
 148
 149         // not found ?
 150         if ( !pAccel )
 151         {
 152             // abort sequence
 153             FlushAccel();
 154             return sal_False;
 155         }
 156
 157         // can the entry be found ?
 158         ImplAccelEntry* pEntry = pAccel->ImplGetAccelData( rKeyCode );
 159         if ( pEntry )
 160         {
 161             Accelerator* pNextAccel = pEntry->mpAccel;
 162
 163             // is an accelerator coupled ?
 164             if ( pNextAccel )
 165             {
 166                 DBG_CHKOBJ( pNextAccel, Accelerator, NULL );
 167
 168                 mpSequenceList->insert( mpSequenceList->begin(), pNextAccel );
 169
 170                 // call Activate-Handler of the new one
 171                 pNextAccel->Activate();
 172                 return sal_True;
 173             }
 174             else
 175             {
 176                 // it is there already !
 177                 if ( pEntry->mbEnabled )
 178                 {
 179                     // stop sequence (first call deactivate-handler)
 180                     EndSequence();
 181
 182                     // set accelerator of the actuel item
 183                     // and call the handler
 184                     sal_Bool bDel = sal_False;
 185                     pAccel->maCurKeyCode    = rKeyCode;
 186                     pAccel->mnCurId         = pEntry->mnId;
 187                     pAccel->mnCurRepeat     = nRepeat;
 188                     pAccel->mpDel           = &bDel;
 189                     pAccel->Select();
 190
 191                     // did the accelerator survive the call
 192                     if ( !bDel )
 193                     {
 194                         DBG_CHKOBJ( pAccel, Accelerator, NULL );
 195                         pAccel->maCurKeyCode    = KeyCode();
 196                         pAccel->mnCurId         = 0;
 197                         pAccel->mnCurRepeat     = 0;
 198                         pAccel->mpDel           = NULL;
 199                     }
 200
 201                     return sal_True;
 202                 }
 203                 else
 204                 {
 205                     // stop sequence as the accelerator was disbled
 206                     // transfer the key (to the system)
 207                     FlushAccel();
 208                     return sal_False;
 209                 }
 210             }
 211         }
 212         else
 213         {
 214             // wrong key => stop sequence
 215             FlushAccel();
 216             return sal_False;
 217         }
 218     }
 219
 220     // step through the list of accelerators
 221     for ( size_t i = 0, n = mpAccelList->size(); i < n; ++i )
 222     {
 223         pAccel = (*mpAccelList)[ i ];
 224         DBG_CHKOBJ( pAccel, Accelerator, NULL );
 225
 226         // is the entry contained ?
 227         ImplAccelEntry* pEntry = pAccel->ImplGetAccelData( rKeyCode );
 228         if ( pEntry )
 229         {
 230             Accelerator* pNextAccel = pEntry->mpAccel;
 231
 232             // is an accelerator assigned ?
 233             if ( pNextAccel )
 234             {
 235                 DBG_CHKOBJ( pNextAccel, Accelerator, NULL );
 236
 237                 // create sequence list
 238                 mpSequenceList = new ImplAccelList;
 239                 mpSequenceList->insert( mpSequenceList->begin(), pAccel     );
 240                 mpSequenceList->insert( mpSequenceList->begin(), pNextAccel );
 241
 242                 // call activate-Handler of the new one
 243                 pNextAccel->Activate();
 244
 245                 return sal_True;
 246             }
 247             else
 248             {
 249                 // already assigned !
 250                 if ( pEntry->mbEnabled )
 251                 {
 252                     // first call activate/aeactivate-Handler
 253                     pAccel->Activate();
 254                     pAccel->Deactivate();
 255
 256                     // define accelerator of the actual item
 257                     // and call the handler
 258                     sal_Bool bDel = sal_False;
 259                     pAccel->maCurKeyCode    = rKeyCode;
 260                     pAccel->mnCurId         = pEntry->mnId;
 261                     pAccel->mnCurRepeat     = nRepeat;
 262                     pAccel->mpDel           = &bDel;
 263                     pAccel->Select();
 264
 265                     // if the accelerator did survive the call
 266                     if ( !bDel )
 267                     {
 268                         DBG_CHKOBJ( pAccel, Accelerator, NULL );
 269                         pAccel->maCurKeyCode    = KeyCode();
 270                         pAccel->mnCurId         = 0;
 271                         pAccel->mnCurRepeat     = 0;
 272                         pAccel->mpDel           = NULL;
 273                     }
 274
 275                     return sal_True;
 276                 }
 277                 else
 278                     return sal_False;
 279             }
 280         }
 281     }
 282
 283     return sal_False;
 284 }
 285
 286 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */