maxGraph/dotnet/docs/html/classcom_1_1mxgraph_1_1mxCe...

165 lines
8.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>mxGraph: com::mxgraph::mxCellPath Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>com</b>::<b>mxgraph</b>::<a class="el" href="classcom_1_1mxgraph_1_1mxCellPath.html">mxCellPath</a>
</div>
</div>
<div class="contents">
<h1>com::mxgraph::mxCellPath Class Reference</h1><!-- doxytag: class="com::mxgraph::mxCellPath" -->
<p>Implements a mechanism for temporary cell Ids.
<a href="#_details">More...</a></p>
<p><a href="classcom_1_1mxgraph_1_1mxCellPath-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCellPath.html#a5d6ef3ddf18cdcf7250bb4eb47f930a9">Create</a> (<a class="el" href="interfacecom_1_1mxgraph_1_1mxICell.html">mxICell</a> cell)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates the cell path for the given cell. The cell path is a concatenation of the indices of all cells on the (finite) path to the root, eg. "0.0.0.1". <a href="#a5d6ef3ddf18cdcf7250bb4eb47f930a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCellPath.html#a0f50a9dd6e3983bc5a5e867d200faa52">GetParentPath</a> (string path)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the path for the parent of the cell represented by the given path. Returns null if the given path has no parent. <a href="#a0f50a9dd6e3983bc5a5e867d200faa52"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="interfacecom_1_1mxgraph_1_1mxICell.html">mxICell</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCellPath.html#ad5059bd5081b1a2f127eb95cc63b51dd">Resolve</a> (<a class="el" href="interfacecom_1_1mxgraph_1_1mxICell.html">mxICell</a> root, string path)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the cell for the specified cell path using the given root as the root of the path. <a href="#ad5059bd5081b1a2f127eb95cc63b51dd"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCellPath.html#a8308de65cdb622585ffdf7a5cb05a8a8">PATH_SEPARATOR</a> = '.'</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Defines the separator between the path components. Default is ".". <a href="#a8308de65cdb622585ffdf7a5cb05a8a8"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Implements a mechanism for temporary cell Ids. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5d6ef3ddf18cdcf7250bb4eb47f930a9"></a><!-- doxytag: member="com::mxgraph::mxCellPath::Create" ref="a5d6ef3ddf18cdcf7250bb4eb47f930a9" args="(mxICell cell)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static string com::mxgraph::mxCellPath::Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interfacecom_1_1mxgraph_1_1mxICell.html">mxICell</a>&nbsp;</td>
<td class="paramname"> <em>cell</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates the cell path for the given cell. The cell path is a concatenation of the indices of all cells on the (finite) path to the root, eg. "0.0.0.1". </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cell</em>&nbsp;</td><td>Cell whose path should be returned.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the string that represents the path.</dd></dl>
</div>
</div>
<a class="anchor" id="a0f50a9dd6e3983bc5a5e867d200faa52"></a><!-- doxytag: member="com::mxgraph::mxCellPath::GetParentPath" ref="a0f50a9dd6e3983bc5a5e867d200faa52" args="(string path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static string com::mxgraph::mxCellPath::GetParentPath </td>
<td>(</td>
<td class="paramtype">string&nbsp;</td>
<td class="paramname"> <em>path</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the path for the parent of the cell represented by the given path. Returns null if the given path has no parent. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>Path whose parent path should be returned.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad5059bd5081b1a2f127eb95cc63b51dd"></a><!-- doxytag: member="com::mxgraph::mxCellPath::Resolve" ref="ad5059bd5081b1a2f127eb95cc63b51dd" args="(mxICell root, string path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="interfacecom_1_1mxgraph_1_1mxICell.html">mxICell</a> com::mxgraph::mxCellPath::Resolve </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interfacecom_1_1mxgraph_1_1mxICell.html">mxICell</a>&nbsp;</td>
<td class="paramname"> <em>root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&nbsp;</td>
<td class="paramname"> <em>path</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the cell for the specified cell path using the given root as the root of the path. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>root</em>&nbsp;</td><td>Root cell of the path to be resolved.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>String that defines the path.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the cell that is defined by the path.</dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a8308de65cdb622585ffdf7a5cb05a8a8"></a><!-- doxytag: member="com::mxgraph::mxCellPath::PATH_SEPARATOR" ref="a8308de65cdb622585ffdf7a5cb05a8a8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char <a class="el" href="classcom_1_1mxgraph_1_1mxCellPath.html#a8308de65cdb622585ffdf7a5cb05a8a8">com::mxgraph::mxCellPath::PATH_SEPARATOR</a> = '.'<code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Defines the separator between the path components. Default is ".". </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/model/mxCellPath.cs</li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Dec 18 13:18:35 2012 for mxGraph by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>