All Frameworks  Class Hierarchy  This Framework  Next  Indexes

Dialog Class CATBasicAuthenticationPanel

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATBasicAuthenticationPanel
 

Usage: you must use this class as is. You should never derive it.


public class CATBasicAuthenticationPanel

Base class for the basic authentication panel.
Role: The basic authentication panel allows the end user to give answers to different questions, usually name and password through a keyboard entry.


Constructor and Destructor Index


o CATBasicAuthenticationPanel()
Constructs an empty basic authentication panel.
o ~CATBasicAuthenticationPanel()

Method Index


o AddLabelAndEditor(CATUnicodeString&,CATUnicodeString&,int,CATBoolean)
Inserts a label and an editor at the current line in the basic authentication panel.
o AddLogo(CATString&)
Inserts an image at the current line in the basic authentication panel.
o AddSeparator()
Inserts a separator at the current line in the basic authentication panel.
o GetLine(CATUnicodeString&,int)
Retrieves the contents of the line from its index (first line has 0 for index).
o GetLineCount()
Returns the number of questions in the basic authentication panel.
o SetTitle(CATUnicodeString&)
Sets the title of the dialog object to the specified character string.
o WaitAuthentication(CATUnicodeString&,CATUnicodeString&)
Runs the dialog window in a modal loop.

Constructor and Destructor


o CATBasicAuthenticationPanel
public CATBasicAuthenticationPanel()
Constructs an empty basic authentication panel.
o ~CATBasicAuthenticationPanel
public virtual ~CATBasicAuthenticationPanel()

Methods


o AddLabelAndEditor
public void AddLabelAndEditor( const CATUnicodeString& iLabelText,
const CATUnicodeString& iDefaultText,
const int iWidthEdit=10,
const CATBoolean iPassword=FALSE)
Inserts a label and an editor at the current line in the basic authentication panel.
Parameters:
iLabelText
The text of the label.
iDefaultText
The default text displayed in the editor.
iWidthEdit
The visible text width (column count).
iPassword

Legal values:
TRUE
if the text is hidden with special characters.
FALSE
if the text isn't hidden. (default)
o AddLogo
public void AddLogo( const CATString& iLogo)
Inserts an image at the current line in the basic authentication panel.
Parameters:
iLogo
The name of the icon.
o AddSeparator
public void AddSeparator()
Inserts a separator at the current line in the basic authentication panel.
o GetLine
public void GetLine(CATUnicodeString& oLine,
const int iIndex)
Retrieves the contents of the line from its index (first line has 0 for index).
Parameters:
oLine
The returned contents of the specified line.
iIndex
The index of the line.
o GetLineCount
public int GetLineCount()
Returns the number of questions in the basic authentication panel.
o SetTitle
public void SetTitle( const CATUnicodeString& iTitle)
Sets the title of the dialog object to the specified character string.
Parameters:
iTitle
The title to be displayed.
o WaitAuthentication
public int WaitAuthentication(CATUnicodeString& oUserName,
CATUnicodeString& oPassword)
Runs the dialog window in a modal loop.
Parameters:
oUserName
the text of the first editor, typically the user name. oUserName is empty if the basic authentication panel contains 0 editor.
oPassword
the text of the second editor, typically the password. oPassword is empty if the basic authentication panel contains 0 or 1 editor.
Returns:
an integer identifying the button which has been pressed.
Legal values:
1
The OK button has been pressed.
0
The Cancel button has been pressed.

This object is included in the file: CATBasicAuthenticationPanel.h
If needed, your Imakefile.mk should include the module: CATDlgStandard

Copyright © 2003, Dassault Systèmes. All rights reserved.