80 lines
14 KiB
HTML
80 lines
14 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.io.Path - API Reference</title><meta name="description" content="This class provides a convenient way of working with paths. It supports the
|
|
common path formats:"/></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>class</small> Path</h1><h4><small>package <a href="../../haxe/io/index.html">haxe.io</a></small></h4> <p class="availability"><hr/><em>Available on all platforms</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p>This class provides a convenient way of working with paths. It supports the
|
|
common path formats:</p><ul><li>directory1/directory2/filename.extension</li><li>directory1\directory2\filename.extension</li></ul></div></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3><p><code><a href="#new"><span class="identifier">new</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a></span>)</code></p></h3><div class="doc"><p>Creates a new Path instance by parsing <code>path</code>.</p>
|
|
<p>Path information can be retrieved by accessing the dir, file and ext
|
|
properties.</p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="backslash"></a><h3><p><code><a href="../../haxe/io/Path.html#backslash"><span class="identifier">backslash</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>True if the last directory separator is a backslash, false otherwise.</p></div></div><div class="field "><a name="dir"></a><h3><p><code><a href="../../haxe/io/Path.html#dir"><span class="identifier">dir</span></a>:<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><div class="doc"><p>The directory.</p>
|
|
<p>This is the leading part of the path that is not part of the file name
|
|
and the extension.</p>
|
|
<p>Does not end with a <code>/</code> or <code>\</code> separator.</p>
|
|
<p>If the path has no directory, the value is null.</p></div></div><div class="field "><a name="ext"></a><h3><p><code><a href="../../haxe/io/Path.html#ext"><span class="identifier">ext</span></a>:<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><div class="doc"><p>The file extension.</p>
|
|
<p>It is separated from the file name by a dot. This dot is not part of
|
|
the extension.</p>
|
|
<p>If the path has no extension, the value is null.</p></div></div><div class="field "><a name="file"></a><h3><p><code><a href="../../haxe/io/Path.html#file"><span class="identifier">file</span></a>:<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><div class="doc"><p>The file name.</p>
|
|
<p>This is the part of the part between the directory and the extension.</p>
|
|
<p>If there is no file name, e.g. for ".htaccess" or "/dir/", the value
|
|
is the empty String "".</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="toString"></a><h3><p><code><a href="#toString"><span class="identifier">toString</span></a> ():<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><p class="availability"><em>Available on Neko, Android, iOS, macOS, Linux, HTML5, Windows</em></p><div class="doc"><p>Returns a String representation of <code>this</code> path.</p>
|
|
<p>If <code>this.<a href="#backslash">backslash</a></code> is true, backslash is used as directory separator,
|
|
otherwise slash is used. This only affects the separator between
|
|
<code>this.<a href="#dir">dir</a></code> and <code>this.<a href="#file">file</a></code>.</p>
|
|
<p>If <code>this.<a href="#directory">directory</a></code> or <code>this.<a href="#extension">extension</a></code> is null, their representation
|
|
is the empty String "".</p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="addTrailingSlash"></a><h3><p><code><span class="label">static</span><a href="#addTrailingSlash"><span class="identifier">addTrailingSlash</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a></span>):<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><p class="availability"><em>Available on Neko, macOS, Linux, Windows</em></p><div class="doc"><p>Adds a trailing slash to <code>path</code>, if it does not have one already.</p>
|
|
<p>If the last slash in <code>path</code> is a backslash, a backslash is appended to
|
|
<code>path</code>.</p>
|
|
<p>If the last slash in <code>path</code> is a slash, or if no slash is found, a slash
|
|
is appended to <code>path</code>. In particular, this applies to the empty String
|
|
<code>""</code>.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="directory"></a><h3><p><code><span class="label">static</span><a href="#directory"><span class="identifier">directory</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a></span>):<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><div class="doc"><p>Returns the directory of <code>path</code>.</p>
|
|
<p>If the directory is null, the empty String <code>""</code> is returned.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="extension"></a><h3><p><code><span class="label">static</span><a href="#extension"><span class="identifier">extension</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a></span>):<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><p class="availability"><em>Available on Neko, Flash, macOS, Linux, Windows</em></p><div class="doc"><p>Returns the extension of <code>path</code>.</p>
|
|
<p>If the extension is null, the empty String <code>""</code> is returned.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="isAbsolute"></a><h3><p><code><span class="label">static</span><a href="#isAbsolute"><span class="identifier">isAbsolute</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a></span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><p class="availability"><em>Available on Neko, macOS, Linux, Windows</em></p><div class="doc"><p>Returns true if the path is an absolute path, and false otherwise.</p></div></div><div class="field "><a name="join"></a><h3><p><code><span class="label">static</span><a href="#join"><span class="identifier">join</span></a> (<span style="white-space:nowrap">paths:<a class="type" title="An Array is a storage for values." href="../../Array.html">Array</a><<a class="type" title="The basic String class." href="../../String.html">String</a>></span>):<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><p class="availability"><em>Available on Neko, macOS, Linux, Windows</em></p><div class="doc"><p>Joins all paths in <code>paths</code> together.</p>
|
|
<p>If <code>paths</code> is empty, the empty String <code>""</code> is returned. Otherwise the
|
|
paths are joined with a slash between them.</p>
|
|
<p>If <code>paths</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="normalize"></a><h3><p><code><span class="label">static</span><a href="#normalize"><span class="identifier">normalize</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a></span>):<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><p class="availability"><em>Available on Neko, macOS, Linux, Windows</em></p><div class="doc"><p>Normalize a given <code>path</code> (e.g. make '/usr/local/../lib' to '/usr/lib').</p>
|
|
<p>Also replaces backslashes \ with slashes / and afterwards turns
|
|
multiple slashes into a single one.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="removeTrailingSlashes"></a><h3><p><code><span class="label">static</span><a href="#removeTrailingSlashes"><span class="identifier">removeTrailingSlashes</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a></span>):<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><p class="availability"><em>Available on Neko, macOS, Linux, Windows</em></p><div class="doc"><p>Removes trailing slashes from <code>path</code>.</p>
|
|
<p>If <code>path</code> does not end with a <code>/</code> or <code>\</code>, <code>path</code> is returned unchanged.</p>
|
|
<p>Otherwise the substring of <code>path</code> excluding the trailing slashes or
|
|
backslashes is returned.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="withoutDirectory"></a><h3><p><code><span class="label">static</span><a href="#withoutDirectory"><span class="identifier">withoutDirectory</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a></span>):<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><p class="availability"><em>Available on Neko, Android, iOS, macOS, Linux, HTML5, Windows</em></p><div class="doc"><p>Returns the String representation of <code>path</code> without the directory.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="withoutExtension"></a><h3><p><code><span class="label">static</span><a href="#withoutExtension"><span class="identifier">withoutExtension</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a></span>):<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><p class="availability"><em>Available on Neko, macOS, Linux, Windows</em></p><div class="doc"><p>Returns the String representation of <code>path</code> without the file extension.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</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">© 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> |