All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Dialog Class CATDlgWindow

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

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


public class CATDlgWindow

Base class for all dialog window classes.
Role: The window object base class to share window and dialog box behavior. All the tasks described here consequently apply to any dialog window instance. Its derived classes are:

You cannot construct a CATDlgWindow directly: it can be constructed as the base class of one of its derived class only.


Method Index


o Attach4Sides(CATDialog*)
Fullfills the current window with a delivered object.
o GetDefaultOrientation()
Gets the window default layout orientation.
o GetHorizontalTabIndex(CATDialog*,CATDlgAttachment)
Retrieves the horizontal tabulation line index to which a given object is attached.
o GetMaximumSize(int*,int*)
Getx maximum window size.
o GetVerticalTabIndex(CATDialog*,CATDlgAttachment)
Retrieves the vertical tabulation line index to which a given object is attached.
o GetWindCloseNotification()
Returns the CATDlgWindCloseNotification event notification.
o GetWindMaximizeNotification()
Returns the CATDlgWindMaximizeNotification event notification.
o GetWindMinimizeNotification()
Returns the CATDlgWindMinimizeNotification event notification.
o GetWindMoveNotification()
Returns the CATDlgWindMoveNotification event notification.
o GetWindRestoreNotification()
Returns the CATDlgWindRestoreNotification event notification.
o GetWindSizeNotification()
Returns the CATDlgWindSizeNotification event notification.
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)
Returns if a grid column is resizable.
o IsGridRowResizable(short int)
Returns if a grid row is resizable.
o IsMaximized()
Gets the window maximized/minimized state.
o IsMinimized()
Gets the window maximized/minimized state.
o Maximize()
Maximizes the window.
o Minimize()
Minimizes the window.
o QueryHelpOnContext()
Activates the help on context.
o RemoveAlongHorizontalTab(CATDlgTabIndex,CATDialog*)
Detaches an object from an horizontal tabulation line.
o RemoveAlongVerticalTab(CATDlgTabIndex,CATDialog*)
Detaches an object from an vertical tabulation line.
o ReplaceKeepAttachments(CATDialog*,CATDialog*)
Replaces an object by another.
o ResetAttachment(CATDialog*)
Detaches a delivered object from all its attachments within the current window.
o Restore()
Restores the window to its previous size after being minimized or maximized.
o SetDefaultOrientation(Orientation)
Sets the window 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.

Methods


o Attach4Sides
public void Attach4Sides(CATDialog* iFillingObject)
Fullfills the current window with a delivered object. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
Parameters:
iFillingObject
The object with witch the window is to be filled.
o GetDefaultOrientation
public Orientation GetDefaultOrientation()
Gets the window default layout orientation. The default orientation is taken into account when no other layout information is provided. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
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
public int GetHorizontalTabIndex(CATDialog* iObject,
CATDlgAttachment iAttachmentMode)
Retrieves the horizontal tabulation line index to which a given object is attached. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
Parameters:
iObject
The object.
iAttachmentMode
The attachment mode.
Returns:
The horizontal tabulation index.
o GetMaximumSize
public void GetMaximumSize(int* oHeight,
int* oWidth)
Getx maximum window size.
Parameters:
oHeight
The maximum height.
oWidth
The maximum width.
o GetVerticalTabIndex
public int GetVerticalTabIndex(CATDialog* iObject,
CATDlgAttachment iAttachmentMode)
Retrieves the vertical tabulation line index to which a given object is attached. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
Parameters:
iObject
The object.
iAttachmentMode
The attachment mode.
Returns:
The vertical tabulation index.
o GetWindCloseNotification
public CATNotification * GetWindCloseNotification()const
Returns the CATDlgWindCloseNotification event notification. It is sent whenever the window is closed.
o GetWindMaximizeNotification
public CATNotification * GetWindMaximizeNotification()const
Returns the CATDlgWindMaximizeNotification event notification. It is sent whenever the window is maximized.
o GetWindMinimizeNotification
public CATNotification * GetWindMinimizeNotification()const
Returns the CATDlgWindMinimizeNotification event notification. It is sent whenever the window is minimized.
o GetWindMoveNotification
public CATNotification * GetWindMoveNotification()const
Returns the CATDlgWindMoveNotification event notification. It is sent whenever the window is moved.
o GetWindRestoreNotification
public CATNotification * GetWindRestoreNotification()const
Returns the CATDlgWindRestoreNotification event notification. It is sent whenever the window is restored to its previous size after being minimized or maximized.
o GetWindSizeNotification
public CATNotification * GetWindSizeNotification()const
Returns the CATDlgWindSizeNotification event notification. It is sent whenever the window is resized.
o InsertAlongHorizontalTab
public void InsertAlongHorizontalTab(CATDlgTabIndex iTabulationIndex,
CATDialog* iControlToInsert,
CATDialog* iReferenceControl,
InsertionMode iInsertionMode)
Inserts an object along an horizontal tabulation line with respect to an already inserted object. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
Parameters:
iTabulationIndex
The tabulation index.
iControlToInsert
The control to insert.
iReferenceControl
The reference control
iInsertionMode
Where to insert
o InsertAlongVerticalTab
public void InsertAlongVerticalTab(CATDlgTabIndex iTabulationIndex,
CATDialog* iControlToInsert,
CATDialog* iReferenceControl,
InsertionMode iInsertionMode)
Inserts an object along an vertical tabulation line with respect to an already inserted object. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
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)
Returns if a grid column is resizable. This is available only if the current window is a grid (CATDlgGridLayout style). This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
Parameters:
iColumnIndex
The column index.
o IsGridRowResizable
public int IsGridRowResizable(short int iRowIndex)
Returns if a grid row is resizable. This is available only if the current window is a grid (CATDlgGridLayout style). This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
Parameters:
iRowIndex
The row index.
o IsMaximized
public int IsMaximized()
Gets the window maximized/minimized state.
Returns:

Legal values: 1 if the window is currently maximized, or 0 otherwise.
o IsMinimized
public int IsMinimized()
Gets the window maximized/minimized state.
Returns:

Legal values: 1 if the window is currently minimized, or 0 otherwise.
o Maximize
public void Maximize()
Maximizes the window.
o Minimize
public void Minimize()
Minimizes the window.
o QueryHelpOnContext
public void QueryHelpOnContext()
Activates the help on context. This method will be called when the "What's This" command is selected. This selection might be through a dedicated icon or, on Windows only, through the panel question mark selection, or, on Windows and UNIX, through the panel help button selection.

The "What's This" command turns the cursor to a question mark, and then when the end-user clicks a control, displays the control associated "Long Help" in a balloon. The clicks, after displaying the balloon, ends the current "What's This" command. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.

o RemoveAlongHorizontalTab
public void RemoveAlongHorizontalTab(CATDlgTabIndex iTabulationIndex,
CATDialog* iControlToDetach)
Detaches an object from an horizontal tabulation line. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
Parameters:
iTabulationIndex
The tabulation index.
iControlToDetach
The control to detach.
o RemoveAlongVerticalTab
public void RemoveAlongVerticalTab(CATDlgTabIndex iTabulationIndex,
CATDialog* iControlToDetach)
Detaches an object from an vertical tabulation line. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
Parameters:
iTabulationIndex
The tabulation index.
iControlToDetach
The control to detach.
o ReplaceKeepAttachments
public void ReplaceKeepAttachments(CATDialog* iReplacingObject,
CATDialog* iObjectToReplace)
Replaces an object by another. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
Parameters:
iReplacingObject
The replacing object.
iObjectToReplace
The object to replace.
o ResetAttachment
public void ResetAttachment(CATDialog* iObject)
Detaches a delivered object from all its attachments within the current window. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
Parameters:
iObject
The object to detach.
o Restore
public void Restore()
Restores the window to its previous size after being minimized or maximized.
o SetDefaultOrientation
public void SetDefaultOrientation(Orientation iLayoutOrientation)
Sets the window default layout orientation. The default orientation is taken into account when no other layout information is provided. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
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 window is a grid (CATDlgGridLayout style). This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
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 window is a grid (CATDlgGridLayout style). This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
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
public void SetHorizontalAttachment(CATDlgTabIndex iHorizontalTabLineIndex,
CATDlgAttachment iAttachmentMode,
CATDialog* iAttachedObject1,
... )
Creates horizontal tabulation lines. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
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 side
  • 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
public void SetVerticalAttachment(CATDlgTabIndex iVerticalTabLineIndex,
CATDlgAttachment iAttachmentMode,
CATDialog* iAttachedObject1,
... )
Creates vertical tabulation lines. This deals only with the CATDlgDialog and CATDlgDocument derived classes from this based class.
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: CATDlgWindow.h
If needed, your Imakefile.mk should include the module: DI0PANV2

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