All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Dialog Class CATDlgStatusBar

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---System.CATCommand
          |
          +---Dialog.CATDialog
            |
            +---Dialog.CATDlgBar
              |
              +---CATDlgStatusBar
 

Usage: you can derive this class.


public class CATDlgStatusBar

Base class for document status bar.
Role: The status bar is used to display temporary or permanent information related to the application status, such as the prompts of the active command or its messages, and a keyboard entry field that is used by the application PowerInput. It is generally located at the bottom of the window. It can also include push buttons, check buttons, radio buttons, and labels.
Use the status bar when you want to give application status information.


Constructor and Destructor Index


o CATDlgStatusBar(CATDialog*,CATString&,CATDlgStyle)
Constructs a CATDlgStatusBar.
o ~CATDlgStatusBar()

Method Index


o GetEditModifyNotification()
Returns the event notification sent whenever the end user edits the PowerInput entry field.
o GetFieldSeparator()
Returns the PowerInput field separator.
o GetPowerInputLabel()
Returns the PowerInput label.
o GetPowerInputMode()
Returns the PowerInput mode.
o GetPowerInputText()
Returns the PowerInput text.
o SetDefaultPowerInputLabel(CATUnicodeString&)
Sets the default PowerInput label.
o SetPowerInputLabel(CATUnicodeString&)
Sets the PowerInput label.
o SetPowerInputMode(int)
Sets the PowerInput mode.
o SetPowerInputState(int)
Sets the PowerInput state.
o SetPowerInputText(CATUnicodeString&)
Sets the PowerInput text.

Constructor and Destructor


o CATDlgStatusBar
public CATDlgStatusBar(CATDialog* iParent,
const CATString& iObjectName,
CATDlgStyle iStyle=NULL)
Constructs a CATDlgStatusBar.
Parameters:
iParent
The parent of the status bar.
iObjectName
The name of the status bar.
iStyle
The style of the status bar. The style can be :
NULL
: for the default status bar (if no value is passed).
o ~CATDlgStatusBar
public virtual ~CATDlgStatusBar()

Methods


o GetEditModifyNotification
public CATNotification * GetEditModifyNotification()const
Returns the event notification sent whenever the end user edits the PowerInput entry field.
o GetFieldSeparator
public CATUnicodeChar& GetFieldSeparator()
Returns the PowerInput field separator.
o GetPowerInputLabel
public CATUnicodeString& GetPowerInputLabel()
Returns the PowerInput label.
o GetPowerInputMode
public int GetPowerInputMode()
Returns the PowerInput mode. The mode can be :
1
: the PowerInput is enabled.
0
: the PowerInput is disabled.
o GetPowerInputText
public CATUnicodeString& GetPowerInputText()
Returns the PowerInput text.
o SetDefaultPowerInputLabel
public void SetDefaultPowerInputLabel( const CATUnicodeString& iLabel)
Sets the default PowerInput label.
Parameters:
iLabel
The default label to set for the PowerInput.
o SetPowerInputLabel
public void SetPowerInputLabel( const CATUnicodeString& iLabel)
Sets the PowerInput label.
Parameters:
iLabel
The label to set for the PowerInput.
o SetPowerInputMode
public void SetPowerInputMode(int iMode)
Sets the PowerInput mode.
Parameters:
iMode
The mode to set for the PowerInput. The mode can be :
1
: the PowerInput is enabled.
0
: the PowerInput is disabled.
o SetPowerInputState
public void SetPowerInputState(int iState)
Sets the PowerInput state.
Parameters:
iState
The state to set for the PowerInput. The state can be :
0
: the PowerInput entry must be associated with the active dialog box.
1
: the PowerInput entry was caught by the CATApplicationDocument.
2
: the PowerInput entry cannot be decoded.
o SetPowerInputText
public void SetPowerInputText( const CATUnicodeString& iText)
Sets the PowerInput text.
Parameters:
iText
The text to set for the PowerInput.

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

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