Input Class Reference

The Input JavaScript global object. A simplified version of the Qt input dialogs. More...

Public Slots

QVariant getText (String &label=String::null, String &text=String::null, String &title=String::null, QWidget *parent=0)
 Function to get a string from the user. More...
 
QVariant getNumber (String &label=String::null, double value=0, int decimals=0, double minValue=-2147483647, double maxValue=2147483647, String &title=String::null, QWidget *parent=0)
 Function to get a number from the user. More...
 
QVariant getItem (String &label, StringList &itemList, String &currentItem=String::null, bool editable=false, String &title=String::null, QWidget *parent=0)
 Function to get an item from the user. More...
 
QVariant getItem (StringList &itemList, String &currentItem=String::null, bool editable=false, QWidget *parent=0)
 Function to get an item from the user. More...
 

Detailed Description

The Input JavaScript global object. A simplified version of the Qt input dialogs.

Provides a simple convenient dialog to get a single value from the user.

Member Function Documentation

◆ getItem [1/2]

QVariant Input::getItem ( String &  label,
StringList &  itemList,
String &  currentItem = String::null,
bool  editable = false,
String &  title = String::null,
QWidget *  parent = 0 
)
slot

Function to get an item from the user.

Parameters
label: A prompt for the input you want.
itemList: A list of items for the user to choose from.
currentItem: The currently selected item from the list.
editable: Whether or not the user can enter their own item.
title: The title for the dialog box.
parent: Unused.
Returns
The selection from the item list.

◆ getItem [2/2]

QVariant Input::getItem ( StringList &  itemList,
String &  currentItem = String::null,
bool  editable = false,
QWidget *  parent = 0 
)
inlineslot

Function to get an item from the user.

Parameters
itemList: A list of items for the user to choose from.
currentItem: The currently selected item from the list.
editable: Whether or not the user can enter their own item.
parent: Unused.
Returns
The selection from the item list.

◆ getNumber

QVariant Input::getNumber ( String &  label = String::null,
double  value = 0,
int  decimals = 0,
double  minValue = -2147483647,
double  maxValue = 2147483647,
String &  title = String::null,
QWidget *  parent = 0 
)
slot

Function to get a number from the user.

Parameters
label: A prompt for the input you want.
value: Number to appear in the dialog box number field when opened.
decimals: The number of decimals that will be allowed in the input.
minValue: The minimum value allowed for the input.
maxValue: The maximum value allowed for the input.
title: The title for the dialog box.
parent: Unused.
Returns
The contents of the number field.

◆ getText

QVariant Input::getText ( String &  label = String::null,
String &  text = String::null,
String &  title = String::null,
QWidget *  parent = 0 
)
slot

Function to get a string from the user.

Parameters
label: A prompt for the input you want.
text: Text to appear in the dialog box text field when opened.
title: The title for the dialog box.
parent: Unused.
Returns
The contents of the text box.