• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeui
 

tdeui

Static Public Member Functions | Friends

KInputDialog Class Reference

The KInputDialog class provides a simple dialog to get a single value from the user. More...

#include <kinputdialog.h>

Inheritance diagram for KInputDialog:
KDialogBase KDialog TQDialog

List of all members.

Static Public Member Functions

static TQString getText (const TQString &caption, const TQString &label, const TQString &value=TQString::null, bool *ok=0, TQWidget *parent=0, const char *name=0, TQValidator *validator=0, const TQString &mask=TQString::null)
static TQString text (const TQString &caption, const TQString &label, const TQString &value=TQString::null, bool *ok=0, TQWidget *parent=0, const char *name=0, TQValidator *validator=0, const TQString &mask=TQString::null, const TQString &whatsThis=TQString::null)
static TQString getMultiLineText (const TQString &caption, const TQString &label, const TQString &value=TQString::null, bool *ok=0, TQWidget *parent=0, const char *name=0)
static int getInteger (const TQString &caption, const TQString &label, int value=0, int minValue=-2147483647, int maxValue=2147483647, int step=1, int base=10, bool *ok=0, TQWidget *parent=0, const char *name=0)
static int getInteger (const TQString &caption, const TQString &label, int value=0, int minValue=-2147483647, int maxValue=2147483647, int step=1, bool *ok=0, TQWidget *parent=0, const char *name=0)
static double getDouble (const TQString &caption, const TQString &label, double value=0, double minValue=-2147483647, double maxValue=2147483647, double step=0.1, int decimals=1, bool *ok=0, TQWidget *parent=0, const char *name=0)
static double getDouble (const TQString &caption, const TQString &label, double value=0, double minValue=-2147483647, double maxValue=2147483647, int decimals=1, bool *ok=0, TQWidget *parent=0, const char *name=0)
static TQString getItem (const TQString &caption, const TQString &label, const TQStringList &list, int current=0, bool editable=false, bool *ok=0, TQWidget *parent=0, const char *name=0)
static TQStringList getItemList (const TQString &caption, const TQString &label, const TQStringList &list=TQStringList(), const TQStringList &select=TQStringList(), bool multiple=false, bool *ok=0, TQWidget *parent=0, const char *name=0)

Friends

class KInputDialogPrivate

Detailed Description

The KInputDialog class provides a simple dialog to get a single value from the user.

The value can be a string, a number (either an integer or a float) or an item from a list. This class is designed to be source compatible with QInputDialog.

Five static convenience functions are provided: getText(), getInteger(). getDouble(), getItem() and getItemList().

Since:
3.2
Author:
Nadeem Hasan <nhasan@kde.org>

Definition at line 48 of file kinputdialog.h.


Member Function Documentation

double KInputDialog::getDouble ( const TQString &  caption,
const TQString &  label,
double  value = 0,
double  minValue = -2147483647,
double  maxValue = 2147483647,
double  step = 0.1,
int  decimals = 1,
bool *  ok = 0,
TQWidget *  parent = 0,
const char *  name = 0 
) [static]

Static convenience function to get a floating point number from the user.

caption is the text that is displayed in the title bar. label is the text that appears as the label for the spin box. value is the initial value for the spin box. minValue and maxValue are the minimum and maximum allowable values the user may choose. step is the amount by which the value will change as the user presses the increment and decrement buttons of the spin box.

Parameters:
caption Caption of the dialog
label Text of the label for the spin box
value Initial value of the spin box
minValue Minimum value user can input
maxValue Maximum value user can input
step Amount by which value is incremented or decremented
decimals Number of digits after the decimal point
ok This bool would be set to true if user pressed Ok
parent Parent of the dialog widget
name Name of the dialog widget
Returns:
Number user entered if Ok was pressed, else 0

Definition at line 342 of file kinputdialog.cpp.

double KInputDialog::getDouble ( const TQString &  caption,
const TQString &  label,
double  value = 0,
double  minValue = -2147483647,
double  maxValue = 2147483647,
int  decimals = 1,
bool *  ok = 0,
TQWidget *  parent = 0,
const char *  name = 0 
) [static]

This is an overloaded convenience function.

It behaves exctly like the above function.

Definition at line 361 of file kinputdialog.cpp.

int KInputDialog::getInteger ( const TQString &  caption,
const TQString &  label,
int  value = 0,
int  minValue = -2147483647,
int  maxValue = 2147483647,
int  step = 1,
bool *  ok = 0,
TQWidget *  parent = 0,
const char *  name = 0 
) [static]

This is an overloaded convenience function.

It behaves exactly same as above except it assumes base to be 10, i.e. accepts decimal numbers.

Definition at line 334 of file kinputdialog.cpp.

int KInputDialog::getInteger ( const TQString &  caption,
const TQString &  label,
int  value = 0,
int  minValue = -2147483647,
int  maxValue = 2147483647,
int  step = 1,
int  base = 10,
bool *  ok = 0,
TQWidget *  parent = 0,
const char *  name = 0 
) [static]

Static convenience function to get an integer from the user.

caption is the text that is displayed in the title bar. label is the text that appears as the label for the spin box. value is the initial value for the spin box. minValue and maxValue are the minimum and maximum allowable values the user may choose. step is the amount by which the value will change as the user presses the increment and decrement buttons of the spin box. Base is the base of the number.

Parameters:
caption Caption of the dialog
label Text of the label for the spin box
value Initial value of the spin box
minValue Minimum value user can input
maxValue Maximum value user can input
step Amount by which value is incremented or decremented
base Base of the number
ok This bool would be set to true if user pressed Ok
parent Parent of the dialog widget
name Name of the dialog widget
Returns:
Number user entered if Ok was pressed, else 0

Definition at line 315 of file kinputdialog.cpp.

TQString KInputDialog::getItem ( const TQString &  caption,
const TQString &  label,
const TQStringList &  list,
int  current = 0,
bool  editable = false,
bool *  ok = 0,
TQWidget *  parent = 0,
const char *  name = 0 
) [static]

Static convenience function to let the user select an item from a list.

caption is the text that is displayed in the title bar. label is the text that appears as the label for the list. list is the string list which is inserted into the list, and current is the number of the item which should be the selected item. If editable is true, the user can enter their own text.

Parameters:
caption Caption of the dialog
label Text of the label for the spin box
list List of item for user to choose from
current Index of the selected item
editable If true, user can enter own text
ok This bool would be set to true if user pressed Ok
parent Parent of the dialog widget
name Name of the dialog widget
Returns:
Text of the selected item. If editable is true this can be a text entered by the user.

Definition at line 369 of file kinputdialog.cpp.

TQStringList KInputDialog::getItemList ( const TQString &  caption,
const TQString &  label,
const TQStringList &  list = TQStringList(),
const TQStringList &  select = TQStringList(),
bool  multiple = false,
bool *  ok = 0,
TQWidget *  parent = 0,
const char *  name = 0 
) [static]

Static convenience function to let the user select one or more items from a listbox.

caption is the text that is displayed in the title bar. label is the text that appears as the label for the listbox. list is the string list which is inserted into the listbox, select is the list of item(s) that should be the selected. If multiple is true, the user can select multiple items.

Parameters:
caption Caption of the dialog
label Text of the label for the spin box
list List of item for user to choose from
select List of item(s) that should be selected
multiple If true, user can select multiple items
ok This bool would be set to true if user pressed Ok
parent Parent of the dialog widget
name Name of the dialog widget
Returns:
List of selected items if multiple is true, else currently selected item as a QStringList

Definition at line 394 of file kinputdialog.cpp.

TQString KInputDialog::getMultiLineText ( const TQString &  caption,
const TQString &  label,
const TQString &  value = TQString::null,
bool *  ok = 0,
TQWidget *  parent = 0,
const char *  name = 0 
) [static]

Static convenience function to get a multiline string from the user.

caption is the text that is displayed in the title bar. label is the text that appears as a label for the line edit. value is the initial value of the line edit. ok will be set to true if user pressed Ok and false if user pressed Cancel.

Parameters:
caption Caption of the dialog
label Text of the label for the line edit
value Initial value of the line edit
ok This bool would be set to true if user pressed Ok
parent Parent of the dialog widget
name Name of the dialog widget
Returns:
String user entered if Ok was pressed, else a null string
Since:
3.3

Definition at line 297 of file kinputdialog.cpp.

TQString KInputDialog::getText ( const TQString &  caption,
const TQString &  label,
const TQString &  value = TQString::null,
bool *  ok = 0,
TQWidget *  parent = 0,
const char *  name = 0,
TQValidator *  validator = 0,
const TQString &  mask = TQString::null 
) [static]

Static convenience function to get a string from the user.

caption is the text that is displayed in the title bar. label is the text that appears as a label for the line edit. value is the initial value of the line edit. ok will be set to true if user pressed Ok and false if user pressed Cancel.

If you provide a validator, the Ok button is disabled as long as the validator doesn't return Acceptable. If there is no validator, the Ok button is enabled whenever the line edit isn't empty. If you want to accept empty input, create a trivial TQValidator that always returns acceptable, e.g. TQRegExpValidator with a regexp of ".*".

Parameters:
caption Caption of the dialog
label Text of the label for the line edit
value Initial value of the line edit
ok This bool would be set to true if user pressed Ok
parent Parent of the dialog widget
name Name of the dialog widget
validator A TQValidator to be associated with the line edit
mask Mask associated with the line edit. See the documentation for TQLineEdit about masks.
Returns:
String user entered if Ok was pressed, else a null string

Definition at line 263 of file kinputdialog.cpp.

TQString KInputDialog::text ( const TQString &  caption,
const TQString &  label,
const TQString &  value = TQString::null,
bool *  ok = 0,
TQWidget *  parent = 0,
const char *  name = 0,
TQValidator *  validator = 0,
const TQString &  mask = TQString::null,
const TQString &  whatsThis = TQString::null 
) [static]

Same as getText except it provides an extra parameter to specify a TQWhatsThis text for the input widget.

### KDE4: Merge with getText.

Since:
KDE 3.3

Definition at line 271 of file kinputdialog.cpp.


The documentation for this class was generated from the following files:
  • kinputdialog.h
  • kinputdialog.cpp

tdeui

Skip menu "tdeui"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdeui

Skip menu "tdeui"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeui by doxygen 1.7.1
This website is maintained by Timothy Pearson.