BPS C++ API  2.24.4
BpsKeyFilter Class Reference

Event filter catching key press/release events and emitting signals for them. More...

#include <bpskeyfilter.h>

+ Inheritance diagram for BpsKeyFilter:

Public Types

enum  {
  Enter , F1 , F2 , F3 , F4 , F5 , F6 , F7 , F8 , F9 ,
  F10 , F11 , F12 , CtrlEnter , CtrlF1 , CtrlF2 , CtrlF3 , CtrlF4 , CtrlF5 , CtrlF6 ,
  CtrlF7 , CtrlF8 , CtrlF9 , CtrlF10 , CtrlF11 , CtrlF12 , AltEnter , AltF1 , AltF2 , AltF3 ,
  AltF4 , AltF5 , AltF6 , AltF7 , AltF8 , AltF9 , AltF10 , AltF11 , AltF12
}
 Key specifiers. More...
 

Signals

void keyPressed ()
 This signal is emitted when any of the given keys was pressed. More...
 
void keyPressed (int aKey)
 This signal is emitted when any of the given keys was pressed. More...
 
void keyReleased ()
 This signal is emitted when the key was released. More...
 
void keyReleased (int aKey)
 This signal is emitted when any of the given keys was released. More...
 

Public Member Functions

 BpsKeyFilter (const QSet< int > &aKeys, QObject *aParent=nullptr)
 Filter for list of given keys. More...
 
 BpsKeyFilter (int aKey, QObject *aParent=nullptr)
 Filter for a single given key. More...
 
- Public Member Functions inherited from QObject
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
 QObject (QObject *parent)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Event filter catching key press/release events and emitting signals for them.

// create filters
BpsKeyFilter* enterKeyFilter = new BpsKeyFilter(BpsKeyFilter::Enter, this);
QSet<int> fkeys;
BpsKeyFilter* scalesKeyFilter = new BpsKeyFilter(fkeys , this);
// apply filters to current widget
installEventFilter(enterKeyFilter);
installEventFilter(scalesKeyFilter);
// make connections
connect(enterKeyFilter, SIGNAL(keyPressed()), this, SLOT(weigh()));
connect(scalesKeyFilter, SIGNAL(keyPressed(int)), this, SLOT(selSales(int)));
Event filter catching key press/release events and emitting signals for them.
Definition: bpskeyfilter.h:30
BpsKeyFilter(int aKey, QObject *aParent=nullptr)
Filter for a single given key.
void keyPressed()
This signal is emitted when any of the given keys was pressed.
@ Enter
Enter.
Definition: bpskeyfilter.h:39
@ F4
F4.
Definition: bpskeyfilter.h:43
@ F3
F3.
Definition: bpskeyfilter.h:42
@ F5
F5.
Definition: bpskeyfilter.h:44
QMetaObject::Connection connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
void installEventFilter(QObject *filterObj)

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Key specifiers.

Enumerator
Enter 

Enter.

F1 

F1.

F2 

F2.

F3 

F3.

F4 

F4.

F5 

F5.

F6 

F6.

F7 

F7.

F8 

F8.

F9 

F9.

F10 

F10.

F11 

F11.

F12 

F12.

CtrlEnter 

Ctrl and Enter.

CtrlF1 

Ctrl and F1.

CtrlF2 

Ctrl and F2.

CtrlF3 

Ctrl and F3.

CtrlF4 

Ctrl and F4.

CtrlF5 

Ctrl and F5.

CtrlF6 

Ctrl and F6.

CtrlF7 

Ctrl and F7.

CtrlF8 

Ctrl and F8.

CtrlF9 

Ctrl and F9.

CtrlF10 

Ctrl and F10.

CtrlF11 

Ctrl and F11.

CtrlF12 

Ctrl and F12.

AltEnter 

Alt and Enter.

AltF1 

Alt and F1.

AltF2 

Alt and F2.

AltF3 

Alt and F3.

AltF4 

Alt and F4.

AltF5 

Alt and F5.

AltF6 

Alt and F6.

AltF7 

Alt and F7.

AltF8 

Alt and F8.

AltF9 

Alt and F9.

AltF10 

Alt and F10.

AltF11 

Alt and F11.

AltF12 

Alt and F12.

Constructor & Destructor Documentation

◆ BpsKeyFilter() [1/2]

BpsKeyFilter::BpsKeyFilter ( int  aKey,
QObject aParent = nullptr 
)

Filter for a single given key.

Parameters
aKeyThe key to handle (see key specifiers).
aParentThe parent object.

◆ BpsKeyFilter() [2/2]

BpsKeyFilter::BpsKeyFilter ( const QSet< int > &  aKeys,
QObject aParent = nullptr 
)

Filter for list of given keys.

Parameters
aKeysA set of keys to handle (see key specifiers).
aParentThe parent object.

Member Function Documentation

◆ keyPressed [1/2]

void BpsKeyFilter::keyPressed ( )
signal

This signal is emitted when any of the given keys was pressed.

This is a convenience overload useful when only one single key is filtered.

◆ keyPressed [2/2]

void BpsKeyFilter::keyPressed ( int  aKey)
signal

This signal is emitted when any of the given keys was pressed.

Parameters
aKeyThe key that was pressed (see key specifiers).

◆ keyReleased [1/2]

void BpsKeyFilter::keyReleased ( )
signal

This signal is emitted when the key was released.

This is a convenience overload useful when only one single key is filtered.

◆ keyReleased [2/2]

void BpsKeyFilter::keyReleased ( int  aKey)
signal

This signal is emitted when any of the given keys was released.

Parameters
aKeyThe key that was released (see key specifiers).

The documentation for this class was generated from the following file: