All Frameworks Class Hierarchy This Framework Previous Next Indexes
Dialog Class CATDlgFrame
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATEventSubscriber
|
+---System.CATCommand
|
+---Dialog.CATDialog
|
+---Dialog.CATDlgBox
|
+---CATDlgFrame
Usage: you can derive this class.
public class CATDlgFrame
Class to gather controls having something in common.
Role: Gathers controls having something in common.
The frame is designed to group several Dialog framework objects,
like controls and labels, having something in common from the user
or from the application point of view. The frame is the basic
container to gather controls, and possibly other containers.
These objects should be related to each other.
A frame can be visible or invisible. A visible frame is displayed
as a rectangular box, and can have a title.
Use frames whenever you want to group objects that relate
to each other.
The frame layout may be manipulated either using tabulations
or using a grid.
Constructor and Destructor Index
- o
CATDlgFrame(CATDialog*,CATString&,CATDlgStyle)
- Constructs a class to gather controls having something in common.
Method Index
- o
Attach4Sides(CATDialog*)
- Fullfills the current frame with a delivered object.
- o
GetDefaultOrientation()
- Get the frame default layout orientation.
- o
GetHorizontalTabIndex(CATDialog*,CATDlgAttachment)
- Retrieves the horizontal tabulation line index to
which a given object is attached.
- o
GetVerticalTabIndex(CATDialog*,CATDlgAttachment)
- Retrieves the vertical tabulation line index to
which a given object is attached.
- o
InsertAlongHorizontalTab(CATDlgTabIndex,CATDialog*,CATDialog*,InsertionMode)
- Inserts an object along an horizontal tabulation
line with respect to an already inserted object.
- o
InsertAlongVerticalTab(CATDlgTabIndex,CATDialog*,CATDialog*,InsertionMode)
- Inserts an object along an vertical tabulation
line with respect to an already inserted object.
- o
IsGridColumnResizable(short int)
- Specifies if a grid column is resizable.
- o
IsGridRowResizable(short int)
- Specifies if a grid row is resizable.
- o
RemoveAlongHorizontalTab(CATDlgTabIndex,CATDialog*)
- Detach an object from an horizontal tabulation line.
- o
RemoveAlongVerticalTab(CATDlgTabIndex,CATDialog*)
- Detach an object from an vertical tabulation line.
- o
ReplaceKeepAttachments(CATDialog*,CATDialog*)
- Replace an object by another.
- o
ResetAttachment(CATDialog*)
- Detach a delivered object from all its attachments
within the current frame.
- o
SetDefaultOrientation(Orientation)
- Set the frame default layout orientation.
- o
SetGridColumnResizable(short int,int)
- Defines Grid Column resize policy.
- o
SetGridRowResizable(short int,int)
- Defines Grid Row resize policy.
- o
SetHorizontalAttachment(CATDlgTabIndex,CATDlgAttachment,CATDialog*,...)
- Creates horizontal tabulation lines.
- o
SetVerticalAttachment(CATDlgTabIndex,CATDlgAttachment,CATDialog*,...)
- Creates vertical tabulation lines.
Constructor and Destructor
o CATDlgFrame
-
Constructs a class to gather controls having something in common.
Role: Constructs a class to gather controls having something
in common.
- Parameters:
-
- iParent
- The parent of the frame.
- iDialogObjectName
- The dialog object name.
- iStyle
- The application window styles. You can cumulate several
styles using a logical or.
Legal values:
- NULL (default) so that the
frame is visible and has a title, and so that its layout is
managed using tabulations
- CATDlgFraNoTitle if the
the frame has no title
- CATDlgFraNoFrame
if the the frame is not visible, its contents remaining visible,
(this hides the title if any)
- CATDlgGridLayout if the
frame layout is managed using a grid.
Methods
o Attach4Sides
public void Attach4Sides( | CATDialog* | iFillingObject) |
-
Fullfills the current frame with a delivered object.
- Parameters:
-
- iFillingObject
- The object with witch the frame is to be filled.
o GetDefaultOrientation
-
Get the frame default layout orientation.
The default orientation is taken into account when no other
layout information is provided.
- Returns:
- The layout orientation.
Legal values: Vertical if the
children are presented along a vertical line, or
Horizontal if the
children are presented along a horizontal line.
o GetHorizontalTabIndex
-
Retrieves the horizontal tabulation line index to
which a given object is attached.
- Parameters:
-
- iObject
- The object.
- iAttachmentMode
- The attachment mode.
- Returns:
- The horizontal tabulation index.
o GetVerticalTabIndex
-
Retrieves the vertical tabulation line index to
which a given object is attached.
- Parameters:
-
- iObject
- The object.
- iAttachmentMode
- The attachment mode.
- Returns:
- The vertical tabulation index.
o InsertAlongHorizontalTab
-
Inserts an object along an horizontal tabulation
line with respect to an already inserted object.
- Parameters:
-
- iTabulationIndex
- The tabulation index.
- iControlToInsert
- The control to insert.
- iReferenceControl
- The reference control
- iInsertionMode
- Where to insert
o InsertAlongVerticalTab
-
Inserts an object along an vertical tabulation
line with respect to an already inserted object.
- Parameters:
-
- iTabulationIndex
- The tabulation index.
- iControlToInsert
- The control to insert.
- iReferenceControl
- The reference control
- iInsertionMode
- Where to insert
o IsGridColumnResizable
public int IsGridColumnResizable( | short int | iColumnIndex) |
-
Specifies if a grid column is resizable.
This is available only if the current frame is a grid
(CATDlgGridLayout style)
- Parameters:
-
- iColumnIndex
- The column index.
o IsGridRowResizable
public int IsGridRowResizable( | short int | iRowIndex) |
-
Specifies if a grid row is resizable.
This is available only if the current frame is a grid
(CATDlgGridLayout style)
- Parameters:
-
- iRowIndex
- The row index.
o RemoveAlongHorizontalTab
-
Detach an object from an horizontal tabulation line.
- Parameters:
-
- iTabulationIndex
- The tabulation index.
- iControlToDetach
- The control to detach.
o RemoveAlongVerticalTab
-
Detach an object from an vertical tabulation line.
- Parameters:
-
- iTabulationIndex
- The tabulation index.
- iControlToDetach
- The control to detach.
o ReplaceKeepAttachments
-
Replace an object by another.
- Parameters:
-
- iReplacingObject
- The replacing object.
- iObjectToReplace
- The object to replace.
o ResetAttachment
-
Detach a delivered object from all its attachments
within the current frame.
- Parameters:
-
- iObject
- The object to detach.
o SetDefaultOrientation
public void SetDefaultOrientation( | Orientation | iLayoutOrientation) |
-
Set the frame default layout orientation.
The default orientation is taken into account when no other
layout information is provided.
- Parameters:
-
- iLayoutOrientation
- The layout orientation.
Legal values: Vertical so that the
children be presented along a vertical line, or
Horizontal so that the
children be presented along a horizontal line.
o SetGridColumnResizable
public void SetGridColumnResizable( | short int | iColumnIndex, |
| int | iResizableFlag | =1) |
-
Defines Grid Column resize policy.
This is available only if the current frame is a grid
(CATDlgGridLayout style)
- Parameters:
-
- iColumnIndex
- The column index.
- iResizableFlag
- Integer specifying if the column is to be resizable.
Legal values: 1 if the column is to
be resizable, or 0 otherwise.
o SetGridRowResizable
public void SetGridRowResizable( | short int | iRowIndex, |
| int | iResizableFlag | =1) |
-
Defines Grid Row resize policy.
This is available only if the current frame is a grid
(CATDlgGridLayout style)
- Parameters:
-
- iRowIndex
- The row index.
- iResizableFlag
- Integer specifying if the row is to be resizable.
Legal values: 1 if the row is to
be resizable, or 0 otherwise.
o SetHorizontalAttachment
-
Creates horizontal tabulation lines.
- Parameters:
-
- iHorizontalTabLineIndex
- The horizontal tabulation line index.
- iAttachmentMode
- The attachment mode.
Legal values:
- CATDlgTopOrLeft so that the
the objects be attached using their top sides
- CATDlgTopOrLeftRelative so that the
the objects be attached using their top sides and so that
resizing be enabled
- CATDlgRightOrBottom so that the
the objects be attached using their bottom sides
- CATDlgTopOrLeftRelative so that the
the objects be attached using their bottom sides and so that
resizing be enabled
- CATDlgCenter so that the
the objects be attached using their center
- CATDlgCenterRelative so that the the objects be
attached using their center and so that resizing be enabled
- iAttachedObject1
- The first attached object.
- ...
- The other attached objects
o SetVerticalAttachment
-
Creates vertical tabulation lines.
- Parameters:
-
- iVerticalTabLineIndex
- The vertical tabulation line index.
- iAttachmentMode
- The attachment mode.
Legal values:
- CATDlgTopOrLeft so that the
the objects be attached using their left sides
- CATDlgTopOrLeftRelative so that the
the objects be attached using their left sides and so that
resizing be enabled
- CATDlgRightOrBottom so that the
the objects be attached using their right sides
- CATDlgTopOrLeftRelative so that the
the objects be attached using their right sides and so that
resizing be enabled
- CATDlgCenter so that the
the objects be attached using their center
- CATDlgCenterRelative so that the the objects be
attached using their center and so that resizing be enabled
- iAttachedObject1
- The first attached object.
- ...
- The other attached objects
This object is included in the file: CATDlgFrame.h
If needed, your Imakefile.mk should include the module: DI0PANV2