diff options
author | Grant Gayed <ggayed> | 2008-06-02 20:16:00 +0000 |
---|---|---|
committer | Grant Gayed <ggayed> | 2008-06-02 20:16:00 +0000 |
commit | 181c47829e0f3bc8cf6a3691353cd551d7ad0765 (patch) | |
tree | 3c7347fea4cd9ee613ca9cd0655afa456461d69a | |
parent | bc94da47a3540e3e5da41d302119ad2303398bc6 (diff) | |
download | eclipse.platform.swt-181c47829e0f3bc8cf6a3691353cd551d7ad0765.tar.gz eclipse.platform.swt-181c47829e0f3bc8cf6a3691353cd551d7ad0765.tar.xz eclipse.platform.swt-181c47829e0f3bc8cf6a3691353cd551d7ad0765.zip |
doc
2 files changed, 24 insertions, 4 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleControlSite.java b/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleControlSite.java index 0fb97c9fc8..07ff8ec3dd 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleControlSite.java +++ b/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleControlSite.java @@ -500,10 +500,14 @@ protected int /*long*/ getLicenseInfo(GUID clsid) { } /** * - * Get the control site property specified by the dispIdMember. + * Get the control site property specified by the dispIdMember, or + * <code>null</code> if the dispId is not recognised. * - * @since 2.1 + * @param dispId the dispId + * + * @return the property value or <code>null</code> * + * @since 2.1 */ public Variant getSiteProperty(int dispId){ for (int i = 0; i < sitePropertyIds.length; i++) { @@ -782,6 +786,7 @@ void removeEventListener(int /*long*/ iunknown, GUID guid, int eventID, OleListe /** * Removes the listener. * + * @param propertyID the identifier of the property * @param listener the listener which should no longer be notified * * @exception IllegalArgumentException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleListener.java b/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleListener.java index 58265938f3..c5697a2275 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleListener.java +++ b/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleListener.java @@ -12,11 +12,26 @@ package org.eclipse.swt.ole.win32; /** + * Implementers of <code>OleListener</code> provide a simple + * <code>handleEvent()</code> method that is used internally + * by SWT to dispatch events. + * <p> + * After creating an instance of a class that implements this + * interface it can be added to an <code>OleControlSite</code> + * using the <code>addEventListener()</code> method and removed + * using the <code>removeEventListener()</code> method. When the + * specified event occurs, <code>handleEvent()</code> will be + * sent to the instance. + * </p> + * + * @see OleControlSite */ -public interface OleListener -{ +public interface OleListener { + /** + * Sent when an event that the receiver has registered for occurs. * + * @param event the event which occurred */ public void handleEvent(OleEvent event); } |