{{Template:GUI_Object|input|[wiki:GUI_-_Properties#buffer_zone buffer_zone], [wiki:GUI_-_Properties#caption caption], [wiki:GUI_-_Properties#cell_id cell_id], [wiki:GUI_-_Properties#font font], [wiki:GUI_-_Properties#max_length max_length], [wiki:GUI_-_Properties#multiline multiline], [wiki:GUI_-_Properties#sprite sprite], [wiki:GUI_-_Properties#sprite_disabled sprite_disabled]'''*''', [wiki:GUI_-_Properties#sprite_selectarea sprite_selectarea],  [wiki:GUI_-_Properties#textcolor textcolor], [wiki:GUI_-_Properties#textcolor_selected textcolor_selected], [wiki:GUI_-_Properties#textcolor_disabled textcolor_disabled]'''*''', [wiki:GUI_-_Properties#tooltip tooltip], [wiki:GUI_-_Properties#tooltip_style tooltip_style]|none}}

An input box allows the user to enter text, that can be used by the application, like a Windows edit box.

It can have a sprite filling all of its size, and text that can be edited. 

Selecting a section of it will make a cursor sprite appear below the text (remember they can be monochrome), and a specific text colour for parts that are selected can be set. An initial caption for the input box (eg "Enter your name here"), along with an initial text colour, can be set, which is cleared when the control is first clicked'''*'''.

If ''multiline'' is set to "false", the text being inputted does not word-wrap, but scrolls horizontally without a scrollbar.

[wiki:Image:gui-object-input.png]

{{Template:TODO| |Possibly the control can support clipboard paste from outside the application ... Needs to be confirmed.}}

'''''Code of example image:'''''

{{{
  <object type="input"
          name="the_one_to_the_left"
          multiline="false"
          size="20 20 150 40"
          sprite="gd-input"
          sprite_selectarea="gd-blue"
          font="verdana12"
          textcolor="0 0 0"
          textcolor_selected="255 255 255"
  >Input control with transparent horizontal scrolling
  </object>
  
  <object type="input"
          name="the_one_to_the_right"
          multiline="true"
          size="180 20 350 100"
          sprite="gd-input"
          sprite_selectarea="gd-blue"
          font="verdana12"
          scrollbar="true"
          scrollbar_style="gd-scrollbar"
          textcolor="0 0 0"
          textcolor_selected="255 255 255"
  >This is an 'multiline' input control that word-wraps when reaching the right edge.
  </object>
}}}


'''Not yet implemented.''' * Planned, but not implemented