88 lines
13 KiB
HTML
88 lines
13 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>top level - API Reference</title></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"><h1>top level </h1><!--
|
|
::if full == ""::
|
|
<h1>Haxe API documentation <small ::cond api.isDefined("version")::>version ::api.getValue('version')::</small></h1>
|
|
<p>Haxe is an open source toolkit based on a modern, high level, strictly typed programming language, a cross-compiler, a complete cross-platform standard library and ways to access each platform's native capabilities.</p>
|
|
<h3>Getting Started With Haxe</h3>
|
|
<ul>
|
|
<li>Take a look at our <a href="http://haxe.org/documentation/introduction/">introduction</a></li>
|
|
<li>Read through the <a href="http://haxe.org/manual/">Haxe Manual</a></li>
|
|
<li>Look at these <a href="http://haxe.org/use-cases/">use cases for Haxe</a></li>
|
|
<li>Find and install <a href="http://lib.haxe.org/t/all/">popular Haxe libraries</a></li>
|
|
<li>Learn by example with the <a href="http://code.haxe.org">Haxe Code Cookbook</a></li>
|
|
</ul>
|
|
<hr/>
|
|
<h3>Top Level</h3>
|
|
::elseif full.split(".").length==1::
|
|
<h1>Haxe/::full:: API documentation</h1>
|
|
<p>To get started with the Haxe ::full:: target:</p>
|
|
<ul>
|
|
<li>Read through the <a href="http://haxe.org/manual/">Haxe Manual</a></li>
|
|
<li ::cond full=="js"::>Read the <a href="http://haxe.org/manual/target-javascript.html">Haxe/JavaScript target details</a></li>
|
|
<li ::cond full=="flash"::>Read the <a href="http://haxe.org/manual/target-flash.html">Haxe/Flash target details</a></li>
|
|
<li ::cond full=="php"::>Read the <a href="http://haxe.org/manual/target-php.html">Haxe/PHP target details</a></li>
|
|
<li ::cond full=="cpp"::>Read the <a href="http://haxe.org/manual/target-cpp.html">Haxe/C++ target details</a></li>
|
|
<li ::cond full=="neko"::>Read the <a href="http://nekovm.org/doc">Neko documentation</a></li>
|
|
<li>Find and install <a href="http://lib.haxe.org/t/::full::/">popular Haxe/::full:: libraries</a></li>
|
|
<li>Learn by example with the <a href="http://code.haxe.org">Haxe Code Cookbook</a></li>
|
|
</ul>
|
|
<hr/>
|
|
<h1><small class="directive">package</small> ::full::</h1>
|
|
::else::
|
|
<h1><small class="directive">package</small> ::full::</h1>
|
|
::end::
|
|
-->
|
|
<table class="table table-condensed"><tbody><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./cpp/index.html" title=".cpp">cpp</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./haxe/index.html" title=".haxe">haxe</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./js/index.html" title=".js">js</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./lime/index.html" title=".lime">lime</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./neko/index.html" title=".neko">neko</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./openfl/index.html" title=".openfl">openfl</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./sys/index.html" title=".sys">sys</a></td></tr><tr class="abstract"><td width="200"><a href="./Any.html" title=".Any">Any</a></td><td><p><code><a href="./Any.html">Any</a></code> is a type that is compatible with any other in both ways.</p></td></tr><tr class="class"><td width="200"><a href="./Array.html" title=".Array">Array</a></td><td><p>An Array is a storage for values. You can access it using indexes or
|
|
with its API.</p></td></tr><tr class="class"><td width="200"><a href="./ArrayAccess.html" title=".ArrayAccess">ArrayAccess</a></td><td><p><code><a href="./ArrayAccess.html">ArrayAccess</a></code> is used to indicate a class that can be accessed using brackets.
|
|
The type parameter represents the type of the elements stored.</p></td></tr><tr class="abstract"><td width="200"><a href="./Bool.html" title=".Bool">Bool</a></td><td><p>The standard Boolean type, which can either be <code>true</code> or <code>false</code>.</p></td></tr><tr class="abstract"><td width="200"><a href="./Class.html" title=".Class">Class</a></td><td><p>An abstract type that represents a Class.</p></td></tr><tr class="class"><td width="200"><a href="./Date.html" title=".Date">Date</a></td><td><p>The Date class provides a basic structure for date and time related
|
|
information. Date instances can be created by</p></td></tr><tr class="abstract"><td width="200"><a href="./Dynamic.html" title=".Dynamic">Dynamic</a></td><td><p><code><a href="./Dynamic.html">Dynamic</a></code> is a special type which is compatible with all other types.</p></td></tr><tr class="class"><td width="200"><a href="./EReg.html" title=".EReg">EReg</a></td><td><p>The EReg class represents regular expressions.</p></td></tr><tr class="abstract"><td width="200"><a href="./Enum.html" title=".Enum">Enum</a></td><td><p>An abstract type that represents an Enum type.</p></td></tr><tr class="abstract"><td width="200"><a href="./EnumValue.html" title=".EnumValue">EnumValue</a></td><td><p>An abstract type that represents any enum value.
|
|
See <code><a href="./Type.html">Type</a></code> for the Haxe Reflection API.</p></td></tr><tr class="abstract"><td width="200"><a href="./Float.html" title=".Float">Float</a></td><td><p>The standard <code><a href="./Float.html">Float</a></code> type, this is a double-precision IEEE 64bit float.</p></td></tr><tr class="abstract"><td width="200"><a href="./Int.html" title=".Int">Int</a></td><td><p>The standard <code><a href="./Int.html">Int</a></code> type. Its precision depends on the platform.</p></td></tr><tr class="type"><td width="200"><a href="./Iterable.html" title=".Iterable">Iterable</a></td><td><p>An <code><a href="./Iterable.html">Iterable</a></code> is a data structure which has an <code>iterator()</code> method.
|
|
See <code>Lambda</code> for generic functions on iterable structures.</p></td></tr><tr class="type"><td width="200"><a href="./Iterator.html" title=".Iterator">Iterator</a></td><td><p>An <code><a href="./Iterator.html">Iterator</a></code> is a structure that permits iteration over elements of type <code>T</code>.</p></td></tr><tr class="class"><td width="200"><a href="./List.html" title=".List">List</a></td><td><p>A linked-list of elements. The list is composed of element container objects
|
|
that are chained together. It is optimized so that adding or removing an
|
|
element does not imply copying the whole list content every time.</p></td></tr><tr class="abstract"><td width="200"><a href="./Map.html" title=".Map">Map</a></td><td><p>Map allows key to value mapping for arbitrary value types, and many key
|
|
types.</p></td></tr><tr class="class"><td width="200"><a href="./Math.html" title=".Math">Math</a></td><td><p>This class defines mathematical functions and constants.</p></td></tr><tr class="type"><td width="200"><a href="./Null.html" title=".Null">Null</a></td><td><p><code><a href="./Null.html">Null</a></code> can be useful in two cases. In order to document some methods
|
|
that accept or can return a <code>null</code> value, or for the Flash compiler and AS3
|
|
generator to distinguish between base values that can be <code>null</code> and others that
|
|
can't.</p></td></tr><tr class="class"><td width="200"><a href="./Reflect.html" title=".Reflect">Reflect</a></td><td><p>The Reflect API is a way to manipulate values dynamically through an
|
|
abstract interface in an untyped manner. Use with care.</p></td></tr><tr class="class"><td width="200"><a href="./Std.html" title=".Std">Std</a></td><td><p>The Std class provides standard methods for manipulating basic types.</p></td></tr><tr class="class"><td width="200"><a href="./String.html" title=".String">String</a></td><td><p>The basic String class.</p></td></tr><tr class="class"><td width="200"><a href="./StringBuf.html" title=".StringBuf">StringBuf</a></td><td><p>A String buffer is an efficient way to build a big string by appending small
|
|
elements together.</p></td></tr><tr class="class"><td width="200"><a href="./StringTools.html" title=".StringTools">StringTools</a></td><td><p>This class provides advanced methods on Strings. It is ideally used with
|
|
<code>using <a href="./StringTools.html">StringTools</a></code> and then acts as an <a href="https://haxe.org/manual/lf-static-extension.html">extension</a>
|
|
to the <code><a href="./String.html">String</a></code> class.</p></td></tr><tr class="class"><td width="200"><a href="./Sys.html" title=".Sys">Sys</a></td><td><p>This class gives you access to many base functionalities of system platforms. Looks in <code>sys</code> sub packages for more system APIs.</p></td></tr><tr class="class"><td width="200"><a href="./Type.html" title=".Type">Type</a></td><td><p>The Haxe Reflection API allows retrieval of type information at runtime.</p></td></tr><tr class="abstract"><td width="200"><a href="./UInt.html" title=".UInt">UInt</a></td><td><p>The unsigned <code><a href="./Int.html">Int</a></code> type is only defined for Flash and C#.
|
|
Simulate it for other platforms.</p></td></tr><tr class="enum"><td width="200"><a href="./ValueType.html" title=".ValueType">ValueType</a></td><td><p></p></td></tr><tr class="abstract"><td width="200"><a href="./Void.html" title=".Void">Void</a></td><td><p>The standard <code><a href="./Void.html">Void</a></code> type. Only <code>null</code> values can be of the type <code><a href="./Void.html">Void</a></code>.</p></td></tr><tr class="class"><td width="200"><a href="./Xml.html" title=".Xml">Xml</a></td><td><p>Cross-platform Xml API.</p></td></tr><tr class="abstract"><td width="200"><a href="./XmlType.html" title=".XmlType">XmlType</a></td><td><p>Xml node types.</p></td></tr></tbody></table></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">© 2017 <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> |