QPinOptions Class Reference
[QtTelephonyModule]

Detailed Description

The QPinOptions class provides information about a pin that may be useful in determining the type of user interface to use.

Pin options are sent to client applications as a parameter to the QPinManager::pinStatus() signal.

See also QPinManager.

Member Type Documentation

enum QPinOptions::Format

This enum defines the format of a pin, as a hint to input widgets as to what type of characters are valid within the pin.

Member Function Documentation

QPinOptions::QPinOptions ()

Construct an empty pin options block with default values.

QPinOptions::QPinOptions ( const QPinOptions & other )

Construct a copy of other.

QPinOptions::~QPinOptions ()

Destroy this pin options block.

bool QPinOptions::canCancel () const

Returns true if the request can be canceled by the user and normal modem operations will continue after failing the current operation. If this returns false, then the user must supply a pin for normal modem operations to proceed.

See also setCanCancel().

QPinOptions::Format QPinOptions::format () const

Returns the format of the pin. The default value is QPinManager::Number.

See also setFormat().

int QPinOptions::maxLength () const

Returns the maximum length of pin to be supplied. The default value is 32.

See also setMaxLength().

int QPinOptions::minLength () const

Returns the minimum length of pin to be supplied. The default value is zero.

See also setMinLength().

QString QPinOptions::prompt () const

Returns the prompt to display to the user. May be the empty string if the prompt is implicitly specified by the pin type. The default value is an empty string.

See also setPrompt().

void QPinOptions::setCanCancel ( bool value )

Sets the pin cancel state to value.

See also canCancel().

void QPinOptions::setFormat ( QPinOptions::Format value )

Sets the pin format to value.

See also format().

void QPinOptions::setMaxLength ( int value )

Sets the maximum pin length to value.

See also maxLength().

void QPinOptions::setMinLength ( int value )

Sets the minimum pin length to value.

See also minLength().

void QPinOptions::setPrompt ( const QString & value )

Sets the prompt to value.

See also prompt().

QPinOptions & QPinOptions::operator= ( const QPinOptions & other )

Make a copy of other.