include/vcl/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 #ifndef INCLUDED_VCL_ACCEL_HXX
  21 #define INCLUDED_VCL_ACCEL_HXX
  22
  23 #include <tools/link.hxx>
  24 #include <vcl/keycod.hxx>
  25 #include <vcl/dllapi.h>
  26
  27 class ImplAccelData;
  28 class ImplAccelEntry;
  29 class CommandEvent;
  30
  31 class VCL_DLLPUBLIC Accelerator
  32 {
  33     friend class ImplAccelManager;
  34
  35 private:
  36     ImplAccelData*          mpData;
  37     Link<Accelerator&,void> maActivateHdl;
  38     Link<Accelerator&,void> maSelectHdl;
  39
  40     // Will be set by AcceleratorManager
  41     vcl::KeyCode            maCurKeyCode;
  42     sal_uInt16              mnCurId;
  43     sal_uInt16              mnCurRepeat;
  44     bool*                   mpDel;
  45
  46     SAL_DLLPRIVATE  void    ImplInit();
  47     SAL_DLLPRIVATE  void    ImplCopyData( ImplAccelData& rAccelData );
  48     SAL_DLLPRIVATE  void    ImplDeleteData();
  49     SAL_DLLPRIVATE  void    ImplInsertAccel(
  50                                 sal_uInt16 nItemId,
  51                                 const vcl::KeyCode& rKeyCode,
  52                                 bool bEnable,
  53                                 Accelerator* pAutoAccel );
  54
  55     SAL_DLLPRIVATE  ImplAccelEntry*
  56                             ImplGetAccelData( const vcl::KeyCode& rKeyCode ) const;
  57
  58 public:
  59                             Accelerator();
  60                             Accelerator( const Accelerator& rAccel );
  61                             ~Accelerator();
  62
  63     void                    Activate();
  64     void                    Select();
  65
  66     void                    InsertItem( sal_uInt16 nItemId, const vcl::KeyCode& rKeyCode );
  67
  68     sal_uInt16              GetCurItemId() const { return mnCurId; }
  69     const vcl::KeyCode&     GetCurKeyCode() const { return maCurKeyCode; }
  70
  71     sal_uInt16              GetItemCount() const;
  72     sal_uInt16              GetItemId( sal_uInt16 nPos ) const;
  73
  74     Accelerator*            GetAccel( sal_uInt16 nItemId ) const;
  75
  76     void                    SetActivateHdl( const Link<Accelerator&,void>& rLink ) { maActivateHdl = rLink; }
  77     void                    SetSelectHdl( const Link<Accelerator&,void>& rLink ) { maSelectHdl = rLink; }
  78
  79     Accelerator&            operator=( const Accelerator& rAccel );
  80
  81     static bool             ToggleMnemonicsOnHierarchy(const CommandEvent& rCEvent, vcl::Window *pWindow);
  82     static void             GenerateAutoMnemonicsOnHierarchy(vcl::Window* pWindow);
  83 };
  84
  85 #endif // INCLUDED_VCL_ACCEL_HXX
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */