Dialog CATDlgTabContainer
Usage: you can derive this class.
public class CATDlgTabContainer
Base class for managing CATDlgTabPages.
Constructor and Destructor Index
- o
CATDlgTabContainer(CATDialog*,CATString&,CATDlgStyle)
- Constructor.
- o
~CATDlgTabContainer()
- Destructor.
Method Index
- o
GetPageCount()
- Return count of CATDlgTabPages contained by the CATDlgTabContainer.
- o
GetPagePtr(int)
- Gets the CATDlgTabPage at the specified index.
- o
GetSelectedPage()
- Gets the currently selected CATDlgTabPage.
- o
GetSelectedPagePtr()
- Gets the currently selected CATDlgTabPage.
- o
GetTabSelectNotification()
- Returns the event sent whenever the selected CATDlgTabPage changes.
- o
RemoveAllPages()
- Remove all CATDlgTabPages contained by the CATDlgTabContainer.
- o
SetSelectedPage(int,int)
- Sets the selected CATDlgTabPage.
- o
SetSelectedPage(CATDlgTabPage*,int)
- Sets the selected CATDlgTabPage.
- o
SwitchPages(int*,int)
- Reorder the CATDlgTabPages contained by the CATDlgTabContainer.
Constructor and Destructor
o CATDlgTabContainer
| public CATDlgTabContainer( | | iParent, |
| const | iObjectName, |
| | iStyle | =NULL) |
-
Constructor.
- Parameters:
-
- iParent
- The parent widget.
- iObjectName
- The internal name of the tab container.
- iStyle
- The style of the tab container.
Legal values:Only the current default value is available.
o ~CATDlgTabContainer
| public virtual ~CATDlgTabContainer( | ) |
-
Destructor.
Methods
o GetPageCount
-
Return count of CATDlgTabPages contained by the CATDlgTabContainer.
o GetPagePtr
| public GetPagePtr( | | iIndex) |
-
Gets the CATDlgTabPage at the specified index.
- Parameters:
-
- iIndex
- the index of the CATDlgTabPage to return.
- Returns:
- the CATDlgTabPage at the specified index.
o GetSelectedPage
-
Gets the currently selected CATDlgTabPage.
- Returns:
- the index of the currently selected CATDlgTabPage.
Legal values: The first CATDlgTabPage has index 0.
o GetSelectedPagePtr
| public GetSelectedPagePtr( | ) |
-
Gets the currently selected CATDlgTabPage.
- Returns:
- the currently selected CATDlgTabPage.
o GetTabSelectNotification
| public GetTabSelectNotification( | ) |
-
Returns the event sent whenever the selected CATDlgTabPage changes.
o RemoveAllPages
-
Remove all CATDlgTabPages contained by the CATDlgTabContainer.
o SetSelectedPage
| public SetSelectedPage( | | iIndex, |
| | iNotify | =0) |
-
Sets the selected CATDlgTabPage.
- Parameters:
-
- iIndex
- the index of the CATDlgTabPage to select.
Legal values: The first CATDlgTabPage has index 0.
- iNotify
- specifies whether the GetTabSelectNotification should be fired upon selection.
Legal values:
- 0
- do not fire the notification.
- not 0
- fire the notification.
o SetSelectedPage
| public SetSelectedPage( | | iPage, |
| | iNotify | =0) |
-
Sets the selected CATDlgTabPage.
- Parameters:
-
- iPage
- the CATDlgTabPage to select.
- iNotify
- specifies whether the GetTabSelectNotification should be fired upon selection.
Legal values:
- 0
- do not fire the notification.
- not 0
- fire the notification.
o SwitchPages
| public SwitchPages( | | iNewPageOrder, |
| | iSize) |
-
Reorder the CATDlgTabPages contained by the CATDlgTabContainer.
- Parameters:
-
- iNewPageOrder
- an array of integers which describes at which position the CATDlgTabPages
currently at index 0..iSize - 1should wind up.
Legal values: The first CATDlgTabPage has index 0.
- iSize
- the size of the iNewPageOrder integer array.
- Returns:
- the currently selected CATDlgTabPage.
This object is included in the file: CATDlgTabContainer.h
If needed, your Imakefile.mk should include the module: DI0PANV2
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.