79 lines
12 KiB
HTML
79 lines
12 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.macro - 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>haxe.macro </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><th width="200"><i class="fa fa-folder-o"></i><a href="../index.html" title="haxe">..</a></th><td></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/AbstractType.html" title="haxe.macro.AbstractType">AbstractType</a></td><td><p>Represents an abstract type.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/AnonType.html" title="haxe.macro.AnonType">AnonType</a></td><td><p>Represents information for anonymous structure types.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/BaseType.html" title="haxe.macro.BaseType">BaseType</a></td><td><p>The information that all types (<code><a href="../../haxe/macro/ClassType.html">ClassType</a></code>, <code><a href="../../haxe/macro/EnumType.html">EnumType</a></code>, <code><a href="../../haxe/macro/DefType.html">DefType</a></code>,
|
|
<code><a href="../../haxe/macro/AbstractType.html">AbstractType</a></code>) have in common.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/Case.html" title="haxe.macro.Case">Case</a></td><td><p>Represents a switch case.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/Catch.html" title="haxe.macro.Catch">Catch</a></td><td><p>Represents a catch in the AST.
|
|
@<a href="https://haxe.org/manual/expression-try-catch.html">https://haxe.org/manual/expression-try-catch.html</a></p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/ClassField.html" title="haxe.macro.ClassField">ClassField</a></td><td><p>Represents a class field.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/ClassType.html" title="haxe.macro.ClassType">ClassType</a></td><td><p>Represents a class type.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/DefType.html" title="haxe.macro.DefType">DefType</a></td><td><p>Represents a typedef.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/EnumField.html" title="haxe.macro.EnumField">EnumField</a></td><td><p>Represents an enum constructor.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/EnumType.html" title="haxe.macro.EnumType">EnumType</a></td><td><p>Represents an enum type.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/Expr.html" title="haxe.macro.Expr">Expr</a></td><td><p>Represents a node in the AST.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/ExprOf.html" title="haxe.macro.ExprOf">ExprOf</a></td><td><p>Represents a AST node identical to <code><a href="../../haxe/macro/Expr.html">Expr</a></code>, but it allows constraining the
|
|
type of accepted expressions.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/Field.html" title="haxe.macro.Field">Field</a></td><td><p>Represents a field in the AST.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/Function.html" title="haxe.macro.Function">Function</a></td><td><p>Represents a function in the AST.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/FunctionArg.html" title="haxe.macro.FunctionArg">FunctionArg</a></td><td><p>Represents a function argument in the AST.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/ImportExpr.html" title="haxe.macro.ImportExpr">ImportExpr</a></td><td><p>Represents the import expression.</p></td></tr><tr class="abstract"><td width="200"><a href="../../haxe/macro/IncludePosition.html" title="haxe.macro.IncludePosition">IncludePosition</a></td><td><p></p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/JSGenApi.html" title="haxe.macro.JSGenApi">JSGenApi</a></td><td><p>This is the api that is passed to the custom JS generator.</p></td></tr><tr class="class"><td width="200"><a href="../../haxe/macro/MacroType.html" title="haxe.macro.MacroType">MacroType</a></td><td><p>This type is meant to be used to generate custom types using a macro.
|
|
For instance by doing MacroType<[my.Class.myMacro(55)]></p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/MetaAccess.html" title="haxe.macro.MetaAccess">MetaAccess</a></td><td><p>MetaAccess is a wrapper for the <code><a href="../../haxe/macro/Metadata.html">Metadata</a></code> array. It can be used to add
|
|
metadata to and remove metadata from its origin.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/Metadata.html" title="haxe.macro.Metadata">Metadata</a></td><td><p>Represents metadata in the AST.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/MetadataEntry.html" title="haxe.macro.MetadataEntry">MetadataEntry</a></td><td><p>Represents a metadata entry in the AST.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/Position.html" title="haxe.macro.Position">Position</a></td><td><p>Represents a position in a file.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/Ref.html" title="haxe.macro.Ref">Ref</a></td><td><p>Represents a reference to internal compiler structure. It exists to avoid
|
|
expensive encoding if it is not required and to ensure that physical
|
|
equality remains intact.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/TFunc.html" title="haxe.macro.TFunc">TFunc</a></td><td><p>Represents a function in the typed AST.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/TVar.html" title="haxe.macro.TVar">TVar</a></td><td><p>Represents a variable in the typed AST.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/TypeDefinition.html" title="haxe.macro.TypeDefinition">TypeDefinition</a></td><td><p>Represents a type definition.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/TypeParamDecl.html" title="haxe.macro.TypeParamDecl">TypeParamDecl</a></td><td><p>Represents a type parameter declaration in the AST.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/TypeParameter.html" title="haxe.macro.TypeParameter">TypeParameter</a></td><td><p>Represents the declaration of type parameters.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/TypePath.html" title="haxe.macro.TypePath">TypePath</a></td><td><p>Represents a type path in the AST.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/TypedExpr.html" title="haxe.macro.TypedExpr">TypedExpr</a></td><td><p>Represents a typed AST node.</p></td></tr><tr class="type"><td width="200"><a href="../../haxe/macro/Var.html" title="haxe.macro.Var">Var</a></td><td><p>Represents a variable in the AST.</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> |