← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qmetaenum.html

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-08-24 04:09:09 UTC
  • Revision ID: james.westby@ubuntu.com-20050824040909-xmxe9jfr4a0w5671
Tags: upstream-4.0.0
Import upstream version 4.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qmetaenum.html
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html
 
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<!-- /tmp/qt-4.0.0-espenr-1119621036935/qt-x11-opensource-desktop-4.0.0/src/corelib/kernel/qmetaobject.cpp -->
 
6
<head>
 
7
    <title>Qt 4.0: QMetaEnum Class Reference</title>
 
8
    <style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
 
9
a:link { color: #004faf; text-decoration: none }
 
10
a:visited { color: #672967; text-decoration: none }
 
11
td.postheader { font-family: sans-serif }
 
12
tr.address { font-family: sans-serif }
 
13
body { background: #ffffff; color: black; }</style>
 
14
</head>
 
15
<body>
 
16
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
17
<tr>
 
18
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></td>
 
19
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="annotated.html"><font color="#004faf">Annotated</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
 
20
<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QMetaEnum Class Reference</h1>
 
21
<p>The QMetaEnum class provides meta-data about an enumerator. <a href="#details">More...</a></p>
 
22
<pre>#include &lt;QMetaEnum&gt;</pre><p>Part of the <a href="qtcore.html">QtCore</a> module.</p>
 
23
<ul>
 
24
<li><a href="qmetaenum-members.html">List of all members, including inherited members</a></li>
 
25
</ul>
 
26
<a name="public-functions"></a>
 
27
<h3>Public Functions</h3>
 
28
<ul>
 
29
<li><div class="fn"/>bool <b><a href="qmetaenum.html#isFlag">isFlag</a></b> () const</li>
 
30
<li><div class="fn"/>bool <b><a href="qmetaenum.html#isValid">isValid</a></b> () const</li>
 
31
<li><div class="fn"/>const char * <b><a href="qmetaenum.html#key">key</a></b> ( int <i>index</i> ) const</li>
 
32
<li><div class="fn"/>int <b><a href="qmetaenum.html#keyCount">keyCount</a></b> () const</li>
 
33
<li><div class="fn"/>int <b><a href="qmetaenum.html#keyToValue">keyToValue</a></b> ( const char * <i>key</i> ) const</li>
 
34
<li><div class="fn"/>int <b><a href="qmetaenum.html#keysToValue">keysToValue</a></b> ( const char * <i>keys</i> ) const</li>
 
35
<li><div class="fn"/>const char * <b><a href="qmetaenum.html#name">name</a></b> () const</li>
 
36
<li><div class="fn"/>const char * <b><a href="qmetaenum.html#scope">scope</a></b> () const</li>
 
37
<li><div class="fn"/>int <b><a href="qmetaenum.html#value">value</a></b> ( int <i>index</i> ) const</li>
 
38
<li><div class="fn"/>const char * <b><a href="qmetaenum.html#valueToKey">valueToKey</a></b> ( int <i>value</i> ) const</li>
 
39
<li><div class="fn"/>QByteArray <b><a href="qmetaenum.html#valueToKeys">valueToKeys</a></b> ( int <i>value</i> ) const</li>
 
40
</ul>
 
41
<a name="details"></a>
 
42
<hr />
 
43
<h2>Detailed Description</h2>
 
44
<p>The QMetaEnum class provides meta-data about an enumerator.</p>
 
45
<p>Use <a href="qmetaenum.html#name">name</a>() for the enumerator's name. The enumerator's keys (names of each enumerated item) are returned by <a href="qmetaenum.html#key">key</a>(); use <a href="qmetaenum.html#keyCount">keyCount</a>() to find the number of keys. <a href="qmetaenum.html#isFlag">isFlag</a>() returns whether the enumerator is meant to be used as a flag, meaning that its values can be combined using the OR operator.</p>
 
46
<p>The conversion functions <a href="qmetaenum.html#keyToValue">keyToValue</a>(), <a href="qmetaenum.html#valueToKey">valueToKey</a>(), <a href="qmetaenum.html#keysToValue">keysToValue</a>(), and <a href="qmetaenum.html#valueToKeys">valueToKeys</a>() allow conversion between the integer representation of an enumeration or set value and its literal representation. The <a href="qmetaenum.html#scope">scope</a>() function returns the class scope this enumerator was declared in.</p>
 
47
<p>See also <a href="qmetaobject.html">QMetaObject</a>, <a href="qmetamethod.html">QMetaMethod</a>, and <a href="qmetaproperty.html">QMetaProperty</a>.</p>
 
48
<hr />
 
49
<h2>Member Function Documentation</h2>
 
50
<h3 class="fn"><a name="isFlag"></a>bool QMetaEnum::isFlag () const</h3>
 
51
<p>Returns true if this enumerator is used as a flag; otherwise returns false.</p>
 
52
<p>When used as flags, enumerators can be combined using the OR operator.</p>
 
53
<p>See also <a href="qmetaenum.html#keysToValue">keysToValue</a>() and <a href="qmetaenum.html#valueToKeys">valueToKeys</a>().</p>
 
54
<h3 class="fn"><a name="isValid"></a>bool QMetaEnum::isValid () const</h3>
 
55
<p>Returns true if this enum is valid (has a name); otherwise returns false.</p>
 
56
<p>See also <a href="qmetaenum.html#name">name</a>().</p>
 
57
<h3 class="fn"><a name="key"></a>const char * QMetaEnum::key ( int <i>index</i> ) const</h3>
 
58
<p>Returns the key with the given <i>index</i>, or 0 if no such key exists.</p>
 
59
<p>See also <a href="qmetaenum.html#keyCount">keyCount</a>(), <a href="qmetaenum.html#value">value</a>(), and <a href="qmetaenum.html#valueToKey">valueToKey</a>().</p>
 
60
<h3 class="fn"><a name="keyCount"></a>int QMetaEnum::keyCount () const</h3>
 
61
<p>Returns the number of keys.</p>
 
62
<p>See also <a href="qmetaenum.html#key">key</a>().</p>
 
63
<h3 class="fn"><a name="keyToValue"></a>int QMetaEnum::keyToValue ( const char * <i>key</i> ) const</h3>
 
64
<p>Returns the integer value of the given enumeration <i>key</i>, or -1 if <i>key</i> is not defined.</p>
 
65
<p>For flag types, use <a href="qmetaenum.html#keysToValue">keysToValue</a>().</p>
 
66
<p>See also <a href="qmetaenum.html#valueToKey">valueToKey</a>(), <a href="qmetaenum.html#isFlag">isFlag</a>(), and <a href="qmetaenum.html#keysToValue">keysToValue</a>().</p>
 
67
<h3 class="fn"><a name="keysToValue"></a>int QMetaEnum::keysToValue ( const char * <i>keys</i> ) const</h3>
 
68
<p>Returns the value derived from combining together the values of the <i>keys</i> using the OR operator. Note that the strings in <i>keys</i> must be '|'-separated.</p>
 
69
<p>See also <a href="qmetaenum.html#isFlag">isFlag</a>(), <a href="qmetaenum.html#valueToKey">valueToKey</a>(), and <a href="qmetaenum.html#valueToKeys">valueToKeys</a>().</p>
 
70
<h3 class="fn"><a name="name"></a>const char * QMetaEnum::name () const</h3>
 
71
<p>Returns the name of the enumerator (without the scope).</p>
 
72
<p>For example, the <tt>Qt::AlignmentFlag</tt> enumeration has <tt>AlignmentFlag</tt> as the name and <tt>Qt</tt> as the scope.</p>
 
73
<p>See also <a href="qmetaenum.html#isValid">isValid</a>() and <a href="qmetaenum.html#scope">scope</a>().</p>
 
74
<h3 class="fn"><a name="scope"></a>const char * QMetaEnum::scope () const</h3>
 
75
<p>Returns the scope this enumerator was declared in.</p>
 
76
<p>For example, the <tt>Qt::AlignmentFlag</tt> enumeration has <tt>Qt</tt> as the scope and <tt>AlignmentFlag</tt> as the name.</p>
 
77
<p>See also <a href="qmetaenum.html#name">name</a>().</p>
 
78
<h3 class="fn"><a name="value"></a>int QMetaEnum::value ( int <i>index</i> ) const</h3>
 
79
<p>Returns the value with the given <i>index</i>; or returns -1 if there is no such value.</p>
 
80
<p>See also <a href="qmetaenum.html#keyCount">keyCount</a>(), <a href="qmetaenum.html#key">key</a>(), and <a href="qmetaenum.html#keyToValue">keyToValue</a>().</p>
 
81
<h3 class="fn"><a name="valueToKey"></a>const char * QMetaEnum::valueToKey ( int <i>value</i> ) const</h3>
 
82
<p>Returns the string that is used as the name of the given enumeration <i>value</i>, or 0 if <i>value</i> is not defined.</p>
 
83
<p>For flag types, use <a href="qmetaenum.html#valueToKeys">valueToKeys</a>().</p>
 
84
<p>See also <a href="qmetaenum.html#isFlag">isFlag</a>() and <a href="qmetaenum.html#valueToKeys">valueToKeys</a>().</p>
 
85
<h3 class="fn"><a name="valueToKeys"></a><a href="qbytearray.html">QByteArray</a> QMetaEnum::valueToKeys ( int <i>value</i> ) const</h3>
 
86
<p>Returns a byte array of '|'-separated keys that represents the given <i>value</i>.</p>
 
87
<p>See also <a href="qmetaenum.html#isFlag">isFlag</a>(), <a href="qmetaenum.html#valueToKey">valueToKey</a>(), and <a href="qmetaenum.html#keysToValue">keysToValue</a>().</p>
 
88
<p /><address><hr /><div align="center">
 
89
<table width="100%" cellspacing="0" border="0"><tr class="address">
 
90
<td width="30%">Copyright &copy; 2005 <a href="trolltech.html">Trolltech</a></td>
 
91
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
92
<td width="30%" align="right"><div align="right">Qt 4.0.0</div></td>
 
93
</tr></table></div></address></body>
 
94
</html>