framework/source/inc/accelerators/acceleratorcache.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 #ifndef INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_ACCELERATORCACHE_HXX
  21 #define INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_ACCELERATORCACHE_HXX
  22
  23 #include <general.h>
  24 #include <stdtypes.h>
  25
  26 #include <com/sun/star/awt/KeyEvent.hpp>
  27
  28 #include <vector>
  29
  30 // definition
  31
  32 namespace framework
  33 {
  34
  35 /**
  36     @short  implements a cache for any accelerator configuration.
  37
  38     @descr  Its implemented threadsafe, supports copy-on-write pattern
  39             and a flush mechansim to support concurrent access to the same
  40             configuration.
  41
  42             copy-on-write ... How? Do the following:
  43  */
  44 class AcceleratorCache
  45 {
  46
  47     // const, types
  48
  49     public:
  50
  51         /** TODO document me
  52             commands -> keys
  53         */
  54         typedef ::std::vector< css::awt::KeyEvent > TKeyList;
  55         typedef BaseHash< TKeyList > TCommand2Keys;
  56
  57         /** TODO document me
  58             keys -> commands
  59         */
  60         typedef std::unordered_map< css::awt::KeyEvent ,
  61                                     OUString    ,
  62                                     KeyEventHashCode   ,
  63                                     KeyEventEqualsFunc > TKey2Commands;
  64
  65     // member
  66
  67     private:
  68
  69         /** map commands to keys in relation 1:n.
  70             First key is interpreted as preferred one! */
  71         TCommand2Keys m_lCommand2Keys;
  72
  73         /** map keys to commands in relation 1:1. */
  74         TKey2Commands m_lKey2Commands;
  75
  76     // interface
  77
  78     public:
  79
  80         /** @short  creates a new - but empty - cache instance. */
  81         AcceleratorCache();
  82
  83         /** @short  make a copy of this cache.
  84             @descr  Used for the copy-on-write feature.
  85         */
  86         AcceleratorCache(const AcceleratorCache& rCopy);
  87
  88         /** @short  does nothing real. */
  89         virtual ~AcceleratorCache();
  90
  91         /** @short  write changes back to the original container.
  92
  93             @param  rCopy
  94                     the (changed!) copy, which should be written
  95                     back to this original container.
  96           */
  97         void takeOver(const AcceleratorCache& rCopy);
  98
  99         /** TODO document me */
 100         AcceleratorCache& operator=(const AcceleratorCache& rCopy);
 101
 102         /** @short  checks if the specified key exists.
 103
 104             @param  aKey
 105                     the key, which should be checked.
 106
 107             @return [bool]
 108                     sal_True if the speicfied key exists inside this container.
 109          */
 110         bool hasKey(const css::awt::KeyEvent& aKey) const;
 111         bool hasCommand(const OUString& sCommand) const;
 112
 113         /** TODO document me */
 114         TKeyList getAllKeys() const;
 115
 116         /** @short  add a new or change an existing key-command pair
 117                     of this container.
 118
 119             @param  aKey
 120                     describe the key.
 121
 122             @param  sCommand
 123                     describe the command.
 124           */
 125         void setKeyCommandPair(const css::awt::KeyEvent& aKey    ,
 126                                        const OUString&    sCommand);
 127
 128         /** @short  returns the list of keys, which are registered
 129                     for this command.
 130
 131             @param  sCommand
 132                     describe the command.
 133
 134             @return [TKeyList]
 135                     the list of registered keys. Can be empty!
 136           */
 137         TKeyList getKeysByCommand(const OUString& sCommand) const;
 138
 139         /** TODO */
 140         OUString getCommandByKey(const css::awt::KeyEvent& aKey) const;
 141
 142         /** TODO */
 143         void removeKey(const css::awt::KeyEvent& aKey);
 144         void removeCommand(const OUString& sCommand);
 145 };
 146
 147 } // namespace framework
 148
 149 #endif // INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_ACCELERATORCACHE_HXX
 150
 151 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */