From d117a0ec3ab433d798117fcb00540c51f5bda117 Mon Sep 17 00:00:00 2001 From: "pavlov%netscape.com" Date: Mon, 22 Jan 2001 07:32:41 +0000 Subject: [PATCH] some documentation changes git-svn-id: svn://10.0.0.236/trunk@85262 18797224-902f-48f8-a5cc-f745e15eee43 --- mozilla/gfx2/public/nsIImageContainer.idl | 19 +++++++++++-------- mozilla/gfx2/public/nsIImageFrame.idl | 12 ++++++------ mozilla/gfx2/src/windows/nsImageContainer.cpp | 2 +- 3 files changed, 18 insertions(+), 15 deletions(-) diff --git a/mozilla/gfx2/public/nsIImageContainer.idl b/mozilla/gfx2/public/nsIImageContainer.idl index 5c71a6b17af..b67cb7b7fbd 100644 --- a/mozilla/gfx2/public/nsIImageContainer.idl +++ b/mozilla/gfx2/public/nsIImageContainer.idl @@ -14,7 +14,7 @@ * * The Initial Developer of the Original Code is Netscape * Communications Corporation. Portions created by Netscape are - * Copyright (C) 2000-2001 Netscape Communications Corporation. All + * Copyright (C) 2001 Netscape Communications Corporation. All * Rights Reserved. * * Contributor(s): @@ -24,16 +24,14 @@ #include "nsISupports.idl" #include "gfxtypes.idl" -interface nsIDrawable; interface nsIImageFrame; interface nsIEnumerator; /** - * nsIImage interface + * nsIImageContainer interface * - * @author Tim Rowley * @author Stuart Parmenter - * @version 1.2 + * @version 0.1 * @see "gfx2" */ [scriptable, uuid(5e8405a4-1dd2-11b2-8385-bc8e3446cad3)] @@ -49,12 +47,12 @@ interface nsIImageContainer : nsISupports in gfx_dimension aHeight); /** - * The width of the image. + * The width of the container rectangle. */ readonly attribute gfx_dimension width; /** - * The height of the image. + * The height of the container rectangle. */ readonly attribute gfx_dimension height; @@ -65,11 +63,16 @@ interface nsIImageContainer : nsISupports readonly attribute nsIImageFrame currentFrame; - readonly attribute unsigned long numFrames; + nsIImageFrame getFrameAt(in unsigned long index); + /** + * Adds \a item to the end of the list of frames. + * @param item frame to add. + */ void appendFrame(in nsIImageFrame item); + void removeFrame(in nsIImageFrame item); nsIEnumerator enumerate(); diff --git a/mozilla/gfx2/public/nsIImageFrame.idl b/mozilla/gfx2/public/nsIImageFrame.idl index 0b4da693ac1..93a1d7e5a34 100644 --- a/mozilla/gfx2/public/nsIImageFrame.idl +++ b/mozilla/gfx2/public/nsIImageFrame.idl @@ -29,7 +29,7 @@ * * @author Tim Rowley * @author Stuart Parmenter - * @version 1.2 + * @version 0.1 * @see "gfx2" */ [scriptable, uuid(51cc27a8-1dd2-11b2-a1aa-dad33ab193b4)] @@ -38,8 +38,8 @@ interface nsIImageFrame : nsISupports /** * Create a new \a aWidth x \a aHeight sized image. * - * @param aX The offset from the nsIImageContainer parent at (0,0) - * @param aY The offset from the nsIImageContainer parent at (0,0) + * @param aX The x-offset from the origin of the nsIImageContainer parent. + * @param aY The y-offset from the origin of the nsIImageContainer parent. * @param aWidth The width of the image to create. * @param aHeight The height of the image to create. * @param aFormat the width of the image to create. @@ -54,12 +54,12 @@ interface nsIImageFrame : nsISupports /** - * The width of the image. + * The x-offset of the image. */ readonly attribute gfx_coord x; /** - * The width of the image. + * The y-offset of the image. */ readonly attribute gfx_coord y; @@ -74,7 +74,7 @@ interface nsIImageFrame : nsISupports readonly attribute gfx_dimension height; /** - * The width of the image. + * The rectangle this frame ocupies. */ [noscript] readonly attribute nsRect2 rect; diff --git a/mozilla/gfx2/src/windows/nsImageContainer.cpp b/mozilla/gfx2/src/windows/nsImageContainer.cpp index 62dd5c9fba8..c45183d88fc 100644 --- a/mozilla/gfx2/src/windows/nsImageContainer.cpp +++ b/mozilla/gfx2/src/windows/nsImageContainer.cpp @@ -14,7 +14,7 @@ * * The Initial Developer of the Original Code is Netscape * Communications Corporation. Portions created by Netscape are - * Copyright (C) 2000-2001 Netscape Communications Corporation. All + * Copyright (C) 2001 Netscape Communications Corporation. All * Rights Reserved. * * Contributor(s):