mirror of
https://github.com/deskflow/deskflow.git
synced 2026-07-10 21:19:24 +08:00
118 lines
2.7 KiB
C++
118 lines
2.7 KiB
C++
/*
|
|
* Deskflow -- mouse and keyboard sharing utility
|
|
* SPDX-FileCopyrightText: (C) 2012 - 2016 Symless Ltd.
|
|
* SPDX-FileCopyrightText: (C) 2004 Chris Schoeneman
|
|
* SPDX-License-Identifier: GPL-2.0-only WITH LicenseRef-OpenSSL-Exception
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "EventTypes.h"
|
|
|
|
using deskflow::EventTypes;
|
|
|
|
class EventData
|
|
{
|
|
public:
|
|
EventData() = default;
|
|
virtual ~EventData() = default;
|
|
};
|
|
|
|
//! Event
|
|
/*!
|
|
A \c Event holds an event type and a pointer to event data.
|
|
*/
|
|
class Event
|
|
{
|
|
public:
|
|
using Flags = uint32_t;
|
|
struct EventFlags
|
|
{
|
|
inline static const Flags NoFlags = 0x00; //!< No flags
|
|
inline static const Flags DeliverImmediately = 0x01; //!< Dispatch and free event immediately
|
|
inline static const Flags DontFreeData = 0x02; //!< Don't free data in deleteData
|
|
};
|
|
|
|
Event() = default;
|
|
|
|
//! Create \c Event with data (POD)
|
|
/*!
|
|
The \p data must be POD (plain old data) allocated by malloc(),
|
|
which means it cannot have a constructor, destructor or be
|
|
composed of any types that do. For non-POD (normal C++ objects
|
|
use \c setDataObject() or use appropriate constructor.
|
|
\p target is the intended recipient of the event.
|
|
\p flags is any combination of \c Flags.
|
|
*/
|
|
explicit Event(EventTypes type, void *target = nullptr, void *data = nullptr, Flags flags = EventFlags::NoFlags);
|
|
|
|
//! Create \c Event with non-POD data
|
|
/*!
|
|
\p type of the event
|
|
\p target is the intended recipient of the event.
|
|
\p dataObject with event data
|
|
*/
|
|
explicit Event(EventTypes type, void *target, EventData *dataObject);
|
|
|
|
//! @name manipulators
|
|
//@{
|
|
|
|
//! Release event data
|
|
/*!
|
|
Deletes event data for the given event (using free()).
|
|
*/
|
|
static void deleteData(const Event &);
|
|
|
|
//! Set data (non-POD)
|
|
/*!
|
|
Set non-POD (non plain old data), where delete is called when the event
|
|
is deleted, and the destructor is called.
|
|
*/
|
|
void setDataObject(EventData *dataObject);
|
|
|
|
//@}
|
|
//! @name accessors
|
|
//@{
|
|
|
|
//! Get event type
|
|
/*!
|
|
Returns the event type.
|
|
*/
|
|
EventTypes getType() const;
|
|
|
|
//! Get the event target
|
|
/*!
|
|
Returns the event target.
|
|
*/
|
|
void *getTarget() const;
|
|
|
|
//! Get the event data (POD).
|
|
/*!
|
|
Returns the event data (POD).
|
|
*/
|
|
void *getData() const;
|
|
|
|
//! Get the event data (non-POD)
|
|
/*!
|
|
Returns the event data (non-POD). The difference between this and
|
|
\c getData() is that when delete is called on this data, so non-POD
|
|
(non plain old data) dtor is called.
|
|
*/
|
|
EventData *getDataObject() const;
|
|
|
|
//! Get event flags
|
|
/*!
|
|
Returns the event flags.
|
|
*/
|
|
Flags getFlags() const;
|
|
|
|
//@}
|
|
|
|
private:
|
|
EventTypes m_type = EventTypes::Unknown;
|
|
void *m_target = nullptr;
|
|
void *m_data = nullptr;
|
|
Flags m_flags = EventFlags::NoFlags;
|
|
EventData *m_dataObject = nullptr;
|
|
};
|