Update of /cvsroot/dynapi/dynapi/docs/config/data/dynapi/api
In directory usw-pr-cvs1:/tmp/cvs-serv25888/data/dynapi/api
Modified Files:
events.js dynlayer.js dyndocument.js dragevent.js browser.js
Log Message:
Documentation updates.
Index: events.js
===================================================================
RCS file: /cvsroot/dynapi/dynapi/docs/config/data/dynapi/api/events.js,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** events.js 2001/01/20 21:36:13 1.1
--- events.js 2001/01/21 06:08:55 1.2
***************
*** 1,4 ****
/// Event Class
-
class DynEvent {
private:
--- 1,3 ----
***************
*** 18,22 ****
/// Event Listener Class
-
class EventListener {
private:
--- 17,20 ----
***************
*** 29,33 ****
/// Mouse Event Class
-
class MouseEvent {
private:
--- 27,30 ----
***************
*** 39,49 ****
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();
--- 36,46 ----
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();
***************
*** 63,69 ****
--- 60,70 ----
/// 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
void removeEventListener(EventListener listener);
+ /// Removes all EventListeners from the DynLayer
void removeAllEventListeners();
+ /// Invokes an event on the DynLayer
void invokeEvent(string type,Event e);
};
***************
*** 75,88 ****
void EventMethod();
public:
! /// \see DynLayer::captureMouseEvents
void captureMouseEvents();
void releaseMouseEvents();
! /// \see DynLayer::addEventListener
void addEventListener(EventListener listener);
! /// \see DynLayer::removeEventListener
void removeEventListener(EventListener listener);
! /// \see DynLayer::removeAllEventListeners
void removeAllEventListeners();
! /// \see DynLayer::invokeEvent
void invokeEvent(string type,Event e);
};
--- 76,89 ----
void EventMethod();
public:
! /// @see DynLayer::captureMouseEvents
void captureMouseEvents();
void releaseMouseEvents();
! /// @see DynLayer::addEventListener
void addEventListener(EventListener listener);
! /// @see DynLayer::removeEventListener
void removeEventListener(EventListener listener);
! /// @see DynLayer::removeAllEventListeners
void removeAllEventListeners();
! /// @see DynLayer::invokeEvent
void invokeEvent(string type,Event e);
};
Index: dynlayer.js
===================================================================
RCS file: /cvsroot/dynapi/dynapi/docs/config/data/dynapi/api/dynlayer.js,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** dynlayer.js 2001/01/20 21:36:13 1.1
--- dynlayer.js 2001/01/21 06:08:55 1.2
***************
*** 1,4 ****
! /// Layer Class
! /**
* The DynLayer provides the basic functionality to control DHTML elements.
* Other higher-level objects use many DynLayers which interact with each other
--- 1,4 ----
! /** Layer Class
! *
* The DynLayer provides the basic functionality to control DHTML elements.
* Other higher-level objects use many DynLayers which interact with each other
***************
*** 32,39 ****
void addChildID(DynLayer child);
public:
! /// Creates a new DynLayer object with the given parameters.
! /**
* All parameters are optional. A unique layer id will be
* created if no id is given.
*/
DynLayer(string id,int x,int y,int w,int h,string bgColor,string visible,int
zIndex,string bgImage);
--- 32,44 ----
void addChildID(DynLayer child);
public:
! /** Creates a new DynLayer object with the given parameters.
! *
* All parameters are optional. A unique layer id will be
* created if no id is given.
+ *
+ * General method of creating a DynLayer:
+ * @code
+ * mylayer = new DynLayer();
+ * @endcode
*/
DynLayer(string id,int x,int y,int w,int h,string bgColor,string visible,int
zIndex,string bgImage);
***************
*** 51,56 ****
void deleteFromParent();
string getOuterHTML();
! /// Sets the DynLayer styles
! /**
* Object properties that can be set are:
* style.id
--- 56,61 ----
void deleteFromParent();
string getOuterHTML();
! /** Sets the DynLayer styles
! *
* Object properties that can be set are:
* style.id
***************
*** 84,94 ****
/// Sets the vertical value of the DynLayer
void setPageY(int y);
! /// 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
*/
--- 89,99 ----
/// Sets the vertical value of the DynLayer
void setPageY(int y);
! /** 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
*/
***************
*** 106,131 ****
/// Returns the background color of the layer
string getBgColor();
! /// Sets the DynLayer object's HTML
! /**
* If noevt is false, then no event is fired
*/
void setHTML(string html,boolean noevt);
! /// Returns the html
! /**
* If the html is empty, then an empty string ('') is returned.
*/
string getHTML();
! /// Sets the size of the DynLayer
! /**
* If noevt is false, then no event is fired
*/
void setSize(int w,int h,boolean noevt);
! /// Sets the width of the DynLayer
! /**
* If noevt is false, then no event is fired
*/
void setWidth(int w,boolean noevt);
! /// Sets the height of the DynLayer
! /**
* If noevt is false, then no event is fired
*/
--- 111,136 ----
/// Returns the background color of the layer
string getBgColor();
! /** Sets the DynLayer object's HTML
! *
* If noevt is false, then no event is fired
*/
void setHTML(string html,boolean noevt);
! /** Returns the html
! *
* If the html is empty, then an empty string ('') is returned.
*/
string getHTML();
! /** Sets the size of the DynLayer
! *
* If noevt is false, then no event is fired
*/
void setSize(int w,int h,boolean noevt);
! /** Sets the width of the DynLayer
! *
* If noevt is false, then no event is fired
*/
void setWidth(int w,boolean noevt);
! /** Sets the height of the DynLayer
! *
* If noevt is false, then no event is fired
*/
***************
*** 141,145 ****
void setClip(int clip[]);
/// Returns a array of length 4 containing the clip values
[right,left,top,bottom]
! int[] getClip();
void invokeEvent();
};
--- 146,150 ----
void setClip(int clip[]);
/// Returns a array of length 4 containing the clip values
[right,left,top,bottom]
! int getClip();
void invokeEvent();
};
Index: dyndocument.js
===================================================================
RCS file: /cvsroot/dynapi/dynapi/docs/config/data/dynapi/api/dyndocument.js,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** dyndocument.js 2001/01/20 21:36:13 1.1
--- dyndocument.js 2001/01/21 06:08:55 1.2
***************
*** 1,4 ****
/// Document Class
-
class DynDocument {
private:
--- 1,3 ----
***************
*** 7,12 ****
/// Stores a id of all DynDocument objects
static string dyndocsID[];
! /// Internally used to create unique id's
! /// \see DynLayer::nullCount
static int nullCount;
object elm;
--- 6,13 ----
/// Stores a id of all DynDocument objects
static string dyndocsID[];
! /** Internally used to create unique id's
! *
! * @see DynLayer::nullCount
! */
static int nullCount;
object elm;
***************
*** 14,20 ****
string fgColor;
string bgColor;
! /// \see DynLayer::isChild
boolean isChild;
! /// \see DynLayer::created
boolean created;
/// Set to true for all DynDocument objects
--- 15,21 ----
string fgColor;
string bgColor;
! /// @see DynLayer::isChild
boolean isChild;
! /// @see DynLayer::created
boolean created;
/// Set to true for all DynDocument objects
***************
*** 29,33 ****
DynDocument doc;
string all[];
! /// \see DynLayer::children
DynLayer children[];
/// Unique id for the DynDocument
--- 30,34 ----
DynDocument doc;
string all[];
! /// @see DynLayer::children
DynLayer children[];
/// Unique id for the DynDocument
***************
*** 36,60 ****
string toString();
object getClass();
! /// \see DynLayer::addChild
void addChild(DynDocument child);
! /// \see DynLayer::removeChild
void removeChild(DynDocument child);
! /// \see DynLayer::deleteChild
void deleteChild(DynDocument child);
! /// \see DynLayer::deleteAllChildren
void deleteAllChildren();
/// Recreates all of the elements of the document
void recreateAll();
! /// Retuns 0
! /// \see DynLayer::getX
int getX();
! /// Retuns 0
! /// \see DynLayer::getY
int getY();
! /// Retuns 0
! /// \see DynLayer::getPageX
int getPageX();
! /// Retuns 0
! /// \see DynLayer::getPageY
int getPageY();
/// Returns the document width
--- 37,69 ----
string toString();
object getClass();
! /// @see DynLayer::addChild
void addChild(DynDocument child);
! /// @see DynLayer::removeChild
void removeChild(DynDocument child);
! /// @see DynLayer::deleteChild
void deleteChild(DynDocument child);
! /// @see DynLayer::deleteAllChildren
void deleteAllChildren();
/// Recreates all of the elements of the document
void recreateAll();
! /** Returns 0
! *
! * @see DynLayer::getX
! */
int getX();
! /** Returns 0
! *
! * @see DynLayer::getY
! */
int getY();
! /** Returns 0
! *
! * @see DynLayer::getPageX
! */
int getPageX();
! /** Returns 0
! *
! * @see DynLayer::getPageY
! */
int getPageY();
/// Returns the document width
Index: dragevent.js
===================================================================
RCS file: /cvsroot/dynapi/dynapi/docs/config/data/dynapi/api/dragevent.js,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** dragevent.js 2001/01/20 21:36:13 1.1
--- dragevent.js 2001/01/21 06:08:55 1.2
***************
*** 1,4 ****
/// Drag Event Class
-
class DragEvent {
private:
--- 1,3 ----
***************
*** 20,40 ****
DragEvent(string type, object src);
/// Returns the event type
! /// \see DynEvent::getType
string getType();
/// Returns the event source
! /// \see DynEvent::getSource
object getSource();
/// Returns the event target
! /// \see DynEvent::getTarget
object getTarget();
! /// \see DynLayer::getX
int getX();
! /// \see DynLayer::getY
int getY();
! /// \see DynLayer::getPageX
int getPageX();
! /// \see DynLayer::getPageY
int getPageY();
! /// \see MouseEvent::setBubble
void setBubble(boolean bubble);
/// Cancels the drag
--- 19,39 ----
DragEvent(string type, object src);
/// Returns the event type
! /// @see DynEvent::getType
string getType();
/// Returns the event source
! /// @see DynEvent::getSource
object getSource();
/// Returns the event target
! /// @see DynEvent::getTarget
object getTarget();
! /// @see DynLayer::getX
int getX();
! /// @see DynLayer::getY
int getY();
! /// @see DynLayer::getPageX
int getPageX();
! /// @see DynLayer::getPageY
int getPageY();
! /// @see MouseEvent::setBubble
void setBubble(boolean bubble);
/// Cancels the drag
Index: browser.js
===================================================================
RCS file: /cvsroot/dynapi/dynapi/docs/config/data/dynapi/api/browser.js,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** browser.js 2001/01/20 21:36:13 1.1
--- browser.js 2001/01/21 06:08:55 1.2
***************
*** 1,8 ****
! /// Browser-Dection Class
! /**
* 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:
! * if (is.ns) {}
*/
class Browser {
--- 1,12 ----
! /** Browser-Dection Class
! *
* 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
*/
class Browser {
_______________________________________________
Dynapi-CVS mailing list
[EMAIL PROTECTED]
http://lists.sourceforge.net/lists/listinfo/dynapi-cvs
