webkit  2cdf99a9e3038c7e01b3c37e8ad903ecbe5eecf1
https://github.com/WebKit/webkit
Instance Methods | Class Methods | List of all members
NSObject(WebScripting) Category Reference

#import <WebScriptObject.h>

Instance Methods

(id- invokeUndefinedMethodFromWebScript:withArguments:
 
(id- invokeDefaultMethodWithArguments:
 
(10_4) - WEBKIT_AVAILABLE_MAC
 
(id- invokeUndefinedMethodFromWebScript:withArguments:
 
(id- invokeDefaultMethodWithArguments:
 
(10_4) - WEBKIT_AVAILABLE_MAC
 

Class Methods

(NSString *) + webScriptNameForSelector:
 
(BOOL+ isSelectorExcludedFromWebScript:
 
(NSString *) + webScriptNameForKey:
 
(BOOL+ isKeyExcludedFromWebScript:
 
(NSString *) + webScriptNameForSelector:
 
(BOOL+ isSelectorExcludedFromWebScript:
 
(NSString *) + webScriptNameForKey:
 
(BOOL+ isKeyExcludedFromWebScript:
 

Method Documentation

◆ invokeDefaultMethodWithArguments:() [1/2]

- (id) invokeDefaultMethodWithArguments: (10_4)  WEBKIT_AVAILABLE_MAC

invokeDefaultMethodWithArguments:

Parameters
argumentsThe arguments to pass the method. If a script attempts to call an exposed object as a function, this method will be called.
Returns
The return value of the call. The value will be converted as appropriate for the script environment.

◆ invokeDefaultMethodWithArguments:() [2/2]

- (id) invokeDefaultMethodWithArguments: (10_4)  WEBKIT_AVAILABLE_MAC

invokeDefaultMethodWithArguments:

Parameters
argumentsThe arguments to pass the method. If a script attempts to call an exposed object as a function, this method will be called.
Returns
The return value of the call. The value will be converted as appropriate for the script environment.

◆ invokeUndefinedMethodFromWebScript:withArguments:() [1/2]

- (id) invokeUndefinedMethodFromWebScript: (NSString *)  name
withArguments: (10_4)  WEBKIT_AVAILABLE_MAC 

invokeUndefinedMethodFromWebScript:withArguments:

Parameters
nameThe name of the method to invoke.
argumentsThe arguments to pass the method. If a script attempts to invoke a method that is not exported, invokeUndefinedMethodFromWebScript:withArguments: will be called.
Returns
The return value of the invocation. The value will be converted as appropriate for the script environment.

◆ invokeUndefinedMethodFromWebScript:withArguments:() [2/2]

- (id) invokeUndefinedMethodFromWebScript: (NSString *)  name
withArguments: (10_4)  WEBKIT_AVAILABLE_MAC 

invokeUndefinedMethodFromWebScript:withArguments:

Parameters
nameThe name of the method to invoke.
argumentsThe arguments to pass the method. If a script attempts to invoke a method that is not exported, invokeUndefinedMethodFromWebScript:withArguments: will be called.
Returns
The return value of the invocation. The value will be converted as appropriate for the script environment.

◆ isKeyExcludedFromWebScript:() [1/2]

+ (BOOL) isKeyExcludedFromWebScript: (10_4)  WEBKIT_AVAILABLE_MAC

isKeyExcludedFromWebScript:

Parameters
nameThe name of the instance variable that will be exposed to the script environment. Return NO to export the property to the script environment. Return YES to prevent the property from being exported to the script environment.
Returns
Returns YES to hide the property, NO to export the property.

◆ isKeyExcludedFromWebScript:() [2/2]

+ (BOOL) isKeyExcludedFromWebScript: (10_4)  WEBKIT_AVAILABLE_MAC

isKeyExcludedFromWebScript:

Parameters
nameThe name of the instance variable that will be exposed to the script environment. Return NO to export the property to the script environment. Return YES to prevent the property from being exported to the script environment.
Returns
Returns YES to hide the property, NO to export the property.

◆ isSelectorExcludedFromWebScript:() [1/2]

+ (BOOL) isSelectorExcludedFromWebScript: (10_4)  WEBKIT_AVAILABLE_MAC

isSelectorExcludedFromWebScript:

Parameters
selectorThe selector the will be exposed to the script environment. Return NO to export the selector to the script environment. Return YES to prevent the selector from being exported to the script environment. If this method is not implemented on the class no selectors will be exported.
Returns
Returns YES to hide the selector, NO to export the selector.

◆ isSelectorExcludedFromWebScript:() [2/2]

+ (BOOL) isSelectorExcludedFromWebScript: (10_4)  WEBKIT_AVAILABLE_MAC

isSelectorExcludedFromWebScript:

Parameters
selectorThe selector the will be exposed to the script environment. Return NO to export the selector to the script environment. Return YES to prevent the selector from being exported to the script environment. If this method is not implemented on the class no selectors will be exported.
Returns
Returns YES to hide the selector, NO to export the selector.

◆ WEBKIT_AVAILABLE_MAC() [1/2]

- (10_4) WEBKIT_AVAILABLE_MAC

finalizeForWebScript finalizeForScript is called on objects exposed to the script environment just before the script environment garbage collects the object. Subsequently, any references to WebScriptObjects made by the exposed object will be invalid and have undefined consequences.

◆ WEBKIT_AVAILABLE_MAC() [2/2]

- (10_4) WEBKIT_AVAILABLE_MAC

finalizeForWebScript finalizeForScript is called on objects exposed to the script environment just before the script environment garbage collects the object. Subsequently, any references to WebScriptObjects made by the exposed object will be invalid and have undefined consequences.

◆ webScriptNameForKey:() [1/2]

+ (NSString *) webScriptNameForKey: (10_4)  WEBKIT_AVAILABLE_MAC

webScriptNameForKey:

Parameters
nameThe name of the instance variable that will be exposed to the script environment. Only instance variables that meet the export criteria will be exposed. Provide an alternate name for a property.
Returns
Returns the name to be used to represent the specified property in the scripting environment.

◆ webScriptNameForKey:() [2/2]

+ (NSString *) webScriptNameForKey: (10_4)  WEBKIT_AVAILABLE_MAC

webScriptNameForKey:

Parameters
nameThe name of the instance variable that will be exposed to the script environment. Only instance variables that meet the export criteria will be exposed. Provide an alternate name for a property.
Returns
Returns the name to be used to represent the specified property in the scripting environment.

◆ webScriptNameForSelector:() [1/2]

+ (NSString *) webScriptNameForSelector: (10_4)  WEBKIT_AVAILABLE_MAC

webScriptNameForSelector:

Parameters
selectorThe selector that will be exposed to the script environment. Use the returned string as the exported name for the selector in the script environment. It is the responsibility of the class to ensure uniqueness of the returned name. If nil is returned or this method is not implemented the default name for the selector will be used. The default name concatenates the components of the Objective-C selector name and replaces ':' with '_'. '_' characters are escaped with an additional '$', i.e. '_' becomes "$_". '$' are also escaped, i.e. Objective-C name Default script name moveTo:: move__ moveTo_ moveTo$_ moveTo$_ moveTo$$$_
Returns
Returns the name to be used to represent the specified selector in the scripting environment.

◆ webScriptNameForSelector:() [2/2]

+ (NSString *) webScriptNameForSelector: (10_4)  WEBKIT_AVAILABLE_MAC

webScriptNameForSelector:

Parameters
selectorThe selector that will be exposed to the script environment. Use the returned string as the exported name for the selector in the script environment. It is the responsibility of the class to ensure uniqueness of the returned name. If nil is returned or this method is not implemented the default name for the selector will be used. The default name concatenates the components of the Objective-C selector name and replaces ':' with '_'. '_' characters are escaped with an additional '$', i.e. '_' becomes "$_". '$' are also escaped, i.e. Objective-C name Default script name moveTo:: move__ moveTo_ moveTo$_ moveTo$_ moveTo$$$_
Returns
Returns the name to be used to represent the specified selector in the scripting environment.

The documentation for this category was generated from the following file: