qmetaobject(3qt)

1QMetaObject(3qt)                                              QMetaObject(3qt)
2
3
4

NAME

6       QMetaObject - Meta information about Qt objects
7

SYNOPSIS

9       #include <qmetaobject.h>
10
11   Public Members
12       const char * className () const
13       const char * superClassName () const
14       QMetaObject * superClass () const
15       bool inherits ( const char * clname ) const
16       int numSlots ( bool super = FALSE ) const
17       int numSignals ( bool super = FALSE ) const
18       QStrList slotNames ( bool super = FALSE ) const
19       QStrList signalNames ( bool super = FALSE ) const
20       int numClassInfo ( bool super = FALSE ) const
21       const QClassInfo * classInfo ( int index, bool super = FALSE ) const
22       const char * classInfo ( const char * name, bool super = FALSE ) const
23       const QMetaProperty * property ( int index, bool super = FALSE ) const
24       int findProperty ( const char * name, bool super = FALSE ) const
25       QStrList propertyNames ( bool super = FALSE ) const
26       int numProperties ( bool super = FALSE ) const
27

DESCRIPTION

29       The QMetaObject class contains meta information about Qt objects.
30
31       The Meta Object System in Qt is responsible for the signals and slots
32       inter-object communication mechanism, runtime type information and the
33       property system. All meta information in Qt is kept in a single
34       instance of QMetaObject per class.
35
36       This class is not normally required for application programming. But if
37       you write meta applications, such as scripting engines or GUI builders,
38       you might find these functions useful:
39
40       className() to get the name of a class.
41
42       superClassName() to get the name of the superclass.
43
44       inherits(), the function called by QObject::inherits().
45
46       superClass() to access the superclass's meta object.
47
48       numSlots(), numSignals(), slotNames(), and signalNames() to get
49       information about a class's signals and slots.
50
51       property() and propertyNames() to obtain information about a class's
52       properties.
53
54       Classes may have a list of name-value pairs of class information. The
55       number of pairs is returned by numClassInfo(), and values are returned
56       by classInfo().
57
58       See also moc (Meta Object Compiler) and Object Model.
59

MEMBER FUNCTION DOCUMENTATION

const QClassInfo * QMetaObject::classInfo ( int index, bool super = FALSE )

62       const
63       Returns the class information with index index or 0 if no such
64       information exists.
65
66       If super is TRUE, inherited class information is included.
67

const char * QMetaObject::classInfo ( const char * name, bool super = FALSE )

69       const
70       This is an overloaded member function, provided for convenience. It
71       behaves essentially like the above function.
72
73       Returns the class information with name name or 0 if no such
74       information exists.
75
76       If super is TRUE, inherited class information is included.
77

const char * QMetaObject::className () const

79       Returns the class name.
80
81       See also QObject::className() and superClassName().
82

int QMetaObject::findProperty ( const char * name, bool super = FALSE ) const

84       Returns the index for the property with name name or -1 if no such
85       property exists.
86
87       If super is TRUE, inherited properties are included.
88
89       See also property() and propertyNames().
90

bool QMetaObject::inherits ( const char * clname ) const

92       Returns TRUE if this class inherits clname within the meta object
93       inheritance chain; otherwise returns FALSE.
94
95       (A class is considered to inherit itself.)
96

int QMetaObject::numClassInfo ( bool super = FALSE ) const

98       Returns the number of items of class information available for this
99       class.
100
101       If super is TRUE, inherited class information is included.
102

int QMetaObject::numProperties ( bool super = FALSE ) const

104       Returns the number of properties for this class.
105
106       If super is TRUE, inherited properties are included.
107
108       See also propertyNames().
109

int QMetaObject::numSignals ( bool super = FALSE ) const

111       Returns the number of signals for this class.
112
113       If super is TRUE, inherited signals are included.
114
115       See also signalNames().
116

int QMetaObject::numSlots ( bool super = FALSE ) const

118       Returns the number of slots for this class.
119
120       If super is TRUE, inherited slots are included.
121
122       See also slotNames().
123

const QMetaProperty * QMetaObject::property ( int index, bool super = FALSE )

125       const
126       Returns the property meta data for the property at index index or 0 if
127       no such property exists.
128
129       If super is TRUE, inherited properties are included.
130
131       See also propertyNames().
132

QStrList QMetaObject::propertyNames ( bool super = FALSE ) const

134       Returns a list with the names of all this class's properties.
135
136       If super is TRUE, inherited properties are included.
137
138       See also property().
139

QStrList QMetaObject::signalNames ( bool super = FALSE ) const

141       Returns a list with the names of all this class's signals.
142
143       If super is TRUE, inherited signals are included.
144

QStrList QMetaObject::slotNames ( bool super = FALSE ) const

146       Returns a list with the names of all this class's slots.
147
148       If super is TRUE, inherited slots are included.
149
150       See also numSlots().
151

QMetaObject * QMetaObject::superClass () const

153       Returns the meta object of the super class or 0 if there is no such
154       object.
155

const char * QMetaObject::superClassName () const

157       Returns the class name of the superclass or 0 if there is no superclass
158       in the QObject hierachy.
159
160       See also className().
161
162

COPYRIGHT

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

AUTHOR

173       Generated automatically from the source code.
174

BUGS

176       If you find a bug in Qt, please report it as described in
177       http://doc.trolltech.com/bughowto.html.  Good bug reports help us to
178       help you. Thank you.
179
180       The definitive Qt documentation is provided in HTML format; it is
181       located at $QTDIR/doc/html and can be read using Qt Assistant or with a
182       web browser. This man page is provided as a convenience for those users
183       who prefer man pages, although this format is not officially supported
184       by Trolltech.
185
186       If you find errors in this manual page, please report them to qt-
187       bugs@trolltech.com.  Please include the name of the manual page
188       (qmetaobject.3qt) and the Qt version (3.3.8).
189
190
191
192Trolltech AS                    2 February 2007               QMetaObject(3qt)