QCustomEvent man page on aLinux

Man page or keyword search:  
man Server   7435 pages
apropos Keyword Search (all sections)
Output format
aLinux logo
[printable version]

QCustomEvent(3qt)					     QCustomEvent(3qt)

NAME
       QCustomEvent - Support for custom events

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.

       QCustomEvent is a generic event class for user-defined events. User
       defined events can be sent to widgets or other QObject instances using
       QApplication::postEvent() or QApplication::sendEvent(). Subclasses of
       QObject can easily receive custom events by implementing the
       QObject::customEvent() event handler function.

       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.

       QCustomEvent contains a generic void* data member that may be used for
       transferring event-specific data to the receiver. Note that since
       events are normally delivered asynchronously, the data pointer, if
       used, must remain valid until the event has been received and
       processed.

       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.

       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
       http://doc.trolltech.com/qcustomevent.html
       http://www.trolltech.com/faq/tech.html

COPYRIGHT
       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.

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).

Trolltech AS			2 February 2007		     QCustomEvent(3qt)
[top]

List of man pages available for aLinux

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net