diff dwt/ole/win32/OleClientSite.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/OleClientSite.d	Tue Jul 01 08:58:50 2008 +0200
+++ b/dwt/ole/win32/OleClientSite.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
@@ -86,6 +86,8 @@
  *  <dt><b>Events</b> <dd>Dispose, Move, Resize
  * </dl>
  *
+ * @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 class OleClientSite : Composite {
 
@@ -633,6 +635,14 @@
     }
     return xFormHimetricToPixels(sizel);
 }
+/**
+ * Returns the indent value that would be used to compute the clipping area
+ * of the active X object.
+ * 
+ * NOTE: The indent value is no longer being used by the client site.
+ * 
+ * @return the rectangle representing the indent
+ */
 public Rectangle getIndent() {
     return new Rectangle(indent.left, indent.right, indent.top, indent.bottom);
 }
@@ -740,6 +750,14 @@
 
     return COM.S_OK;
 }
+/**
+ * Returns whether ole document is dirty by checking whether the content 
+ * of the file representing the document is dirty.
+ * 
+ * @return <code>true</code> if the document has been modified,
+ *         <code>false</code> otherwise.
+ * @since 3.1
+ */
 public bool isDirty() {
     /*
      *  Note: this method must return true unless it is absolutely clear that the
@@ -987,7 +1005,7 @@
 }
 protected void releaseObjectInterfaces() {
 
-    if (objIOleInPlaceObject!is null)
+    if (objIOleInPlaceObject !is null)
         objIOleInPlaceObject.Release();
     objIOleInPlaceObject = null;
 
@@ -1019,6 +1037,17 @@
 
     COM.CoFreeUnusedLibraries();
 }
+/**
+ * Saves the document to the specified file and includes OLE specific information if specified.  
+ * This method must <b>only</b> be used for files that have an OLE Storage format.  For example, 
+ * a word file edited with Word.Document should be saved using this method because there is 
+ * formating information that should be stored in the OLE specific Storage format.
+ *
+ * @param file the file to which the changes are to be saved
+ * @param includeOleInfo the flag to indicate whether OLE specific information should be saved.
+ *
+ * @return true if the save was successful
+ */
 public bool save(File file, bool includeOleInfo) {
     if (includeOleInfo)
         return saveToStorageFile(file);
@@ -1210,6 +1239,11 @@
             objIOleObject.Close(COM.OLECLOSE_SAVEIFDIRTY);
     }
 }
+/**
+ * The indent value is no longer being used by the client site.
+ * 
+ * @param newIndent the rectangle representing the indent amount
+ */
 public void setIndent(Rectangle newIndent) {
     indent.left = newIndent.x;
     indent.right = newIndent.width;