| class CAknTitlePane : public CAknControl |
A default control in the status pane's title pane.
avkon.lib
| Public Member Functions | |
|---|---|
| CAknTitlePane() | |
| ~CAknTitlePane() | |
| IMPORT_C void | ConstructFromResourceL(TResourceReader &) |
| IMPORT_C void | ConstructL() |
| IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| IMPORT_C TInt | MaxNumberOfVisibleTextRows() |
| IMPORT_C void | PrepareContext(CWindowGc &) |
| IMPORT_C void | SetFromResourceL(TResourceReader &) |
| IMPORT_C void | SetNumberOfVisibleTextRows(TInt) |
| IMPORT_C void | SetPicture(const CFbsBitmap *, const CFbsBitmap *) |
| IMPORT_C void | SetPictureFromFileL(const TDesC &, TInt, TInt) |
| IMPORT_C void | SetSmallPicture(const CFbsBitmap *, const CFbsBitmap *, TBool) |
| IMPORT_C void | SetText(HBufC *) |
| IMPORT_C void | SetText(HBufC *, TBool) |
| IMPORT_C void | SetTextL(const TDesC &) |
| IMPORT_C void | SetTextL(const TDesC &, TBool) |
| IMPORT_C void | SetTextToDefaultL() |
| IMPORT_C void | SetTitlePaneObserver(MAknTitlePaneObserver *) |
| const TDesC * | Text() |
| CEikLabel * | TextLabel() |
| CEikImage * | TitleImage() |
| Protected Member Functions | |
|---|---|
| IMPORT_C CCoeControl * | ComponentControl(TInt) |
| IMPORT_C TInt | CountComponentControls() |
| IMPORT_C void | HandleResourceChange(TInt) |
| IMPORT_C void | PositionChanged() |
| IMPORT_C void | SizeChanged() |
| Private Member Functions | |
|---|---|
| TUid | AppUid() |
| void | CommonConstructL() |
| IMPORT_C void | Draw(const TRect &) |
| IMPORT_C void * | ExtensionInterface(TUid) |
| TInt | FormatTitlePaneLabelL(const TInt, const TInt, const CFont *, const CFont *) |
| void | ReadFromResourceFileL(TResourceReader &) |
| void | SetContainerWindowNonFading(TBool) |
| void | SetSmallPictureFromFileL(const TDesC &, TInt, TInt) |
| void | SetupExtendedStatusPaneScrollEffectL() |
| void | SetupFlatStatusPaneFadeEffectL() |
| void | SetupFlatStatusPaneScrollEffectL() |
| void | SetupNoEffectL() |
| void | SetupNormalStatusPaneScrollEffectL() |
| void | SetupStaconPaneScrollEffectL() |
| void | SetupTitleLabelEffectL() |
| void | SizeChangedInExtendedStatusPane() |
| void | SizeChangedInFlatStatusPane() |
| void | SizeChangedInNormalStatusPane() |
| void | SizeChangedInStaconPane() |
| RWindow * | StatuspaneContainerWindow() |
| TBool | TextFits(TAknTextLineLayout &) |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
| Protected Attributes | |
|---|---|
| MAknTitlePaneObserver * | iTitlePaneObserver |
| Private Attributes | |
|---|---|
| HBufC * | iDefaultTitleText |
| CAknTitlePaneExtension * | iExtension |
| TBool | iImageShown |
| CAknTitlePaneLabel * | iTitleLabel |
| HBufC * | iTitleText |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| IMPORT_C CCoeControl * | ComponentControl | ( | TInt | aIndex | ) | const [protected, virtual] |
Returns a control determined by control index.
Pointer to the control.
| TInt aIndex | Index of a control to be returned. |
| IMPORT_C void | ConstructFromResourceL | ( | TResourceReader & | aReader | ) | [virtual] |
Read title pane data from resource file and show it in the status pane's title pane.
| TResourceReader & aReader |
| IMPORT_C TInt | CountComponentControls | ( | ) | const [protected, virtual] |
Returns number of controls inside the title pane control.
Number of component controls.
| IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [private, virtual] |
| const TRect & aRect |
| IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
Virtual method provided to allow extensibility of virtual behaviour
| TUid aInterface |
| TInt | FormatTitlePaneLabelL | ( | const TInt | aOneLineLayoutWidth, |
| const TInt | aTwoLineLayoutWidth, | |||
| const CFont * | aOneLineFont, | |||
| const CFont * | aTwoLineFont | |||
| ) | [private] | |||
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Handles pointer events.
| const TPointerEvent & aPointerEvent | Pointer event to be handled. |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [protected, virtual] |
Handles a change to the control's resources which are shared across the environment, e.g. skin change.
| TInt aType | Event type. |
| IMPORT_C TInt | MaxNumberOfVisibleTextRows | ( | ) | const |
Gets the maximum amount of text rows that title pane is able to display simultaneously in the currently active status pane layout. Typically the return value is either 2 (default portrait mode layout) or 1 (landscape mode layouts). In the extended status pane layouts the maximum number of lines is always 1.
Since release 3.2, regardless of the status pane layout, the maximum number of lines is always 1.
3.1
Maximum number of visible text lines.
| IMPORT_C void | PositionChanged | ( | ) | [protected, virtual] |
Handles the position change events.
| IMPORT_C void | PrepareContext | ( | CWindowGc & | aGc | ) | const [virtual] |
Allows to modify graphics context before Draw.
| CWindowGc & aGc | Graphics context to be modified. |
| void | ReadFromResourceFileL | ( | TResourceReader & | aReader | ) | [private] |
| TResourceReader & aReader |
| void | SetContainerWindowNonFading | ( | TBool | aNonFading | ) | [private] |
| TBool aNonFading |
| IMPORT_C void | SetFromResourceL | ( | TResourceReader & | aReader | ) |
Set data from resource file and show it in the status pane's title pane.
| TResourceReader & aReader | Resource reader of the title pane data. |
| IMPORT_C void | SetNumberOfVisibleTextRows | ( | TInt | aRows | ) |
Sets the number of text rows that can be used to display the text. The largest allowed value is the the value returned from MaxNumberOfVisibleTextRows() and the minimum value is always 1.
3.1
| TInt aRows | Number of rows that can be used to display the text. |
| IMPORT_C void | SetPicture | ( | const CFbsBitmap * | aBitmap, |
| const CFbsBitmap * | aMaskBitmap = NULL | |||
| ) | ||||
Set a picture to the title pane and show it in the status pane's title pane. Title pane object takes ownership of the picture. If NULL bitmap is passed, previously set image is shown.
| const CFbsBitmap * aBitmap | Bitmap to be set on the title pane. |
| const CFbsBitmap * aMaskBitmap = NULL | Mask of the bitmap. |
| IMPORT_C void | SetPictureFromFileL | ( | const TDesC & | aFileName, |
| TInt | aMainId, | |||
| TInt | aMaskId = -1 | |||
| ) | ||||
Set a picture from file and show it in the status pane's title pane.
| IMPORT_C void | SetSmallPicture | ( | const CFbsBitmap * | aBitmap, |
| const CFbsBitmap * | aMaskBitmap, | |||
| TBool | aVisible | |||
| ) | ||||
Set a small picture to the title pane and show it in the status pane's title pane together with text.
Title pane object takes ownership of the picture.
If NULL bitmap is passed, previously set image is used.
3.0
| const CFbsBitmap * aBitmap | Bitmap to be set on the title pane. |
| const CFbsBitmap * aMaskBitmap | Mask of the bitmap. |
| TBool aVisible | If ETrue, picture is set visible. Otherwise only text is shown. |
| void | SetSmallPictureFromFileL | ( | const TDesC & | aFileName, |
| TInt | aMainId, | |||
| TInt | aMaskId = -1 | |||
| ) | [private] | |||
| IMPORT_C void | SetText | ( | HBufC * | aText | ) |
Sets text to the title pane.
| HBufC * aText | New text. This object takes ownership of aText. |
| IMPORT_C void | SetText | ( | HBufC * | aText, |
| TBool | aScroll | |||
| ) | ||||
Sets text to the title pane. If whole text does not fit into titlepane, it will be scrolled once and then shown in truncated form.
3.0
| IMPORT_C void | SetTextL | ( | const TDesC & | aText | ) |
Set a text and show it in the status pane's title pane. Descriptor is copied to the title pane control and ownership of the original descriptor is left to the application.
| const TDesC & aText | Text to be shown on the title pane. |
| IMPORT_C void | SetTextL | ( | const TDesC & | aText, |
| TBool | aScroll | |||
| ) | ||||
Set a text and show it in the status pane's title pane. If whole text does not fit into titlepane, it will be scrolled once and then shown in truncated form.
Descriptor is copied to the title pane control and ownership of the original descriptor is left to the application.
3.0
| IMPORT_C void | SetTextToDefaultL | ( | ) |
Set default value to the status pane's title pane. Default value is the name of currently active application.
| IMPORT_C void | SetTitlePaneObserver | ( | MAknTitlePaneObserver * | aObserver | ) |
Sets observer for title pane events.
| MAknTitlePaneObserver * aObserver | Pointer to title pane observer. |
| const TDesC * | Text | ( | ) | const [inline] |
Returns text currently in the status pane's title pane. Ownership is not transferred.
Text currently shown in the title pane.
| TBool | TextFits | ( | TAknTextLineLayout & | aTextLayout | ) | [private] |
| TAknTextLineLayout & aTextLayout |