MGUI::DLG_PASSWORD Class Reference

Inheritance diagram for MGUI::DLG_PASSWORD:

Public Member Functions
	DLG_PASSWORD (const MISTRING &title, const MISTRING &Description, HELPID HelpID=HELPID__None, FORM_PASSWORD::FLAGS flags=FORM_PASSWORD::FLAG_Default)
virtual	~DLG_PASSWORD ()
bool	DoRememberPassword () const
void	GetBasicAuthString (MISTRING &AuthString)
const MISTRING &	GetPassword ()
const MISTRING &	GetUserName ()
void	SetDelegateOnValidateUserName (FastDelegate< bool(const MISTRING &)> delegate)
void	SetUserName (const MISTRING &UserName)

Constructor & Destructor Documentation

MGUI::DLG_PASSWORD::DLG_PASSWORD	(	const MISTRING &	title,
		const MISTRING &	Description,
		HELPID	HelpID = `HELPID__None`,
		FORM_PASSWORD::FLAGS	flags = `FORM_PASSWORD::FLAG_Default`
	)

Constructor.

Parameters:

	title	Title string, can use TEXTID also. If empty uses TEXTID_Title_UserNameAndPassword
	Description	String to be placed above User Name and Password, Eg: HTTP Realm string, empty if none wanted
	HelpID	Help ID

virtual MGUI::DLG_PASSWORD::~DLG_PASSWORD ( ) [virtual]

Destructor.

bool MGUI::DLG_PASSWORD::DoRememberPassword ( ) const [inline]

Determine if the user wants us to remember the password for future use.

It is up to the calling code to 'remember' the password. This method can only return true if the FLAG_RememberPassword is used.

void MGUI::DLG_PASSWORD::GetBasicAuthString ( MISTRING & AuthString ) [inline]

Get HTTP Basic Authentication string Does not include: "Authorization: Basic" part.

const MISTRING& MGUI::DLG_PASSWORD::GetPassword ( ) [inline]

Get password entered If you make a copy of the password, you need to make sure to clean up properly.

const MISTRING& MGUI::DLG_PASSWORD::GetUserName ( ) [inline]

Get user name entered.

void MGUI::DLG_PASSWORD::SetDelegateOnValidateUserName ( FastDelegate< bool(const MISTRING &)> delegate ) [inline]

Set delegate to call to validate user name.

This delegate is called only if the FLAG_ValidatePassword is used. This delegate can be used to enforce a unique user name

void MGUI::DLG_PASSWORD::SetUserName ( const MISTRING & UserName ) [inline]

The documentation for this class was generated from the following file: