stmm-games-doc  0.32.0
Public Member Functions | List of all members
stmi::testing::FakeKeyCapability Class Reference

Fake key capability. More...

Inheritance diagram for stmi::testing::FakeKeyCapability:
Inheritance graph
[legend]

Public Member Functions

 FakeKeyCapability (FakeDevice< FakeKeyCapability > *p0Device) noexcept
 Constructor. More...
 
shared_ptr< DevicegetDevice () const noexcept override
 Returns the device owning this capability, if any. More...
 
bool isKeyboard () const noexcept override
 Not implemented. More...
 
- Public Member Functions inherited from stmi::Capability
virtual ~Capability () noexcept=default
 
int32_t getId () const noexcept
 The capability id. More...
 
const ClassgetCapabilityClass () const noexcept
 Get the registered class of the capability instance. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from stmi::KeyCapability
static const Capability::ClassgetClass () noexcept
 
- Static Public Member Functions inherited from stmi::Capability
static bool isCapabilityClassIdRegistered (const std::string &sCapabilityClassId) noexcept
 Tells whether the given capability class id is registered. More...
 
static Class getCapabilityClassIdClass (const std::string &sCapabilityClassId) noexcept
 Gets the class with given class id. More...
 
- Static Public Attributes inherited from stmi::KeyCapability
static const char *const s_sClassId
 
- Protected Member Functions inherited from stmi::KeyCapability
 KeyCapability () noexcept
 
- Protected Member Functions inherited from stmi::Capability
 Capability (const Class &oClass) noexcept
 Constructor to be called from subclasses. More...
 
- Static Protected Member Functions inherited from stmi::Capability
static bool isCapabilityTypeRegistered (const std::type_info &oCapabilityType) noexcept
 Tells whether a capability type was registered. More...
 
static const std::type_info & getCapabilityClassIdType (const std::string &sCapabilityClassId, bool &bRegistered) noexcept
 Gets the type of the registered capability subclass associated with class id. More...
 
static std::string getCapabilityTypeClassId (const std::type_info &oType) noexcept
 Gets the class id of the given type. More...
 

Detailed Description

Fake key capability.

Constructor & Destructor Documentation

◆ FakeKeyCapability()

stmi::testing::FakeKeyCapability::FakeKeyCapability ( FakeDevice< FakeKeyCapability > *  p0Device)
inlinenoexcept

Constructor.

Parameters
p0DeviceThe fake device the instance belongs to. Cannot be null.

Member Function Documentation

◆ getDevice()

shared_ptr<Device> stmi::testing::FakeKeyCapability::getDevice ( ) const
inlineoverridevirtualnoexcept

Returns the device owning this capability, if any.

If it's a device manager capability this might return null. It also can be null if the device was deleted.

Implements stmi::Capability.

◆ isKeyboard()

bool stmi::testing::FakeKeyCapability::isKeyboard ( ) const
inlineoverridevirtualnoexcept

Not implemented.

Implements stmi::KeyCapability.