[gnue] r8388 - trunk/gnue-designer/doc/technotes

[jcater]

Author: jcater
Date: 2006-04-06 21:03:25 -0500 (Thu, 06 Apr 2006)
New Revision: 8388

Added:
   trunk/gnue-designer/doc/technotes/00004.txt
Modified:
   trunk/gnue-designer/doc/technotes/00003.txt
Log:
added a technote on GObject class extensions for Designer-loaded documents

Modified: trunk/gnue-designer/doc/technotes/00003.txt
===================================================================
--- trunk/gnue-designer/doc/technotes/00003.txt 2006-04-07 01:51:42 UTC (rev 
8387)
+++ trunk/gnue-designer/doc/technotes/00003.txt 2006-04-07 02:03:25 UTC (rev 
8388)
@@ -4,12 +4,58 @@
 
 
 ObjectModified
+
+    Called when an object is modified. 
+
+    It will have the following attributes: 
+       object    The GObject being modified
+       
+       old       A dictionary containing modified attributes
+                 and their original values.  If an attribute 
+                 is being set, but was not previously set, 
+                 then the attribute will have an entry in "new"
+                 but not "old". 
+
+          new       A dictionary containing modified attributes
+                 and their new values. 
+
+    When ObjectModified is called, any attributes changes should
+    already have been made to the GObject. 
+
 ObjectDeleted
+
+    Called when an object is being deleted. 
+
 ObjectCreated
+
+    Called after an object is freshly created. 
+
+InventoryObject
+
+    Called as an object is being inventoried for the first time. 
+    
+    The difference between InventoryObject and ObjectCreated
+    is that Inventory will always be called exactly once
+    for every object in a GObject tree, including when the 
+    document is first loaded.  ObjectCreated is only called 
+    when a new object is added to an already loaded document. 
+
 ObjectSelected
 
-MakeDirty -- Called after a document has been modified
-MakeClean -- Called after a document has been saved
+    Called when an object has been selected. 
 
+MakeDirty
+   
+    Called after a document has been modified
+
+MakeClean
+
+   Called after a document has been saved
+
+DocumentClosing -- Called when a document is being closed
+                   A certain amount of cleanup should happen 
+                   by tools.
+
 BeginWizard -- Called whenever a wizard has been selected to run
+
 EndWizard -- Called whenever a wizard has finished running

Added: trunk/gnue-designer/doc/technotes/00004.txt
===================================================================
--- trunk/gnue-designer/doc/technotes/00004.txt 2006-04-07 01:51:42 UTC (rev 
8387)
+++ trunk/gnue-designer/doc/technotes/00004.txt 2006-04-07 02:03:25 UTC (rev 
8388)
@@ -0,0 +1,30 @@
+Title: Runtime Modifications to GObjects in Designer
+Status: Current
+Created: 06 April 2006
+
+Designer adds the following properties to any GObject created: 
+
+  * dispatch_designer_event() 
+   
+    Dispatches an Event with 
+    object pre-set to the current GObject. 
+
+    Syntax:   gobject.dispatch_designer_event('EventName',param=value)
+
+    This is equivalent to: 
+       EventController.dispatchEvent('EventName', object=gobject, param=value)
+
+  
+  * gobject_attributes
+
+    The appropriate GParser definition for this object.
+
+
+  * Any attribute assignments using a dict-style assignment will cause
+    an ObjectModified event to be called. 
+
+    For example: 
+      gobject['label'] = 'New Label'
+
+    will cause an ObjectModified event to be called with the new and old 
+    label values indicated. 
\ No newline at end of file