|Home | Tutorial | Classes | Functions | QSA Workbench | Language | Qt API | QSA Articles | Qt Script for Applications | ![]() |
[Prev: Creating Qt Scripts] [Home]
The QSA Input Dialog Framework is a set of classes that extends QSA to enable the user to create dialogs using Qt Script. The Input Dialog Framework is available in the QSObjectFactory subclass QSInputDialogFactory.
The QSA Input Dialog Framework provides two types of classes. The first types are the ones that can be used to build up complex input dialogs. These classes include, Dialog, CheckBox, GroupBox, LineEdit, TextEdit etc. The classes each have a set of properties for describing how they appear and some classes also have functions.
The following is a simple example on how to use the Input Dialog Framework to create a dialog that will query the user for first and last name, and read out the values again:
var dialog = new Dialog; dialog.caption = "Name reading dialog"; dialog.okButtonText = "Done" dialog.cancelButtonText = "Abort"; var first = new LineEdit; first.label = "First name: "; dialog.add( first ); var last = new LineEdit; last.label = "Last name: "; dialog.add( last ); if( dialog.exec() ) { var fullName = last.text + ", " + first.text; print( "Full name is: " + fullName ); }
Below is a list of the classes available from the Input Dialog Framework. Each class has a short description and a list of its properties and functions.
The CheckBox widget provides a checkbox with a text label. CheckBox is an option button; it can be switched on (checked) or off (unchecked).
checked : Boolean; This property holds whether the checkbox is checked. The default is unchecked, i.e. false.
text : String; This property holds the text shown on the button.
tooltip : String; This property holds tool tips (balloon help) for any widget or rectangular part of a widget.
whatsThis : String; This property holds a simple description of any widget, i.e. answering the question "What's this?"
The ComboBox widget is a combined button and popup list. A combobox is a selection widget which displays the current item and can pop up a list of items. A combobox may be editable in which case the user can enter arbitrary strings.
currentItem : String; This property is used in two ways: To specify the default selected item in the combobox; and to get the value the user selected in the combobox when the dialog is closed. The default is the first item in the list.
editable : Boolean; This property holds whether the combobox is editable. This property's default is false.
itemList : Array; The list of items in a combobox.
label : String; The label for the combobox.
tooltip : String; This property holds tool tips (balloon help) for any widget or rectangular part of a widget.
whatsThis : String; This property holds a simple description of any widget, i.e. answering the question "What's this?"
The DateEdit class provides a date editor. DateEdit allows the user to edit dates by using the keyboard or the arrow keys to increase/decrease date values. The arrow keys can be used to move from section to section within the DateEdit box. Dates appear in accordance with the local date/time settings or in year, month, day order if the system doesn't provide this information.
date : Date; This property holds the editor's date value. The default is now.
label : String; The label for the date.
maximum : Date; This property holds the editor's maximum value. The default maximum date is 8000-12-31.
minimum : Date; This property holds the editor's minimum value. The default minimum date is 1752-09-14.
order : Order; This property holds the order in which the year, month and day appear. The default order is locale dependent.
tooltip : String; This property holds tool tips (balloon help) for any widget or rectangular part of a widget.
whatsThis : String; This property holds a simple description of any widget, i.e. answering the question "What's this?"
The Dialog class is the base class of dialog windows.A dialog window is a top-level window mostly used for short-term tasks and brief communications with the user. Dialogs may be modal or modeless.
caption : String; This property holds the window caption (title). The default is the application's name.
cancelButtonText : String; This property holds the text shown on the cancel button.
okButtonText: String; This property holds the text shown on the ok button.
width : Number; This property holds the width of the widget excluding any window frame. The default is set by the lay out of the widgets.
tooltip : String; This property holds tool tips (balloon help) for any widget or rectangular part of a widget.
whatsThis : String; This property holds a simple description of any widget, i.e. answering the question "What's this?"
add( widget : QSWidget ); Adds a widget to the dialog. Widgets are placed from top to bottom.
addSpace( space : Number ); Adds vertical space, measured in pixels between, the previous and next added widget.
exec() : Boolean; Executes the dialog. This will open the dialog and hold the script until the user presses the ok or cancel button. The function returns true of the user pressed ok; otherwise false.
newColumn(); Creates a new column in the dialog. All widgets subsequently added to the dialog will be placed in the new column.
newTab( label : String ); Creates a new tab in the dialog with the given label. All widgets subsequently added to the dialog will be placed in the newly created tab.
The GroupBox widget provides a group box frame with a title and it displays various other widgets inside itself.
title : String; This property holds the group box title text.
tooltip : String; This property holds tool tips (balloon help) for any widget or rectangular part of a widget.
whatsThis : String; This property holds a simple description of any widget, i.e. answering the question "What's this?"
add( widget : QSWidget ); Adds a widget to this groupbox.
addSpace( space : Number ); Adds vertical space, measured in pixels, between the previous and the next widget that is added.
newColumn(); Creates a new column within this groupbox. All widgets that are added sequentially will be placed in the new column.
addSpace()
The QLineEdit widget is a one-line text editor.
label : String; Describes the label for this line edit.
text : String; This property holds the selected text.
tooltip : String; This property holds tool tips (balloon help) for any widget or rectangular part of a widget.
whatsThis : String; This property holds a simple description of any widget, i.e. answering the question "What's this?"
The NumberEdit class provides range checking of floating-point numbers. NumberEdit provides an upper bound, a lower bound and a limit on the number of digits after the decimal point.
decimals : Number; This property holds the number edits's maximum number of digits after the decimal point. the default is 0.
label : String; Describes the label of the number edit.
maximum : Number; This property holds the number edit's maximum acceptable value. The default is 2.147.483.647.
minimum : Number; This property holds the number edit's minimum acceptable value. The default is 2.147.483.647.
value : Number; This property holds the number edit's input value. The default is 0.
tooltip : String; This property holds tool tips (balloon help) for any widget or rectangular part of a widget.
whatsThis : String; This property holds a simple description of any widget, i.e. answering the question "What's this?"
The RadioButton widget provides a radio button with a text label. RadioButton is an option button; it can be switched on (checked) or off (unchecked).
checked : Boolean; This property holds whether the radio button is checked.
text : String; This property holds the text shown on the button. The default value is unchecked (false). Default is no text.
tooltip : String; This property holds tool tips (balloon help) for any widget or rectangular part of a widget.
whatsThis : String; This property holds a simple description of any widget, i.e. answering the question "What's this?"
The SpinBox class provides a spin box widget (spin button). SpinBox allows the user to choose a value either by clicking the up/down buttons to increase/decrease the value currently displayed or by typing the value directly into the spin box. If the value is entered directly into the spin box, Enter (or Return) must be pressed to apply the new value. The value is usually an integer.
label : String; This property describes the label of the spinbox.
maximum : Number; This property holds the maximum value of the spin box. The default maximum value is 2.147.483.647.
minimum : Number; This property holds the minimum value of the spin box. The default minimum value is -2.147.483.648.
value : Number; This property holds the value of the spin box. The default is 0.
tooltip : String; This property holds tool tips (balloon help) for any widget or rectangular part of a widget.
whatsThis : String; This property holds a simple description of any widget, i.e. answering the question "What's this?"
The QTextEdit widget provides a multi-line text editor.
text : String; This property returns the text of the TextEdit.
tooltip : String; This property holds tool tips (balloon help) for any widget or rectangular part of a widget.
whatsThis : String; This property holds a simple description of any widget, i.e. answering the question "What's this?"
The TimeEdit class provides a time editor. TimeEdit allows the user to edit times by using the keyboard or the arrow keys to increase/decrease time values. The arrow keys can be used to move from section to section within the TimeEdit box.
label : String; This property describes the label of the time edit.
maximum : Time; This property holds the maximum time value.
minimum : Time; This property holds the minimum time value.
showAMPM : Boolean; This property holds the AM/PM section that is displayed in the time edit. The default is false.
showSeconds : Boolean; This property holds the seconds section that is displayed in the time edit. The default is true.
time : Time; This property holds the editor's time value.
tooltip : String; This property holds tool tips (balloon help) for any widget or rectangular part of a widget.
whatsThis : String; This property holds a simple description of any widget, i.e. answering the question "What's this?"
Convenience classes with static functions provide a means of getting a value from the user without using any complex widget hierarchies. That a function is static means that it is directly accessible through the class ( e.g. FileDialog.getOpenFileName() ), and that no instances need to be created in order to call the functions.
This class provides a simple way of popping up a message box window for the user. The following lines of code present a pop up messagebox with a warning and query the user to click Yes or No.
MessageBox.warning( "Do you wish to abort!", MessageBox.Yes, MessageBox.No );
The button types are used to describe what the text of the buttons should be. The following are available.
NoButton; No button is displayed.
Ok; Displays a 'Ok' button.
Cancel; Displays a 'Cancel' button.
Yes; Displays a 'Yes' button.
No; Displays a 'No' button.
Abort; Displays an 'Abort' button.
Retry; Displays a 'Retry' button.
Ignore; Displays an 'Ignore' button.
The following is a list of message box functions. The button1, button2 and button3 parameters can be any of the Button types described above and describe which button types that will end be shown in the message box. Each function returns the button type corresponding to the one that the user pressed.
information( label : String, button1 : ButtonType, button2 : ButtonType, button3 : ButtonType, title : String ); Displays an information message box with the content described in label.
warning( label : String, button1 : ButtonType, button2 : ButtonType, button3 : ButtonType, title : String ); Displays a warning message box with the content described in label.
critical( label : String, button1 : ButtonType, button2 : ButtonType, button3 : ButtonType, title : String ) Displays a critical error message box with the content described in label.
This class provides dialogs that allow users to select files or directories. The following functioncall will open a file dialog with that will look for files with extension .txt.
FileDialog.getOpenFileName( "*.txt" );
getOpenFileName( filter : String, title : String ); Opens an "Open" dialog. If filter is specified ( e.g. "textfiles (*.txt)" ) it is used to filter out invalid file types. The function returns a string with the filename selected.
getSaveFileName( filter : String, title : String ); Opens an "Save As" dialog. If filter is specified ( e.g. "textfiles (*.txt)" ) it is used to filter out invalid file types. The function returns a string with the filename selected.
getExistingDirectory( dir : String, title : String ); Opens a "Find Directory" dialog for the user to select an existing directory. The parameter dir can be used to specify the starting directory.
getOpenFileNames( dir : String, filter : String, title : String ); Opens an "Open" dialog for the user to select and open an existing file. If dir is specified it describes the directory the dialog opens in. If filter is specified it describes the file name filter.
This class provides convenience functions for getting simple input from the user. The following code can be used to open a dialog that queries the user for a text:
Input.getText( "What is your name? " );
getText( label : String, text : String, title : String ); Queries the user for a text. label describes the label and text describes the default value if set. The function returns the value typed in by the user or undefined if the user cancels the operation.
getNumber( label : String, value : Number, decimals : Number, minValue : Number, maxValue : Number, title : String ); Queries the user for a number. label describes the label, value describes the default value, decimals describes the number of decimals allowed, minValue describes the minimum value and maxValue describes the maximum value. The function returns the value selected by the user or undefined if the user cancels the dialog.
getItem( label : String, itemList : Array, current : String, editable : Boolean, title : String ); Opens a dialog with a list of predefined values described by itemList. The label is specified with label. current describes the value that is selected when the item opens. If editable is true, the user is allowed to input a value that is not specified by itemList. The function returns the value selected by the user or undefined if the user cancels the dialog.
Copyright © 2001-2003 Trolltech | Trademarks | QSA version 1.0.0
|