Empty brief comment. More...

#include <ilviews/gadgets/passwded.h>

Inheritance diagram for IlvPasswordTextField:

Public Member Functions
	IlvPasswordTextField (IlvDisplay display, const char label, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Verbose: More...

	IlvPasswordTextField (IlvDisplay display, const IlvPoint &point, const char label, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Verbose: More...

void	changeMaskChar (char character, IlBoolean redraw=IlTrue)
	Sets the character that will replace the letters of the password. More...

char	getMaskChar () const
	Returns the character that will replace the letters of the password. More...

virtual const char *	getMessage () const
	Returns the message displayed by this text field. More...

void	setMaskChar (char character)
	Sets the character that will replace the letters of the password. More...

Public Member Functions inherited from IlvTextField
	IlvTextField (IlvDisplay display, const char label, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Constructor. More...

	IlvTextField (IlvDisplay display, const IlvPoint &point, const char label, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	Constructor. More...

void	addChangeCallback (IlvGraphicCallback callback)
	Adds a Label Changed callback. More...

void	addChangeCallback (IlSymbol *callbackName)
	Adds a named Label Changed callback. More...

void	addChangeCallback (IlvGraphicCallback callback, IlAny arg)
	Adds a Label Changed callback. More...

void	addChangeCallback (IlSymbol *callbackName, IlAny arg)
	Adds a named Label Changed callback. More...

virtual const char *	check (IlUShort character)
	Is called by the interactor for each key down event that corresponds to a regular character. More...

void	ensureVisible (IlShort position, const IlvTransformer *t=0)
	Ensures that the character located at the specified position is visible. More...

IlvPosition	getAlignment () const
	Returns the alignment of the text field. More...

IlvGraphicCallback	getChangeCallback () const
	Returns a pointer to the first unnamed callback in the Label Changed callback list. More...

IlSymbol *	getChangeCallbackName () const
	Returns the name of the first named callback in the Label Changed callback list. More...

IlBoolean	getChangeFocusOnValidation () const
	Indicates whether the text field moves the keyboard focus to the next gadget once validated. More...

IlShort	getCursorPosition () const
	Returns the cursor position. More...

IlShort	getEndSelection () const
	Returns the index of the last selected character. More...

IlFloat	getFloatValue () const
	Converts the text field contents to a floating point value and returns the result of the conversion. More...

IlInt	getIntValue () const
	Converts the text field contents to an integer and returns the result of the conversion. More...

const char *	getLabel () const
	Returns the label displayed by the text field. More...

IlShort	getMaxChar () const
	Returns the maximum number of characters that the user can type in the text field. More...

IlShort	getStartSelection () const
	Returns the index of the first selected character. More...

IlShort	getTextPosition () const
	Returns the index of the first visible character of the text field. More...

virtual IlBoolean	handleControl (IlUShort character)
	Is called by the interactor to handle control keys. More...

IlBoolean	isCursorShown () const
	Indicates whether the cursor is visible. More...

IlBoolean	isEditable () const
	Indicates whether the text field can be edited. More...

virtual void	labelChanged ()
	Is called by the interactor whenever the label of the text field changes. More...

IlShort	pointToPosition (const IlvPoint &point, const IlvTransformer *t=0) const
	Returns the index of the character located at the specified point. More...

virtual void	removeSelection ()
	Removes the selected label from the text field. More...

void	setAlignment (IlvPosition alignment)
	Sets the alignment of the text field. More...

void	setChangeCallback (IlvGraphicCallback callback)
	Sets a Label Changed callback. More...

void	setChangeCallback (IlSymbol *callbackName)
	Sets a named Label Changed callback. More...

void	setChangeCallback (IlvGraphicCallback callback, IlAny arg)
	Sets a Label Changed callback. More...

void	setChangeCallback (IlSymbol *callbackName, IlAny arg)
	Sets a named Label Changed callback. More...

void	setChangeFocusOnValidation (IlBoolean value)
	Specifies whether the text field should move the keyboard focus to the next gadget once validated. More...

void	setCursorPosition (IlShort position)
	Sets the cursor position. More...

void	setEditable (IlBoolean value)
	Specifies whether the text field can be edited. More...

void	setEndSelection (IlShort position)
	Sets the index of the last selected character. More...

virtual void	setLabel (const char *label, IlBoolean redraw=IlFalse)
	Sets the label of the text field. More...

void	setMaxChar (IlShort count)
	Sets the maximum number of characters that the user can type in the text field. More...

void	setSelection (IlShort start, IlShort end)
	Selects a portion of the text field content. More...

void	setStartSelection (IlShort position)
	Sets the index of the first selected character. More...

void	setTextPosition (IlShort position)
	Sets the index of the first visible character of the text field. More...

void	setValue (IlInt value, IlBoolean redraw=IlFalse)
	Sets the text field label to an integer value. More...

void	setValue (IlFloat value, const char *format=0, IlBoolean redraw=IlFalse)
	Sets the text field label to a floating-point value. More...

void	showCursor (IlBoolean value, IlBoolean redraw=IlFalse)
	Specifies whether the cursor should be visible. More...

virtual void	validate ()
	Is called by the interactor when the user presses the Return or the Enter key. More...

Detailed Description

Empty brief comment.

Library: ilvgadgt

This class is a specialized text field gadget that allows the user to enter a password by displaying the same special character instead of the characters the user types.

Accessors

Accessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods IlvValueInterface::queryValue(), IlvValueInterface::queryValues(), IlvValueInterface::changeValue(), IlvValueInterface::changeValues(). This class inherits the accessors of its superclass IlvTextField and adds the following ones:

Name	Type	Equivalent methods
`maskChar`	String	`getMaskChar()`, `changeMaskChar()`

Constructor & Destructor Documentation

§ IlvPasswordTextField() [1/2]

IlvPasswordTextField::IlvPasswordTextField	(	IlvDisplay *	display,
		const char *	label,
		const IlvRect &	rect,
		IlUShort	thickness = `IlvDefaultGadgetThickness`,
		IlvPalette *	palette = `0`
	)

Verbose:

Initializes a new instance of the IlvPasswordTextField class.

Parameters

display	The display connection.
label	The label of the password field.
rect	The size and position of the password field.
thickness	The thickness of the password field.
palette	The palette used by the password field.

§ IlvPasswordTextField() [2/2]

IlvPasswordTextField::IlvPasswordTextField	(	IlvDisplay *	display,
		const IlvPoint &	point,
		const char *	label,
		IlUShort	thickness = `IlvDefaultGadgetThickness`,
		IlvPalette *	palette = `0`
	)

Verbose:

Initializes a new instance of the IlvPasswordTextField class. The size of the object is computed by using the label parameter. If you want to specify the size, use the other constructor.

Parameters

display	The display connection.
point	The position of the password field.
label	The label of the password field.
thickness	The thickness of the password field.
palette	The palette used by the password field.

Member Function Documentation

§ changeMaskChar()

void IlvPasswordTextField::changeMaskChar	(	char	character,
		IlBoolean	redraw = `IlTrue`
	)

Sets the character that will replace the letters of the password.

This method recomputes the label currently being displayed.

Parameters

character	The new mask character.
redraw	A Boolean specifying whether the gadget should be redrawn.

See also: getMaskChar, setMaskChar

§ getMaskChar()

char IlvPasswordTextField::getMaskChar ( ) const

Returns the character that will replace the letters of the password.

The default value is `*'.

Returns: the character that will replace the letters of the password.

See also: setMaskChar

§ getMessage()

virtual const char* IlvPasswordTextField::getMessage ( ) const

virtual

Returns the message displayed by this text field.

If the text field cannot be edited, the message database is used to find the translation of the text field contents to the current language. If the text field can be edited, the method returns the result of IlvTextField::getLabel().

Returns: The message displayed by this text field.

See also: getLabel(), IlvMessageDatabase, IlvDisplay::getCurrentLanguage().

Reimplemented from IlvTextField.

§ setMaskChar()

void IlvPasswordTextField::setMaskChar ( char character )

Sets the character that will replace the letters of the password.

The default value is `*'. This method doesn't recompute the label currently being displayed, which is done by the changeMaskChar method.

Parameters

character The new mask character.

See also: getMaskChar, changeMaskChar

Public Member Functions

Detailed Description

Accessors

Constructor & Destructor Documentation

§ IlvPasswordTextField() [1/2]

§ IlvPasswordTextField() [2/2]

Member Function Documentation

§ changeMaskChar()

§ getMaskChar()

§ getMessage()

§ setMaskChar()