Changeset 251 for trunk/nom/idl

Timestamp:

Mar 11, 2007, 2:22:39 PM (19 years ago)

Author:

cinc

Message:

Implemented some methods. Bug fixes and documentation.

Location:

trunk/nom/idl

Files:

• nomcls.idl (modified) (5 diffs)
• nomobj.idl (modified) (1 diff)

trunk/nom/idl/nomcls.idl

@@ -65 +65 @@
 
   /**
-     This method returns the name of the class this class object is an instance of.
+     This method returns the name of the class this class object is the meta class of. This
+     means the returned string is the name of the class the metaclass creates instances of.
+
+     \remarks This method used to be called nomGetName().
 
      \par How to override:
      This method is usually not overriden.
 
-     \sa impl_NOMClass_nomGetName()
+     \sa nomGetClassName()
    */
-  string nomGetName();
+  string nomGetCreatedClassName();
 
   /**
@@ -104 +107 @@
      method is always called during object creation.
 
-     \par How to override
+     \par How to override:
      This method can be overriden to track the creation of objects. When doing so
      the parent should be called first.
@@ -130 +133 @@
      this method does nothing. It's for compatibility with ported code.
 
-     \par How to override
+     \par How to override:
      This method is usually not overriden.
  
@@ -137 +140 @@
   void nomDeallocate(in gpointer memptr);
   void nomSetObjectCreateInfo(in gpointer ncpObject);
+
+  /**
+     \remarks
+     The return type may change.
+   */
   gpointer nomGetObjectCreateInfo();
 
@@ -145 +153 @@
      also be registered.
 
+     \remarks This method is only called by the system during class creation.
+
+     \par How to override:
+     This method is usually not overriden.
+
      \sa impl_NOMClass_nomClassReady()
    */
   void nomClassReady();
 
+  /**
+     \warning
+     The type of this variable will change!
+  */
   NOMINSTANCEVAR(string ncpObject);     //NOMClassPriv structure holding info about the object this class can create
   NOMOVERRIDE(nomInit); 

trunk/nom/idl/nomobj.idl

@@ -161 +161 @@
    */
   PNOMObject new();
+
+  /**
+     This method checks if the object is an instance of the given class or some subclass. Using
+     this method one can make sure some feature is available if the introducing class is known.
+     Every subclass of a given class also supports the features of the introducing class. 
+
+     \remarks This method checks the validity of \e nomClass using nomIsObj() and returns FALSE
+     in case it's not an object.
+
+     \param nomClass Pointer to a class object.
+
+     \returns TRUE if the object is an instance of the given class or one of its
+     subclasses.
+
+     \sa nomIsInstanceOf()
+   */
+  boolean nomIsA(in PNOMClass nomClass);
+
+  /**
+     This method checks if the object is an instance of exactly the given class.
+
+
+     \remarks This method checks the validity of \e nomClass using nomIsObj() and returns FALSE
+     in case it's not an object.
+
+     \param nomClass Pointer to a class object.
+
+     \returns TRUE if the object is an instance of exactly the given class.
+
+     \sa nomIsA()
+   */
+  boolean nomIsInstanceOf(in PNOMClass nomClass);
+  /**
+     This method returns the name of the class this object is an instance of.
+     
+     \par How to override:
+     This method is usually not overriden.
+     
+     \returns A null terminated C string. Note that this is not a copy. The string
+     is valid as long as the class object exists (not the instance).
+
+     \sa impl_NOMClass_nomGetClassName()
+  */
+  string nomGetClassName();
+
+
 };