Dialog CATDlgDocument
Usage: you can derive this class.
public class CATDlgDocument
Class to create an application main window.
Role: An application window is the main application
window. It can contain one or several dialog windows, each
containing a document's presentation, depending on the
application is SDI (Single Document Interface) or MDI
(Multiple Document Interface), and other dialog windows,
such as the Macro window. In addition, it usually features a
menu bar, toolbars, and a status bar.
Toolbars can be docked to its frame sides, or undocked as
independent dialog boxes.
Use the application window as a base class when you want to
create the window for a new application.
The parent of an instance of a class that derives from
CATDlgDocument must be an instance of a class that derives
from CATInteractiveApplication.
note: This class is called the Dialog Document.
So that not to make any confusion with the memory
documents that are edited during a CATIA session, we
will call below these last ones "internalized document".
Constructor and Destructor Index
- o
CATDlgDocument(CATInteractiveApplication*,CATString&,CATDlgStyle)
- Constructs an application main window.
- o
~CATDlgDocument()
-
Method Index
- o
AcceptFileDrop(CATBoolean)
- Specify whether the window (and its child windows) accept drop of files
under Windows.
- o
GetContextualMenu()
- Get the contextual menu, if there is one, for the current
main window.
- o
GetDSLogoNotification()
- Returns the CATDlgDSLogoNotification event notification.
- o
GetDroppedFileNotification()
- Returns the CATDlgDroppedFileNotification event notification.
- o
GetEscapeNotification()
- Returns the CATDlgEscapeNotification event notification.
- o
GetMenuBar()
- Get the menu bar, if there is one, for the current
main window.
- o
GetStatusBar()
- Get the status bar, if there is one, of the current main
window.
- o
IsMDI()
- Specifies if the current main window is MDI or SDI.
- o
MDIActivate(CATDlgDialog*)
- Activates an internalized document child window.
- o
MDICascade(int)
- Shows spacially the current main window internalized document
child windows under a cascade form.
- o
MDIGetActive()
- Get the current internalized document active window.
- o
MDIIconArrange()
- Arranges spacially the icons of the internalized documents
child windows which are currently minimized.
- o
MDIMaximize(CATDlgDialog*)
- Maximizes spacially the size of an internalized document child
window.
- o
MDIMinimize(CATDlgDialog*)
- Minimizes spacially the size of an internalized document child
window.
- o
MDINext()
- Activates the internalized document child window which just
follows the currently active internalized document child
window.
- o
MDIPrevious()
- Activates the internalized document child window which just
preceeds the currently active internalized document child
window.
- o
MDIRestore(CATDlgDialog*)
- Restores spacially the size of an internalized document child
window previously maximized or minimized spacially.
- o
MDITile(int)
- Shows spacially the current main window internalized document
child windows under a tiled form.
Constructor and Destructor
o CATDlgDocument
| public CATDlgDocument( | | iParent, |
| const | iDialogObjectName, |
| | iStyle | =NULL) |
-
Constructs an application main window.
Role: Constructs an application window.
Regarding the use of this method, you have to know that,
to create the main window for your application, you
must derive the current class.
- Parameters:
-
- iParent
- The parent of the CATDlgDocument.
- iDialogObjectName
- The dialog object name.
- iStyle
- The application window style.
Legal values: NULL (default) for a SDI
application (see above), or CATDlgWndFrameMDI
the application must be MDI (see above).
o ~CATDlgDocument
| public virtual ~CATDlgDocument( | ) |
-
Methods
o AcceptFileDrop
| public AcceptFileDrop( | | iAccept) |
-
Specify whether the window (and its child windows) accept drop of files
under Windows.
If this method is not called, default is TRUE.
To be taken into account, this method must be called just after object allocation.
- Parameters:
-
- iAccept
-
Legal values:
- TRUE
- the window accepts drop of files under Windows.
- FALSE
- the window does not accept drop of files under Windows.
o GetContextualMenu
| public GetContextualMenu( | ) |
-
Get the contextual menu, if there is one, for the current
main window.
- Returns:
- The contextual menu.
Legal values: NULL: if the current
main window has no contextual menu, Other
otherwise.
o GetDSLogoNotification
| public GetDSLogoNotification( | ) |
-
Returns the CATDlgDSLogoNotification event notification.
It is sent whenever the end user select the CATIA logo
which is displayed in the bottom-right corner of the
application window. In CATIA, this event notification
activates the in-line documentation process.
o GetDroppedFileNotification
| public GetDroppedFileNotification( | ) |
-
Returns the CATDlgDroppedFileNotification event notification.
It is sent whenever the end user drops an object in a
document window.
o GetEscapeNotification
| public GetEscapeNotification( | ) |
-
Returns the CATDlgEscapeNotification event notification.
It is sent whenever the end user press the escape
key. In CATIA, this event notification, when a command is
being used, ends the command.
o GetMenuBar
-
Get the menu bar, if there is one, for the current
main window.
- Returns:
- The menu bar for this main window.
Legal values: NULL: if the current
main window has no menu bar, Other otherwise.
o GetStatusBar
-
Get the status bar, if there is one, of the current main
window.
- Returns:
- Status bar dialog object.
o IsMDI
-
Specifies if the current main window is MDI or SDI.
- Returns:
- Boolean specifying if the current main window is MDI or SDI.
Legal values: 1: if the current main
window is MDI, or 0: otherwise.
o MDIActivate
| public MDIActivate( | | iChildWindow) |
-
Activates an internalized document child window.
This method relates only to MDI-style CATDlgDocument
windows.
- Parameters:
-
- iChildWindow
- The internalized document child window to activate.
o MDICascade
| public MDICascade( | | iCascadeType | =0) |
-
Shows spacially the current main window internalized document
child windows under a cascade form.
This method relates only to MDI-style CATDlgDocument
windows.
- Parameters:
-
- iCascadeType
- The cascade type.
Legal values:
0 (default) if the cascade process must impact the
minimized internalized document child windows,
CATDlgTileSkipHidden to specify that
the cascade process must not impact the minimized
internalized document child windows.
o MDIGetActive
-
Get the current internalized document active window.
This method relates only to MDI-style CATDlgDocument
windows.
- Returns:
- The internalized document child window currently activated.
o MDIIconArrange
-
Arranges spacially the icons of the internalized documents
child windows which are currently minimized.
This method must be called by an application
when the current main window has been resized.
o MDIMaximize
| public MDIMaximize( | | iChildWindow) |
-
Maximizes spacially the size of an internalized document child
window.
This method relates only to MDI-style CATDlgDocument
windows.
- Parameters:
-
- iChildWindow
- The internalized document child window to maximize
spacially.
o MDIMinimize
-
Minimizes spacially the size of an internalized document child
window.
This method relates only to MDI-style CATDlgDocument
windows.
- Parameters:
-
- iChildWindow
- The internalized document child window to minimize
spacially.
o MDINext
-
Activates the internalized document child window which just
follows the currently active internalized document child
window.
This method relates only to MDI-style CATDlgDocument
windows.
o MDIPrevious
-
Activates the internalized document child window which just
preceeds the currently active internalized document child
window.
This method relates only to MDI-style CATDlgDocument
windows.
o MDIRestore
| public MDIRestore( | | iChildWindow) |
-
Restores spacially the size of an internalized document child
window previously maximized or minimized spacially.
This method relates only to MDI-style CATDlgDocument
windows.
- Parameters:
-
- iChildWindow
- The internalized document child window to restore
spacially.
o MDITile
| public MDITile( | | iTilingType | =CATDlgTileHorizontal) |
-
Shows spacially the current main window internalized document
child windows under a tiled form.
This method relates only to MDI-style CATDlgDocument
windows.
- Parameters:
-
- iTilingType
- The tiling type.
Legal values:
CATDlgTileHorizontal (default) for an horizontal
tiling, CATDlgTileVertical for a vertical
tiling, CATDlgTileSkipHidden to specify that
the tiling process must not impact the minimized
internalized document child windows. This last option
may be associated to one of the two previous ones,
using a logical or.
This object is included in the file: CATDlgDocument.h
If needed, your Imakefile.mk should include the module: DI0PANV2
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.