QGamepadManager Class

Queries attached gamepads and related events. More...

Header: #include <QGamepadManager>
qmake: QT += gamepad
Inherits: QObject

Public Types

flags GamepadAxes
enum GamepadAxis { AxisInvalid, AxisLeftX, AxisLeftY, AxisRightX, AxisRightY }
enum GamepadButton { ButtonInvalid, ButtonA, ButtonB, ButtonX, ..., ButtonGuide }
flags GamepadButtons

Properties

  • 1 property inherited from QObject

Public Functions

const QList<int> connectedGamepads() const
bool isGamepadConnected(int deviceId) const
  • 32 public functions inherited from QObject

Public Slots

bool configureAxis(int deviceId, GamepadAxis axis)
bool configureButton(int deviceId, GamepadButton button)
bool isConfigurationNeeded(int deviceId) const
void resetConfiguration(int deviceId)
bool setCancelConfigureButton(int deviceId, GamepadButton button)
void setSettingsFile(const QString &file)
  • 1 public slot inherited from QObject

Signals

void axisConfigured(int deviceId, QGamepadManager::GamepadAxis axis)
void buttonConfigured(int deviceId, QGamepadManager::GamepadButton button)
void configurationCanceled(int deviceId)
void connectedGamepadsChanged()
void gamepadAxisEvent(int deviceId, QGamepadManager::GamepadAxis axis, double value)
void gamepadButtonPressEvent(int deviceId, QGamepadManager::GamepadButton button, double value)
void gamepadButtonReleaseEvent(int deviceId, QGamepadManager::GamepadButton button)
void gamepadConnected(int deviceId)
void gamepadDisconnected(int deviceId)

Static Public Members

QGamepadManager *instance()
  • 11 static public members inherited from QObject

Additional Inherited Members

  • 9 protected functions inherited from QObject

Detailed Description

Queries attached gamepads and related events.

QGamepadManager provides a high-level interface for querying the attached gamepads and events related to all of the connected devices.

Member Type Documentation

enum QGamepadManager::GamepadAxis
flags QGamepadManager::GamepadAxes

The GamepadAxes type is a typedef for QFlags<GamepadAxis>. It stores an OR combination of GamepadAxis values.

enum QGamepadManager::GamepadButton
flags QGamepadManager::GamepadButtons

The GamepadButtons type is a typedef for QFlags<GamepadButton>. It stores an OR combination of GamepadButton values.

Property Documentation

connectedGamepads : const QList<int>

Access functions:

const QList<int> connectedGamepads() const

Notifier signal:

void connectedGamepadsChanged()

Member Function Documentation

[signal] void QGamepadManager::axisConfigured(int deviceId, QGamepadManager::GamepadAxis axis)

[signal] void QGamepadManager::buttonConfigured(int deviceId, QGamepadManager::GamepadButton button)

[signal] void QGamepadManager::configurationCanceled(int deviceId)

[slot] bool QGamepadManager::configureAxis(int deviceId, GamepadAxis axis)

Configures axis on the gamepad with the specified deviceId. Returns true in case of success.

[slot] bool QGamepadManager::configureButton(int deviceId, GamepadButton button)

Configures the specified button on the gamepad with this deviceId. Returns true in case of success.

const QList<int> QGamepadManager::connectedGamepads() const

Returns a QList containing the deviceId values of the connected gamepads.

Note: Getter function for property connectedGamepads.

[signal] void QGamepadManager::gamepadAxisEvent(int deviceId, QGamepadManager::GamepadAxis axis, double value)

[signal] void QGamepadManager::gamepadButtonPressEvent(int deviceId, QGamepadManager::GamepadButton button, double value)

[signal] void QGamepadManager::gamepadButtonReleaseEvent(int deviceId, QGamepadManager::GamepadButton button)

[signal] void QGamepadManager::gamepadConnected(int deviceId)

[signal] void QGamepadManager::gamepadDisconnected(int deviceId)

[static] QGamepadManager *QGamepadManager::instance()

Returns the instance of the QGamepadManager.

[slot] bool QGamepadManager::isConfigurationNeeded(int deviceId) const

Returns a boolean indicating whether configuration is needed for the specified deviceId.

bool QGamepadManager::isGamepadConnected(int deviceId) const

Returns a boolean indicating whether the gamepad with the specified deviceId is connected or not.

[slot] void QGamepadManager::resetConfiguration(int deviceId)

Resets the configuration on the gamepad with the specified deviceId.

[slot] bool QGamepadManager::setCancelConfigureButton(int deviceId, GamepadButton button)

Configures button as the cancel button on the gamepad with id deviceId. Returns true in case of success.

[slot] void QGamepadManager::setSettingsFile(const QString &file)

Sets the name of the file that stores the button and axis configuration data.

© 2017 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.