Skip to content

SET_ICON_CLICK_HDL

SET_ICON_CLICK_HDL changes the click handler (the function which is executed on a click) of a smart icon.

Syntax

leo-grammar
CC "Application" [ raw** ] SET_ICON_CLICK_HDL [ component:Component ] name:strValue 
											{ AdoScript } .

Component :	"acquisition" | "modeling" | "analysis" 
			"simulation" | "evaluation" | "importexport" | 
			"all" .

#--> RESULT ecode:intValue .
CC "Application" [ raw** ] SET_ICON_CLICK_HDL [ component:Component ] name:strValue 
											{ AdoScript } .

Component :	"acquisition" | "modeling" | "analysis" 
			"simulation" | "evaluation" | "importexport" | 
			"all" .

#--> RESULT ecode:intValue .

Parameters

  • component (strValue) - name of the component as displayed in the list above
  • name (strValue) - name of the icon

Returns

  • ecode (intValue) - Contains the error code or is 0 in case of success.

Details

The name of a custom smart icon is the name specified at INSERT_ICON. The names of the built-in smart icons are listed in the SET_ICON_VISIBLE documentation.

The raw argument at the CC element may be of importance here! Without specifying raw, variables used in the handler are replaced by the current values of these variables. If the handler just calls a global procedure without parameters, raw is not needed.

See Also

SET_ICON_VISIBLE
INSERT_ICON

Examples

Versions and Changes

Available since ADOxx 1.3