MLEM/Docs/api/MLEM.Misc.TextInputWrapper.yml

### YamlMime:ManagedReference
items:
- uid: MLEM.Misc.TextInputWrapper
  commentId: T:MLEM.Misc.TextInputWrapper
  id: TextInputWrapper
  parent: MLEM.Misc
  children:
  - MLEM.Misc.TextInputWrapper.AddListener(Microsoft.Xna.Framework.GameWindow,MLEM.Misc.TextInputWrapper.TextInputCallback)
  - MLEM.Misc.TextInputWrapper.Current
  - MLEM.Misc.TextInputWrapper.RequiresOnScreenKeyboard
  langs:
  - csharp
  - vb
  name: TextInputWrapper
  nameWithType: TextInputWrapper
  fullName: MLEM.Misc.TextInputWrapper
  type: Class
  source:
    remote:
      path: MLEM/Misc/TextInputWrapper.cs
      branch: master
      repo: https://github.com/Ellpeck/MLEM
    id: TextInputWrapper
    path: ../MLEM/Misc/TextInputWrapper.cs
    startLine: 13
  assemblies:
  - MLEM
  namespace: MLEM.Misc
  summary: "\nA text input wrapper is a wrapper around MonoGame&apos;s built-in text input event.\nSince said text input event does not exist on non-Desktop devices, we want to wrap it in a wrapper that is platform-independent for MLEM.\nSee subclasses of this wrapper or <a href=\"https://mlem.ellpeck.de/articles/ui.html#text-input\">https://mlem.ellpeck.de/articles/ui.html#text-input</a> for more info.\n"
  example: []
  syntax:
    content: public abstract class TextInputWrapper
    content.vb: Public MustInherit Class TextInputWrapper
  inheritance:
  - System.Object
  derivedClasses:
  - MLEM.Misc.TextInputWrapper.DesktopGl`1
  - MLEM.Misc.TextInputWrapper.Mobile
  - MLEM.Misc.TextInputWrapper.None
  - MLEM.Misc.TextInputWrapper.Primitive
  inheritedMembers:
  - System.Object.Equals(System.Object)
  - System.Object.Equals(System.Object,System.Object)
  - System.Object.GetHashCode
  - System.Object.GetType
  - System.Object.MemberwiseClone
  - System.Object.ReferenceEquals(System.Object,System.Object)
  - System.Object.ToString
  modifiers.csharp:
  - public
  - abstract
  - class
  modifiers.vb:
  - Public
  - MustInherit
  - Class
- uid: MLEM.Misc.TextInputWrapper.Current
  commentId: P:MLEM.Misc.TextInputWrapper.Current
  id: Current
  parent: MLEM.Misc.TextInputWrapper
  langs:
  - csharp
  - vb
  name: Current
  nameWithType: TextInputWrapper.Current
  fullName: MLEM.Misc.TextInputWrapper.Current
  type: Property
  source:
    remote:
      path: MLEM/Misc/TextInputWrapper.cs
      branch: master
      repo: https://github.com/Ellpeck/MLEM
    id: Current
    path: ../MLEM/Misc/TextInputWrapper.cs
    startLine: 21
  assemblies:
  - MLEM
  namespace: MLEM.Misc
  summary: "\nThe current text input wrapper.\nSet this value before starting your game if you want to use text input wrapping.\n"
  example: []
  syntax:
    content: public static TextInputWrapper Current { get; set; }
    parameters: []
    return:
      type: MLEM.Misc.TextInputWrapper
    content.vb: Public Shared Property Current As TextInputWrapper
  overload: MLEM.Misc.TextInputWrapper.Current*
  exceptions:
  - type: System.InvalidOperationException
    commentId: T:System.InvalidOperationException
  modifiers.csharp:
  - public
  - static
  - get
  - set
  modifiers.vb:
  - Public
  - Shared
- uid: MLEM.Misc.TextInputWrapper.RequiresOnScreenKeyboard
  commentId: M:MLEM.Misc.TextInputWrapper.RequiresOnScreenKeyboard
  id: RequiresOnScreenKeyboard
  parent: MLEM.Misc.TextInputWrapper
  langs:
  - csharp
  - vb
  name: RequiresOnScreenKeyboard()
  nameWithType: TextInputWrapper.RequiresOnScreenKeyboard()
  fullName: MLEM.Misc.TextInputWrapper.RequiresOnScreenKeyboard()
  type: Method
  source:
    remote:
      path: MLEM/Misc/TextInputWrapper.cs
      branch: master
      repo: https://github.com/Ellpeck/MLEM
    id: RequiresOnScreenKeyboard
    path: ../MLEM/Misc/TextInputWrapper.cs
    startLine: 34
  assemblies:
  - MLEM
  namespace: MLEM.Misc
  summary: "\nDetermines if this text input wrapper requires an on-screen keyboard.\n"
  example: []
  syntax:
    content: public abstract bool RequiresOnScreenKeyboard()
    return:
      type: System.Boolean
      description: If this text input wrapper requires an on-screen keyboard
    content.vb: Public MustOverride Function RequiresOnScreenKeyboard As Boolean
  overload: MLEM.Misc.TextInputWrapper.RequiresOnScreenKeyboard*
  modifiers.csharp:
  - public
  - abstract
  modifiers.vb:
  - Public
  - MustOverride
- uid: MLEM.Misc.TextInputWrapper.AddListener(Microsoft.Xna.Framework.GameWindow,MLEM.Misc.TextInputWrapper.TextInputCallback)
  commentId: M:MLEM.Misc.TextInputWrapper.AddListener(Microsoft.Xna.Framework.GameWindow,MLEM.Misc.TextInputWrapper.TextInputCallback)
  id: AddListener(Microsoft.Xna.Framework.GameWindow,MLEM.Misc.TextInputWrapper.TextInputCallback)
  parent: MLEM.Misc.TextInputWrapper
  langs:
  - csharp
  - vb
  name: AddListener(GameWindow, TextInputWrapper.TextInputCallback)
  nameWithType: TextInputWrapper.AddListener(GameWindow, TextInputWrapper.TextInputCallback)
  fullName: MLEM.Misc.TextInputWrapper.AddListener(Microsoft.Xna.Framework.GameWindow, MLEM.Misc.TextInputWrapper.TextInputCallback)
  type: Method
  source:
    remote:
      path: MLEM/Misc/TextInputWrapper.cs
      branch: master
      repo: https://github.com/Ellpeck/MLEM
    id: AddListener
    path: ../MLEM/Misc/TextInputWrapper.cs
    startLine: 42
  assemblies:
  - MLEM
  namespace: MLEM.Misc
  summary: "\nAdds a text input listener to this text input wrapper.\nThe supplied listener will be called whenever a character is input.\n"
  example: []
  syntax:
    content: public abstract void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback)
    parameters:
    - id: window
      type: Microsoft.Xna.Framework.GameWindow
      description: The game&apos;s window
    - id: callback
      type: MLEM.Misc.TextInputWrapper.TextInputCallback
      description: The callback that should be called whenever a character is pressed
    content.vb: Public MustOverride Sub AddListener(window As GameWindow, callback As TextInputWrapper.TextInputCallback)
  overload: MLEM.Misc.TextInputWrapper.AddListener*
  modifiers.csharp:
  - public
  - abstract
  modifiers.vb:
  - Public
  - MustOverride
references:
- uid: MLEM.Misc
  commentId: N:MLEM.Misc
  name: MLEM.Misc
  nameWithType: MLEM.Misc
  fullName: MLEM.Misc
- uid: System.Object
  commentId: T:System.Object
  parent: System
  isExternal: true
  name: Object
  nameWithType: Object
  fullName: System.Object
- uid: System.Object.Equals(System.Object)
  commentId: M:System.Object.Equals(System.Object)
  parent: System.Object
  isExternal: true
  name: Equals(Object)
  nameWithType: Object.Equals(Object)
  fullName: System.Object.Equals(System.Object)
  spec.csharp:
  - uid: System.Object.Equals(System.Object)
    name: Equals
    nameWithType: Object.Equals
    fullName: System.Object.Equals
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - uid: System.Object
    name: Object
    nameWithType: Object
    fullName: System.Object
    isExternal: true
  - name: )
    nameWithType: )
    fullName: )
  spec.vb:
  - uid: System.Object.Equals(System.Object)
    name: Equals
    nameWithType: Object.Equals
    fullName: System.Object.Equals
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - uid: System.Object
    name: Object
    nameWithType: Object
    fullName: System.Object
    isExternal: true
  - name: )
    nameWithType: )
    fullName: )
- uid: System.Object.Equals(System.Object,System.Object)
  commentId: M:System.Object.Equals(System.Object,System.Object)
  parent: System.Object
  isExternal: true
  name: Equals(Object, Object)
  nameWithType: Object.Equals(Object, Object)
  fullName: System.Object.Equals(System.Object, System.Object)
  spec.csharp:
  - uid: System.Object.Equals(System.Object,System.Object)
    name: Equals
    nameWithType: Object.Equals
    fullName: System.Object.Equals
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - uid: System.Object
    name: Object
    nameWithType: Object
    fullName: System.Object
    isExternal: true
  - name: ', '
    nameWithType: ', '
    fullName: ', '
  - uid: System.Object
    name: Object
    nameWithType: Object
    fullName: System.Object
    isExternal: true
  - name: )
    nameWithType: )
    fullName: )
  spec.vb:
  - uid: System.Object.Equals(System.Object,System.Object)
    name: Equals
    nameWithType: Object.Equals
    fullName: System.Object.Equals
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - uid: System.Object
    name: Object
    nameWithType: Object
    fullName: System.Object
    isExternal: true
  - name: ', '
    nameWithType: ', '
    fullName: ', '
  - uid: System.Object
    name: Object
    nameWithType: Object
    fullName: System.Object
    isExternal: true
  - name: )
    nameWithType: )
    fullName: )
- uid: System.Object.GetHashCode
  commentId: M:System.Object.GetHashCode
  parent: System.Object
  isExternal: true
  name: GetHashCode()
  nameWithType: Object.GetHashCode()
  fullName: System.Object.GetHashCode()
  spec.csharp:
  - uid: System.Object.GetHashCode
    name: GetHashCode
    nameWithType: Object.GetHashCode
    fullName: System.Object.GetHashCode
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - name: )
    nameWithType: )
    fullName: )
  spec.vb:
  - uid: System.Object.GetHashCode
    name: GetHashCode
    nameWithType: Object.GetHashCode
    fullName: System.Object.GetHashCode
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - name: )
    nameWithType: )
    fullName: )
- uid: System.Object.GetType
  commentId: M:System.Object.GetType
  parent: System.Object
  isExternal: true
  name: GetType()
  nameWithType: Object.GetType()
  fullName: System.Object.GetType()
  spec.csharp:
  - uid: System.Object.GetType
    name: GetType
    nameWithType: Object.GetType
    fullName: System.Object.GetType
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - name: )
    nameWithType: )
    fullName: )
  spec.vb:
  - uid: System.Object.GetType
    name: GetType
    nameWithType: Object.GetType
    fullName: System.Object.GetType
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - name: )
    nameWithType: )
    fullName: )
- uid: System.Object.MemberwiseClone
  commentId: M:System.Object.MemberwiseClone
  parent: System.Object
  isExternal: true
  name: MemberwiseClone()
  nameWithType: Object.MemberwiseClone()
  fullName: System.Object.MemberwiseClone()
  spec.csharp:
  - uid: System.Object.MemberwiseClone
    name: MemberwiseClone
    nameWithType: Object.MemberwiseClone
    fullName: System.Object.MemberwiseClone
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - name: )
    nameWithType: )
    fullName: )
  spec.vb:
  - uid: System.Object.MemberwiseClone
    name: MemberwiseClone
    nameWithType: Object.MemberwiseClone
    fullName: System.Object.MemberwiseClone
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - name: )
    nameWithType: )
    fullName: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
  commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
  parent: System.Object
  isExternal: true
  name: ReferenceEquals(Object, Object)
  nameWithType: Object.ReferenceEquals(Object, Object)
  fullName: System.Object.ReferenceEquals(System.Object, System.Object)
  spec.csharp:
  - uid: System.Object.ReferenceEquals(System.Object,System.Object)
    name: ReferenceEquals
    nameWithType: Object.ReferenceEquals
    fullName: System.Object.ReferenceEquals
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - uid: System.Object
    name: Object
    nameWithType: Object
    fullName: System.Object
    isExternal: true
  - name: ', '
    nameWithType: ', '
    fullName: ', '
  - uid: System.Object
    name: Object
    nameWithType: Object
    fullName: System.Object
    isExternal: true
  - name: )
    nameWithType: )
    fullName: )
  spec.vb:
  - uid: System.Object.ReferenceEquals(System.Object,System.Object)
    name: ReferenceEquals
    nameWithType: Object.ReferenceEquals
    fullName: System.Object.ReferenceEquals
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - uid: System.Object
    name: Object
    nameWithType: Object
    fullName: System.Object
    isExternal: true
  - name: ', '
    nameWithType: ', '
    fullName: ', '
  - uid: System.Object
    name: Object
    nameWithType: Object
    fullName: System.Object
    isExternal: true
  - name: )
    nameWithType: )
    fullName: )
- uid: System.Object.ToString
  commentId: M:System.Object.ToString
  parent: System.Object
  isExternal: true
  name: ToString()
  nameWithType: Object.ToString()
  fullName: System.Object.ToString()
  spec.csharp:
  - uid: System.Object.ToString
    name: ToString
    nameWithType: Object.ToString
    fullName: System.Object.ToString
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - name: )
    nameWithType: )
    fullName: )
  spec.vb:
  - uid: System.Object.ToString
    name: ToString
    nameWithType: Object.ToString
    fullName: System.Object.ToString
    isExternal: true
  - name: (
    nameWithType: (
    fullName: (
  - name: )
    nameWithType: )
    fullName: )
- uid: System
  commentId: N:System
  isExternal: true
  name: System
  nameWithType: System
  fullName: System
- uid: System.InvalidOperationException
  commentId: T:System.InvalidOperationException
  isExternal: true
- uid: MLEM.Misc.TextInputWrapper.Current*
  commentId: Overload:MLEM.Misc.TextInputWrapper.Current
  name: Current
  nameWithType: TextInputWrapper.Current
  fullName: MLEM.Misc.TextInputWrapper.Current
- uid: MLEM.Misc.TextInputWrapper
  commentId: T:MLEM.Misc.TextInputWrapper
  parent: MLEM.Misc
  name: TextInputWrapper
  nameWithType: TextInputWrapper
  fullName: MLEM.Misc.TextInputWrapper
- uid: MLEM.Misc.TextInputWrapper.RequiresOnScreenKeyboard*
  commentId: Overload:MLEM.Misc.TextInputWrapper.RequiresOnScreenKeyboard
  name: RequiresOnScreenKeyboard
  nameWithType: TextInputWrapper.RequiresOnScreenKeyboard
  fullName: MLEM.Misc.TextInputWrapper.RequiresOnScreenKeyboard
- uid: System.Boolean
  commentId: T:System.Boolean
  parent: System
  isExternal: true
  name: Boolean
  nameWithType: Boolean
  fullName: System.Boolean
- uid: MLEM.Misc.TextInputWrapper.AddListener*
  commentId: Overload:MLEM.Misc.TextInputWrapper.AddListener
  name: AddListener
  nameWithType: TextInputWrapper.AddListener
  fullName: MLEM.Misc.TextInputWrapper.AddListener
- uid: Microsoft.Xna.Framework.GameWindow
  commentId: T:Microsoft.Xna.Framework.GameWindow
  parent: Microsoft.Xna.Framework
  isExternal: true
  name: GameWindow
  nameWithType: GameWindow
  fullName: Microsoft.Xna.Framework.GameWindow
- uid: MLEM.Misc.TextInputWrapper.TextInputCallback
  commentId: T:MLEM.Misc.TextInputWrapper.TextInputCallback
  parent: MLEM.Misc
  name: TextInputWrapper.TextInputCallback
  nameWithType: TextInputWrapper.TextInputCallback
  fullName: MLEM.Misc.TextInputWrapper.TextInputCallback
- uid: Microsoft.Xna.Framework
  commentId: N:Microsoft.Xna.Framework
  isExternal: true
  name: Microsoft.Xna.Framework
  nameWithType: Microsoft.Xna.Framework
  fullName: Microsoft.Xna.Framework