UIQ Technology
 Developer Library

UIQ 3 SDK

UIQ developer portal

FEEDBACK 

[Index] [Spacer] [Previous] [Next]



Location: QikListBoxColumn.h
Link against: qiklbx.lib

Class CQikListBoxColumn

class CQikListBoxColumn : public CQikListBoxLayoutElement;

Description

Representation of a column in a CQikListBox .

Derivation

Members

Defined in CQikListBoxColumn:
GetProperties(), NewRowAboveL(), NewRowL(), SetProperties()

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

Inherited from CQikListBoxLayoutElement:
ApplyRect(), CalculateSize(), Column(), ContentType(), DoColumnInterlacing(), DynamicSized(), FixedSized(), FromSubTreeSized(), GetContentTypeProperties(), GetContentTypePropertiesL(), IsHideIfEmpty(), Margins(), MinimumSize(), Row(), SemiFixedSized(), SetContentTypeL(), SetContentTypePropertiesL(), SetMargins(), SizeGrabWeight(), SizeInPixels(), iComponent, iComponentSize, iDrawingMargins, iFirstElement, iLayoutValues, iLeftElement, iRect, iRightElement, iSlotId


Member functions


NewRowL()

IMPORT_C CQikListBoxRow *NewRowL(TInt aSlotId);

Description

Construct a new CQikListBoxRow and add it to this column. The row will be constructed with default properties. To change the properties of the row see CQikListBoxRow::SetProperties .

Parameters

TInt aSlotId

The slotid for the new row. Set to EQikListBoxParentSlotId if this is a parent.

Return value

CQikListBoxRow *

The newly created row.

Panic codes

EQikListBoxPanicContentTypeMismatch

Raised if the column already contains a content type that is not parent since an element containing an other content type can not be parent to other elements. Debug builds only.


NewRowAboveL()

IMPORT_C CQikListBoxRow *NewRowAboveL(TInt aNewRowSlotId, TInt aExistingRowSlotId);

Description

Creates and inserts a new row, above an existing child row of this column.

Parameters

TInt aNewRowSlotId

Slot id that will be assigned to the new row to create.

TInt aExistingRowSlotId

Slot id of an existing child row of this column. The new row will be inserted above this one.

Return value

CQikListBoxRow *

The newly created and inserted row.

Panic codes

EQikListBoxPanicContentTypeMismatch

Raised if the column already contains a content type that is not parent since an element containing an other content type can not be parent to other elements. Debug builds only.

EQikListBoxPanicSlotIdIsNotZeroOrHigher

Slot id of aNewRowSlotId is not positive. Debug builds only.

EQikListBoxPanicElementIsNull

The row with slot id aExistingRowSlotId was not found as a child of this column. Debug builds only.


SetProperties()

IMPORT_C void SetProperties(const TQikListBoxPropertiesColumn &aColumnProps);

Description

Set properties for this column. Whether a column can have a type of size set to EQikListBoxColWidthFromContentType depends upon the content type it contains and the properties of that component, therefor the content type of the column must be set using CQikListBoxLayoutElement::SetComponentL prior to calling this method. Failure to do so might cause a panic.

Parameters

const TQikListBoxPropertiesColumn &aColumnProps

Properties to be applied to this column.

Panic codes

EQikListBoxPanicSizeTypeNotApplicable

Raised when trying to set the column to use EQikListBoxColWidthFromContentType when it has no content type that i can get content size from. Debug builds only.

EQikListBoxPanicGrabSizeMustBeGreaterThanZero

Raised when trying to set column to use EQikListBoxSizeTypeGrab but the grab size is invalid.

EQikListBoxPanicPixelSizeMustBeEqualOrGreaterThanZero

Raised when trying to set column to use EQikListBoxSizeTypePixels but the size specified is negative. Debug builds only.


GetProperties()

IMPORT_C void GetProperties(TQikListBoxPropertiesColumn &aColumnProps) const;

Description

Gets the properties of this column. The properties are copied into aColumnProps.

Parameters

TQikListBoxPropertiesColumn &aColumnProps

Contains the properties of this column upon return.

Terms and conditions of use of the material