AfrFoundation CATFrmContext
Usage: you must use this class as is. You should never derive it.
public class CATFrmContext
Constructor and Destructor Index
- o
CATFrmContext()
-
- o
~CATFrmContext()
-
Method Index
- o
CATDeclareCBEvent(FrmContextModified)
- This event is sent each time a transaction ends.
- o
GetActiveEditorList()
- Retrieves the list of open editors.
- o
GetContext()
- Retrieves the pointer on the Application Frame context singleton.
- o
GetEditor()
- Retrieves the current editor pointer.
- o
GetEditorList()
- Retrieves the list of open editors.
- o
GetNextWorkbenchName()
- Retrieves the next workbench name.
- o
GetNextWorkshopName()
- Retrieves the next workshop name.
- o
GetPreviousWorkbenchName()
- Retrieves the previous workbench name.
- o
GetPreviousWorkshopName()
- Retrieves the previous workshop name.
- o
GetTransaction()
- Retrieves the current transaction status.
- o
GetWindow()
- Retrieves the current window pointer.
- o
GetWorkbench()
- Retrieves the current workbench pointer.
- o
GetWorkbenchName()
- Retrieves the current workbench name.
- o
GetWorkshop()
- Retrieves the current workshop pointer.
- o
GetWorkshopName()
- Retrieves the current workshop name.
- o
SetWindow(CATFrmWindow*)
- Changes the current window.
Constructor and Destructor
o CATFrmContext
-
o ~CATFrmContext
| public virtual ~CATFrmContext( | ) |
-
Methods
o CATDeclareCBEvent
| public CATDeclareCBEvent( | | ) |
-
This event is sent each time a transaction ends.
o GetActiveEditorList
| public static GetActiveEditorList( | ) |
-
Retrieves the list of open editors. Please delete the list after use.
- Returns:
- the list of open editors
o GetContext
| public static GetContext( | ) |
-
Retrieves the pointer on the Application Frame context singleton.
- Returns:
- the pointer on the context
o GetEditor
-
Retrieves the current editor pointer.
- Returns:
- the pointer on the editor
o GetEditorList
-
Retrieves the list of open editors.
o GetNextWorkbenchName
| public GetNextWorkbenchName( | ) |
-
Retrieves the next workbench name.
- Returns:
- the next workbench name. Useful during a workbench transition.
o GetNextWorkshopName
| public GetNextWorkshopName( | ) |
-
Retrieves the next workshop name.
- Returns:
- the next workshop name. Useful during a workshop transition.
o GetPreviousWorkbenchName
| public GetPreviousWorkbenchName( | ) |
-
Retrieves the previous workbench name.
- Returns:
- the previous workbench name. Useful during a workbench transition
o GetPreviousWorkshopName
| public GetPreviousWorkshopName( | ) |
-
Retrieves the previous workshop name.
- Returns:
- the previous workshop name. Useful during a workshop transition
o GetTransaction
-
Retrieves the current transaction status. RoleFor example, GetTransaction() & CATFrmCtxWorkbench is TRUE whether a transaction is opened
and the current workbench is being changed (and the change is not completely done).
- Returns:
- the transaction status
o GetWindow
-
Retrieves the current window pointer.
- Returns:
- the pointer on the window
o GetWorkbench
-
Retrieves the current workbench pointer.
- Returns:
- the pointer on the context
o GetWorkbenchName
| public GetWorkbenchName( | ) |
-
Retrieves the current workbench name.
- Returns:
- the current workbench name
o GetWorkshop
-
Retrieves the current workshop pointer.
- Returns:
- the pointer on the current workshop
o GetWorkshopName
-
Retrieves the current workshop name.
- Returns:
- the workshop name
o SetWindow
| public SetWindow( | | ipWindow) |
-
Changes the current window.
- Parameters:
-
- ipWindow
- The window to set as current
This object is included in the file: CATFrmContext.h
If needed, your Imakefile.mk should include the module: CATAfrFoundation
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.