qmetaobject.h Include File

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# qmetaobject.h

This is the verbatim text of the qmetaobject.h include file. It is provided only for illustration; the copyright remains with Trolltech.

    /****************************************************************************
    ** $Id: qt/qmetaobject.h   3.3.8   edited Jan 11 14:38 $
    **
    ** Definition of QMetaObject class
    **
    ** Created : 930419
    **
    ** Copyright (C) 1992-2007 Trolltech ASA.  All rights reserved.
    **
    ** This file is part of the kernel module of the Qt GUI Toolkit.
    **
    ** This file may be used under the terms of the GNU General Public
    ** License versions 2.0 or 3.0 as published by the Free Software
    ** Foundation and appearing in the file LICENSE.GPL included in the
    ** packaging of this file. Alternatively you may (at your option) use any
    ** later version of the GNU General Public License if such license has
    ** been publicly approved by Trolltech ASA (or its successors, if any)
    ** and the KDE Free Qt Foundation.
    **
    ** Please review the following information to ensure GNU General
    ** Public Licensing requirements will be met:
    ** http://trolltech.com/products/qt/licenses/licensing/opensource/.
    ** If you are unsure which license is appropriate for your use, please
    ** review the following information:
    ** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
    ** or contact the sales department at sales@trolltech.com.
    **
    ** This file may be used under the terms of the Q Public License as
    ** defined by Trolltech ASA and appearing in the file LICENSE.QPL
    ** included in the packaging of this file.  Licensees holding valid Qt
    ** Commercial licenses may use this file in accordance with the Qt
    ** Commercial License Agreement provided with the Software.
    **
    ** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
    ** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
    ** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
    ** herein.
    **
    **********************************************************************/

    #ifndef QMETAOBJECT_H
    #define QMETAOBJECT_H

    #ifndef QT_H
    #include "qconnection.h"
    #include "qstrlist.h"
    #endif // QT_H

    #ifndef Q_MOC_OUTPUT_REVISION
    #define Q_MOC_OUTPUT_REVISION 26
    #endif

    class QObject;
    struct QUMethod;
    class QMetaObjectPrivate;

    struct QMetaData				// - member function meta data
    {						//   for signal and slots
        const char *name;				// - member name
        const QUMethod* method;			// - detailed method description
        enum Access { Private, Protected, Public };
        Access access;				// - access permission
    };

    #ifndef QT_NO_PROPERTIES
    struct QMetaEnum				// enumerator meta data
    {						//  for properties
        const char *name;				// - enumerator name
        uint count;					// - number of values
        struct Item					// - a name/value pair
        {
    	const char *key;
    	int value;
        };
        const Item *items;				// - the name/value pairs
        bool set;					// whether enum has to be treated as a set
    };
    #endif

    #ifndef QT_NO_PROPERTIES

    class Q_EXPORT QMetaProperty			// property meta data
    {
    public:
        const char*	type() const { return t; }	// type of the property
        const char*	name() const { return n; }	// name of the property

        bool writable() const;
        bool isValid() const;

        bool isSetType() const;
        bool isEnumType() const;
        QStrList enumKeys() const;			// enumeration names

        int keyToValue( const char* key ) const;	// enum and set conversion functions
        const char* valueToKey( int value ) const;
        int keysToValue( const QStrList& keys ) const;
        QStrList valueToKeys( int value ) const;

        bool designable( QObject* = 0 ) const;
        bool scriptable( QObject* = 0 ) const;
        bool stored( QObject* = 0 ) const;

        bool reset( QObject* ) const;

        const char* t;			// internal
        const char* n;			// internal

        enum Flags  {
    	Invalid		= 0x00000000,
    	Readable	= 0x00000001,
    	Writable	= 0x00000002,
    	EnumOrSet	= 0x00000004,
    	UnresolvedEnum	= 0x00000008,
    	StdSet		= 0x00000100,
    	Override	= 0x00000200
        };

        uint flags; // internal
        bool testFlags( uint f ) const;	// internal
        bool stdSet() const; 		// internal
        int id() const; 			// internal

        QMetaObject** meta; 		// internal

        const QMetaEnum* enumData;		// internal
        int _id; 				// internal
        void clear(); 			// internal
    };

    inline bool QMetaProperty::testFlags( uint f ) const
    { return (flags & (uint)f) != (uint)0; }

    #endif // QT_NO_PROPERTIES

    struct QClassInfo				// class info meta data
    {
        const char* name;				// - name of the info
        const char* value;				// - value of the info
    };

    class Q_EXPORT QMetaObject			// meta object class
    {
    public:
        QMetaObject( const char * const class_name, QMetaObject *superclass,
    		 const QMetaData * const slot_data, int n_slots,
    		 const QMetaData * const signal_data, int n_signals,
    #ifndef QT_NO_PROPERTIES
    		 const QMetaProperty *const prop_data, int n_props,
    		 const QMetaEnum *const enum_data, int n_enums,
    #endif
    		 const QClassInfo *const class_info, int n_info );

    #ifndef QT_NO_PROPERTIES
        QMetaObject( const char * const class_name, QMetaObject *superclass,
    		 const QMetaData * const slot_data, int n_slots,
    		 const QMetaData * const signal_data, int n_signals,
    		 const QMetaProperty *const prop_data, int n_props,
    		 const QMetaEnum *const enum_data, int n_enums,
    		 bool (*qt_static_property)(QObject*, int, int, QVariant*),
    		 const QClassInfo *const class_info, int n_info );
    #endif

        virtual ~QMetaObject();

        const char	*className()		const { return classname; }
        const char	*superClassName()	const { return superclassname; }

        QMetaObject *superClass()		const { return superclass; }

        bool	inherits( const char* clname ) const;

        int	numSlots( bool super = FALSE ) const;
        int		numSignals( bool super = FALSE ) const;

        int		findSlot( const char *, bool super = FALSE ) const;
        int		findSignal( const char *, bool super = FALSE ) const;

        const QMetaData 	*slot( int index, bool super = FALSE ) const;
        const QMetaData 	*signal( int index, bool super = FALSE ) const;

        QStrList	slotNames( bool super = FALSE ) const;
        QStrList	signalNames( bool super = FALSE ) const;

        int		slotOffset() const;
        int		signalOffset() const;
        int		propertyOffset() const;

        int		numClassInfo( bool super = FALSE ) const;
        const QClassInfo	*classInfo( int index, bool super = FALSE ) const;
        const char	*classInfo( const char* name, bool super = FALSE ) const;

    #ifndef QT_NO_PROPERTIES
        const QMetaProperty	*property( int index, bool super = FALSE ) const;
        int findProperty( const char *name, bool super = FALSE ) const;
        int indexOfProperty( const QMetaProperty*, bool super = FALSE ) const;
        const QMetaProperty* resolveProperty( const QMetaProperty* ) const;
        int resolveProperty( int ) const;
        QStrList		propertyNames( bool super = FALSE ) const;
        int		numProperties( bool super = FALSE ) const;
    #endif

        // static wrappers around constructors, necessary to work around a
        // Windows-DLL limitation: objects can only be deleted within a
        // DLL if they were actually created within that DLL.
        static QMetaObject	*new_metaobject( const char *, QMetaObject *,
    					const QMetaData *const, int,
    					const QMetaData *const, int,
    #ifndef QT_NO_PROPERTIES
    					const QMetaProperty *const prop_data, int n_props,
    					const QMetaEnum *const enum_data, int n_enums,
    #endif
    					const QClassInfo *const  class_info, int n_info );
    #ifndef QT_NO_PROPERTIES
        static QMetaObject	*new_metaobject( const char *, QMetaObject *,
    					const QMetaData *const, int,
    					const QMetaData *const, int,
    					const QMetaProperty *const prop_data, int n_props,
    					const QMetaEnum *const enum_data, int n_enums,
    					 bool (*qt_static_property)(QObject*, int, int, QVariant*),
    					const QClassInfo *const  class_info, int n_info );
        QStrList		enumeratorNames( bool super = FALSE ) const;
        int numEnumerators( bool super = FALSE ) const;
        const QMetaEnum		*enumerator( const char* name, bool super = FALSE ) const;
    #endif

        static QMetaObject *metaObject( const char *class_name );
        static bool hasMetaObject( const char *class_name );

    private:
        QMemberDict		*init( const QMetaData *, int );

        const char		*classname;		// class name
        const char		*superclassname;	// super class name
        QMetaObject	*superclass;			// super class meta object
        QMetaObjectPrivate	*d;			// private data for...
        void	*reserved;			// ...binary compatibility
        const QMetaData		*slotData;	// slot meta data
        QMemberDict	*slotDict;			// slot dictionary
        const QMetaData		*signalData;	// signal meta data
        QMemberDict	*signalDict;			// signal dictionary
        int signaloffset;
        int slotoffset;
    #ifndef QT_NO_PROPERTIES
        int propertyoffset;
    public:
        bool qt_static_property( QObject* o, int id, int f, QVariant* v);
    private:
        friend class QMetaProperty;
    #endif

    private:	// Disabled copy constructor and operator=
    #if defined(Q_DISABLE_COPY)
        QMetaObject( const QMetaObject & );
        QMetaObject &operator=( const QMetaObject & );
    #endif
    };

    inline int QMetaObject::slotOffset() const
    { return slotoffset; }

    inline int QMetaObject::signalOffset() const
    { return signaloffset; }

    #ifndef QT_NO_PROPERTIES
    inline int QMetaObject::propertyOffset() const
    { return propertyoffset; }
    #endif

    typedef QMetaObject *(*QtStaticMetaObjectFunction)();

    class Q_EXPORT QMetaObjectCleanUp
    {
    public:
        QMetaObjectCleanUp( const char *mo_name, QtStaticMetaObjectFunction );
        QMetaObjectCleanUp();
        ~QMetaObjectCleanUp();

        void setMetaObject( QMetaObject *&mo );

    private:
        QMetaObject **metaObject;
    };

    #endif // QMETAOBJECT_H