Update of /cvsroot/dynapi/dynapi/docs/config/data/dynapi/api
In directory usw-pr-cvs1:/tmp/cvs-serv28156
Modified Files:
events.js dynlayer.js dyndocument.js browser.js
Log Message:
More Documentation updates.
Index: events.js
===================================================================
RCS file: /cvsroot/dynapi/dynapi/docs/config/data/dynapi/api/events.js,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** events.js 2001/01/21 06:08:55 1.2
--- events.js 2001/01/21 21:15:09 1.3
***************
*** 7,15 ****
public:
DynEvent(string type,object src,object target);
! /// Returns the event type
string getType();
! /// Returns the event source
object getSource();
! /// Returns the event target
object getTarget();
};
--- 7,24 ----
public:
DynEvent(string type,object src,object target);
! /** Returns the type
! *
! * @return type of the event as a string
! */
string getType();
! /** Returns the source
! *
! * @return source object for the event
! */
object getSource();
! /** Returns the target
! *
! * @return target object for the event
! */
object getTarget();
};
***************
*** 22,25 ****
--- 31,44 ----
void handleEvent(object target);
public:
+ /** Creates a new EventListener
+ *
+ * @param target The EventListener's target object
+ *
+ * Example Usage:
+ * @code
+ * mylayer = new DynLayer();
+ * var listener = new EventListener(mylayer);
+ * @endcode
+ */
EventListener(object target);
};
***************
*** 35,46 ****
void bubbleEvent();
public:
! /// Returns the event type
! /// @see DynEvent::getType
string getType();
! /// Returns the event source
! /// @see DynEvent::getSoure
object getSource();
! /// Returns the event target
! /// @see DynEvent::getTarget
object getTarget();
int getX();
--- 54,71 ----
void bubbleEvent();
public:
! /** Returns the event type
! *
! * @see DynEvent::getType
! */
string getType();
! /** Returns the event source
! *
! * @see DynEvent::getSoure
! */
object getSource();
! /** Returns the event target
! *
! * @see DynEvent::getTarget
! */
object getTarget();
int getX();
***************
*** 48,52 ****
--- 73,82 ----
int getPageX();
int getPageY();
+ /** Sets bubble event
+ *
+ * @param bubble Determines whether or not to bubble the MouseEvent
+ */
void setBubble(boolean bubble);
+ /// Cancels the event
void cancelBrowserEvent();
};
***************
*** 60,64 ****
/// Captures the mouse events for the layer
void captureMouseEvents();
! /// Adds the EventListener to the DynLayer
void addEventListener(EventListener listener);
/// Removes the EventListener from the DynLayer
--- 90,101 ----
/// Captures the mouse events for the layer
void captureMouseEvents();
! /** Adds the EventListener to the DynLayer
! *
! * Example Usage:
! * @code
! * var x = new EventListener(mylayer);
! * mylayer.addEventListner(x);
! * @endcode
! */
void addEventListener(EventListener listener);
/// Removes the EventListener from the DynLayer
Index: dynlayer.js
===================================================================
RCS file: /cvsroot/dynapi/dynapi/docs/config/data/dynapi/api/dynlayer.js,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** dynlayer.js 2001/01/21 07:03:51 1.3
--- dynlayer.js 2001/01/21 21:15:09 1.4
***************
*** 23,26 ****
--- 23,27 ----
/// Invokes the precreate event for the given DynLayer
static void flagPrecreate(DynLayer dlyr);
+ /// Invokes the predelete event for the given DynLayer
static void flagDeleteChildren(DynLayer dlyr);
/// Set to true for all DynLayer objects
***************
*** 56,60 ****
* created if no id is given.
*
! * General method of creating a DynLayer:
* @code
* mylayer = new DynLayer();
--- 57,61 ----
* created if no id is given.
*
! * Example Usage:
* @code
* mylayer = new DynLayer();
***************
*** 63,78 ****
DynLayer(string id,int x,int y,int w,int h,string bgColor,string visible,int
zIndex,string bgImage);
DynLayer children[];
! /// Adds the given DynLayer(s) to this DynLayer
void addChild(DynLayer dlyr);
/// Removes the given child
void removeChild(DynLayer child);
! /// Removes this from the parent
void removeFromParent();
/// Deletes the child object permanently from the document
void deleteChild(DynLayer child);
! /// Deletes all of the children from this
void deleteAllChildren();
! /// Deletes this from its parent
void deleteFromParent();
string getOuterHTML();
/** Sets the DynLayer styles
--- 64,93 ----
DynLayer(string id,int x,int y,int w,int h,string bgColor,string visible,int
zIndex,string bgImage);
DynLayer children[];
! /** Adds the given DynLayer(s) to this DynLayer
! *
! * @note Once a layer has been added to a document, it may not be
! * added again. You must use removeChild first.
! */
void addChild(DynLayer dlyr);
/// Removes the given child
void removeChild(DynLayer child);
! /** Removes this from the parent
! *
! * @see removeChild
! */
void removeFromParent();
/// Deletes the child object permanently from the document
void deleteChild(DynLayer child);
! /** Deletes all of the children from this
! *
! * @see deleteChild
! */
void deleteAllChildren();
! /** Deletes this from its parent
! *
! * @see deleteChild
! */
void deleteFromParent();
+ /// Includes the html for the DynLayer including its children
string getOuterHTML();
/** Sets the DynLayer styles
***************
*** 87,90 ****
--- 102,113 ----
* style.visibility
* style.zIndex;
+ *
+ * Example Usage:
+ * @code
+ * var style = new Object();
+ * style.left = 4
+ * style.height = 11
+ * mylayer.getStyle(style);
+ * @endcode
*/
void setStyle(object style);
***************
*** 111,120 ****
/** Sets the DynLayer visible
*
! * true shows the layer and false hides the layer
*/
void setVisible(boolean visible);
/** Returns the layer's visibility
*
! * true for visible and false for hidden
*/
boolean getVisible();
--- 134,144 ----
/** Sets the DynLayer visible
*
! * @param true shows the layer and false hides the layer
*/
void setVisible(boolean visible);
/** Returns the layer's visibility
*
! * @retval true layer is visible
! * @retval false layer is hidden
*/
boolean getVisible();
Index: dyndocument.js
===================================================================
RCS file: /cvsroot/dynapi/dynapi/docs/config/data/dynapi/api/dyndocument.js,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** dyndocument.js 2001/01/21 07:03:51 1.3
--- dyndocument.js 2001/01/21 21:15:09 1.4
***************
*** 21,24 ****
--- 21,25 ----
/// Set to true for all DynDocument objects
boolean isDynDocument;
+ /// @see DynLayer::addChildID
void addChildID(DynDocument child);
/// Finds the document dimensions
Index: browser.js
===================================================================
RCS file: /cvsroot/dynapi/dynapi/docs/config/data/dynapi/api/browser.js,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** browser.js 2001/01/21 06:08:55 1.2
--- browser.js 2001/01/21 21:15:09 1.3
***************
*** 2,11 ****
*
* The Browser class is automatically initialized as DynAPI.browser and
! * a global "is" Browser object. To test the clients' browser for Netscape,
! * you would say:
* @code
! * if (is.ns) {
! *
! * }
* @endcode
*/
--- 2,13 ----
*
* The Browser class is automatically initialized as DynAPI.browser and
! * a global "is" Browser object. The Browser Class allows you to test
! * for the client's browser type.
! *
! * Example Usage:
* @code
! * if (is.ns) { }
! * else if (is.ie) { }
! * else if (is.opera { }
* @endcode
*/
***************
*** 21,25 ****
string ua;
public:
! /// Initializes all properties of the Browser class
Browser();
/// Boolean value for Netscape
--- 23,30 ----
string ua;
public:
! /** Initializes all properties of the Browser class
! *
! * @note This class is intialized globally as "is" and "DynAPI.browser".
! */
Browser();
/// Boolean value for Netscape
_______________________________________________
Dynapi-CVS mailing list
[EMAIL PROTECTED]
http://lists.sourceforge.net/lists/listinfo/dynapi-cvs
