Class CQikListBoxLayout

class CQikListBoxLayout : public CBase, public MQikListBoxLayoutRects;

Description

Description of how to graphically respresent the List Box item.

The CQikListBoxLayout class is a desscription of how to graphically respresent the List Box item. It is composed of a number of elements. I.e. CQikListBoxColumn s and CQikListBoxRow s. Each element has a specific content type.

Derivation

• MQikListBoxLayoutRects - Interface used for queries of the rect sizes of the slots of a List Box item
• CBase - Base class for all classes to be instantiated on the heap
• CQikListBoxLayout - Description of how to graphically respresent the List Box item

Members

Defined in CQikListBoxLayout:
ColumnGap(), ColumnGapFromSystem(), GetColumn(), GetElement(), GetRow(), HeightType(), HeightValue(), IsRowAware(), LeftEdgeToContent(), LeftEdgeToContentFromSystem(), MultiSelectionOrientation(), MultiSelectionSlotId(), NewColumnL(), NewColumnLeftOfL(), RemoveElement(), RightEdgeToContent(), RightEdgeToContentFromSystem(), SelectorVerticalOffset(), SetColumnGap(), SetColumnGapFromSystem(), SetHeightTypeAndHeightValue(), SetLeftEdgeToContent(), SetLeftEdgeToContentFromSystem(), SetMultiSelectionOrientation(), SetOrnament(), SetRightEdgeToContent(), SetRightEdgeToContentFromSystem(), SetRowAware(), SetSelectorVerticalOffset(), Slot()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also:

• TQikListBoxContentsType

IMPORT_C CQikListBoxColumn *NewColumnL(TInt aSlotId);

Description

Constructs a new CQikListBoxColumn and adds it to the top level of the layout. The column will be constructed with default properties. To change the properties of the column see CQikListBoxColumn::SetProperties .

Parameters

Return value

IMPORT_C CQikListBoxColumn *NewColumnLeftOfL(TInt aNewColumnSlotId, TInt aExistingColumnSlotId);

Description

Creates and inserts a new column, left of an existing column, in the top level of the layout.

Parameters

Return value

IMPORT_C CQikListBoxLayoutElement *GetElement(TInt aSlotId);

Description

Get the element (Row or Column) at the given slot. NULL will be returned if slot could not be found

Parameters

Return value

Panic codes

IMPORT_C CQikListBoxColumn *GetColumn(TInt aSlotId);

Description

Get the Column at the given slot. NULL will be returned if Column could not be found

Parameters

Return value

Panic codes

IMPORT_C CQikListBoxRow *GetRow(TInt aSlotId);

Description

Get the row at the given slot. NULL will be returned if slot could not be found

Parameters

Return value

Panic codes

IMPORT_C void RemoveElement(TInt aSlotId);

Description

Removes a branch of the layout structure tree. The element with slot id aSlotId and all of its children will be removed from the layout structure.

If multiple select is enabled, it is not allowed to remove the element containing the selector, either change the slot where the selector is to be drawn or disable multiple select.

Make sure to call CQikListBox::LayoutUpdatedL to get the List Box re-calculated and redrawn.

Parameters

Panic codes

IMPORT_C void SetMultiSelectionOrientation(TQikListBoxSelectorOrientation aOrientation, TInt aSlotId);

Description

Sets the orientation of the selection area for multiple selection in the specified slot.

Multiple select area can be either left/right of an item or inside one of it is slots. If left/right orientation is used, the slot id is ignored.

Parameters

IMPORT_C TInt MultiSelectionSlotId() const;

Description

Returns the slot id set to contains the selector.

Return value

IMPORT_C TQikListBoxSelectorOrientation MultiSelectionOrientation() const;

Description

Returns the orientation of the selection area for multiple selection.

Return value

See also:

• TQikListBoxSelectorOrientation

IMPORT_C void SetSelectorVerticalOffset(TInt aTopOffset);

Description

Sets the number of pixels between the top of the item and the top of the selector rectangle. When layout is row aware this setting is not used instead the selector is aligned vertically with the first row in the item/layout.

Parameters

IMPORT_C TInt SelectorVerticalOffset() const;

Description

Gets the number of pixels set to be used between the top of the item and the top of the selector rectangle. When layout is row aware this setting is not used instead the selector is aligned vertically with the first row in the item/layout.

Return value

IMPORT_C TBool IsRowAware() const;

Description

Checks if this layout has row aware enabled or not.

Return value

IMPORT_C void SetRowAware(TBool aRowAware);

Description

Sets the row awareness state.

aRowAware ETrue sets the layout to row aware.

Parameters

IMPORT_C TInt ColumnGap() const;

Description

Returns the currently used column gap. If the column gap is set to be fetched from the system wide layout settings this value is not necessarily static, it could be changed run time according to different zoom levels etc.

Return value

See also:

• SetColumnGap

IMPORT_C void SetColumnGap(TInt aGap);

Description

Column gap is the space used in between columns of the same level when laying them out. The column gap to use can either be explicitly set or indicated that it should be fetched from system layout settings which will give the list box a system coherent look. For the layout to actually use aGap, use-column-gap-from-system must be toggled off using SetColumnGapFromSystem .

Parameters

See also:

• SetColumnGapFromSystem

IMPORT_C TBool ColumnGapFromSystem() const;

Description

Return value

See also:

• SetColumnGap
• ColumnGap

IMPORT_C void SetColumnGapFromSystem(TBool aFromSystem);

Description

If the column gap is set to be gotten from system, subsequent calls to ColumnGap will return the column gap currently used, i.e column gap previously set through SetColumnGap will be discarded.

Parameters

See also:

• SetColumnGap

IMPORT_C TInt LeftEdgeToContent() const;

Description

Returns the currently used left-edge-to-content spacing. If the left-edge-to-content spacing is set to be fetched from the system wide layout settings this value is not necessarily static, it could be changed run time according to different zoom levels etc.

Return value

See also:

• SetLeftEdgeToContent

IMPORT_C void SetLeftEdgeToContent(TInt aSpacing);

Description

Left-edge-to-content is the gap that will space the item apart from the left edge of the list box when laying the item out. The left-edge-to-content spacing to use can either be explicitly set or indicated that it should be fetched from system layout settings which will give the list box a system coherent look. For the layout to actually use aSpacing, use-system-value must be toggled off using SetLeftEdgeToContentFromSystem .

Parameters

See also:

• SetLeftEdgeToContentFromSystem

IMPORT_C TBool LeftEdgeToContentFromSystem() const;

Description

Return value

See also:

• SetLeftEdgeToContent
• LeftEdgeToContent

IMPORT_C void SetLeftEdgeToContentFromSystem(TBool aFromSystem);

Description

If the left-edge-to-content is set to be gotten from system, subsequent calls to LeftEdgeToContent will return the value currently used, i.e left-edge-to-content previously set through SetLeftEdgeToContent will be discarded.

Parameters

IMPORT_C TInt RightEdgeToContent() const;

Description

Returns the currently used right-edge-to-content spacing. If the right-edge-to-content spacing is set to be fetched from the system wide layout settings this value is not necessarily static, it could be changed run time according to different zoom levels etc.

Return value

See also:

• SetLeftEdgeToContent

IMPORT_C void SetRightEdgeToContent(TInt aSpacing);

Description

Right-edge-to-content is the gap that will space the item apart from the right edge of the list box when laying the item out. The right-edge-to-content spacing to use can either be explicitly set or indicated that it should be fetched from system layout settings which will give the list box a system coherent look.

Parameters

See also:

• SetRightEdgeToContentFromSystem

IMPORT_C TBool RightEdgeToContentFromSystem() const;

Description

Return value

See also:

• SetRightEdgeToContent
• RightEdgeToContent

IMPORT_C void SetRightEdgeToContentFromSystem(TBool aFromSystem);

Description

If the right-edge-to-content is set to be gotten from system, subsequent calls to RightEdgeToContent will return the value currently used, i.e right-edge-to-content previously set through SetRightEdgeToContent will be discarded.

Parameters

IMPORT_C void SetHeightTypeAndHeightValue(TQikListBoxLayoutSizeType aHeightType, TInt aHeightValue);

Description

Sets the height type and height value to be used by the layout. aHeightValue is only used when the type is set to EQikListBoxLayoutHeightPixels.

Parameters

IMPORT_C TQikListBoxLayoutSizeType HeightType() const;

Description

Return value

See also:

• HeightValue
• SetHeightTypeAndHeightValue

IMPORT_C TInt HeightValue() const;

Description

Return value

See also:

• HeightType
• SetHeightTypeAndHeightValue

virtual IMPORT_C TRect Slot(TInt aSlotId) const;

Description

Returns the size of the chosen slot id.

Parameters

Return value

Panic codes

IMPORT_C void SetOrnament(MQikListBoxLayoutOrnament *aOrnament);

Description

Sets the itemdrawers for the forground and background. No ownership is taken so both aForground and aBackground can be the same object, and that object can be reused.

Parameters