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