Changeset 237 for trunk/desktop/idl/wpobject.idl

Timestamp:

Feb 11, 2007, 4:52:34 PM (19 years ago)

Author:

cinc

Message:

Started drag and drop implementation. Some dox additions.

File:

• trunk/desktop/idl/wpobject.idl (modified) (16 diffs)

trunk/desktop/idl/wpobject.idl

@@ -16 +16 @@
 * The Initial Developer of the Original Code is
 * netlabs.org: Chris Wohlgemuth <cinc-ml@netlabs.org>.
-* Portions created by the Initial Developer are Copyright (C) 2005-2006
+* Portions created by the Initial Developer are Copyright (C) 2005-2007
 * the Initial Developer. All Rights Reserved.
 *
@@ -73 +73 @@
      is tracked in the objects inuse list.
 
-     \par How to override
+     \par How to override:
      This method is usually not overriden.
 
@@ -89 +89 @@
      will be collected later.
 
-     \par How to override
+     \par How to override:
      This method is usually not overriden.
 
@@ -104 +104 @@
      \remark Desktop classes should override this method instead of nomInit().
 
-     \par How to override
+     \par How to override:
      This method should be overriden by classes which need initialization. The parent
      must be called first.
@@ -129 +129 @@
      taken into account. wpViewObject() should be called most of the time.
 
-     \par How to override
+     \par How to override:
      Desktop objects override this method when they have a private view.
 
@@ -149 +149 @@
      that the method call itself is not.
 
-     \par How to override
+     \par How to override:
      This method is usually not overriden.
 
@@ -163 +163 @@
      that the method call itself is not.
 
-     \par How to override
+     \par How to override:
      This method is usually not overriden.
 
@@ -176 +176 @@
      in a multithreaded environment other threads may alter the use counter at any time.
 
-     \par How to override
+     \par How to override:
      This method is usually not overriden.
 
@@ -187 +187 @@
 
   /**
-
+     Request the object semaphor which protects the objects data structures. For example
+     before changing the in use list of the object the semaphor is aquired to prevent
+     access from several places at the same time.
+
+     \par How to override
+     This method is usually not overriden.
+
+     \return 0 if no error occured. Any other value describes an error.
+
+     \sa wpReleaseObjectMutexSem()
    */
   unsigned long  wpRequestObjectMutexSem(in unsigned long ulReserved);
-  unsigned long  wpReleaseObjectMutexSem();
+
+  /**
+     Release the object semaphor which protects the objects data structures. For example
+     before changing the in use list of the object the semaphor is aquired to prevent
+     access from several places at the same time.
+
+     \par How to override:
+     This method is usually not overriden.
+
+     \return 0 if no error occured. Any other value describes an error.
+
+     \sa wpRequestObjectMutexSem()
+   */
+  unsigned long wpReleaseObjectMutexSem();
 
   void wpSetTitle(in PNOMString pnomStrNewTitle);
@@ -218 +240 @@
      \remark This method should be use in preference to the wpOpen() method.
 
-     \par How to override
+     \par How to override:
      This method is usually not overriden.
 
@@ -235 +257 @@
      Search the objects inuse list for the given view and if found bring it to the front.
 
-     \par How to override
+     \par How to override:
      This method is usually not overriden.
 
@@ -253 +275 @@
      memory used by the object, open views and some more.
 
-     \How to override
-     This method is usually not overriden.
-
-     \param
+     \par How to override:
+     This method is usually not overriden.
+
+
      \return TRUE if success.
 
@@ -267 +289 @@
      memory used by the object, open views and some more.
 
-     \remark The use item will not be freed by this method.
-
-     \par How to override
+     \remark The use item will not be freed by this method. This must be done by the caller.
+
+     \par How to override:
      This method is usually not overriden.
 
@@ -288 +310 @@
   boolean wpSaveImmediate();
 
+  /**
+     Set the information about the folder this object is living in. This method is called for
+     example if the object is moved to another location.
+
+     \par How to override:
+     This method is usually not overriden.
+
+     \param wpParentFolder The folder this object is living in.
+     \return Folder object. Note that this is not a folder view (window).
+
+     \sa wpQueryFolder()
+   */
   void wpSetFolder(in PWPFolder wpParentFolder);
 
@@ -293 +327 @@
      Get the folder this object is living in.
 
-     \return Folder object. Note that this is not a folder view (window)
+     \par How to override:
+     This method is usually not overriden.
+
+     \return Folder object. Note that this is not a folder view (window).
 
      \sa wpSetFolder()
@@ -307 +344 @@
   gulong wpQueryConcurrentView();
 
+  gulong wpDragOver(in gpointer containerHandle, in gpointer pDragInfo);
+
+  gulong wpDrop(in gpointer containerHandle, in gpointer pDragInfo);
   /* Methods overriden by this class */