MAnimGeneralFunctionsWindowExtension Class Reference

class MAnimGeneralFunctionsWindowExtension

General Window utility functions interface.

The member functions define the interface for querying and manipulating the window and screen attributes.

You obtain one by calling: iFunctions->ExtendedInterface(MAnimGeneralFunctions::EWindowExtensionInterface) and casting the result.

It is not intended for user derivation.

Member Functions Documentation

FocusScreens()

TInt FocusScreens()const [pure virtual]

Returns the number of the screen which is currently in focus. The number of the screen which is currently in focus.

Reserved1()

voidReserved1()const [private, virtual]

Reserved2()

voidReserved2()const [private, virtual]

Reserved3()

voidReserved3()const [private, virtual]

Screens()

TInt Screens()const [pure virtual]

Returns the total number of screens. The total number of screens.

SetFocusScreen(TInt)

voidSetFocusScreen(TIntaScreenNo)[pure virtual]

Changes the focused screen.

Parameters

TInt aScreenNoNew screen number.

SetOrdinalPosition(TInt, TInt, TInt)

TInt SetOrdinalPosition(TIntaWindowGroupId,
TIntaPos,
TIntaOrdinalPriority
)[pure virtual]

Changes the ordinal position and priority of the window group with the specified ID.

KErrNotFound if there is no window group with the specified ID, KErrNone otherwise.

Parameters

TInt aWindowGroupIdThe window group ID.
TInt aPosThe ordinal position to move the window to.
TInt aOrdinalPriorityThe new ordinal priority of the window.

WindowConfig(TWindowConfig &)

voidWindowConfig(TWindowConfig &aWindowConfig)const [pure virtual]

Accessor for window configuration.

Parameters

TWindowConfig & aWindowConfigGets filled in with window configuration details.

WindowGroupInfo(TWindowGroupInfo &, TInt, TInt)

TBool WindowGroupInfo(TWindowGroupInfo &aInfo,
TIntaScreen,
TIntaFullOrdinalPosition
)const [pure virtual]

Takes a screen number and an ordinal position and returns the complete window group information of the specified window. If the window group does not exist, the function returns EFalse.

Note: the ordinal position specified should be the total or full ordinal position of all group windows of all priorities on that screen.

ETrue if window group information exists, EFalse otherwise.

Parameters

TWindowGroupInfo & aInfoon return, complete window information.
TInt aScreenScreen number.
TInt aFullOrdinalPositionOrdinal position of the window.

WindowGroupName(TPtrC &, TInt, TInt)

TBool WindowGroupName(TPtrC &aWindowName,
TIntaScreen,
TIntaFullOrdinalPosition
)const [pure virtual]

Takes a screen number and an ordinal position and returns the window group name. If the window group does not exist, the function returns false.

Note: the ordinal position specified should be the total or full ordinal position of all group windows of all priorities on that screen.

Note: if the name does not fit into the descriptor provided then it will be truncated.

ETrue if the window group name exists, EFalse otherwise.

Parameters

TPtrC & aWindowNameOn return, the window group name.
TInt aScreenThe screen number.
TInt aFullOrdinalPositionThe ordinal position of the window.

WindowGroups(TInt)

TInt WindowGroups(TIntaScreen)const [pure virtual]

Returns the number of window groups available for the specified screen.

The number of window groups.

Parameters

TInt aScreenThe screen number.