QCustomEvent(3qt)

📦 version 3.3.8b, in fedora 43, fedora 44

💖 QCustomEvent 💖

okay bestie, welcome to the QCustomEvent(3qt) page — this is the Qt 3 manual, and we're about to make custom events make sense. no cap. 🦋

✨ NAME ✨

QCustomEvent — support for custom events. that's it, that's the whole job. 💅

🌸 SYNOPSIS 🌸

#include <qevent.h>

Inherits QEvent.

🎀 Public Members 🎀

QCustomEvent ( int type )
QCustomEvent ( Type type, void * data )
void * data () const
void setData ( void * data )

💜 DESCRIPTION 💜

The QCustomEvent class provides support for custom events. periodt. 🔥

QCustomEvent is a generic event class for user-defined events, like the blank canvas of the event world. User defined events can be sent to widgets or other QObject instances using QApplication::postEvent() or QApplication::sendEvent(). And here's the slay part: subclasses of QObject can easily receive custom events by implementing the QObject::customEvent() event handler function. it's giving "we made it easy for u." 💖

QCustomEvent objects should be created with a type ID that uniquely identifies the event type. To avoid clashes with the Qt-defined events types, the value should be at least as large as the value of the "User" entry in the QEvent::Type enum. like, don't pick a number in Qt's lane, pick your own lane bestie. 🚫

QCustomEvent contains a generic void* data member that may be used for transferring event-specific data to the receiver. ⚠️ Note this tho: since events are normally delivered asynchronously, the data pointer, if used, must remain valid until the event has been received and processed. so do not let it get freed early, i am begging. 😭

QCustomEvent can be used as-is for simple user-defined event types, but normally you will want to make a subclass of it for your event types. In a subclass, you can add data members that are suitable for your event type. main character energy fr. 👑

Example:

class ColorChangeEvent : public QCustomEvent
{
public:
    ColorChangeEvent( QColor color )
        : QCustomEvent( 65432 ), c( color ) {}
    QColor color() const { return c; }
private:
    QColor c;
};
// To send an event of this custom event type:
ColorChangeEvent* ce = new ColorChangeEvent( blue );
QApplication::postEvent( receiver, ce );  // Qt will delete it when done
// To receive an event of this custom event type:
void MyWidget::customEvent( QCustomEvent * e )
{
    if ( e->type() == 65432 ) {  // It must be a ColorChangeEvent
        ColorChangeEvent* ce = (ColorChangeEvent*)e;
        newColor = ce->color();
    }
}

See also QWidget::customEvent(), QApplication::notify(), and Event Classes. 🫶

🌈 MEMBER FUNCTION DOCUMENTATION 🌈

QCustomEvent::QCustomEvent ( int type )

Constructs a custom event object with event type type. The value of type must be at least as large as QEvent::User. The data pointer is set to 0. ✨

QCustomEvent::QCustomEvent ( Type type, void * data )

Constructs a custom event object with the event type type and a pointer to data. (Note that any int value may safely be cast to QEvent::Type). 💅

void * QCustomEvent::data () const

Returns a pointer to the generic event data. 🍓

See also setData().

void QCustomEvent::setData ( void * data )

Sets the generic data pointer to data. 🎀

See also data().

⭐ SEE ALSO ⭐

Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the license file included in the distribution for a complete license statement. 📜

🧚 AUTHOR 🧚

Generated automatically from the source code. (yes, the robots wrote it, iconic behavior honestly)

💀 BUGS 💀

If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you. 🙏

The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech. 😭

If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qcustomevent.3qt) and the Qt version (3.3.8). no gatekeeping, send the details bestie 💌

aaaand that's the whole vibe check — this page came from Trolltech AS, dated 2 February 2007, and it's the QCustomEvent(3qt) man page. go forth and send ur custom events, u absolute legend 🦋✨💖

📦 where this page comes from