Collapse all Symbian^3 Product Developer Library

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.

Nested Classes and Structures

MAnimGeneralFunctionsWindowExtension::TWindowGroupInfo

Public Member Functions
TInt	FocusScreens()
TInt	Screens()
void	SetFocusScreen(TInt)
TInt	SetOrdinalPosition(TInt, TInt, TInt)
void	WindowConfig(TWindowConfig &)
TBool	WindowGroupInfo(TWindowGroupInfo &, TInt, TInt)
TBool	WindowGroupName(TPtrC &, TInt, TInt)
TInt	WindowGroups(TInt)

Private Member Functions
void	Reserved1()
void	Reserved2()
void	Reserved3()

Member Functions Documentation

FocusScreens()

TInt

FocusScreens

(

)

const [pure virtual]

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

Reserved1()

void

Reserved1

(

)

const [private, virtual]

Reserved2()

void

Reserved2

(

)

const [private, virtual]

Reserved3()

void

Reserved3

(

)

const [private, virtual]

Screens()

TInt

Screens

(

)

const [pure virtual]

Returns the total number of screens.

SetFocusScreen(TInt)

void

SetFocusScreen

(

TInt

aScreenNo

)

[pure virtual]

Changes the focused screen.

Parameters

TInt aScreenNo

New screen number.

SetOrdinalPosition(TInt, TInt, TInt)

TInt	SetOrdinalPosition	(	TInt	aWindowGroupId,
			TInt	aPos,
			TInt	aOrdinalPriority
		)	[pure virtual]

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

Parameters

TInt aWindowGroupId	The window group ID.
TInt aPos	The ordinal position to move the window to.
TInt aOrdinalPriority	The new ordinal priority of the window.

WindowConfig(TWindowConfig &)

void

WindowConfig

(

TWindowConfig &

aWindowConfig

)

const [pure virtual]

Accessor for window configuration.

Parameters

TWindowConfig & aWindowConfig

Gets filled in with window configuration details.

WindowGroupInfo(TWindowGroupInfo &, TInt, TInt)

TBool	WindowGroupInfo	(	TWindowGroupInfo &	aInfo,
			TInt	aScreen,
			TInt	aFullOrdinalPosition
		)	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.

Parameters

TWindowGroupInfo & aInfo	on return, complete window information.
TInt aScreen	Screen number.
TInt aFullOrdinalPosition	Ordinal position of the window.

WindowGroupName(TPtrC &, TInt, TInt)

TBool	WindowGroupName	(	TPtrC &	aWindowName,
			TInt	aScreen,
			TInt	aFullOrdinalPosition
		)	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.

Parameters

TPtrC & aWindowName	On return, the window group name.
TInt aScreen	The screen number.
TInt aFullOrdinalPosition	The ordinal position of the window.

WindowGroups(TInt)

TInt

WindowGroups

(

TInt

aScreen

)

const [pure virtual]

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

Parameters

TInt aScreen

The screen number.