class Gosu::TextInput

• Gosu::TextInput
• Reference
• Object

Overview

A TextInput is an invisible object that handles input using the operating system's input manager.

At its most basic, you only need to set Gosu::Window#text_input to an instance of this class. The TextInput will then handle all keyboard input until Gosu::Window#text_input is set to nil. Any text the user has typed is available through #text.

This class is purely back-end and does not come with a GUI; drawing the input field is up to you, the programmer. The best way to do that is left completely open. TextInput only aims to provide a foundation for you to build your own GUI.

see Gosu::Window#text_input

see file: examples/TextInput.cr

Defined in:

Constructors

• .new

Instance Method Summary

• #caret_pos : UInt32

  The position of the editing caret.

• #caret_pos=(position : UInt32 | Int32)

  Sets the position of the editing caret to position.

• #delete_backward

  Deletes the current selection, if any, or the previous character.

• #delete_forward

  Deletes the current selection, if any, or the next character.

• #filter(text : String) : String

  This method is an overridable filter that is applied to all newly entered text.

• #insert_text(text : String)

  Replaces the current selection (if any) and inserts the given string at the current caret position.

• #selection_start : UInt32

  The starting position of the currently selected text.

• #selection_start=(position : UInt32 | Int32)

  Sets the starting position of the currently selected text to position.

• #text : String

  The text that the user has typed.

• #text=(text : String)

  Replaces TextInput text with #text.

Constructor Detail

Instance Method Detail

input = TextInput.new

def input.filter(text_in)
  text_in.upcase.gsub(/[^A-Z0-9]/, "")
end