lmgrSetLibDisplayOverride

lmgrSetLibDisplayOverride
g_libNames
[?color g_color]
[?icon g_icon]
) 
=> t / nil 

Description

Sets color, icon, or both for a library or a group of libraries to display in the Library Manager. This SKILL function can override the color and icon library attributes settings in the Library Manager.

The database settings of Library Manager take precedence for its defined libraries if this SKILL function targets the same library. When a target library is specified under both systems, the settings specified by lmgrSetLibDisplayOverride is displayed if the targeting attribute from the Display Options is set to allow overrides.

The display override values from lmgrSetLibDisplayOverride are retained in memory only and are not saved permanently. The settings persist in memory until removed by lmgrClearLibDisplayOverride.

Arguments

g_libNames	A string or a list of strings. A string must be a valid library name within the current library list. A list of strings can have multiple library names. For example, "basic" or list( "basic" "US_8ths")
?color g_color	A string, a symbol, or nil. A string can be a number triplet consisting of 2 hex digits for each of red, green, and blue component color values from 00 to ff, and must be prefixed by #. It can also be a string having a SVG standard color name. The symbol 'standard is accepted and correspondes to the Cadence UI style foreground value. The default value is nil that represents no change to the specified icon setting. For example, "#ff7f50" [having RGB values of 255 127 80] or "coral" or 'standard
?icon g_icon	A string, a symbol, or nil. A string can be either a full path to an icon file or the relative file name that resolves to match using the CSF search mechanism. You can set the symbol 'standard to use the default icon of any library displayed in the respective list or tree widget display style. The default value is nil that represents no change to the specified icon setting. For example,"warning.png" or 'standard

Value Returned

t	The specified values are set for the Library Manager.
nil	The specified values could not be set because no value is specified in g_libNames.

Examples

This includes wrapping example calls within errset to avoid potential bypassing of any code occurring after the errset, it is recommended for specific batch change cases when an error may occur, such as icon not found via CSF. Adding errset to each lmgrSetLibDisplayOverride call allows the remaining ones be called in case error occurs in one of them.

errset( progn(

   lmgrSetLibDisplayOverride( "workLibrary" ?color "#00ffff" )

   lmgrSetLibDisplayOverride( "testLibrary" ?icon "test.png" ?color "coral" )

   lmgrSetLibDisplayOverride( list( "lib1" "lib2" "lib3" ) ?color "green" ?icon "/usr1/shared/libicons/greenLib.png" )

) t )

Related Topics

hiLoadIconFile

Display Settings Form

lmgrClearLibDisplayColorOverride

lmgrClearLibDisplayOverride

lmgrGetLibDisplayOverride

Return to top