Symbian^3 Application Developer Library >

TAknWindowComponentLayout Class Reference

class TAknWindowComponentLayout

A window component structure from scalable layout.

The data members of this class have the following invariants which must be preserved in any methods of this class.

il + iW + ir = parentRect.Width() it + iH + ib = parentRect.Height()

The data format of the data members are as follows: (AknLayoutUtils knows this) any of il,iW,ir, it,iH,ib may be one of the following 1) coordinate value 2) ELayoutEmpty 3) ELayoutP - value

Nested Classes and Structures

Public Member Functions
TAknWindowComponentLayout ()
TAknWindowComponentLayout ( TAknWindowLineLayout )
IMPORT_C TAknWindowComponentLayout Anim ( TAknWindowComponentLayout , TAknWindowComponentLayout , const TRangeTriplet &)
IMPORT_C TAknWindowComponentLayout Compose ( TAknWindowComponentLayout , TAknWindowComponentLayout )
IMPORT_C TAknTextComponentLayout ComposeText ( TAknWindowComponentLayout , TAknTextComponentLayout )
void FormFieldHack ( TAknWindowComponentLayout &)
IMPORT_C TAknWindowComponentLayout Intersect ( TAknWindowComponentLayout , TAknWindowComponentLayout )
IMPORT_C TAknLayoutScalableComponentType LayoutComponentType ()
IMPORT_C TAknWindowLineLayout LayoutLine ()
IMPORT_C TAknWindowLineLayout LayoutLineNoEmptys ()
void ListGenPaneHack ( TAknWindowComponentLayout &)
TAknWindowComponentLayout ListPaneHack (const TAknWindowComponentLayout &, const TAknWindowComponentLayout )
IMPORT_C TAknWindowComponentLayout Minus ( TAknWindowComponentLayout , TAknWindowComponentLayout )
IMPORT_C TAknWindowComponentLayout MultiLineGrid ( TAknWindowComponentLayout , TInt , TInt , TInt , TInt )
IMPORT_C TAknWindowComponentLayout MultiLineX ( TAknWindowComponentLayout , TInt , TInt )
IMPORT_C TAknWindowComponentLayout MultiLineY ( TAknWindowComponentLayout , TInt , TInt )
void ScrollIndicatorHack (const TAknWindowComponentLayout &, TAknWindowComponentLayout &, TAknWindowComponentLayout &, TInt )
IMPORT_C void SetZeroSized ()
IMPORT_C TAknWindowComponentLayout SiblingAsChild ( TAknWindowComponentLayout , TAknWindowComponentLayout )
IMPORT_C TAknWindowComponentLayout Split ( TAknWindowComponentLayout , TInt )
IMPORT_C TAknWindowComponentLayout operator= ( TAknWindowLineLayout )
Private Member Functions
IMPORT_C TInt16 C ()
TAknTextComponentLayout CombineAttrs ( TAknWindowComponentLayout , const TAknTextComponentLayoutAttrs &)
TAknWindowComponentLayout ExtractWindow ( TAknTextComponentLayout )
TTriplet FromRangeToTriplet (const TRangeTriplet &)
IMPORT_C TInt16 H ()
TAknWindowComponentLayout Multiply ( TAknWindowComponentLayout , const TTriplet &)
TInt16 MultiplyValue ( TInt16 , TScaledInt , TScaledInt )
TAknWindowComponentLayout RemoveLayoutEmptys ( TAknWindowComponentLayout )
IMPORT_C void SetC ( TInt16 )
IMPORT_C void SetH ( TInt16 )
IMPORT_C void SetW ( TInt16 )
IMPORT_C void Setb ( TInt16 )
IMPORT_C void Setl ( TInt16 )
IMPORT_C void Setr ( TInt16 )
IMPORT_C void Sett ( TInt16 )
IMPORT_C TInt16 W ()
IMPORT_C TInt16 b ()
IMPORT_C TInt16 l ()
IMPORT_C TInt16 r ()
IMPORT_C TInt16 t ()
Private Attributes
TInt16 iAttributeSetID
TInt16 iC
TInt16 iFirstChildID
TInt16 iH
TInt16 iNextSiblingID
TInt16 iParentID
TInt16 iParentVariety
TInt16 iReserved1
TInt16 iReserved2
TInt16 iReserved3
TInt16 iType
TInt16 iW
TInt16 ib
TInt16 il
TInt16 ir
TInt16 it

Constructor & Destructor Documentation

TAknWindowComponentLayout()

IMPORT_C TAknWindowComponentLayout ( )

contructor

TAknWindowComponentLayout(TAknWindowLineLayout)

IMPORT_C TAknWindowComponentLayout ( TAknWindowLineLayout aLine )

Parameters

TAknWindowLineLayout aLine

Member Functions Documentation

Anim(TAknWindowComponentLayout, TAknWindowComponentLayout, const TRangeTriplet &)

IMPORT_C TAknWindowComponentLayout Anim ( TAknWindowComponentLayout aLine,
TAknWindowComponentLayout aLine2,
const TRangeTriplet & aTriplet
) [static]

Parameters

TAknWindowComponentLayout aLine
TAknWindowComponentLayout aLine2
const TRangeTriplet & aTriplet

C()

IMPORT_C TInt16 C ( ) const [private]

CombineAttrs(TAknWindowComponentLayout, const TAknTextComponentLayoutAttrs &)

TAknTextComponentLayout CombineAttrs ( TAknWindowComponentLayout aLine1,
const TAknTextComponentLayoutAttrs & aAttrs
) [private, static]

Parameters

TAknWindowComponentLayout aLine1
const TAknTextComponentLayoutAttrs & aAttrs

Compose(TAknWindowComponentLayout, TAknWindowComponentLayout)

IMPORT_C TAknWindowComponentLayout Compose ( TAknWindowComponentLayout aLine1,
TAknWindowComponentLayout aLine2
) [static]

Parameters

TAknWindowComponentLayout aLine1
TAknWindowComponentLayout aLine2

ComposeText(TAknWindowComponentLayout, TAknTextComponentLayout)

IMPORT_C TAknTextComponentLayout ComposeText ( TAknWindowComponentLayout aLine1,
TAknTextComponentLayout aLine2
) [static]

Parameters

TAknWindowComponentLayout aLine1
TAknTextComponentLayout aLine2

ExtractWindow(TAknTextComponentLayout)

TAknWindowComponentLayout ExtractWindow ( TAknTextComponentLayout aText ) [private, static]

Parameters

TAknTextComponentLayout aText

FormFieldHack(TAknWindowComponentLayout &)

void FormFieldHack ( TAknWindowComponentLayout & aLayout ) [static, inline]

Parameters

TAknWindowComponentLayout & aLayout

FromRangeToTriplet(const TRangeTriplet &)

TTriplet FromRangeToTriplet ( const TRangeTriplet & aRange ) [private, static]

Parameters

const TRangeTriplet & aRange

H()

IMPORT_C TInt16 H ( ) const [private]

Intersect(TAknWindowComponentLayout, TAknWindowComponentLayout)

IMPORT_C TAknWindowComponentLayout Intersect ( TAknWindowComponentLayout aLine,
TAknWindowComponentLayout aLine2
) [static]

Parameters

TAknWindowComponentLayout aLine
TAknWindowComponentLayout aLine2

LayoutComponentType()

IMPORT_C TAknLayoutScalableComponentType LayoutComponentType ( ) const

LayoutLine()

IMPORT_C TAknWindowLineLayout LayoutLine ( ) const

LayoutLineNoEmptys()

IMPORT_C TAknWindowLineLayout LayoutLineNoEmptys ( ) const

ListGenPaneHack(TAknWindowComponentLayout &)

void ListGenPaneHack ( TAknWindowComponentLayout & aLayout ) [static, inline]

Parameters

TAknWindowComponentLayout & aLayout

ListPaneHack(const TAknWindowComponentLayout &, const TAknWindowComponentLayout)

TAknWindowComponentLayout ListPaneHack ( const TAknWindowComponentLayout & aLayout,
const TAknWindowComponentLayout aListGenPane
) [static, inline]

Parameters

const TAknWindowComponentLayout & aLayout
const TAknWindowComponentLayout aListGenPane

Minus(TAknWindowComponentLayout, TAknWindowComponentLayout)

IMPORT_C TAknWindowComponentLayout Minus ( TAknWindowComponentLayout aLine,
TAknWindowComponentLayout aParentDiff
) [static]

subtract two layout lines relative to the same parent rectangle

Minus combines two layout lines in such way that a) the result is aLine with it's parent rectangle changed b) aLine and aParentDiff's parent rectangles becomes the same; and result's parent rectangle is calculated to be aParentDiff's child rectangle.

Parameters

TAknWindowComponentLayout aLine the inner rect
TAknWindowComponentLayout aParentDiff the difference between the parent and the inner rect

MultiLineGrid(TAknWindowComponentLayout, TInt, TInt, TInt, TInt)

IMPORT_C TAknWindowComponentLayout MultiLineGrid ( TAknWindowComponentLayout aFirst,
TInt aColumnIndex,
TInt aRowIndex,
TInt aGapBetweenColumns,
TInt aGapBetweenRows
) [static]

This method calculates a grid item position in based on first cell.

Parameters

TAknWindowComponentLayout aFirst
TInt aColumnIndex
TInt aRowIndex
TInt aGapBetweenColumns
TInt aGapBetweenRows

MultiLineX(TAknWindowComponentLayout, TInt, TInt)

IMPORT_C TAknWindowComponentLayout MultiLineX ( TAknWindowComponentLayout aFirst,
TInt aColumnIndex,
TInt aGapBetweenColumns
) [static]

This method calculates a grid item position in X-dimension based on first cell.

Parameters

TAknWindowComponentLayout aFirst
TInt aColumnIndex
TInt aGapBetweenColumns

MultiLineY(TAknWindowComponentLayout, TInt, TInt)

IMPORT_C TAknWindowComponentLayout MultiLineY ( TAknWindowComponentLayout aFirst,
TInt aItemIndex,
TInt aGapBetweenItems
) [static]

This method calculates a list item position based on first item. This can be used to calculate either list item positions or grid cell Y-positions.

Parameters

TAknWindowComponentLayout aFirst
TInt aItemIndex
TInt aGapBetweenItems

Multiply(TAknWindowComponentLayout, const TTriplet &)

TAknWindowComponentLayout Multiply ( TAknWindowComponentLayout aLine1,
const TTriplet & aTriplet
) [private, static]

Parameters

TAknWindowComponentLayout aLine1
const TTriplet & aTriplet

MultiplyValue(TInt16, TScaledInt, TScaledInt)

TInt16 MultiplyValue ( TInt16 aValue,
TScaledInt aMultiplier,
TScaledInt aPMultiplier
) [private, static]

Parameters

TInt16 aValue
TScaledInt aMultiplier
TScaledInt aPMultiplier

RemoveLayoutEmptys(TAknWindowComponentLayout)

TAknWindowComponentLayout RemoveLayoutEmptys ( TAknWindowComponentLayout aLine1 ) [private, static]

Parameters

TAknWindowComponentLayout aLine1

ScrollIndicatorHack(const TAknWindowComponentLayout &, TAknWindowComponentLayout &, TAknWindowComponentLayout &, TInt)

void ScrollIndicatorHack ( const TAknWindowComponentLayout & aWidthHeightLayout,
TAknWindowComponentLayout & aParent,
TAknWindowComponentLayout & aLayout,
TInt aDirection
) [static, inline]

Parameters

const TAknWindowComponentLayout & aWidthHeightLayout
TAknWindowComponentLayout & aParent
TAknWindowComponentLayout & aLayout
TInt aDirection

SetC(TInt16)

IMPORT_C void SetC ( TInt16 aC ) [private]

Parameters

TInt16 aC

SetH(TInt16)

IMPORT_C void SetH ( TInt16 aH ) [private]

Parameters

TInt16 aH

SetW(TInt16)

IMPORT_C void SetW ( TInt16 aW ) [private]

Parameters

TInt16 aW

SetZeroSized()

IMPORT_C void SetZeroSized ( )

Makes the window zero-sized, positioned in the top left corner.

Setb(TInt16)

IMPORT_C void Setb ( TInt16 ab ) [private]

Parameters

TInt16 ab

Setl(TInt16)

IMPORT_C void Setl ( TInt16 al ) [private]

Parameters

TInt16 al

Setr(TInt16)

IMPORT_C void Setr ( TInt16 ar ) [private]

Parameters

TInt16 ar

Sett(TInt16)

IMPORT_C void Sett ( TInt16 at ) [private]

Parameters

TInt16 at

SiblingAsChild(TAknWindowComponentLayout, TAknWindowComponentLayout)

IMPORT_C TAknWindowComponentLayout SiblingAsChild ( TAknWindowComponentLayout aSiblingTreatedAsParent,
TAknWindowComponentLayout aSiblingTreatedAsChild
) [static]

Treat two layout lines as if one is a child of the other. The two layouts must have the same parent. They must also have the same pattern of absolute, ElayoutEmptys and Parent relative measurements, both vertically and horizontally.

Parameters

TAknWindowComponentLayout aSiblingTreatedAsParent
TAknWindowComponentLayout aSiblingTreatedAsChild

Split(TAknWindowComponentLayout, TInt)

IMPORT_C TAknWindowComponentLayout Split ( TAknWindowComponentLayout aLine,
TInt aValue
) [static]

This method splits parent rectangle to one of the 9 pieces based on aLine.

aValue is one of the numbers: 0 1 2 3 4 5 6 7 8 This is highly related to "frames" in skins. This allows us to generate a skin frame definition from a single TAknWindowComponentLayout .

Parameters

TAknWindowComponentLayout aLine
TInt aValue

W()

IMPORT_C TInt16 W ( ) const [private]

b()

IMPORT_C TInt16 b ( ) const [private]

l()

IMPORT_C TInt16 l ( ) const [private]

operator=(TAknWindowLineLayout)

IMPORT_C TAknWindowComponentLayout operator= ( TAknWindowLineLayout aLine )

Parameters

TAknWindowLineLayout aLine

r()

IMPORT_C TInt16 r ( ) const [private]

t()

IMPORT_C TInt16 t ( ) const [private]

Member Data Documentation

TInt16 iAttributeSetID

TInt16 iAttributeSetID [private]

TInt16 iC

TInt16 iC [private]

TInt16 iFirstChildID

TInt16 iFirstChildID [private]

TInt16 iH

TInt16 iH [private]

TInt16 iNextSiblingID

TInt16 iNextSiblingID [private]

TInt16 iParentID

TInt16 iParentID [private]

TInt16 iParentVariety

TInt16 iParentVariety [private]

TInt16 iReserved1

TInt16 iReserved1 [private]

TInt16 iReserved2

TInt16 iReserved2 [private]

TInt16 iReserved3

TInt16 iReserved3 [private]

TInt16 iType

TInt16 iType [private]

TInt16 iW

TInt16 iW [private]

TInt16 ib

TInt16 ib [private]

TInt16 il

TInt16 il [private]

TInt16 ir

TInt16 ir [private]

TInt16 it

TInt16 it [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.