kwin/x11eventfilter.h
2020-08-07 19:57:56 +00:00

76 lines
1.7 KiB
C++

/*
KWin - the KDE window manager
This file is part of the KDE project.
SPDX-FileCopyrightText: 2014 Fredrik Höglund <fredrik@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef X11EVENTFILTER_H
#define X11EVENTFILTER_H
#include <xcb/xcb.h>
#include <QVector>
#include <kwin_export.h>
namespace KWin
{
class KWIN_EXPORT X11EventFilter
{
public:
/**
* Creates an event filter for the given event type.
*/
X11EventFilter(int eventType, int opcode = 0, int genericEventType = 0);
X11EventFilter(int eventType, int opcode, const QVector<int> &genericEventTypes);
X11EventFilter(const QVector<int> &eventTypes);
/**
* Destroys the event filter.
*/
virtual ~X11EventFilter();
/**
* Returns the type of events to filter.
*/
QVector<int> eventTypes() const { return m_eventTypes; }
/**
* Returns the major opcode of the extension.
*
* Only used when the event type is XCB_GE_GENERIC.
*/
int extension() const { return m_extension; }
/**
* Returns the types of generic events to filter.
*
* Only used when the event type is XCB_GE_GENERIC.
*/
QVector<int> genericEventTypes() const { return m_genericEventTypes; }
/**
* This method is called for every event of the filtered type.
*
* Return true to accept the event and stop further processing, and false otherwise.
*/
virtual bool event(xcb_generic_event_t *event) = 0;
/**
* Whether the event filter is for XCB_GE_GENERIC events.
*/
bool isGenericEvent() const;
private:
QVector<int> m_eventTypes;
int m_extension;
QVector<int> m_genericEventTypes;
};
} // namespace KWin
#endif