summaryrefslogtreecommitdiffstats
path: root/doc/html/qmetaobject.html
blob: c777457862bc703afd2222fb4925a8999d852666 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qmetaobject.cpp:80 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QMetaObject Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QMetaObject Class Reference</h1>

<p>The QMetaObject class contains meta information about Qt objects.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qmetaobject-h.html">qmetaobject.h</a>&gt;</tt>
<p><a href="qmetaobject-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn>const char * <a href="#className"><b>className</b></a> () const</li>
<li class=fn>const char * <a href="#superClassName"><b>superClassName</b></a> () const</li>
<li class=fn>QMetaObject * <a href="#superClass"><b>superClass</b></a> () const</li>
<li class=fn>bool <a href="#inherits"><b>inherits</b></a> ( const&nbsp;char&nbsp;*&nbsp;clname ) const</li>
<li class=fn>int <a href="#numSlots"><b>numSlots</b></a> ( bool&nbsp;super = FALSE ) const</li>
<li class=fn>int <a href="#numSignals"><b>numSignals</b></a> ( bool&nbsp;super = FALSE ) const</li>
<li class=fn>QStrList <a href="#slotNames"><b>slotNames</b></a> ( bool&nbsp;super = FALSE ) const</li>
<li class=fn>QStrList <a href="#signalNames"><b>signalNames</b></a> ( bool&nbsp;super = FALSE ) const</li>
<li class=fn>int <a href="#numClassInfo"><b>numClassInfo</b></a> ( bool&nbsp;super = FALSE ) const</li>
<li class=fn>const QClassInfo * <a href="#classInfo"><b>classInfo</b></a> ( int&nbsp;index, bool&nbsp;super = FALSE ) const</li>
<li class=fn>const char * <a href="#classInfo-2"><b>classInfo</b></a> ( const&nbsp;char&nbsp;*&nbsp;name, bool&nbsp;super = FALSE ) const</li>
<li class=fn>const QMetaProperty * <a href="#property"><b>property</b></a> ( int&nbsp;index, bool&nbsp;super = FALSE ) const</li>
<li class=fn>int <a href="#findProperty"><b>findProperty</b></a> ( const&nbsp;char&nbsp;*&nbsp;name, bool&nbsp;super = FALSE ) const</li>
<li class=fn>QStrList <a href="#propertyNames"><b>propertyNames</b></a> ( bool&nbsp;super = FALSE ) const</li>
<li class=fn>int <a href="#numProperties"><b>numProperties</b></a> ( bool&nbsp;super = FALSE ) const</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QMetaObject class contains meta information about Qt objects.
<p> 
<p> The Meta Object System in Qt is responsible for the signals and
slots inter-object communication mechanism, runtime type
information and the property system. All meta information in Qt is
kept in a single instance of QMetaObject per class.
<p> This class is not normally required for application programming.
But if you write meta applications, such as scripting engines or
GUI builders, you might find these functions useful:
<ul>
<li> <a href="#className">className</a>() to get the name of a class.
<li> <a href="#superClassName">superClassName</a>() to get the name of the superclass.
<li> <a href="#inherits">inherits</a>(), the function called by <a href="qobject.html#inherits">QObject::inherits</a>().
<li> <a href="#superClass">superClass</a>() to access the superclass's <a href="metaobjects.html#meta-object">meta object</a>.
<li> <a href="#numSlots">numSlots</a>(), <a href="#numSignals">numSignals</a>(), <a href="#slotNames">slotNames</a>(), and  <a href="#signalNames">signalNames</a>() to get
information about a class's signals and slots.
<li> <a href="#property">property</a>() and <a href="#propertyNames">propertyNames</a>() to obtain information about a
class's properties.
</ul>
<p> Classes may have a list of name-value pairs of class information.
The number of pairs is returned by <a href="#numClassInfo">numClassInfo</a>(), and values are
returned by <a href="#classInfo">classInfo</a>().
<p> <p>See also <a href="moc.html">moc (Meta Object Compiler)</a> and <a href="objectmodel.html">Object Model</a>.

<p> 
<hr><h2>Member Function Documentation</h2>
<h3 class=fn>const QClassInfo * <a name="classInfo"></a>QMetaObject::classInfo ( int&nbsp;index, bool&nbsp;super = FALSE ) const
</h3>
Returns the class information with index <em>index</em> or 0 if no such
information exists.
<p> If <em>super</em> is TRUE,  inherited class information is included.

<h3 class=fn>const char * <a name="classInfo-2"></a>QMetaObject::classInfo ( const&nbsp;char&nbsp;*&nbsp;name, bool&nbsp;super = FALSE ) const
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Returns the class information with name <em>name</em> or 0 if no such
information exists.
<p> If <em>super</em> is TRUE, inherited class information is included.

<h3 class=fn>const char * <a name="className"></a>QMetaObject::className () const
</h3>

<p> Returns the class name.
<p> <p>See also <a href="qobject.html#className">QObject::className</a>() and <a href="#superClassName">superClassName</a>().

<h3 class=fn>int <a name="findProperty"></a>QMetaObject::findProperty ( const&nbsp;char&nbsp;*&nbsp;name, bool&nbsp;super = FALSE ) const
</h3>
Returns the index for the property with name <em>name</em> or -1 if no
such property exists.
<p> If <em>super</em> is TRUE, inherited properties are included.
<p> <p>See also <a href="#property">property</a>() and <a href="#propertyNames">propertyNames</a>().

<h3 class=fn>bool <a name="inherits"></a>QMetaObject::inherits ( const&nbsp;char&nbsp;*&nbsp;clname ) const
</h3>
Returns TRUE if this class inherits <em>clname</em> within the <a href="metaobjects.html#meta-object">meta object</a> inheritance chain; otherwise returns FALSE.
<p> (A class is considered to inherit itself.)

<h3 class=fn>int <a name="numClassInfo"></a>QMetaObject::numClassInfo ( bool&nbsp;super = FALSE ) const
</h3>
Returns the number of items of class information available for
this class.
<p> If <em>super</em> is TRUE, inherited class information is included.

<h3 class=fn>int <a name="numProperties"></a>QMetaObject::numProperties ( bool&nbsp;super = FALSE ) const
</h3>
Returns the number of properties for this class.
<p> If <em>super</em> is TRUE, inherited properties are included.
<p> <p>See also <a href="#propertyNames">propertyNames</a>().

<h3 class=fn>int <a name="numSignals"></a>QMetaObject::numSignals ( bool&nbsp;super = FALSE ) const
</h3>
Returns the number of signals for this class.
<p> If <em>super</em> is TRUE, inherited signals are included.
<p> <p>See also <a href="#signalNames">signalNames</a>().

<h3 class=fn>int <a name="numSlots"></a>QMetaObject::numSlots ( bool&nbsp;super = FALSE ) const
</h3>
Returns the number of slots for this class.
<p> If <em>super</em> is TRUE, inherited slots are included.
<p> <p>See also <a href="#slotNames">slotNames</a>().

<h3 class=fn>const&nbsp;<a href="qmetaproperty.html">QMetaProperty</a>&nbsp;* <a name="property"></a>QMetaObject::property ( int&nbsp;index, bool&nbsp;super = FALSE ) const
</h3>
Returns the property meta data for the property at index <em>index</em>
or 0 if no such property exists.
<p> If <em>super</em> is TRUE, inherited properties are included.
<p> <p>See also <a href="#propertyNames">propertyNames</a>().

<h3 class=fn><a href="qstrlist.html">QStrList</a> <a name="propertyNames"></a>QMetaObject::propertyNames ( bool&nbsp;super = FALSE ) const
</h3>
Returns a list with the names of all this class's properties.
<p> If <em>super</em> is TRUE, inherited properties are included.
<p> <p>See also <a href="#property">property</a>().

<h3 class=fn><a href="qstrlist.html">QStrList</a> <a name="signalNames"></a>QMetaObject::signalNames ( bool&nbsp;super = FALSE ) const
</h3>
Returns a list with the names of all this class's signals.
<p> If <em>super</em> is TRUE, inherited signals are included.

<h3 class=fn><a href="qstrlist.html">QStrList</a> <a name="slotNames"></a>QMetaObject::slotNames ( bool&nbsp;super = FALSE ) const
</h3>
Returns a list with the names of all this class's slots.
<p> If <em>super</em> is TRUE, inherited slots are included.
<p> <p>See also <a href="#numSlots">numSlots</a>().

<h3 class=fn><a href="qmetaobject.html">QMetaObject</a>&nbsp;* <a name="superClass"></a>QMetaObject::superClass () const
</h3>

<p> Returns the <a href="metaobjects.html#meta-object">meta object</a> of the super class or 0 if there is no
such object.

<h3 class=fn>const char * <a name="superClassName"></a>QMetaObject::superClassName () const
</h3>

<p> Returns the class name of the superclass or 0 if there is no
superclass in the <a href="qobject.html">QObject</a> hierachy.
<p> <p>See also <a href="#className">className</a>().

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>