deskflow/src/lib/platform/IOSXKeyResource.h

/*
 * Deskflow -- mouse and keyboard sharing utility
 * Copyright (C) 2016 Symless Ltd.
 *
 * This package is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * found in the file LICENSE that should have accompanied this file.
 *
 * This package is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include "deskflow/KeyState.h"

class IOSXKeyResource : public IInterface
{
public:
  virtual bool isValid() const = 0;
  virtual UInt32 getNumModifierCombinations() const = 0;
  virtual UInt32 getNumTables() const = 0;
  virtual UInt32 getNumButtons() const = 0;
  virtual UInt32 getTableForModifier(UInt32 mask) const = 0;
  virtual KeyID getKey(UInt32 table, UInt32 button) const = 0;

  // Convert a character in the current script to the equivalent KeyID
  static KeyID getKeyID(UInt8);

  // Convert a unicode character to the equivalent KeyID.
  static KeyID unicharToKeyID(UniChar);
};