<!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>Tcl: ns Namespace Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Tcl </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="namespaces.html"><span>Namespace List</span></a></li> <li><a href="namespacemembers.html"><span>Namespace Members</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#namespaces">Namespaces</a> | <a href="#nested-classes">Classes</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">ns Namespace Reference</div> </div> </div> <div class="contents"> <p>Documented namespace <code>ns</code> . <a href="#details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="namespaces"></a> Namespaces</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacens_1_1itcl__class.html">itcl_class</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacens_1_1oo__class.html">oo_class</a></td></tr> <tr><td colspan="2"><h2><a name="nested-classes"></a> Classes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classns_1_1itcl__class.html">itcl_class</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Documented itcl class <code><a class="el" href="classns_1_1itcl__class.html" title="Documented itcl class itcl_class .">itcl_class</a></code> . <a href="classns_1_1itcl__class.html#details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classns_1_1oo__class.html">oo_class</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Documented oo class <code><a class="el" href="classns_1_1oo__class.html" title="Documented oo class oo_class .">oo_class</a></code> . <a href="classns_1_1oo__class.html#details">More...</a><br/></td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacens.html#a1429cbe84d32b17ea4783e5c5c00615b">ns_proc</a> arg</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Documented proc <code>ns_proc</code> . <a href="#a1429cbe84d32b17ea4783e5c5c00615b"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Documented namespace <code>ns</code> . </p> <p>The code is inserted here:</p> <div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="keyword">namespace</span> <span class="keyword">eval</span> ns { <a name="l00002"></a>00002 <span class="comment">## Documented proc \c ns_proc . <a name="l00003"></a>00003 </span><span class="comment"> </span><span class="comment"># param[in] arg some argument <a name="l00004"></a>00004 </span><span class="comment"> </span><span class="keyword">proc</span> ns_proc {arg} {}<span class="comment"> <a name="l00005"></a>00005 </span> <span class="comment">## Documented var \c ns_var . <a name="l00006"></a>00006 </span><span class="comment"> </span><span class="comment"># Some documentation. <a name="l00007"></a>00007 </span><span class="comment"> </span><span class="keyword">variable</span> ns_var<span class="comment"> <a name="l00008"></a>00008 </span> <span class="comment">## Documented itcl class \c itcl_class . <a name="l00009"></a>00009 </span><span class="comment"> </span><span class="keyword">itcl::class</span> <span class="NULL">itcl_class</span><span class="NULL"> </span>{ <a name="l00010"></a>00010 <span class="comment">## Create object. <a name="l00011"></a>00011 </span><span class="comment"> </span><span class="keyword">constructor</span> {args} {eval $args}<span class="comment"> <a name="l00012"></a>00012 </span> <span class="comment">## Destroy object. <a name="l00013"></a>00013 </span><span class="comment"> </span><span class="keyword">destructor</span> {<span class="keyword">exit</span>}<span class="comment"> <a name="l00014"></a>00014 </span> <span class="comment">## Documented itcl method \c itcl_method_x . <a name="l00015"></a>00015 </span><span class="comment"> </span><span class="comment"># param[in] arg Argument <a name="l00016"></a>00016 </span><span class="comment"> </span><span class="keyword">private</span> <span class="keyword">method</span> itcl_method_x {arg}{}<span class="comment"> <a name="l00017"></a>00017 </span> <span class="comment">## Documented itcl method \c itcl_method_y . <a name="l00018"></a>00018 </span><span class="comment"> </span><span class="comment"># param[in] arg Argument <a name="l00019"></a>00019 </span><span class="comment"> </span><span class="keyword">protected</span> <span class="keyword">method</span> itcl_method_y {arg} {}<span class="comment"> <a name="l00020"></a>00020 </span> <span class="comment">## Documented itcl method \c itcl_method_z . <a name="l00021"></a>00021 </span><span class="comment"> </span><span class="comment"># param[in] arg Argument <a name="l00022"></a>00022 </span><span class="comment"> </span><span class="keyword">public</span> <span class="keyword">method</span> itcl_method_z {arg} {}<span class="comment"> <a name="l00023"></a>00023 </span> <span class="comment">## Documented common itcl var \c itcl_Var . <a name="l00024"></a>00024 </span><span class="comment"> </span><span class="keyword">common</span> itcl_Var<span class="comment"> <a name="l00025"></a>00025 </span> <span class="comment">## \protectedsection <a name="l00026"></a>00026 </span><span class="comment"> </span> <a name="l00027"></a>00027 <span class="keyword">variable</span> itcl_var1<span class="comment">;#< Documented itcl var \c itcl_var1 . <a name="l00028"></a>00028 </span><span class="keyword">variable</span> itcl_var2<span class="comment">;#< Documented itcl var \c itcl_var2 . <a name="l00029"></a>00029 </span>}<span class="comment"> <a name="l00030"></a>00030 </span> <span class="comment">## Documented oo class \c oo_class . <a name="l00031"></a>00031 </span><span class="comment"> </span><span class="keyword">oo::class</span> <span class="NULL">create</span><span class="NULL"> </span><span class="NULL">oo_class</span><span class="NULL"> </span>{ <a name="l00032"></a>00032 <span class="comment">## Create object. <a name="l00033"></a>00033 </span><span class="comment"> </span><span class="comment"># Configure with args <a name="l00034"></a>00034 </span><span class="comment"> </span><span class="keyword">constructor</span> {args} {eval $args}<span class="comment"> <a name="l00035"></a>00035 </span> <span class="comment">## Destroy object. <a name="l00036"></a>00036 </span><span class="comment"> </span><span class="comment"># Exit. <a name="l00037"></a>00037 </span><span class="comment"> </span><span class="keyword">destructor</span> {<span class="keyword">exit</span>}<span class="comment"> <a name="l00038"></a>00038 </span> <span class="comment">## Documented oo var \c oo_var . <a name="l00039"></a>00039 </span><span class="comment"> </span><span class="comment"># Defined inside class <a name="l00040"></a>00040 </span><span class="comment"> </span><span class="keyword">variable</span> oo_var<span class="comment"> <a name="l00041"></a>00041 </span> <span class="comment">## \private Documented oo method \c oo_method_x . <a name="l00042"></a>00042 </span><span class="comment"> </span><span class="comment"># param[in] arg Argument <a name="l00043"></a>00043 </span><span class="comment"> </span><span class="keyword">method</span> oo_method_x {arg} {}<span class="comment"> <a name="l00044"></a>00044 </span> <span class="comment">## \protected Documented oo method \c oo_method_y . <a name="l00045"></a>00045 </span><span class="comment"> </span><span class="comment"># param[in] arg Argument <a name="l00046"></a>00046 </span><span class="comment"> </span><span class="keyword">method</span> oo_method_y {arg} {}<span class="comment"> <a name="l00047"></a>00047 </span> <span class="comment">## \public Documented oo method \c oo_method_z . <a name="l00048"></a>00048 </span><span class="comment"> </span><span class="comment"># param[in] arg Argument <a name="l00049"></a>00049 </span><span class="comment"> </span><span class="keyword">method</span> oo_method_z {arg} {}<span class="comment"> <a name="l00050"></a>00050 </span> }<span class="comment"> <a name="l00051"></a>00051 </span>}<span class="comment"> <a name="l00052"></a>00052 </span></pre></div> </div><hr/><h2>Function Documentation</h2> <a class="anchor" id="a1429cbe84d32b17ea4783e5c5c00615b"></a><!-- doxytag: member="ns::ns_proc" ref="a1429cbe84d32b17ea4783e5c5c00615b" args="arg" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ns::ns_proc <td class="paramname">arg </td> </tr> </td> </td> </tr> </table> </div> <div class="memdoc"> <p>Documented proc <code>ns_proc</code> . </p> <p>param[in] arg some argument </p> <div class="fragment"><pre class="fragment"> <span class="keyword">proc</span> ns_proc {arg} {}<span class="comment"> </span></pre></div> </div> </div> </div> <hr class="footer"/><address class="footer"><small> Generated on Fri Aug 26 2011 21:27:38 for Tcl by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.7.5 </small></address> </body> </html>