AknLayoutUtils Class Reference

Public Types

Static Public Member Functions

Data Structures

Enumerator:

EAknCbaLocationBottom
EAknCbaLocationRight
EAknCbaLocationLeft

Layout Metrics.

Enumerator:

EScreen	Screen.
EApplicationWindow	Window that fills the entire screen.
EStatusPane	Indicates common components for most of the applications.
EMainPane	The application main pane is used in all the applications.
EControlPane	Control pane.
ESignalPane	The signal pane is used to indicate signal strength.
EContextPane	The context pane is used to indicate an active application.
ETitlePane	Used to indicate the subject or the name of the main pane content.
EBatteryPane	The battery pane is used to indicate battery strength.
EUniversalIndicatorPane	The universal indicator pane is used to indicate items that require the user's attention while browsing applications.
ENaviPane	The navi pane is used to indicate navigation within an application, to provide context sensitive information to the user while entering or editing data, or to show additional information.
EFindPane	A fixed find pane is used with lists instead of the find pop-up window.
EWallpaperPane	Wallpaper pane.
EIndicatorPane	The universal indicator pane is used to indicate items that require the user's attention while browsing applications.
EAColunm	Used generally to display small sized graphics or heading texts.
EBColunm	Used generally to display large sized icons or heading texts.
ECColunm	Used generally to display data entered by the user. Overlaps with the D column.
EDColunm	Used generally to display additional icons. Overlaps with the C column.
EStatusPaneSecondary	Deprecated: , do not use
EControlPaneSecondary	deprecated, do not use
EStaconTop	Top part of status and control panes in landscape layout.
EStaconBottom	Bottom part of status and control panes in landscape layout.
EStatusPaneBottom	Bottom part of status pane in landscape layout.
EControlPaneBottom	Bottom part of control pane in landscape layout.
EControlPaneTop	Top part of control pane in landscape layout.
EStatusPaneTop	Top part of status pane in landscape layout.

Flags for main_pane status.

Enumerator:

EAknMainPaneForTinyStatusPane

This method tells location of softkeys (CBA) field in current running application.

Possible location of softkeys are bottom (portrait and landscape), left and right (only landscape).

Returns:

TAknCbaLocation

This method returns a new value for a baseline, based upon a value for bottom and a value for height.

For legacy layout data, the baseline will be correct, and this method will detect that it is a legacy font id and just return aBottom. However, for scalable layout data, the bottom value will be hidden inside the old baseline variable, so call this method passing in 'iB', NOT passing in 'ib' ... e.g.: (the following line is an example, so is ok to have commented out code) TInt newbaseline = CorrectBaseline(myLayoutLine.iB, myLayoutLine.iFont);

Parameters:

	aBottom	Baseline or Bottom value of text pane (found in TAknTextLineLayout.iB)
	aFontId	FontId of text pane (for scalable layouts, this will encode the height)

Returns:

new Baseline value

This method updates fontid if it has ELayoutEmpty or parent relative values.

Return a fully constructed CAknLayoutFont object based upon the typeface and specification passed in.

The TTypeface object contains a typeface name that is used as the primary key to select a font. The S60 font specifiation object is also used, but any value of TAknFontCategory passed in is reset to EAknFontCategoryUndefined, and is not used to select the font.

The font object is returned as non-const, since it is owned and will eventually be deleted by the client.

Parameters:

	aTypeface	Symbian Typface object
	aSpec	S60 font specification object

Returns:

pointer to a CAknLayoutFont object, owned by the caller

Return a fully constructed CAknLayoutFont object based upon the specification passed in.

The Avkon font specifiation object uses TAknFontCategory to determine the font.

The font object is returned as non-const, since it is owned and will eventually be deleted by the client.

Parameters:

aSpec

S60 font specification object

Returns:

pointer to a CAknLayoutFont object, owned by the caller

Utility routine to give the number of text lines that will completely fit, including room for highlights, within the given height, when the passed in layout is being used.

Note that the NumberOfLinesShown() value from the TAknTextLineLayout object is not taken into consideration. This routine ignores it, and returns number of lines based upon the font metrics, hightlight specification, and the passed in maximum height.

Note that this API does not cause a layout of the editor.

Parameters:

	aLayout	S60 layout object for the text to be laid out in the editor
	aBaselineSeparationOverride	vertical separation of baselines overriding aLayout, if not KAknLayoutUtilsDoNotOverride
	aMaxHeight	Input maximum height to use for the editor.
	aUsedHeight	Returns the number of pixels required for the lines that fit

Returns:

The number of lines which completely fit

Method to return a useable system font reference from a S60 font enumeration from among the supported list.

This method should only be used if application code needs to render its own graphics. That is, it is not using S60 controls and furthermore not using the recommended methods AknLayoutUtils::LayoutEdwin(), AknLayoutUtils::LayoutLabel() or AknLayoutUtils::LayoutSecretEditor().

Fonts returned by this are not recommended to be stored in clients' member data, but should be accessed when they are required for use.

Applications that are written to run with their layout dynamically adapting to different screen sizes should use only the values found in the S60 logical font enumeration, TAknLogicalFontId.

Parameters:

	aFontId	Input S60 font id.
	aCustomFont	Font to return if aFontId is given as EFontCustom

Returns:

const pointer to a system font, or aCustomFont

Deprecated! Do not use!

Utility method to be used along side LayoutEdwin methods that take number of lines or baseline separation overrides.

This routine returns the edwin height in pixels required to fit exactly the passed-in layout, or the layout with overridden baseline separation and/or number of lines.

The vertical position of the editor is also returned. Note that the correct height of the parent layout item is needed in order for this to be calculated properly.

Note that this API does not cause a layout of the editor.

Parameters:

	aParentHeight	Height of the parent layout item
	aLayout	S60 layout object for the text to be laid out in the editor
	aBaselineSeparationOverride	vertical separation of baselines overriding aLayout, if not KAknLayoutUtilsDoNotOverride aLayout, if not KAknLayoutUtilsDoNotOverride
	aNumberOfLinesToShowOverride	number of lines overriding aLayout, if not KAknLayoutUtilsDoNotOverride
	aEdwinVerticalPositionRelativeToParent	Returns the vertical postion of the editor relative to its parent when laid out.
	aEdwinHeight	The height required in pixels to fit the required number of laid out lines plus highlights.

Used by pop-ups to align themselves around the given highlighted area.

Parameters:

	aHighlightRect	Highlighted area.
	aControl	Control whose position should be calculated,

Returns:

TRect Size and position of pop-up.

Deprecated! Do not use!

Deprecated! Do not use!

Layouts an editor via parameters from the specification.

Parameters:

	aLayout	a define from aknlayout.lag file
	font	font id, ELatinPlain12, ELatinBold12, ELatinBold13, ELatinBold17, ELatinBold19 etc..
	C	colour index, 0..255
	l	left margin
	r	right margin
	B	Baseline from top of the parent rectangle
	W	text width in pixels
	J	justification. ELayoutAlignNone; ELayoutAlignCenter; ELayoutAlignLeft; ELayoutAlignRight; ELayoutAlignBidi
	aNumberOfLinesShown	number of lines visible for the editor
	NextLineB	baseline of 2nd line for multi-line labels/editors
	aMinimizeEdwinView	whether to use minimum size. You need to use MinimizedEdwinRect() if you use ETrue here.

Routine to perform standard layout of a CEikEdwin editor.

Two elements from the S60 layout data are required: The rectangle of the containing layout element, and the TAknTextLineLayout object created for the contained text pane element.

Override parameters can be supplied for a different number of lines, a different baseline separation, or substituted skin color. Various "Do Not Override" values are to be passed if the values passed in aLayout are to be used. Refer to the parameters' documentation.

The lower extent of the editor to be laid out (whether driven by the NumberOfLinesToShow() feature of the TAknTextLineLayout object, or overridden by aNumberOfLinesToShowOverRide) will not extend below the lower limit of the rectangle aEdwinParent. Thus the number of lines formatted is limited, and is available as an output parameter.

The height of the editor is also restricted by any value previously set in CEikEdwin::SetMaximumHeightInLines().

Parameters:

	aEdwin	pointer to the editor to be laid out
	aEdwinParent	rectangle of the containing layout element
	aLayout	object representing the layout of the text pane implemented by this editor
	aNumberOfLinesToShowOverride	number of lines overriding aLayout, if not KAknLayoutUtilsDoNotOverride
	aBaselineSeparationOverride	vertical separation of baselines overriding aLayout, if not KAknLayoutUtilsDoNotOverride
	aOverrideColor	Avkon Skins color index to override with, if not (TAknsQsnTextColorsIndex)KAknLayoutUtilsDoNotOverride
	aNumberOfVisibleLines	Number of lines of editor actually laid out.

Layouts an editor via a structure of layout parameters.

Parameters:

aLayout

the structure

Layouts an editor via a structure of layout parameters.

Parameters:

aLayout

the structure

Deprecated! Do not use!

Deprecated! Do not use!

Method to return a system font reference from a S60 font id.

This will always conform to type CAknLayoutFont

This method should only be used if application code needs to render its own graphics. That is, it is not using S60 controls and furthermore not using the recommended methods AknLayoutUtils::LayoutEdwin(), AknLayoutUtils::LayoutLabel() or AknLayoutUtils::LayoutSecretEditor().

Fonts returned by this are not recommended to be stored in clients' member data, but should be accessed when they are required for use.

Applications that are written to run with their layout dynamically adapting to different screen sizes should use only the values found in the S60 logical font enumeration, TAknLogicalFontId.

Parameters:

	aFontId	Input S60 font id.
	aCustomFont	Font to return if aFontId is given as EFontCustom

Returns:

const pointer to a system font, or aCustomFont

Deprecated! Do not use!

Deprecated! Do not use!

Layouts a label via parameters from the specification.

Parameters:

	aLayout	a define from aknlayout.lag file
	font	font id, ELatinPlain12, ELatinBold12, ELatinBold13, ELatinBold17, ELatinBold19 etc..
	C	colour index, 0..255
	l	left margin
	r	right margin
	B	Baseline from top of the parent rectangle
	W	text width in pixels
	J	justification. ELayoutAlignNone; ELayoutAlignCenter; ELayoutAlignLeft; ELayoutAlignRight; ELayoutAlignBidi
	NextLineB	baseline of 2nd line for multi-line labels/editors
	aCustomFont	a font used, if resource file uses EFontCustom

Layouts a label via a layout compiler output.

Parameters:

aLayout

a define from aknlayout.lag file

Layouts a label via a layout compiler output.

Parameters:

aLayout

a define from aknlayout.lag file

Layouts a label via a structure of layout parameters.

Parameters:

aLayout

the structure

Deprecated! Do not use!

Deprecated! Do not use!

This method returns position of top left corner for given layout component.

Returns EFalse for status pane descendants if requested layout component is not available in current layout. For other components returns always ETrue (returned position is from layout definition).

Parameters:

	aParam	Layout component to be queried.
	aPos	Resulting position.
	ETrue	If requested value was available. EFalse Otherwise.

Fills given TRect with rectangle for given layout component.

Returns EFalse for status pane descendants if requested layout component is not available in current layout. For other components returns always ETrue (returned rectangle is from layout definition).

Parameters:

	aParam	Layout component to be queried.
	aRect	Resulting rectangle.
	ETrue	If requested value was available. EFalse Otherwise.

This method returns size of rectangle for given layout component.

Returns EFalse for status pane descendants if requested layout component is not available in current layout. For other components returns always ETrue (returned size is from layout definition).

Parameters:

	aParam	Layout component to be queried.
	aSize	Resulting size.
	ETrue	If requested value was available. EFalse Otherwise.

Deprecated! Do not use!

Deprecated! Do not use!

Sets CEikSecretEditor's position, colors and fonts based on LAF specification.

Access the system font array to see if there is a font that matches the font specification presented in Twips.

Device map is also passed in case the system font array has fonts from different devices.

A null return value means that the system font array is not constructed yet, or does not contain a font that has the same TFontSpec or device map.

Parameters:

	aSpec	Symbian font specification object to match
	aMap	Device map to disambiguate fonts on different devices

Returns:

NULL if no match was found; otherwise a CAknLayoutFont pointer

Use this, if you give aMinimizeEdwinView to LayoutEdwin as true.

The edwin will not draw the whole rectangle allocated for the control.

This method can be used to check whether MSK support is enabled.

Returns:

ETrue if MSK support is enabled, otherwise EFalse.

This method can be used to check whether pen support is enabled.

Returns:

ETrue if pen support is enabled, otherwise EFalse.

This method tells if the scalable layout interface is available.

Different conversions Fonts: ELatinPlain12, ELatinBold12, ELatinBold13, ELatinBold17, ELatinBold19, ENumberPlain5, EClockBold30, ELatinClock14, EFontCustom EAknLogicalFontPrimaryFont, EAknLogicalFontSecondaryFont, EAknLogicalFontTitleFont, Alignments: ELayoutAlignNone, ELayoutAlignCenter, ELayoutAlignLeft, ELayoutAlignRight, ELayoutAlignBidi with these.