#include <app/mmsgbiocontrol.h>
| class MMsgBioControl |
| Public Member Functions | |
|---|---|
| pure virtual TRect | CurrentLineRect() |
| pure virtual TBool | HandleBioCommandL(TInt) |
| pure virtual HBufC * | HeaderTextL(void) |
| pure virtual TBool | IsCursorLocation(TMsgCursorLocation) |
| pure virtual TBool | IsFocusChangePossible(TMsgFocusDirection) |
| pure virtual TUint32 | OptionMenuPermissionsL() |
| pure virtual void | SetAndGetSizeL(TSize &) |
| pure virtual void | SetMenuCommandSetL(CEikMenuPane &) |
| pure virtual TInt | VirtualHeight() |
| pure virtual TInt | VirtualVisibleTop() |
The interface for Bio controls
| TRect | CurrentLineRect | ( | ) | const [pure virtual] |
Returns a rectangle slice of the bio controls viewing area. It is used by the CMsgEditorView class for scrolling the screen. The position is given relative to the bio controls top left corner.
Returns: TRect
The command handler. The Bio Control should only handle its own commands that it has set using the function SetMenuCommandSetL().
| Parameter | Description |
|---|---|
| aCommand | ID of command to be handled. |
Returns: If the command is handled, it returns ETrue, and vice versa
| TBool | IsCursorLocation | ( | TMsgCursorLocation | aLocation | ) | const [pure virtual] |
Tells whether the cursor is in the topmost or bottom position. It is used by the scrolling framework.
| Parameter | Description |
|---|---|
| aLocation | Specifies either top or bottom. |
Returns: ETrue if the cursor is in the part specified by aLocation.
| TBool | IsFocusChangePossible | ( | TMsgFocusDirection | aDirection | ) | const [pure virtual] |
Used by the body container for managing focus and scrolling.
| Parameter | Description |
|---|---|
| aDirection | The direction to be checked. |
Returns: ETrue if focus change is possible, and vice versa.
| TUint32 | OptionMenuPermissionsL | ( | ) | const [pure virtual] |
The application can get the option menu permissions using this function.
Returns: The option menu permission flags. If the flag is off it means that the option menu command is not recommended with this Bio Control.
| void | SetAndGetSizeL | ( | TSize & | aSize | ) | [pure virtual] |
Calculates and sets size for a Bio control according to aSize. This function might become deprecated. The SetSizeL() function will be the replacement. The height of the Bio control may be less or more than requested by aSize, but the width must be exactly the same. If width of the Bio control is not the same as given by aSize, the width must be reset back to requested one. The aSize is set to the new size.
| Parameter | Description |
|---|---|
| aSize | Size. See explanation. |
| void | SetMenuCommandSetL | ( | CEikMenuPane & | aMenuPane | ) | [pure virtual] |
This is called by the container to allow the Bio control to add a menu item command. The command ID's should start from the value returned by the MMsgBioControlObserver::FirstFreeCommand().
| Parameter | Description |
|---|---|
| aMenuPane | Reference to the applications menu which will be modified. |
| TInt | VirtualHeight | ( | ) | [pure virtual] |
Gives the height of the text in pixels. It is used by the scrolling framework.
Returns: Height of the text in pixels.
| TInt | VirtualVisibleTop | ( | ) | [pure virtual] |
Gives the cursor position in pixels. It is used by the scrolling framework.
Returns: Cursor position in pixels.