/**
* @class XObject
- * @namespace XObject
*
* Yet another attempt to create a usable object construction library for seed..
*
* Extend this.. to use it's wonderful features..
*
* normal usage:
+ * <pre><code>
* XObject = imports.XObject.XObject;
*
* Xyz = new XObject({
* ]
* });
* Xyz.init(); // create and show.
- *
+ * </code></pre>
*
* He's some questions.
* - should we generate ID's for all elements? (if so we probably need to garbage collect)
* @cfg listeners {Object} (optional) map Gobject signals to functions
* @cfg pack {Function|String|Array} (optional) how this object gets added to it's parent
* @cfg el {Object} (optional) premade GObject
- *
- *
- *
-
- *
+ *
*/
function XObject (cfg) {
XObject.prototype = {
/**
- * @property el {GObject} the Gtk / etc. element.
+ * @type {GObject}
+ * the Gtk / GObject element.
*/
el : false,
- /*
- * @property items {Array} list of sub elements
+ /**
+ * @type {Array}
+ * list of sub elements
*/
items : false,
/**
- * @property parent {XObject} parent Element
+ * @type {XObject}
+ * parent Element
*/
parent: false,
/**
- * @property config {Object} the construction configuration.
+ * @type {Object}
+ * the constructor configuration.
*/
config: false,
/**
- * @method init
* Initializes the Element (el) hooks up all the listeners
* and packs the children.
* you can override this, in child objects, then
/**
- * @method addItem
* Adds an item to the object using a new XObject
* uses pack property to determine how to add it.
- * @arg cfg {Object} same as XObject constructor.
+ * @param {Object} o same as XObject constructor.
*/
addItem : function(o) {
},
/**
- * @method addListener
* Connects a method to a signal. (gjs/Seed aware)
*
- * @arg sig {String} name of signal
- * @arg fn {Function} handler.
+ * @param {String} sig name of signal
+ * @param {Function} fn handler.
*/
addListener : function(sig, fn)
{
},
/**
- * @method get
* Finds an object in the child elements using xid of object.
* prefix with '.' to look up the tree.. multiple '..' to look further up..
*
- * @arg name {String} name of signal
+ * @param {String} name name of signal
* @return {XObject|false} the object if found.
*/
get : function(xid)