Difference between revisions of "TextInputDialog"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
 
 
<!-- GIDEROSOBJ:TextInputDialog -->
 
<!-- GIDEROSOBJ:TextInputDialog -->
−
 
+
'''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/>
−
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/>
+
'''Available since:''' Gideros 2012.8<br/>
−
'''<translate>Available since</translate>:''' Gideros 2012.8<br/>
+
'''Inherits from:''' [[AlertDialog]]<br/>
−
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/AlertDialog|AlertDialog]]<br/>
 
  
 
=== Description ===
 
=== Description ===
−
The '''TextInputDialog''' class is used to display native text input dialogs with one text edit field, one button (as cancel button) and two optional buttons. When the user presses any buttons in the alert dialog, it is dismissed and [[Special:MyLanguage/Event.COMPLETE|Event.COMPLETE]] event is dispatched.
+
The '''TextInputDialog''' class is used to display native text input dialogs with one text edit field, one button (as cancel button) and two optional buttons. When the user presses any buttons in the alert dialog, it is dismissed and '''[[TextInputDialog_Event.COMPLETE]]''' event is dispatched.
  
 
If text input dialog is dismissed by any other means (by pressing back button on Android or by pressing close button on desktop), it behaves as cancel button is pressed.
 
If text input dialog is dismissed by any other means (by pressing back button on Android or by pressing close button on desktop), it behaves as cancel button is pressed.
  
 
=== Example ===
 
=== Example ===
−
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
local textInputDialog = TextInputDialog.new("my title", "my message", "some text", "Cancel", "OK")
 
local textInputDialog = TextInputDialog.new("my title", "my message", "some text", "Cancel", "OK")
  
Line 22: Line 20:
 
textInputDialog:addEventListener(Event.COMPLETE, onComplete)
 
textInputDialog:addEventListener(Event.COMPLETE, onComplete)
 
textInputDialog:show()
 
textInputDialog:show()
−
</source>
+
</syntaxhighlight>
 +
 
 +
=== See also ===
 +
'''[[AlertDialog]]'''
  
 
{|-
 
{|-
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
−
=== <translate>Methods</translate> ===
+
=== Methods ===
−
[[Special:MyLanguage/TextInputDialog.new|TextInputDialog.new]] ''Creates an input dialog'' <br/>
+
[[TextInputDialog.new]] ''creates an input dialog''<br/><!--GIDEROSMTD:TextInputDialog.new(title,message,text,cancelButton,button1,button2) creates an input dialog-->
−
<!-- GIDEROSMTD:TextInputDialog.new(title,message,text,cancelButton,button1,button2) Creates an input dialog -->
+
 
−
[[Special:MyLanguage/TextInputDialog:getInputType|TextInputDialog:getInputType]] ''Gets the input type'' <br/>
+
[[TextInputDialog:getInputType]] ''gets the input type''<br/><!--GIDEROSMTD:TextInputDialog:getInputType() gets the input type-->
−
<!-- GIDEROSMTD:TextInputDialog:getInputType() Gets the input type -->
+
[[TextInputDialog:getText]] ''retrieves the entered text''<br/><!--GIDEROSMTD:TextInputDialog:getText() retrieves the entered text-->
−
[[Special:MyLanguage/TextInputDialog:getText|TextInputDialog:getText]] ''Retrieve the entered text'' <br/>
+
[[TextInputDialog:isSecureInput]] ''checks if this dialog is secure (password)''<br/><!--GIDEROSMTD:TextInputDialog:isSecureInput() checks if this dialog is secure (password)-->
−
<!-- GIDEROSMTD:TextInputDialog:getText() Retrieve the entered text -->
+
[[TextInputDialog:setInputType]] ''specifies the type of input''<br/><!--GIDEROSMTD:TextInputDialog:setInputType(type) specifies the type of input-->
−
[[Special:MyLanguage/TextInputDialog:isSecureInput|TextInputDialog:isSecureInput]] ''Check if this dialog is secure (password)'' <br/>
+
[[TextInputDialog:setSecureInput]] ''instructs the dialog to secure the input''<br/><!--GIDEROSMTD:TextInputDialog:setSecureInput(secureInput) instructs the dialog to secure the input-->
−
<!-- GIDEROSMTD:TextInputDialog:isSecureInput() Check if this dialog is secure (password) -->
+
[[TextInputDialog:setText]] ''sets the input text''<br/><!--GIDEROSMTD:TextInputDialog:setText(text) sets the input text-->
−
[[Special:MyLanguage/TextInputDialog:setInputType|TextInputDialog:setInputType]] ''Specify the type of input'' <br/>
 
−
<!-- GIDEROSMTD:TextInputDialog:setInputType(type) Specify the type of input -->
 
−
[[Special:MyLanguage/TextInputDialog:setSecureInput|TextInputDialog:setSecureInput]] ''Instruct the dialog the secure the input'' <br/>
 
−
<!-- GIDEROSMTD:TextInputDialog:setSecureInput(secureInput) Instruct the dialog the secure the input -->
 
−
[[Special:MyLanguage/TextInputDialog:setText|TextInputDialog:setText]] ''Sets the input text'' <br/>
 
−
<!-- GIDEROSMTD:TextInputDialog:setText(text) Sets the input text -->
 
  
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
  
−
=== <translate>Events</translate> ===
+
=== Events ===
−
<!--[[Special:MyLanguage/Event.COMPLETE|Event.COMPLETE]]<br/>-->
+
<!--[[Event.COMPLETE]]<br/>-->
−
[[Special:MyLanguage/TextInputDialog_Event.COMPLETE|TextInputDialog_Event.COMPLETE]]<br/>
+
[[TextInputDialog_Event.COMPLETE]]<br/><!--GIDEROSEVT:Event.COMPLETE complete-->
−
<!-- GIDEROSEVT:Event.COMPLETE complete-->
+
=== Constants ===
−
=== <translate>Constants</translate> ===
+
[[TextInputDialog.EMAIL]]<br/><!--GIDEROSCST:TextInputDialog.EMAIL email-->
−
[[Special:MyLanguage/TextInputDialog.EMAIL|TextInputDialog.EMAIL]]<br/>
+
[[TextInputDialog.NUMBER]]<br/><!--GIDEROSCST:TextInputDialog.NUMBER number-->
−
<!-- GIDEROSCST:TextInputDialog.EMAIL email-->
+
[[TextInputDialog.PHONE]]<br/><!--GIDEROSCST:TextInputDialog.PHONE phone-->
−
[[Special:MyLanguage/TextInputDialog.NUMBER|TextInputDialog.NUMBER]]<br/>
+
[[TextInputDialog.TEXT]]<br/><!--GIDEROSCST:TextInputDialog.TEXT text-->
−
<!-- GIDEROSCST:TextInputDialog.NUMBER number-->
+
[[TextInputDialog.URL]]<br/><!--GIDEROSCST:TextInputDialog.URL url-->
−
[[Special:MyLanguage/TextInputDialog.PHONE|TextInputDialog.PHONE]]<br/>
 
−
<!-- GIDEROSCST:TextInputDialog.PHONE phone-->
 
−
[[Special:MyLanguage/TextInputDialog.TEXT|TextInputDialog.TEXT]]<br/>
 
−
<!-- GIDEROSCST:TextInputDialog.TEXT text-->
 
−
[[Special:MyLanguage/TextInputDialog.URL|TextInputDialog.URL]]<br/>
 
−
<!-- GIDEROSCST:TextInputDialog.URL url-->
 
 
|}
 
|}
  
 
{{GIDEROS IMPORTANT LINKS}}
 
{{GIDEROS IMPORTANT LINKS}}

Latest revision as of 14:33, 13 July 2023

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
Available since: Gideros 2012.8
Inherits from: AlertDialog

Description

The TextInputDialog class is used to display native text input dialogs with one text edit field, one button (as cancel button) and two optional buttons. When the user presses any buttons in the alert dialog, it is dismissed and TextInputDialog_Event.COMPLETE event is dispatched.

If text input dialog is dismissed by any other means (by pressing back button on Android or by pressing close button on desktop), it behaves as cancel button is pressed.

Example

local textInputDialog = TextInputDialog.new("my title", "my message", "some text", "Cancel", "OK")

local function onComplete(event)
	print(event.text, event.buttonIndex, event.buttonText)
end

textInputDialog:addEventListener(Event.COMPLETE, onComplete)
textInputDialog:show()

See also

AlertDialog

Methods

TextInputDialog.new creates an input dialog

TextInputDialog:getInputType gets the input type
TextInputDialog:getText retrieves the entered text
TextInputDialog:isSecureInput checks if this dialog is secure (password)
TextInputDialog:setInputType specifies the type of input
TextInputDialog:setSecureInput instructs the dialog to secure the input
TextInputDialog:setText sets the input text

Events

TextInputDialog_Event.COMPLETE

Constants

TextInputDialog.EMAIL
TextInputDialog.NUMBER
TextInputDialog.PHONE
TextInputDialog.TEXT
TextInputDialog.URL


Retrieved from ‘https://wiki.gideros.rocks/index.php?title=TextInputDialog&oldid=22413’