KnowledgeUIItf Interface CATIKweTypesBrowser
Usage: you must use this class as is. You should never derive it.
interface CATIKweTypesBrowser
Creates a dialog box to select a sub type
Method Index
- o
CreateTypesBrowser(CATDialog*,CATBoolean)
- Creates the browser and fills it up with all the derivable types whose location is Representation.
- o
CreateTypesBrowser(CATDialog*,CATLISTV(CATBaseUnknown_var),CATBoolean,CATBoolean)
- Creates the browser and fills it up with the root types (and all their children) given by iRootTypesList.
- o
GetOnBrowserCANCELNotification()
- Gets the callback sent when the CANCEL button is pressed or when the browser is closed.
- o
GetOnBrowserOKNotification()
- Gets the callback sent when the OK button is pressed.
- o
GetSelectedType(CATIType**)
- Gets the selected type.
- o
GetSelectedType(CATUnicodeString&)
- Gets the name of the selected type.
- o
SetVisibility(CATULong)
- Sets the visibility of the types browser.
Methods
o CreateTypesBrowser
| public virtual CreateTypesBrowser( | | iFather, |
| | iIsRuntime | = FALSE) |
-
Creates the browser and fills it up with all the derivable types whose location is Representation.
- Parameters:
-
- iFather
-
the father command
- iIsRuntime
-
TRUE if the browser is instantiated in a context of execution, DPX (it enables to display the NLS name and the customized icon of an object)
FALSE if the browser is instantiated in a buildtime context, DPC (it enables to display the internal name and the standard icon of an object)
o CreateTypesBrowser
| public virtual CreateTypesBrowser( | | iFather, |
| | iRootTypesList, |
| | iIsRuntime | = TRUE, |
| | iTypeOnly | =FALSE) |
-
Creates the browser and fills it up with the root types (and all their children) given by iRootTypesList.
- Parameters:
-
- iFather
-
the father command
- iRootTypesList
-
the list of the root types to be displayed in the browser
NOTA BENE : this list must contain only root types, their children are computed afterwards
- iIsRuntime
-
TRUE if the browser is instantiated in a context of execution, DPX (it enables to display the NLS name and the customized icon of an object)
FALSE if the browser is instantiated in a buildtime context, DPC (it enables to display the internal name and the standard icon of an object)
- iTypeOnly
-
TRUE if the browser is used to present types only (as opposed to extensions: an extension is often inheriting from the type it extends)
FALSE if the browser can show types and extensions
o GetOnBrowserCANCELNotification
| public virtual GetOnBrowserCANCELNotification( | ) |
-
Gets the callback sent when the CANCEL button is pressed or when the browser is closed.
- Returns:
- CATCallbackEvent
the callback.
o GetOnBrowserOKNotification
| public virtual GetOnBrowserOKNotification( | ) |
-
Gets the callback sent when the OK button is pressed.
- Returns:
- CATCallbackEvent
the callback.
o GetSelectedType
| public virtual GetSelectedType( | | oSelectedType) |
-
Gets the selected type.
- Parameters:
-
- oSelectedType
-
The selected type [out, CATBaseUnknown#Release]
o GetSelectedType
| public virtual GetSelectedType( | | oSelectedType) |
-
Gets the name of the selected type.
- Parameters:
-
- oSelectedType
-
Name of the selected type.
o SetVisibility
| public virtual SetVisibility( | | iVisibility | = CATDlgShow) |
-
Sets the visibility of the types browser.
- Parameters:
-
- iVisibility
-
Legal values : It can be set to either :
- CATDlgShow
- to show the browser,
- CATDlgHide
- to hide the browser.
This object is included in the file: CATIKweTypesBrowser.h
If needed, your Imakefile.mk should include the module: CATKnowledgeUIItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.