#include <w32adll.h>
| class MAnimGeneralFunctionsWindowExtension |
| Public Member Functions | |
|---|---|
| pure virtual TInt | FocusScreens() |
| pure virtual TInt | Screens() |
| pure virtual void | SetFocusScreen(TInt) |
| pure virtual TInt | SetOrdinalPosition(TInt, TInt, TInt) |
| pure virtual void | WindowConfig(TWindowConfig &) |
| pure virtual TBool | WindowGroupInfo(TWindowGroupInfo &, TInt, TInt) |
| pure virtual TBool | WindowGroupName(TPtrC &, TInt, TInt) |
| pure virtual TInt | WindowGroups(TInt) |
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.
| TInt | FocusScreens | ( | ) | const [pure virtual] |
Returns the number of the screen which is currently in focus.
Returns: The number of the screen which is currently in focus.
| TInt | Screens | ( | ) | const [pure virtual] |
Returns the total number of screens.
Returns: The total number of screens.
| void | SetFocusScreen | ( | TInt | aScreenNo | ) | [pure virtual] |
Changes the focused screen.
| Parameter | Description |
|---|---|
| aScreenNo | New screen number. |
Changes the ordinal position and priority of the window group with the specified ID.
| Parameter | Description |
|---|---|
| aWindowGroupId | The window group ID. |
| aPos | The ordinal position to move the window to. |
| aOrdinalPriority | The new ordinal priority of the window. |
Returns: KErrNotFound if there is no window group with the specified ID, KErrNone otherwise.
| void | WindowConfig | ( | TWindowConfig & | aWindowConfig | ) | const [pure virtual] |
Accessor for window configuration.
| Parameter | Description |
|---|---|
| aWindowConfig | Gets filled in with window configuration details. |
| 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.
| Parameter | Description |
|---|---|
| aInfo | on return, complete window information. |
| aScreen | Screen number. |
| aFullOrdinalPosition | Ordinal position of the window. |
Returns: ETrue if window group information exists, EFalse otherwise.
| 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.
| Parameter | Description |
|---|---|
| aWindowName | On return, the window group name. |
| aScreen | The screen number. |
| aFullOrdinalPosition | The ordinal position of the window. |
Returns: ETrue if the window group name exists, EFalse otherwise.