<!-- clanlib header begin --> <HTML> <HEAD> <TITLE>CL_InputBox - ClanLib Game SDK</TITLE> <STYLE TYPE="text/css"><!-- HTML BODY { font-family: verdana, helvetica, sans-serif; font-size: 12px; } H1 { font-size: 22px; } H2 { font-size: 18px; } H3 { font-size: 16px; } H4 { font-size: 14px; } P { font-size: 12px; } LI { font-size: 12px; } --></STYLE> </HEAD> <body bgcolor=white text=black link=blue vlink=#800080> <center> <img src="http://clanlib.org/gfx/clanlib.png"> </center> <!-- clanlib header end --> <center> <p> <a href="http://clanlib.org/docs.html">Home</a> | <a href="classes.html">All Classes</a> | <a href="modules.html">Grouped Classes</a> | <a href="index.html">Index</a> | <a href="search.html">Search</a> </p> </center> <h1>Class CL_InputBox</h1> <p> Inputbox component <a href="#description">More...</a></p> <p>Derived from: <a href="CL_Component.html">CL_Component</a> <br> Derived by: <i>none</i> <br>Group: GUI (Controls)</p> <p> #include <ClanLib/gui.h> <p> <table border=0 width=100%> </table> <p><b>Construction:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_InputBox__CL_InputBox.html">CL_InputBox</a></p></td><td valign=top><p> InputBox Constructor</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__on_input_down.html">on_input_down</a></p></td><td valign=top><p></p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__on_input_up.html">on_input_up</a></p></td><td valign=top><p></p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__on_mouse_Ldown.html">on_mouse_Ldown</a></p></td><td valign=top><p></p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__on_mouse_Lup.html">on_mouse_Lup</a></p></td><td valign=top><p></p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__on_mouse_move.html">on_mouse_move</a></p></td><td valign=top><p></p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__on_lost_focus.html">on_lost_focus</a></p></td><td valign=top><p></p></td></tr></table> <p><b>Attributes:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_InputBox__get_text.html">get_text</a></p></td><td valign=top><p> Returns the inputfield text.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__get_length.html">get_length</a></p></td><td valign=top><p> Returns the length of the inputfield text.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__get_marked_text.html">get_marked_text</a></p></td><td valign=top><p> Returns the marked text from the inputfield.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__has_marked_text.html">has_marked_text</a></p></td><td valign=top><p> Returns true if part of the text has been marked by the user.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__get_selection_start.html">get_selection_start</a></p></td><td valign=top><p> Returns the position where the selection starts.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__get_selection_length.html">get_selection_length</a></p></td><td valign=top><p> Returns the length of current selection.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__get_max_length.html">get_max_length</a></p></td><td valign=top><p> Returns the maximum permitted length of the text.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__in_password_mode.html">in_password_mode</a></p></td><td valign=top><p> Returns true if password mode is enabled, false othewise.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__is_read_only.html">is_read_only</a></p></td><td valign=top><p> Returns whether the inputfield is read-only. </p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__get_cursor_position.html">get_cursor_position</a></p></td><td valign=top><p> Returns the current cursor position.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__is_edited.html">is_edited</a></p></td><td valign=top><p> Returns true if the contents has been edited.</p></td></tr></table> <p><b>Operations:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_InputBox__set_text.html">set_text</a></p></td><td valign=top><p> Sets the line edit text to text, clears the selection and moves the cursor to the end of the line.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__set_max_length.html">set_max_length</a></p></td><td valign=top><p> Set the maximum length of the text in the editor.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__set_password_mode.html">set_password_mode</a></p></td><td valign=top><p> If enable is true, display asterisks instead of the characters actually entered.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__set_read_only.html">set_read_only</a></p></td><td valign=top><p> Enables or disables read-only mode.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__select_all.html">select_all</a></p></td><td valign=top><p> Selects all text, and moves the cursor to the end.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__deselect.html">deselect</a></p></td><td valign=top><p> Deselects all text (i.e. removes marking) and leaves the cursor at the current position. </p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__set_selection.html">set_selection</a></p></td><td valign=top><p> Sets the marked area at start and be length characters long. </p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__set_cursor_position.html">set_cursor_position</a></p></td><td valign=top><p> Sets the cursor position to pos. </p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__clear.html">clear</a></p></td><td valign=top><p> Syntactic sugar for set_text("").</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__backspace.html">backspace</a></p></td><td valign=top><p> Deletes the character to the left of the text cursor and moves the cursor one position to the left.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__del.html">del</a></p></td><td valign=top><p> Deletes the character on the right side of the text cursor.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__cut.html">cut</a></p></td><td valign=top><p> Cut the selected text if any.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__move_cursor.html">move_cursor</a></p></td><td valign=top><p> Moves the cursor position.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__move_cursor_word.html">move_cursor_word</a></p></td><td valign=top><p> Moves the cursor by word.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__home.html">home</a></p></td><td valign=top><p> Moves the text cursor to the left end of the line.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__end.html">end</a></p></td><td valign=top><p> Moves the text cursor to the right end of the line.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__set_edited.html">set_edited</a></p></td><td valign=top><p> Sets the edited flag to on. </p></td></tr></table> <p><b>Signals:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_InputBox__sig_changed.html">sig_changed</a></p></td><td valign=top><p> This signal is emitted whenever text is changed in the inputfield.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__sig_return_pressed.html">sig_return_pressed</a></p></td><td valign=top><p> This signal is emitted when enter is pressed in the inputfield.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__sig_activity.html">sig_activity</a></p></td><td valign=top><p> This signal is emitted whenever some character is changed/added/removed, cursor moved etc.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_InputBox__sig_validate_character.html">sig_validate_character</a></p></td><td valign=top><p> This signal is emitted after user enter some character, but before it added, to allow user to accept/decline it.</p></td></tr></table> <a name="#description"><p><b>Detailed description:</b></p> !group=GUI/Controls! !header=gui.h! <!-- clanlib footer begin --> <center><br><br><font color="#a0a0a0"> Questions or comments, write to the <a href="http://clanlib.org/contact.html">ClanLib mailing list</a>. </font></center> </body> </html> <!-- clanlib footer end -->