AfrFoundation CATFrmWindow
Usage: you can derive this class.
public class CATFrmWindow
Class to provid a working area to visualize application data.
Role: Allows to display and manipulate application data.
This basic class will be derived by application to display
the application's specific data. See also: ,
and
.
Constructor and Destructor Index
- o
CATFrmWindow(CATString&,CATFrmEditor*)
- Constructs a CATFrmWindow.
- o
~CATFrmWindow()
-
Method Index
- o
CATDeclareCBEvent(WINDOW_DELETED)
- Event sent when the window is deleted.
- o
CATDeclareCBEvent(WINDOW_ACTIVATED)
- Event sent when the window is activated.
- o
CATDeclareCBEvent(WINDOW_DEACTIVATED)
- Event sent when the window is deactivated.
- o
DeleteWindow()
- Close the window.
- o
DuplicateWindow()
- Creates and returns a new window of the same document.
- o
GetBaseName()
- Returns the name of window.
- o
GetCurrentCamera()
- Retrieves the current viewpoint of the window.
- o
GetEditor()
- Returns the document editor.
- o
GetImmersiveLayoutFlag()
-
- o
GetViewer()
- Returns the viewer created in the window.
- o
GetViewerFrame()
- Returns the frame in wich the viewer will be attached.
- o
SetBaseName(CATUnicodeString&)
- Changes the name of window.
- o
SetCurrentCamera(CATICamera*)
- Changes the viewpoint of the window.
- o
SetImmersiveLayoutFlag(CATBoolean&)
-
- o
SetViewer(CATViewer*)
- Changes the current viewer of the window.
Constructor and Destructor
o CATFrmWindow
| public CATFrmWindow( | const | iWindowTag, |
| | iEditor | = NULL) |
-
Constructs a CATFrmWindow.
- Parameters:
-
- iWindowTag
- The window name.
This name is the base of displayed window title.
- iEditor
- The editor of the document.
o ~CATFrmWindow
| public virtual ~CATFrmWindow( | ) |
-
Methods
o CATDeclareCBEvent
| public CATDeclareCBEvent( | | ) |
-
Event sent when the window is deleted.
Role:
this event is sent by the CATFrmLayout.
Sample of callback:
::AddCallback(this,
CATFrmLayout::GetCurrentLayout(),
CATFrmWindow::WINDOW_DELETED(),
(CATSubscriberMethod)&MyClass::MyCBMethod,
NULL);
o CATDeclareCBEvent
| public CATDeclareCBEvent( | | ) |
-
Event sent when the window is activated.
Role:
this event is sent by the CATFrmLayout.
Sample of callback:
::AddCallback(this,
CATFrmLayout::GetCurrentLayout(),
CATFrmWindow::WINDOW_ACTIVATED(),
(CATSubscriberMethod)&MyClass::MyCBMethod,
NULL);
o CATDeclareCBEvent
| public CATDeclareCBEvent( | | ) |
-
Event sent when the window is deactivated.
Role:
this event is sent by the CATFrmLayout.
Sample of callback:
::AddCallback(this,
CATFrmLayout::GetCurrentLayout(),
CATFrmWindow::WINDOW_DEACTIVATED(),
(CATSubscriberMethod)&MyClass::MyCBMethod,
NULL);
o DeleteWindow
| public virtual DeleteWindow( | ) |
-
Close the window.
o DuplicateWindow
| public virtual DuplicateWindow( | ) |
-
Creates and returns a new window of the same document.
o GetBaseName
-
Returns the name of window.
o GetCurrentCamera
| public virtual GetCurrentCamera( | ) |
-
Retrieves the current viewpoint of the window.
Role:See the
method.
- Returns:
- The current viewpoint. This pointeur must be released after usage.
o GetEditor
| public virtual GetEditor( | ) |
-
Returns the document editor.
o GetImmersiveLayoutFlag
| public GetImmersiveLayoutFlag( | ) |
-
o GetViewer
| public virtual GetViewer( | ) |
-
Returns the viewer created in the window.
o GetViewerFrame
| public virtual GetViewerFrame( | ) |
-
Returns the frame in wich the viewer will be attached.
o SetBaseName
| public virtual SetBaseName( | const | iWindowName) |
-
Changes the name of window.
- Parameters:
-
- iWindowName
- The new name of window.
o SetCurrentCamera
| public virtual SetCurrentCamera( | | iCamera) |
-
Changes the viewpoint of the window.
Example to handle the camera:
CATICamera *pICamera = NULL ;
pICamera = myWindow->GetCurrentCamera();
// Modify the camera
pICamera->.......
myWindow->SetCurrentCamera(pICamera);
pICamera->Release();
pICamera = NULL ;
- Parameters:
-
- iCamera
- This Camera contains the new viewpoint.
o SetImmersiveLayoutFlag
| public SetImmersiveLayoutFlag( | const | i_immersiveLayoutFlag) |
-
o SetViewer
| public virtual SetViewer( | | iViewer) |
-
Changes the current viewer of the window.
- Parameters:
-
- iViewer
- The new current viewer.
This object is included in the file: CATFrmWindow.h
If needed, your Imakefile.mk should include the module: CATAfrFoundation
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.