<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.4"/> <title>ClanLib: textedit.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">ClanLib  <span id="projectnumber">2.3.7</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.4 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_14852d208b69b5a1926f5d908b4903da.html">Sources</a></li><li class="navelem"><a class="el" href="dir_66cde9167ab84f7398e86467706d8b82.html">API</a></li><li class="navelem"><a class="el" href="dir_581c4848279b3493f1289a6380f599b2.html">GUI</a></li><li class="navelem"><a class="el" href="dir_6e6c067ae7ee11f4fc8ee359b22a71a8.html">Components</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">textedit.h</div> </div> </div><!--header--> <div class="contents"> <a href="textedit_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">** ClanLib SDK</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">** Copyright (c) 1997-2011 The ClanLib Team</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">**</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">** This software is provided 'as-is', without any express or implied</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">** warranty. In no event will the authors be held liable for any damages</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">** arising from the use of this software.</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">**</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">** Permission is granted to anyone to use this software for any purpose,</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">** including commercial applications, and to alter it and redistribute it</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">** freely, subject to the following restrictions:</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">**</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">** 1. The origin of this software must not be misrepresented; you must not</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">** claim that you wrote the original software. If you use this software</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">** in a product, an acknowledgment in the product documentation would be</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">** appreciated but is not required.</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">** 2. Altered source versions must be plainly marked as such, and must not be</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">** misrepresented as being the original software.</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">** 3. This notice may not be removed or altered from any source distribution.</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">**</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">** Note: Some of the libraries ClanLib may link to may have additional</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">** requirements or restrictions.</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">**</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">** File Author(s):</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">**</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">** Magnus Norddahl</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">** Harry Storbacka</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">*/</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#pragma once</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "../api_gui.h"</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "../gui_component.h"</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>CL_TextEdit_Impl;</div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> <div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="classCL__TextEdit.html"> 43</a></span> <span class="keyword">class </span><a class="code" href="api__gui_8h.html#aeaa9000f97df987dab1dd53e85f034cd">CL_API_GUI</a> <a class="code" href="classCL__TextEdit.html" title="Text edit component. ">CL_TextEdit</a> : <span class="keyword">public</span> <a class="code" href="classCL__GUIComponent.html" title="GUI base component class. ">CL_GUIComponent</a></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> {</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="classCL__TextEdit.html" title="Text edit component. ">CL_TextEdit</a>(<a class="code" href="classCL__GUIComponent.html" title="GUI base component class. ">CL_GUIComponent</a> *parent);</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">virtual</span> ~<a class="code" href="classCL__TextEdit.html" title="Text edit component. ">CL_TextEdit</a>();</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">using</span> <a class="code" href="classCL__GUIComponent.html#ae65c1ec6ab3c015a5551cd87645ee064" title="Find child component with the specified component ID name. ">CL_GUIComponent::get_named_item</a>;</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">static</span> <a class="code" href="classCL__TextEdit.html" title="Text edit component. ">CL_TextEdit</a> *<a class="code" href="classCL__GUIComponent.html#ae65c1ec6ab3c015a5551cd87645ee064" title="Find child component with the specified component ID name. ">get_named_item</a>(<a class="code" href="classCL__GUIComponent.html" title="GUI base component class. ">CL_GUIComponent</a> *reference_component, <span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &<span class="keywordtype">id</span>);</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">bool</span> is_read_only() <span class="keyword">const</span>;</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">bool</span> is_lowercase() <span class="keyword">const</span>;</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">bool</span> is_uppercase() <span class="keyword">const</span>;</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">int</span> get_max_length() <span class="keyword">const</span>;</div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="classCL__String8.html" title="String container template. ">CL_String</a> get_text() <span class="keyword">const</span>;</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">int</span> get_line_count() <span class="keyword">const</span>;</div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="classCL__String8.html" title="String container template. ">CL_String</a> get_line_text(<span class="keywordtype">int</span> line) <span class="keyword">const</span>;</div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classCL__String8.html" title="String container template. ">CL_String</a> get_selection() <span class="keyword">const</span>;</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">int</span> get_selection_start() <span class="keyword">const</span>;</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">int</span> get_selection_length() <span class="keyword">const</span>;</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">int</span> get_cursor_pos() <span class="keyword">const</span>;</div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">int</span> get_cursor_line_number() <span class="keyword">const</span>;</div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">virtual</span> <a class="code" href="classCL__Size.html" title="2D (width,height) size structure - Integer ">CL_Size</a> <a class="code" href="classCL__GUIComponent.html#a058bccee014e4d9f4c2222d45c3c77e8" title="Returns the preferred size of a render box. ">get_preferred_size</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">int</span> get_total_height();</div> <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div> <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordtype">void</span> set_select_all_on_focus_gain(<span class="keywordtype">bool</span> enable);</div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordtype">void</span> select_all();</div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordtype">void</span> set_read_only(<span class="keywordtype">bool</span> enable = <span class="keyword">true</span>);</div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div> <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">void</span> set_lowercase(<span class="keywordtype">bool</span> enable = <span class="keyword">true</span>);</div> <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordtype">void</span> set_uppercase(<span class="keywordtype">bool</span> enable = <span class="keyword">true</span>);</div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div> <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keywordtype">void</span> set_max_length(<span class="keywordtype">int</span> length);</div> <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordtype">void</span> set_text(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &text);</div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">void</span> add_text(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &text);</div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div> <div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordtype">void</span> set_selection(<span class="keywordtype">int</span> pos, <span class="keywordtype">int</span> length);</div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keywordtype">void</span> clear_selection();</div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordtype">void</span> set_cursor_pos(<span class="keywordtype">int</span> pos);</div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div> <div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="keywordtype">void</span> delete_selected_text();</div> <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keywordtype">void</span> set_input_mask(<span class="keyword">const</span> <a class="code" href="classCL__StringRef8.html" title="String reference template. ">CL_StringRef</a> &mask);</div> <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div> <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keywordtype">void</span> set_cursor_drawing_enabled(<span class="keywordtype">bool</span> enable);</div> <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div> <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div> <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <a class="code" href="classCL__Callback__v1.html" title="CL_Callback_v1. ">CL_Callback_v1<CL_InputEvent &></a> &func_before_edit_changed();</div> <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> </div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <a class="code" href="classCL__Callback__v1.html" title="CL_Callback_v1. ">CL_Callback_v1<CL_InputEvent &></a> &func_after_edit_changed();</div> <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div> <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <a class="code" href="classCL__Callback__v0.html" title="CL_Callback_v0. ">CL_Callback_v0</a> &func_selection_changed();</div> <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> </div> <div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <a class="code" href="classCL__Callback__v0.html" title="CL_Callback_v0. ">CL_Callback_v0</a> &<a class="code" href="classCL__GUIComponent.html#aab556e0d21765f5c7da023606b413ffc" title="bool func_focus_gained() ">func_focus_gained</a>();</div> <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> </div> <div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <a class="code" href="classCL__Callback__v0.html" title="CL_Callback_v0. ">CL_Callback_v0</a> &<a class="code" href="classCL__GUIComponent.html#aba230bc0081639761d33e199c99cdd2b" title="bool func_focus_lost() ">func_focus_lost</a>();</div> <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> </div> <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <a class="code" href="classCL__Callback__v0.html" title="CL_Callback_v0. ">CL_Callback_v0</a> &func_enter_pressed();</div> <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> </div> <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div> <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  CL_SharedPtr<CL_TextEdit_Impl> impl;</div> <div class="line"><a name="l00231"></a><span class="lineno"> 231</span> };</div> <div class="line"><a name="l00232"></a><span class="lineno"> 232</span> </div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Jun 14 2013 13:05:47 for ClanLib by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.4 </small></address> </body> </html>