deFindToolbar

deFindToolbar( 
S_name
w_sessionWindow
)
=> o_instance / nil

Description

Searches for and returns an instance of the specified toolbar installed in the given session window. This function also supports the Virtuoso design editor toolbars, such as Workspaces, Go, and Bookmarks.

Arguments

S_name	Specifies the design editor toolbars, the value of text property (a string), or the name property (a symbol) of the toolbar as specified in the toolbar definition file. Unless S_name is specified as the name(symbol) of a toolbar, the toolbar is searched for in the active tab window.
w_sessionWindow	Specifies the ID of the session window in which you want to search for the named toolbar

Value Returned

o_instance	Returns an instance of the specified toolbar in the given session window.
nil	Returns nil if the toolbar you are searching for is not found.

Examples

In this example, the S_name values for the Schematics toolbar in the toolbar definition file are as follows:

(nil

 name schFileToolbar

 text "File"

 items (

         ...

You can search for the Schematics toolbar in a session window, say 1, using any of the function calls listed below:

(deFindToolbar 'schFileToolbar (swindow 1))

(deFindToolbar "File" (swindow 1))

The following example illustrates how you can show the Workspaces toolbar and hide the Bookmarks toolbar in the session window 2:

hiShowToolbar( deFindToolbar( "Workspaces" swindow(2)))

hiHideToolbar( deFindToolbar( "Bookmarks" swindow(2)))

Return to top