rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPasswordTextField Class Reference

Empty brief comment. More...

#include <ilviews/gadgets/passwded.h>

Inheritance diagram for IlvPasswordTextField:
IlvTextField IlvGadget IlvSimpleGraphic IlvGraphic

List of all members.

Public Member Functions

 IlvPasswordTextField (IlvDisplay *display, const IlvPoint &point, const char *label, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Verbose:.
 IlvPasswordTextField (IlvDisplay *display, const char *label, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Verbose:.
void changeMaskChar (char character, IlBoolean redraw=IlTrue)
 Sets the character that will replace the letters of the password.
char getMaskChar () const
 Returns the character that will replace the letters of the password.
virtual const char * getMessage () const
 Returns the message displayed by this text field.
void setMaskChar (char character)
 Sets the character that will replace the letters of the password.

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.


Constructor & Destructor Documentation

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::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

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
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
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.

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
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.