Source

GUI-eXtended_OpenSource / GUI-eXtended-1 / trunk / build / Docs / BaseDocs / html / class_g_u_i_x_1_1_text_area.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>GUI-eXtended: GUIX.TextArea Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">GUI-eXtended</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('class_g_u_i_x_1_1_text_area.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a>  </div>
  <div class="headertitle">
<div class="title">GUIX.TextArea Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="GUIX::TextArea" --><!-- doxytag: inherits="GUIX::ElementBase" -->
<p>Text Area element.  
 <a href="class_g_u_i_x_1_1_text_area.html#details">More...</a></p>

<p><a href="class_g_u_i_x_1_1_text_area-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb9e914a8c5d160be0ec5dd0b4cc46fa"></a><!-- doxytag: member="GUIX::TextArea::Draw" ref="abb9e914a8c5d160be0ec5dd0b4cc46fa" args="()" -->
override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_u_i_x_1_1_text_area.html#abb9e914a8c5d160be0ec5dd0b4cc46fa">Draw</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws this element. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_u_i_x_1_1_text_area.html#a4523b2551288111b17979c2da75bb28f">EditorDraw</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs drawing in the Designer / Editor Override when you need to change behaviour of the element so it cooperates with the designer.  <a href="#a4523b2551288111b17979c2da75bb28f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_g_u_i_x_1_1_element_base.html">ElementBase</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_u_i_x_1_1_text_area.html#a61fe6bfb47784f1f448c086c2fdd38d0">GetNewInstance</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a new instance of this element.  <a href="#a61fe6bfb47784f1f448c086c2fdd38d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_g_u_i_x_1_1_element_base.html">ElementBase</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_u_i_x_1_1_text_area.html#a00db194df2635c597d674f5101b7fe49">Copy</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the copy constructor even if we don't know the type of this element.  <a href="#a00db194df2635c597d674f5101b7fe49"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">override string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_u_i_x_1_1_text_area.html#aa119763cb567a639b5e64b9d2b519774">ElementName</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of this element.  <a href="#aa119763cb567a639b5e64b9d2b519774"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">override string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_u_i_x_1_1_text_area.html#a6d48e342573d9aa03bcdb6af51b15724">ElementType</a><code> [get]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">String representation of the type of this element.  <a href="#a6d48e342573d9aa03bcdb6af51b15724"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_u_i_x_1_1_text_area.html#a8b19fe02ac1868bb5b9470686e626042">Value</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Current value of this <a class="el" href="class_g_u_i_x_1_1_text_area.html" title="Text Area element.">TextArea</a> (string)  <a href="#a8b19fe02ac1868bb5b9470686e626042"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0af77697b43993909ad1a8a2ab37409e"></a><!-- doxytag: member="GUIX::TextArea::MaxLength" ref="a0af77697b43993909ad1a8a2ab37409e" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_u_i_x_1_1_text_area.html#a0af77697b43993909ad1a8a2ab37409e">MaxLength</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Max input length of this <a class="el" href="class_g_u_i_x_1_1_text_area.html" title="Text Area element.">TextArea</a> (defaults to 1,000,000 characters). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_g_u_i_x_1_1_text_area.html#a72301be18916bd9e94719a1f3bb17a72">HandleClick</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets whether or not the base class handles click testing automatically.  <a href="#a72301be18916bd9e94719a1f3bb17a72"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Text Area element. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a00db194df2635c597d674f5101b7fe49"></a><!-- doxytag: member="GUIX::TextArea::Copy" ref="a00db194df2635c597d674f5101b7fe49" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">override <a class="el" href="class_g_u_i_x_1_1_element_base.html">ElementBase</a> GUIX.TextArea.Copy </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provides access to the copy constructor even if we don't know the type of this element. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>

<p>Implements <a class="el" href="class_g_u_i_x_1_1_element_base.html#a6d5a5a54ea3b03354759f57131de8670">GUIX.ElementBase</a>.</p>

</div>
</div>
<a class="anchor" id="a4523b2551288111b17979c2da75bb28f"></a><!-- doxytag: member="GUIX::TextArea::EditorDraw" ref="a4523b2551288111b17979c2da75bb28f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">override void GUIX.TextArea.EditorDraw </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Performs drawing in the Designer / Editor Override when you need to change behaviour of the element so it cooperates with the designer. </p>
<p>Default action simply disables click handling and calls the standard <a class="el" href="class_g_u_i_x_1_1_text_area.html#abb9e914a8c5d160be0ec5dd0b4cc46fa" title="Draws this element.">Draw()</a> method. </p>

<p>Reimplemented from <a class="el" href="class_g_u_i_x_1_1_element_base.html#af6864a69ebf0e010887dbf975d06c1d9">GUIX.ElementBase</a>.</p>

</div>
</div>
<a class="anchor" id="a61fe6bfb47784f1f448c086c2fdd38d0"></a><!-- doxytag: member="GUIX::TextArea::GetNewInstance" ref="a61fe6bfb47784f1f448c086c2fdd38d0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">override <a class="el" href="class_g_u_i_x_1_1_element_base.html">ElementBase</a> GUIX.TextArea.GetNewInstance </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns a new instance of this element. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>New element</dd></dl>

<p>Implements <a class="el" href="class_g_u_i_x_1_1_element_base.html#af9d50bca5b598290dc0ee0c3d58d955f">GUIX.ElementBase</a>.</p>

</div>
</div>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="aa119763cb567a639b5e64b9d2b519774"></a><!-- doxytag: member="GUIX::TextArea::ElementName" ref="aa119763cb567a639b5e64b9d2b519774" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">override string GUIX.TextArea.ElementName<code> [get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The name of this element. </p>
<p>Used internally. </p>

<p>Reimplemented from <a class="el" href="class_g_u_i_x_1_1_element_base.html#a9584979a79172fadcc5115a0c5cae569">GUIX.ElementBase</a>.</p>

</div>
</div>
<a class="anchor" id="a6d48e342573d9aa03bcdb6af51b15724"></a><!-- doxytag: member="GUIX::TextArea::ElementType" ref="a6d48e342573d9aa03bcdb6af51b15724" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">override string GUIX.TextArea.ElementType<code> [get]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>String representation of the type of this element. </p>
<p>(Read-only)</p>
<p>Used internally. </p>

<p>Reimplemented from <a class="el" href="class_g_u_i_x_1_1_element_base.html#a6d83eabcf352b4f4b7b5f78c91b55e9e">GUIX.ElementBase</a>.</p>

</div>
</div>
<a class="anchor" id="a72301be18916bd9e94719a1f3bb17a72"></a><!-- doxytag: member="GUIX::TextArea::HandleClick" ref="a72301be18916bd9e94719a1f3bb17a72" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">override bool GUIX.TextArea.HandleClick<code> [get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets whether or not the base class handles click testing automatically. </p>
<p>Disable in custom control code to impliment custom click handling. </p>

<p>Reimplemented from <a class="el" href="class_g_u_i_x_1_1_element_base.html#a56566c47a1fba4f4fa7a567f9fbf2d5d">GUIX.ElementBase</a>.</p>

</div>
</div>
<a class="anchor" id="a8b19fe02ac1868bb5b9470686e626042"></a><!-- doxytag: member="GUIX::TextArea::Value" ref="a8b19fe02ac1868bb5b9470686e626042" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string GUIX.TextArea.Value<code> [get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Current value of this <a class="el" href="class_g_u_i_x_1_1_text_area.html" title="Text Area element.">TextArea</a> (string) </p>

</div>
</div>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespace_g_u_i_x.html">GUIX</a>      </li>
      <li class="navelem"><a class="el" href="class_g_u_i_x_1_1_text_area.html">TextArea</a>      </li>
      <li class="footer">Generated on Tue Feb 21 2012 04:53:06 for GUI-eXtended by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
    </ul>
  </div>

</body>
</html>