Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

Dialog CATDlgTabPage

Usage: you can derive this class.

public class CATDlgTabPage

Base class for pages in a CATDlgTabContainer.

Constructor and Destructor Index

o CATDlgTabPage(CATDlgTabContainer*,CATString&,CATDlgStyle): Constructor.
o ~CATDlgTabPage(): Destructor.

Method Index

o Attach4Sides(CATDialog*): Causes any resizing of the tab page to be transmitted to the supplied child widget.
o GetDefaultOrientation(): Returns the orientation of the page.
o GetHorizontalTabIndex(CATDialog*,CATDlgAttachment): Returns the horizontal tabulation on which a widget is attached.
o GetVerticalTabIndex(CATDialog*,CATDlgAttachment): Returns the vertical tabulation on which a widget is attached.
o InsertAlongHorizontalTab(CATDlgTabIndex,CATDialog*,CATDialog*,InsertionMode): Adds a child widget to an existing horizontal tabulation.
o InsertAlongVerticalTab(CATDlgTabIndex,CATDialog*,CATDialog*,InsertionMode): Adds a child widget to an existing vertical tabulation.
o IsGridColumnResizable(short int): Returns whether a grid column can be resized or not.
o IsGridRowResizable(short int): Returns whether a grid row can be resized or not.
o RemoveAlongHorizontalTab(CATDlgTabIndex,CATDialog*): Detaches a child widget of the tab page from an horizontal tabulation.
o RemoveAlongVerticalTab(CATDlgTabIndex,CATDialog*): Detaches a child widget of the tab page from an vertical tabulation.
o ReplaceKeepAttachments(CATDialog*,CATDialog*): Positions a child widget at the position previously held by another child widget.
o ResetAttachment(CATDialog*): Removes all the attachments which cause the supplied child widget to be resized when the tab page is resized.
o SetDefaultOrientation(Orientation): Sets the default orientation of the page.
o SetGridColumnResizable(short int,int): Sets whether a grid column can be resized or not.
o SetGridRowResizable(short int,int): Sets whether a grid row can be resized or not.
o SetHorizontalAttachment(CATDlgTabIndex,CATDlgAttachment,CATDialog*,...): Attaches one or many child widgets to an invisible horizontal tabulation.
o SetVerticalAttachment(CATDlgTabIndex,CATDlgAttachment,CATDialog*,...): Attaches one or many child widgets to an invisible vertical tabulation.

Constructor and Destructor

o CATDlgTabPage

public CATDlgTabPage(		`iParent`,
	const	`iObjectName`,
		`iStyle`	`=NULL`)

Constructor.

Parameters:

iParent

The parent widget.

iObjectName

The internal name of the tab page.

iStyle

The style of the tab page.
Legal values:

default: The layout of the page is done using tabulations
CATDlgGridLayout: The layout of the page is done with a grid

o ~CATDlgTabPage

public virtual ~CATDlgTabPage(

)

Destructor.

Methods

o Attach4Sides

public Attach4Sides( iDialog)

Causes any resizing of the tab page to be transmitted to the supplied child widget.

Parameters:

iDialog: the widget to resize when the tab page is resized.

o GetDefaultOrientation

public GetDefaultOrientation(

)

Returns the orientation of the page.

Returns:

a constant describing the orientation of the page.
Legal values:

Vertical: The contained widgets will be positionned along a vertical line.
Horizontal: The contained widgets will be positionned along an horizontal line.

o GetHorizontalTabIndex

public GetHorizontalTabIndex(		`iDialog`,
		`iAttachment`)

Returns the horizontal tabulation on which a widget is attached.

Parameters:

iDialog: the attached child widget.
iAttachment: the type of attachment of the widget.

Returns:

an integer which identifies the tabulation.

o GetVerticalTabIndex

public GetVerticalTabIndex(		`iDialog`,
		`iAttachment`)

Returns the vertical tabulation on which a widget is attached.

Parameters:

iDialog: the attached child widget.
iAttachment: the type of attachment of the widget.

Returns:

an integer which identifies the tabulation.

o InsertAlongHorizontalTab

public InsertAlongHorizontalTab(		`iIndex`,
		`iDialog`,
		`iReferenceDialog`,
		`iMode`)

Adds a child widget to an existing horizontal tabulation.

Parameters:

iIndex

an integer which identifies the tabulation.

iDialog

the widget to attach to the tabulation.

iReferenceDialog

a reference widget which is already aligned on the tabulation.

iMode

a constant describing the insertion mode.
Legal values:

After: the widget is inserted after the reference widget.
Before: the widget is inserted before the reference widget.

o InsertAlongVerticalTab

public InsertAlongVerticalTab(		`iIndex`,
		`iDialog`,
		`iReferenceDialog`,
		`iMode`)

Adds a child widget to an existing vertical tabulation.

Parameters:

iIndex

an integer which identifies the tabulation.

iDialog

the widget to attach to the tabulation.

iReferenceDialog

a reference widget which is already aligned on the tabulation.

iMode

a constant describing the insertion mode.
Legal values:

After: the widget is inserted after the reference widget.
Before: the widget is inserted before the reference widget.

o IsGridColumnResizable

public IsGridColumnResizable( iIndex)

Returns whether a grid column can be resized or not.
Precondition: the CATDlgTabPage must use the CATDlgGridLayout style.

Parameters:

iIndex: the index of the grid column.

Returns:

a constant describing the resizing policy for the column.
Legal values:

0: the column has a fixed size.
1: the column is resized when the tab page is resized.

o IsGridRowResizable

public IsGridRowResizable( iIndex)

Returns whether a grid row can be resized or not.
Precondition: the CATDlgTabPage must use the CATDlgGridLayout style.

Parameters:

iIndex: the index of the grid row.

Returns:

a constant describing the resizing policy for the row.
Legal values:

0: the row has a fixed size.
1: the row is resized when the tab page is resized.

o RemoveAlongHorizontalTab

public RemoveAlongHorizontalTab(		`iIndex`,
		`iDialog`)

Detaches a child widget of the tab page from an horizontal tabulation.

Parameters:

iIndex: an integer which identifies the tabulation.
iDialog: the widget to detach from the tabulation.

o RemoveAlongVerticalTab

public RemoveAlongVerticalTab(		`iIndex`,
		`iDialog`)

Detaches a child widget of the tab page from an vertical tabulation.

Parameters:

iIndex: an integer which identifies the tabulation.
iDialog: the widget to detach from the tabulation.

o ReplaceKeepAttachments

public ReplaceKeepAttachments(		`iNewDialog`,
		`iOldDialog`)

Positions a child widget at the position previously held by another child widget.

Parameters:

iNewDialog: the child widget to position.
iOldDialog: the child widget whose position will be occupied iNewDialog.

o ResetAttachment

public ResetAttachment( iDialog)

Removes all the attachments which cause the supplied child widget to be resized when the tab page is resized.

Parameters:

iDialog: the widget to detach from the tab page.

o SetDefaultOrientation

public SetDefaultOrientation( iOrient)

Sets the default orientation of the page.

Parameters:

iOrient

a constant describing the orientation of the page.
Legal values:

Vertical: The contained widgets will be positionned along a vertical line.
Horizontal: The contained widgets will be positionned along an horizontal line.

o SetGridColumnResizable

public SetGridColumnResizable(		`iIndex`,
		`iState`	`=1`)

Sets whether a grid column can be resized or not.
Precondition: the CATDlgTabPage must use the CATDlgGridLayout style.

Parameters:

iIndex

the index of the grid column.

iState

a constant describing the resizing policy for the column.
Legal values:

0: the column has a fixed size.
1: the column is resized when the tab page is resized.

o SetGridRowResizable

public SetGridRowResizable(		`iIndex`,
		`iState`	`=1`)

Sets whether a grid row can be resized or not.
Precondition: the CATDlgTabPage must use the CATDlgGridLayout style.

Parameters:

iIndex

the index of the grid row.

iState

a constant describing the resizing policy for the row.
Legal values:

0: the row has a fixed size.
1: the row is resized when the tab page is resized.

o SetHorizontalAttachment

public SetHorizontalAttachment(		`iIndex`,
		`iAttachment`,
		`iFirstDialog`,
		)

Attaches one or many child widgets to an invisible horizontal tabulation.
Role:
Use this method to specify the way widgets should be positionned and resized when the tab page is resized.

Parameters:

iIndex

an integer which identifies the tabulation.

iAttachment

a constant which specifies the position of the widgets with respect to the tabulation.
Legal values:

CATDlgUnspecified: The position of the widget with respect to the tabulation is left unspecified.
CATDlgTopOrLeft: The left side of the widget is aligned on the tabulation. The tabulation does not move when the tab page is resized.
CATDlgTopOrLeftRelative: The left side of the widget is aligned on the tabulation. The tabulation moves to accomodate the resizing of the tab page.
CATDlgRightOrBottom: The right side of the widget is aligned on the tabulation. The tabulation does not move when the tab page is resized.
CATDlgRightOrBottomRelative: The right side of the widget is aligned on the tabulation. The tabulation moves to accomodate the resizing of the tab page.
CATDlgCenter: The widget is centered on the tabulation. The tabulation does not move when the tab page is resized.
CATDlgCenterRelative: The widget is centered on the tabulation. The tabulation moves to accomodate the resizing of the tab page.

iFirstDialog

the first widget of a variable list of child widgets to attach to the tabulation.

o SetVerticalAttachment

public SetVerticalAttachment(		`iIndex`,
		`iAttachment`,
		`iFirstDialog`,
		)

Attaches one or many child widgets to an invisible vertical tabulation.
Role:
Use this method to specify the way widgets should be positionned and resized when the tab page is resized.

Parameters:

iIndex

an integer which identifies the tabulation.

iAttachment

a constant which specifies the position of the widgets with respect to the tabulation.
Legal values:

CATDlgUnspecified: The position of the widget with respect to the tabulation is left unspecified.
CATDlgTopOrLeft: The top side of the widget is aligned on the tabulation. The tabulation does not move when the tab page is resized.
CATDlgTopOrLeftRelative: The top side of the widget is aligned on the tabulation. The tabulation moves to accomodate the resizing of the tab page.
CATDlgRightOrBottom: The bottom side of the widget is aligned on the tabulation. The tabulation does not move when the tab page is resized.
CATDlgRightOrBottomRelative: The bottom side of the widget is aligned on the tabulation. The tabulation moves to accomodate the resizing of the tab page.
CATDlgCenter: The widget is centered on the tabulation. The tabulation does not move when the tab page is resized.
CATDlgCenterRelative: The widget is centered on the tabulation. The tabulation moves to accomodate the resizing of the tab page.

iFirstDialog

the first widget of a variable list of child widgets to attach to the tabulation.

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

Dialog writeClassCharacteristic(); CATDlgTabPage

Constructor and Destructor Index

Method Index

Constructor and Destructor

Methods

Dialog CATDlgTabPage