maxGraph/dotnet/docs/html/classcom_1_1mxgraph_1_1mxSh...

281 lines
14 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::mxSharedDiagram 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_1mxSharedDiagram.html">mxSharedDiagram</a>
</div>
</div>
<div class="contents">
<h1>com::mxgraph::mxSharedDiagram Class Reference</h1><!-- doxytag: class="com::mxgraph::mxSharedDiagram" -->
<p>Implements a diagram that may be shared among multiple sessions.
<a href="#_details">More...</a></p>
<p><a href="classcom_1_1mxgraph_1_1mxSharedDiagram-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a06bae16c4c4a61675e16771577681ff8">mxSharedDiagram</a> (string <a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#aab9d909873c0071a530d71b88ea729e2">state</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a new diagram with the given initial state. <a href="#a06bae16c4c4a61675e16771577681ff8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a3d4597a1b1750ced88c2085768447325">GetDelta</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the delta of all changes as a string. <a href="#a3d4597a1b1750ced88c2085768447325"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a32bb33bee6914b00860028737dfafb9d">ProcessDelta</a> (Object sender, XmlNode <a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#ac528a7daa6452e26c1e3517f1ef68963">delta</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Appends the given string to the history and dispatches the change to all sessions that are listening to this shared diagram. <a href="#a32bb33bee6914b00860028737dfafb9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a337f383a39ccfff3a7b27acee9fc763c">ProcessEdit</a> (XmlNode node)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a867955350b3463cdc7af92727deebbd1">AddDelta</a> (String xml)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears the delta of all changes. <a href="#a867955350b3463cdc7af92727deebbd1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#ae303ea16e8a3290b7f46f8be39d0941c">ResetDelta</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears the delta of all changes. <a href="#ae303ea16e8a3290b7f46f8be39d0941c"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#aab9d909873c0071a530d71b88ea729e2">state</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds the initial state of the diagram. <a href="#aab9d909873c0071a530d71b88ea729e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">StringBuilder&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#ac528a7daa6452e26c1e3517f1ef68963">delta</a> = new StringBuilder()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds the delta of all changes of initial state. <a href="#ac528a7daa6452e26c1e3517f1ef68963"></a><br/></td></tr>
<tr><td colspan="2"><h2>Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a32a05151825a4c51445535a690fe549d">State</a><code> [get]</code></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the initial state of the diagram. <a href="#a32a05151825a4c51445535a690fe549d"></a><br/></td></tr>
<tr><td colspan="2"><h2>Events</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mxDiagramChangeEventHandler&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a3db17c895284a0a4b835c5b6628b5923">DiagramChange</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fires when the diagram was changed. <a href="#a3db17c895284a0a4b835c5b6628b5923"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Implements a diagram that may be shared among multiple sessions. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a06bae16c4c4a61675e16771577681ff8"></a><!-- doxytag: member="com::mxgraph::mxSharedDiagram::mxSharedDiagram" ref="a06bae16c4c4a61675e16771577681ff8" args="(string state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com::mxgraph::mxSharedDiagram::mxSharedDiagram </td>
<td>(</td>
<td class="paramtype">string&nbsp;</td>
<td class="paramname"> <em>state</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new diagram with the given initial state. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>state</em>&nbsp;</td><td>Initial state of the diagram.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a867955350b3463cdc7af92727deebbd1"></a><!-- doxytag: member="com::mxgraph::mxSharedDiagram::AddDelta" ref="a867955350b3463cdc7af92727deebbd1" args="(String xml)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void com::mxgraph::mxSharedDiagram::AddDelta </td>
<td>(</td>
<td class="paramtype">String&nbsp;</td>
<td class="paramname"> <em>xml</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears the delta of all changes. </p>
</div>
</div>
<a class="anchor" id="a3d4597a1b1750ced88c2085768447325"></a><!-- doxytag: member="com::mxgraph::mxSharedDiagram::GetDelta" ref="a3d4597a1b1750ced88c2085768447325" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string com::mxgraph::mxSharedDiagram::GetDelta </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the delta of all changes as a string. </p>
</div>
</div>
<a class="anchor" id="a32bb33bee6914b00860028737dfafb9d"></a><!-- doxytag: member="com::mxgraph::mxSharedDiagram::ProcessDelta" ref="a32bb33bee6914b00860028737dfafb9d" args="(Object sender, XmlNode delta)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void com::mxgraph::mxSharedDiagram::ProcessDelta </td>
<td>(</td>
<td class="paramtype">Object&nbsp;</td>
<td class="paramname"> <em>sender</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XmlNode&nbsp;</td>
<td class="paramname"> <em>delta</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Appends the given string to the history and dispatches the change to all sessions that are listening to this shared diagram. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sender</em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>delta</em>&nbsp;</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a337f383a39ccfff3a7b27acee9fc763c"></a><!-- doxytag: member="com::mxgraph::mxSharedDiagram::ProcessEdit" ref="a337f383a39ccfff3a7b27acee9fc763c" args="(XmlNode node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string com::mxgraph::mxSharedDiagram::ProcessEdit </td>
<td>(</td>
<td class="paramtype">XmlNode&nbsp;</td>
<td class="paramname"> <em>node</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="ae303ea16e8a3290b7f46f8be39d0941c"></a><!-- doxytag: member="com::mxgraph::mxSharedDiagram::ResetDelta" ref="ae303ea16e8a3290b7f46f8be39d0941c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void com::mxgraph::mxSharedDiagram::ResetDelta </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears the delta of all changes. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ac528a7daa6452e26c1e3517f1ef68963"></a><!-- doxytag: member="com::mxgraph::mxSharedDiagram::delta" ref="ac528a7daa6452e26c1e3517f1ef68963" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringBuilder <a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#ac528a7daa6452e26c1e3517f1ef68963">com::mxgraph::mxSharedDiagram::delta</a> = new StringBuilder()<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Holds the delta of all changes of initial state. </p>
</div>
</div>
<a class="anchor" id="aab9d909873c0071a530d71b88ea729e2"></a><!-- doxytag: member="com::mxgraph::mxSharedDiagram::state" ref="aab9d909873c0071a530d71b88ea729e2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#aab9d909873c0071a530d71b88ea729e2">com::mxgraph::mxSharedDiagram::state</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Holds the initial state of the diagram. </p>
</div>
</div>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="a32a05151825a4c51445535a690fe549d"></a><!-- doxytag: member="com::mxgraph::mxSharedDiagram::State" ref="a32a05151825a4c51445535a690fe549d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string com::mxgraph::mxSharedDiagram::State<code> [get]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the initial state of the diagram. </p>
</div>
</div>
<hr/><h2>Event Documentation</h2>
<a class="anchor" id="a3db17c895284a0a4b835c5b6628b5923"></a><!-- doxytag: member="com::mxgraph::mxSharedDiagram::DiagramChange" ref="a3db17c895284a0a4b835c5b6628b5923" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mxDiagramChangeEventHandler com::mxgraph::mxSharedDiagram::DiagramChange</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fires when the diagram was changed. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/sharing/mxSharedState.cs</li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Sep 28 07:43:43 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>