| 1 | // |
|---|
| 2 | // AIAppleScriptAdditions.h |
|---|
| 3 | // Adium |
|---|
| 4 | // |
|---|
| 5 | // Created by Adam Iser on Mon Feb 16 2004. |
|---|
| 6 | // Copyright (c) 2004-2005 The Adium Team. All rights reserved. |
|---|
| 7 | // |
|---|
| 8 | |
|---|
| 9 | /*! |
|---|
| 10 | * @category NSAppleScript(AIAppleScriptAdditions) |
|---|
| 11 | * @brief Provides methods for executing functions in an NSAppleScript |
|---|
| 12 | * |
|---|
| 13 | * These methods allow functions to be executed within an NSApplescript and arguments to be passed to those functions |
|---|
| 14 | */ |
|---|
| 15 | @interface NSAppleScript (AIAppleScriptAdditions) |
|---|
| 16 | |
|---|
| 17 | /*! |
|---|
| 18 | * @brief Execute a function |
|---|
| 19 | * |
|---|
| 20 | * Executes a function <b>functionName</b> within the <tt>NSAppleScript</tt>, returning error information if necessary |
|---|
| 21 | * @param functionName An <tt>NSString</tt> of the function to be called. It is case sensitive. |
|---|
| 22 | * @param errorInfo A reference to an <tt>NSDictionary</tt> variable, which will be filled with error information if needed. It may be nil if error information is not requested. |
|---|
| 23 | * @return An <tt>NSAppleEventDescriptor</tt> generated by executing the function. |
|---|
| 24 | */ |
|---|
| 25 | - (NSAppleEventDescriptor *)executeFunction:(NSString *)functionName error:(NSDictionary **)errorInfo; |
|---|
| 26 | |
|---|
| 27 | /*! |
|---|
| 28 | * @brief Execute a function with arguments |
|---|
| 29 | * |
|---|
| 30 | * Executes a function <b>functionName</b> within the <tt>NSAppleScript</tt>, returning error information if necessary. Arguments in <b>argumentArray</b> are passed to the function. |
|---|
| 31 | * @param functionName An <tt>NSString</tt> of the function to be called. It is case sensitive. |
|---|
| 32 | * @param argumentArray An <tt>NSArray</tt> of <tt>NSString</tt>s to be passed to the function when it is called. |
|---|
| 33 | * @param errorInfo A reference to an <tt>NSDictionary</tt> variable, which will be filled with error information if needed. It may be nil if error information is not requested. |
|---|
| 34 | * @return An <tt>NSAppleEventDescriptor</tt> generated by executing the function. |
|---|
| 35 | */ |
|---|
| 36 | - (NSAppleEventDescriptor *)executeFunction:(NSString *)functionName withArguments:(NSArray *)argumentArray error:(NSDictionary **)errorInfo; |
|---|
| 37 | |
|---|
| 38 | @end |
|---|
