MSmilRegion Class Reference

class MSmilRegion

Interface representing a drawing region

Member Functions Documentation

AddMediaL(CSmilMedia *)

void AddMediaL ( CSmilMedia * aMedia ) [pure virtual]

Called to by the Engine to tell that a piece of media is currently visible on this region

Parameters

CSmilMedia * aMedia

BackgroundTransparent()

TBool BackgroundTransparent ( ) const [pure virtual]

Is background transparent?

ContainsMedia(const CSmilMedia *)

TBool ContainsMedia ( const CSmilMedia * aMedia ) const [pure virtual]

Is the media currently visible on the region?

Parameters

const CSmilMedia * aMedia

GetBackground()

TRgb GetBackground ( ) const [pure virtual]

Background color

GetBackgroundMode()

TBgMode GetBackgroundMode ( ) const [pure virtual]

Background mode of the region. Values match those of SMIL showBackground attribute:

EAlways - background is always drawn EWhenActive - background is drawn when some media is active on the region

GetFit()

TFit GetFit ( ) const [pure virtual]

Value of SMIL fit attribute. Values are:

EFill - media on this regions is scaled to fill it EMeet - media is scaled so that it fills the region in one direction while maintaining the aspect ratio ESlice - scale media to fill the region, while maintaining the aspect ration and slicing off the overflowing part EScroll - provide scrolling mechanism for the media EHidden - don't scale, slice off the overflow

GetForeground()

TRgb GetForeground ( ) const [pure virtual]

Foreground color

GetRectangle()

TRect GetRectangle ( ) const [pure virtual]

Coordinates of the drawing area

GetRectangle(const CSmilMedia *)

TRect GetRectangle ( const CSmilMedia * aMedia ) const [pure virtual]

Coordinates of the media object within the rectangle. Empty rect if the media is not visible on the region

Parameters

const CSmilMedia * aMedia

GetZIndex()

TInt GetZIndex ( ) const [pure virtual]

z-index of the region. Regions with higher z-index are drawn on top of lower ones

IsRoot()

TBool IsRoot ( ) const [pure virtual]

True if this is the root region

MediaTransitionEnd(CSmilMedia *)

void MediaTransitionEnd ( CSmilMedia * aMedia ) [pure virtual]

Called to by the Engine to tell that a piece of media on the region has ended its transition (and fill=transition semantics should be applied)

Parameters

CSmilMedia * aMedia

Parent()

MSmilRegion * Parent ( ) const [pure virtual]

Return the parent region

Redraw()

void Redraw ( ) [pure virtual]

Requests redrawing of this region and its visible contents

Redraw(TRect)

void Redraw ( TRect aUpdate ) [pure virtual]

Requests redrawing of this region and its visible contents. Update area is given in the coordinate space of the region

Parameters

TRect aUpdate

RemoveMedia(CSmilMedia *)

void RemoveMedia ( CSmilMedia * aMedia ) [pure virtual]

Called to by the Engine to tell that a piece of media is no longer visible on this region

Parameters

CSmilMedia * aMedia

Root()

MSmilRegion * Root ( ) const [pure virtual]

Return the root region

Member Enumerations Documentation

Enum TBgMode

Enumerators

EAlways
EWhenActive

Enum TFit

Enumerators

EFill
EMeet
ESlice
EScroll
EHidden