Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
imgIContainer Interface Reference

gfxIImageContainer interface More...

import "imgIContainer.idl";

Inheritance diagram for imgIContainer:
Inheritance graph
[legend]
Collaboration diagram for imgIContainer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void init (in PRInt32 aWidth, in PRInt32 aHeight, in imgIContainerObserver aObserver)
 Create a new aWidth x aHeight sized image container.
gfxIImageFrame getFrameAt (in unsigned long index)
void appendFrame (in gfxIImageFrame item)
 Adds item to the end of the list of frames.
void removeFrame (in gfxIImageFrame item)
void endFrameDecode (in unsigned long framenumber, in unsigned long timeout)
void decodingComplete ()
void clear ()
void startAnimation ()
void stopAnimation ()
void resetAnimation ()

Public Attributes

readonly attribute gfx_format preferredAlphaChannelFormat
readonly attribute PRInt32 width
 The width of the container rectangle.
readonly attribute PRInt32 height
 The height of the container rectangle.
readonly attribute gfxIImageFrame currentFrame
 Get the current frame that would be drawn if the image was to be drawn now.
readonly attribute unsigned long numFrames
const short kNormalAnimMode = 0
 Animation mode Constants 0 = normal 1 = don't animate 2 = loop once.
const short kDontAnimMode = 1
const short kLoopOnceAnimMode = 2
attribute unsigned short animationMode
attribute long loopCount
 number of times to loop the image.

Detailed Description

gfxIImageContainer interface

Author:
Stuart Parmenter pavlo.nosp@m.v@ne.nosp@m.tscap.nosp@m.e.co.nosp@m.m
Version:
0.1
See also:
"gfx2"

Definition at line 55 of file imgIContainer.idl.


Member Function Documentation

Adds item to the end of the list of frames.

Parameters:
itemframe to add.
void imgIContainer::endFrameDecode ( in unsigned long  framenumber,
in unsigned long  timeout 
)
void imgIContainer::init ( in PRInt32  aWidth,
in PRInt32  aHeight,
in imgIContainerObserver  aObserver 
)

Create a new aWidth x aHeight sized image container.

Parameters:
aWidthThe width of the container in which all the gfxIImageFrame children will fit.
aHeightThe height of the container in which all the gfxIImageFrame children will fit.
aObserverObserver to send animation notifications to.

Member Data Documentation

Definition at line 103 of file imgIContainer.idl.

Get the current frame that would be drawn if the image was to be drawn now.

Definition at line 88 of file imgIContainer.idl.

The height of the container rectangle.

Definition at line 82 of file imgIContainer.idl.

Definition at line 100 of file imgIContainer.idl.

Definition at line 101 of file imgIContainer.idl.

Animation mode Constants 0 = normal 1 = don't animate 2 = loop once.

Definition at line 99 of file imgIContainer.idl.

number of times to loop the image.

Note:
-1 means forever.

Definition at line 135 of file imgIContainer.idl.

Definition at line 91 of file imgIContainer.idl.

Definition at line 72 of file imgIContainer.idl.

The width of the container rectangle.

Definition at line 77 of file imgIContainer.idl.


The documentation for this interface was generated from the following file: