Class MAnimGeneralFunctionsWindowExtension

class MAnimGeneralFunctionsWindowExtension;

Description

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.

Members

Defined in MAnimGeneralFunctionsWindowExtension:
FocusScreens(), Reserved1(), Reserved2(), Reserved3(), Reserved4(), Screens(), SetFocusScreen(), SetOrdinalPosition(), TWindowGroupInfo, WindowGroupInfo(), WindowGroupName(), WindowGroups()

virtual TInt Screens() const=0;

Description

Returns the total number of screens.

Return value

TInt The total number of screens.

virtual TInt FocusScreens() const=0;

Description

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

Return value

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

virtual void SetFocusScreen(TInt aScreenNo)=0;

Description

Changes the focused screen.

Parameters

TInt aScreenNo New screen number.

virtual TInt WindowGroups(TInt aScreen) const=0;

Description

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

Parameters

TInt aScreen The screen number.

Return value

TInt The number of window groups.

virtual TBool WindowGroupInfo(TWindowGroupInfo &aInfo, TInt aScreen, TInt aFullOrdinalPosition) const=0;

Description

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.

Return value

TBool ETrue if window group information exists, EFalse otherwise.

virtual TBool WindowGroupName(TPtrC &aWindowName, TInt aScreen, TInt aFullOrdinalPosition) const=0;

Description

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.

Return value

TBool ETrue if the window group name exists, EFalse otherwise.

virtual TInt SetOrdinalPosition(TInt aWindowGroupId, TInt aPos, TInt aOrdinalPriority)=0;

Description

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.

Return value

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

private: virtual void Reserved1() const;

Description

private: virtual void Reserved2() const;

Description

private: virtual void Reserved3() const;

Description

private: virtual void Reserved4() const;

Description

class TWindowGroupInfo;

Description

Class contains the information pertaining to a window group: name, priority, focusability.

Members

Defined in MAnimGeneralFunctionsWindowExtension::TWindowGroupInfo:
EIsFocusable, IsFocusable(), anonymous, iFlags, iId, iNameLength, iOrdinalPriority, iParentId

Member functions

---

IsFocusable()

inline TBool IsFocusable() const;

Description

Returns whether or not the window is focusable.

Return value

TBool ETrue if focusable, else returns EFalse.

Member enumerations

---

Enum anonymous

n/a

Description

EIsFocusable Window is focusable flag.

Member data

---

iId

TInt iId;

Description

---

iFlags

TUint32 iFlags;

Description

---

iOrdinalPriority

TInt iOrdinalPriority;

Description

---

iNameLength

TInt iNameLength;

Description

---

iParentId

TInt iParentId;

Description