vcl/inc/accel.hxx

   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 #pragma once
  21
  22 #include <tools/solar.h>
  23 #include <tools/link.hxx>
  24 #include <vcl/keycod.hxx>
  25 #include <memory>
  26 #include <map>
  27 #include <vector>
  28
  29 class CommandEvent;
  30
  31 class Accelerator;
  32
  33 class ImplAccelEntry
  34 {
  35 public:
  36     Accelerator*    mpAccel;
  37     Accelerator*    mpAutoAccel;
  38     vcl::KeyCode    maKeyCode;
  39     sal_uInt16      mnId;
  40     bool            mbEnabled;
  41 };
  42
  43 typedef ::std::vector< std::unique_ptr<ImplAccelEntry> > ImplAccelList;
  44
  45 class Accelerator
  46 {
  47     friend class ImplAccelManager;
  48
  49 private:
  50     typedef ::std::map< sal_uLong, ImplAccelEntry* > ImplAccelMap;
  51     ImplAccelMap  maKeyMap; // for keycodes, generated with a code
  52     ImplAccelList maIdList; // Id-List
  53     Link<Accelerator&,void> maActivateHdl;
  54     Link<Accelerator&,void> maSelectHdl;
  55
  56     // Will be set by AcceleratorManager
  57     sal_uInt16              mnCurId;
  58     bool*                   mpDel;
  59
  60     void    ImplInit();
  61     void    ImplCopyData( const Accelerator& rAccelData );
  62     void    ImplDeleteData();
  63     void    ImplInsertAccel(sal_uInt16 nItemId, const vcl::KeyCode& rKeyCode,
  64                             bool bEnable, Accelerator* pAutoAccel);
  65
  66     ImplAccelEntry*         ImplGetAccelData( const vcl::KeyCode& rKeyCode ) const;
  67
  68 public:
  69                             Accelerator();
  70                             Accelerator( const Accelerator& rAccel );
  71                             ~Accelerator();
  72
  73     void                    Activate();
  74     void                    Select();
  75
  76     void                    InsertItem( sal_uInt16 nItemId, const vcl::KeyCode& rKeyCode );
  77
  78     sal_uInt16              GetCurItemId() const { return mnCurId; }
  79
  80     sal_uInt16              GetItemCount() const;
  81     sal_uInt16              GetItemId( sal_uInt16 nPos ) const;
  82
  83     Accelerator*            GetAccel( sal_uInt16 nItemId ) const;
  84
  85     void                    SetActivateHdl( const Link<Accelerator&,void>& rLink ) { maActivateHdl = rLink; }
  86     void                    SetSelectHdl( const Link<Accelerator&,void>& rLink ) { maSelectHdl = rLink; }
  87
  88     Accelerator&            operator=( const Accelerator& rAccel );
  89 };
  90
  91 bool ImplGetKeyCode( KeyFuncType eFunc, sal_uInt16& rCode1, sal_uInt16& rCode2, sal_uInt16& rCode3, sal_uInt16& rCode4 );
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */