2025-01-15 19:42:35 +01:00

47 lines
9.5 KiB
HTML

<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../jquery-1.9.1.min.js"></script><script src="../../bootstrap/js/bootstrap.min.js"></script><script src="../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../styles.css" rel="stylesheet"/><link href="../../haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "../../",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="../../nav.js"></script><script type="text/javascript" src="../../index.js"></script><link rel="icon" href="../../favicon.ico" type="image/x-icon"></link><title>haxe.rtti.ClassField - API Reference</title><meta name="description" content="The runtime class field information."/></head><body><style>
a, code .type {
color: #24afc4;
}
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
background: #24afc4;
color: #ffffff;
text-shadow: 0 0 0 transparent;
}
.navbar .container {
width: 940px ;
}
@media (max-width: 767px) {
.navbar .container {
width: auto;
}
}
@media (max-width: 979px) and (min-width: 768px) {
.navbar .container {
width: 724px;
}
}
@media (min-width: 1200px) {
.navbar .container {
width: 1170px;
}
}
.navbar .container img {
margin: 5px 0 0 4px;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="../../">API Reference</a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>typedef</small> ClassField</h1><h4><small>package <a href="../../haxe/rtti/index.html">haxe.rtti</a></small></h4><p><h4><small>import <a href="../../haxe/rtti/CType.html">haxe.rtti.CType</a></small></h4></p><p class="availability"><hr/><em>Available on all platforms</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p>The runtime class field information.</p><p class="javadoc">See:</p><div class="indent inline-content"><p><a href="https://haxe.org/manual/cr-rtti-structure.html#class-field-information">https://haxe.org/manual/cr-rtti-structure.html#class-field-information</a></p></div></div></div><h3 class="section">Properties</h3><div class="fields"><div class="field "><a name="doc"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#doc"><span class="identifier">doc</span></a>:<a class="type" title="Null can be useful in two cases." href="../../Null.html">Null</a>&lt;<a class="type" title="The basic String class." href="../../String.html">String</a>&gt;</code></p></h3><div class="doc"><p>The documentation of the field. This information is only available
if the compiler flag <code>-D use_rtti_doc</code> was in place. Otherwise, or
if the field has no documentation, the value is <code>null</code>.</p></div></div><div class="field "><a name="expr"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#expr"><span class="identifier">expr</span></a>:<a class="type" title="Null can be useful in two cases." href="../../Null.html">Null</a>&lt;<a class="type" title="The basic String class." href="../../String.html">String</a>&gt;</code></p></h3><div class="doc"><p>The actual expression of the field or <code>null</code> if there is no expression.</p></div></div><div class="field "><a name="get"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#get"><span class="identifier">get</span></a>:<span class="type">Rights</span></code></p></h3><div class="doc"><p>The <a href="https://haxe.org/manual/dictionary.html#define-read-access">read access</a>
behavior of the field.</p></div></div><div class="field "><a name="isOverride"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#isOverride"><span class="identifier">isOverride</span></a>:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p>Whether or not the field overrides another field.</p></div></div><div class="field "><a name="isPublic"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#isPublic"><span class="identifier">isPublic</span></a>:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p>Whether or not the field is public.</p></div></div><div class="field "><a name="line"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#line"><span class="identifier">line</span></a>:<a class="type" title="Null can be useful in two cases." href="../../Null.html">Null</a>&lt;<a class="type" title="The standard Int type." href="../../Int.html">Int</a>&gt;</code></p></h3><div class="doc"><p>The line number where the field is defined. This information is only
available if the field has an expression.
Otherwise the value is <code>null</code>.</p></div></div><div class="field "><a name="meta"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#meta"><span class="identifier">meta</span></a>:<a class="type" title="The list of runtime metadata." href="../../haxe/rtti/MetaData.html">MetaData</a></code></p></h3><div class="doc"><p>The meta data the field was annotated with.</p></div></div><div class="field "><a name="name"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#name"><span class="identifier">name</span></a>:<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><div class="doc"><p>The name of the field.</p></div></div><div class="field "><a name="overloads"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#overloads"><span class="identifier">overloads</span></a>:<a class="type" title="Null can be useful in two cases." href="../../Null.html">Null</a>&lt;<a class="type" title="A linked-list of elements." href="../../List.html">List</a>&lt;<a class="type" title="The runtime class field information." href="../../haxe/rtti/ClassField.html">ClassField</a>&gt;&gt;</code></p></h3><div class="doc"><p>The list of available overloads for the fields or <code>null</code> if no overloads
exists.</p></div></div><div class="field "><a name="params"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#params"><span class="identifier">params</span></a>:<a class="type" title="An array of strings representing the names of the type parameters the type has." href="../../haxe/rtti/TypeParams.html">TypeParams</a></code></p></h3><div class="doc"><p>An array of strings representing the names of the type parameters
the field has.</p></div></div><div class="field "><a name="platforms"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#platforms"><span class="identifier">platforms</span></a>:<a class="type" title="A list of strings representing the targets where the type is available." href="../../haxe/rtti/Platforms.html">Platforms</a></code></p></h3><div class="doc"><p>A list of strings representing the targets where the field is available.</p></div></div><div class="field "><a name="set"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#set"><span class="identifier">set</span></a>:<span class="type">Rights</span></code></p></h3><div class="doc"><p>The <a href="https://haxe.org/manual/dictionary.html#define-write-access">write access</a>
behavior of the field.</p></div></div><div class="field "><a name="type"></a><h3><p><code><a href="../../haxe/rtti/ClassField.html#type"><span class="identifier">type</span></a>:<span class="type">CType</span></code></p></h3><div class="doc"><p>The type of the field.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">&copy; 2017 &nbsp;<a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>