Product Documentation
Virtuoso Studio Design Environment SKILL Reference
Product Version IC23.1, November 2023

deGetAppInfo

deGetAppInfo( 
t_viewType 
) 
=> l_appInfo / nil

Description

Returns the application registration information associated with t_viewType and its sub-view types.

This function returns a property list with the following elements:

l_appInfo->viewType

viewType

(string)

l_appInfo->parentType

Parent type

(string)

l_appInfo->appName

Application name

(string)

l_appInfo->help

Application help string

(string)

l_appInfo->dataTrigger

SKILL data trigger

(symbol)

l_appInfo->appTrigger

SKILL application trigger

(symbol)

l_appInfo->userAppTrigList

SKILL user app trigger list

(symbol)

l_appInfo->userMenuTrigList

SKILL user menu trigger list

(symbol)

l_appInfo->userPostInstallTrigList

SKILL user post-install trigger list

(symbol)

l_appInfo->inheritEnabling

Whether or not to inherit enabling

(t/nil)

l_appInfo->inheritMenus

Whether or not to inherit menus

(t/nil)

l_appInfo->widgetType

widgetType of the window

(string)

l_appInfo->noCadenceMenu

Whether or not to install the Cadence Menu

(t/nil)

l_appInfo->subTypes

subviewType list of this viewType

(list)

If t_viewType is a root view type, then l_appInfo->parentType will be "", and l_appInfo->dataTrigger and l_appInfo->appTrigger will be non-nil. Otherwise, the opposite is true.

l_appInfo->subTypes is a list of property lists, one for each defined subviewType of t_viewType, which have the same format. Thus l_appInfo contains the entire class tree for t_viewType.

l_appInfo->userAppTrigger, l_appInfo->userMenuTrigger, and l_appInfo->userPostInstallTrigger are supported for compatibility reasons only and should not be used otherwise. If multiple functions are registered for any of these triggers, only the first function of the list is returned.

Arguments

t_viewType

View type for which you want the information.

Value Returned

l_appInfo

Application information for t_viewType, if any.

Example

For the subviewType, maskLayout

deGetAppInfo("maskLayout") => (nil userMenuTrigList (m1 m2) userPostInstallTrigList nil userPostInstallTrigger nil userAppTrigList nil viewType "maskLayout" parentType ""
appName "Layout" apptitle nil help
"Layout" widgetType "graphics" noCadenceMenu t
dataTrigger geDataTrigger appTrigger leAppTrigger enableTrigger
leEnableTrigger menuTrigger leMenuTrigger exitTrigger nil
postInstallTrigger nil windowBBoxProc leWindowBBoxProc userAppTrigger nil userMenuTrigger m1 inheritMenus nil
inheritEnabling nil subTypes (
    (nil viewType "maskLayoutXL" "parentType" "maskLayout"
    appName "Virtuoso XL" appTitle "Layout XL" help
    "layoutXLhelp" widgetType "graphics" noCadenceMenu t
    dataTrigger nil appTrigger nil enableTrigger
    lxiEnableTrigger menuTrigger lxiMenuTrigger exitTrigger
    lxiExitTrigger
    postInstallTrigger lxiPostInstallTrigger windowBBoxProc nil
    userAppTrigger nil userMenuTrigger nil inheritMenus nil
    inheritEnabling nil subTypes nil
    )
deGetAppInfo() returns a pointer to the application information. If the application information is then changed, your local pointer to the application information also changes.

Register the user triggers.

    deRegUserTrigger("maskLayout"
        'appTriggerCB 'menuTriggerCB 'postInstallTriggerCB
     )

Verify that the triggers are registered.

    localAppInfo = deGetAppInfo("maskLayout")
    localAppInfo->userAppTrigger ; Display the userAppTrigger.
         appTriggerCB
    localAppInfo->userMenuTrigger ; Display the userMenuTrigger.
         menuTriggerCB
    localAppInfo->postInstallTriggerCB  ; Display the postInstallTrigger
postInstallTriggerCB

Un-register the user triggers.

    deUnRegUserTriggers("maskLayout")

The localAppInfo properties are set to nil even though localAppInfo was not directly modified.

    localAppInfo->userAppTrigger
         nil
    localAppInfo->userMenuTrigger
         nil
    localAppInfo->postInstallTriggerCB
         nil

Copy the application information into different variables if you want to preserve the information for future reference: 

    localAppTrigger = localAppInfo->userAppTrigger

Return to top
 ⠀
X