Mercurial > projects > dwt-win
diff dwt/ole/win32/OleAutomation.d @ 246:fd9c62a2998e
Updater SWT 3.4M7 to 3.4
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Tue, 01 Jul 2008 10:15:59 +0200 |
parents | ab60f3309436 |
children | bb89fd34ec82 |
line wrap: on
line diff
--- a/dwt/ole/win32/OleAutomation.d Tue Jul 01 08:58:50 2008 +0200 +++ b/dwt/ole/win32/OleAutomation.d Tue Jul 01 10:15:59 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -99,6 +99,9 @@ * automation.dispose(); * * </pre></code> + * + * @see <a href="http://www.eclipse.org/swt/snippets/#ole">OLE and ActiveX snippets</a> + * @see <a href="http://www.eclipse.org/swt/examples.php">DWT Examples: OLEExample, OleWebBrowser</a> */ public final class OleAutomation { private IDispatch objIDispatch; @@ -156,6 +159,13 @@ IDispatch getAddress() { return objIDispatch; } +/** + * Returns the fully qualified name of the Help file for the given member ID. + * + * @param dispId the member ID whose Help file is being retrieved. + * @return a string representing the fully qualified name of a Help + * file or null. + */ public String getHelpFile(int dispId) { if (objITypeInfo is null) return null; BSTR file; @@ -167,6 +177,12 @@ } return null; } +/** + * Returns the documentation string for the given member ID. + * + * @param dispId the member ID in which the documentation is being retrieved. + * @return the documentation string if it exists; otherwise return null. + */ public String getDocumentation(int dispId) { if (objITypeInfo is null) return null; BSTR doc; @@ -178,6 +194,12 @@ } return null; } +/** + * Returns the property description of a variable at the given index. + * + * @param index the index of a variable whose property is being retrieved. + * @return an OlePropertyDescription for a variable at the given index. + */ public OlePropertyDescription getPropertyDescription(int index) { if (objITypeInfo is null) return null; VARDESC* vardesc; @@ -204,6 +226,12 @@ objITypeInfo.ReleaseVarDesc(vardesc); return data; } +/** + * Returns the description of a function at the given index. + * + * @param index the index of a function whose property is being retrieved. + * @return an OleFunctionDescription for a function at the given index. + */ public OleFunctionDescription getFunctionDescription(int index) { if (objITypeInfo is null) return null; FUNCDESC* funcdesc; @@ -256,6 +284,13 @@ objITypeInfo.ReleaseFuncDesc(funcdesc); return data; } +/** + * Returns the type info of the current object referenced by the automation. + * The type info contains information about the object such as the function descriptions, + * the member descriptions and attributes of the type. + * + * @return the type info of the receiver + */ public TYPEATTR* getTypeInfoAttributes() { if (objITypeInfo is null) return null; TYPEATTR* ppTypeAttr; @@ -266,7 +301,12 @@ objITypeInfo.ReleaseTypeAttr(ppTypeAttr); return typeattr; } - +/** + * Returns the name of the given member ID. + * + * @param dispId the member ID in which the name is being retrieved. + * @return the name if it exists; otherwise return null. + */ public String getName(int dispId) { if (objITypeInfo is null) return null; BSTR name; @@ -278,7 +318,13 @@ } return null; } - +/** + * Returns the name of a function and parameter names for the specified function ID. + * + * @param dispId the function ID in which the name and parameters are being retrieved. + * @param maxSize the maximum number of names to retrieve. + * @return an array of name containing the function name and the parameter names + */ public String[] getNames(int dispId, int maxSize) { if (objITypeInfo is null) return new String[0]; BSTR[] names = new BSTR[maxSize];