class CEikColumnListBox : public CEikTextListBox |
Column list box control.
This is a list box whose lines consist of cells that are grouped vertically into columns. The columns can be either textual or graphical, and column widths and fonts can be set explicitly through CColumnListBoxData.
In many cases list is in a container which sits on top of the control stack. The container receives all focus events and should hand them to the list too. E.g. void CContainer::FocusChanged( TDrawNow aDrawNow ) { ... some code ... if( iListBox ) iListBox->SetFocus( IsFocused(), aDrawNow ); }
When switching components programmatically, e.g. from one list to another in the same view, make sure that you remove focus from the other component.
In more complex cases you may have to add a dummy interceptor control to the top of control stack to hand focus events to list.
Make sure you handle resource changes correctly. If resource handle chain is solid it should reach CCoeControl::HandleResourceChange, which informs
Public Member Functions | |
---|---|
CEikColumnListBox() | |
IMPORT_C void | ConstructFromResourceL(TResourceReader &) |
IMPORT_C void | ConstructL(const CCoeControl *, TInt) |
IMPORT_C void | EditItemL(TInt, TInt) |
IMPORT_C void | EnableExtendedDrawingL() |
IMPORT_C void | EnableStretching(const TBool) |
IMPORT_C void | FocusChanged(TDrawNow) |
IMPORT_C void | GetColorUseListL(CArrayFix< TCoeColorUse > &) |
IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
IMPORT_C void | HandleResourceChange(TInt) |
IMPORT_C CColumnListBoxItemDrawer * | ItemDrawer() |
IMPORT_C CListBoxView * | MakeViewClassInstanceL() |
IMPORT_C CTextListBoxModel * | Model() |
IMPORT_C TTypeUid::Ptr | MopSupplyObject(TTypeUid) |
void | SetIconSizes() |
Protected Member Functions | |
---|---|
IMPORT_C void | CreateItemDrawerL() |
IMPORT_C void | CreateModelL() |
Private Member Functions | |
---|---|
IMPORT_C void | CEikListBox_Reserved() |
IMPORT_C void * | ExtensionInterface(TUid) |
Inherited Enumerations | |
---|---|
CCoeControl:TZoomType | |
CEikListBox:@170 | |
CEikListBox:TFlags | |
CEikListBox:TReasonForFocusLost | |
CEikListBox:TScrollBarOwnerShip |
Private Attributes | |
---|---|
TInt | iSpare |
IMPORT_C void | ConstructFromResourceL | ( | TResourceReader & | aReader | ) | [virtual] |
Second-phase construction from a resource.
This function completes the construction of a column list box, initialising any members from the specified resource reader.
TResourceReader & aReader | A resource file reader |
IMPORT_C void | ConstructL | ( | const CCoeControl * | aParent, |
TInt | aFlags = 0 | |||
) | [virtual] |
By default Symbian 2nd phase constructor is private.
This function completes the construction of a column list box.
const CCoeControl * aParent | Parent control for the column list box. |
TInt aFlags = 0 | Flags for the column list box. |
IMPORT_C void | CreateItemDrawerL | ( | ) | [protected, virtual] |
This member is internal and not intended for use.
IMPORT_C void | EnableExtendedDrawingL | ( | ) |
This method needs to be called to enable extended drawing features such as skinning, pictograph drawing and marquee text in the listbox draw routine.
Methods CEikFormattedCellListBox::ConstructL and CEikFormattedCellListBox::ConstructFromResourceL call this method. So, you only need to call this if your listbox implementation does not call either of those.
This method can be safely called more than once. Item drawer must be created before calling this method, or a panic is raised.
S60 2.6
IMPORT_C void | EnableStretching | ( | const TBool | aEnabled | ) |
Enables/disables list stretching. When a column list is stretched its layout is optimized to take advantage of the extra screen space. This is intented for devices with a large screen. This feature might be set as default by a product specific flag.
Item drawer must be created before calling this method.
S60 3.1
const TBool aEnabled | ETrue to enable list stretching. |
IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
TUid aInterface |
IMPORT_C void | FocusChanged | ( | TDrawNow | aDrawNow | ) | [virtual] |
From CEikListBox
Handles focus changes.
The function emphasises or de-emphasises the view as needed, and shows or hides the matcher cursor.
TDrawNow aDrawNow | If EDrawNow, a redraw is performed immediately |
IMPORT_C void | GetColorUseListL | ( | CArrayFix< TCoeColorUse > & | aColorUseList | ) | const [virtual] |
From CCoeControl.
Not used in S60
CArrayFix< TCoeColorUse > & aColorUseList | The colour list |
IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
From CCoeControl.
Handles pointer events.
This function gets called whenever a pointer event occurs in the control, i.e. when the pointer is within the control's extent, or when the control has grabbed the pointer. The control should implement this function to handle pointer events.
Note: events of type EButton1Down are processed before HandlePointerEventL() is called, in order to transfer keyboard focus to the control in which the EButton1Down event occurred.
If overriding HandlePointerEventL(), the implementation must include a base call to CCoeControl's HandlePointerEventL().
const TPointerEvent & aPointerEvent | The pointer event |
IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
From CCoeControl.
Handles a change to the control's resources.
The types of resources handled are those which are shared across the environment, e.g. colours or fonts. For colour scheme changes, DrawDeferred() is called in order to redraw the control.
If overriding HandleResourceChange(), the implementation must include a base call to CCoeControl's HandleResourceChange().
TInt aType | A message UID value |
IMPORT_C CColumnListBoxItemDrawer * | ItemDrawer | ( | ) | const |
Gets the object used by this list box to draw its items.
A pointer to the list box drawer.
IMPORT_C CListBoxView * | MakeViewClassInstanceL | ( | ) | [virtual] |
From CEikListBox.
Creates the list box view. The function is called by @ ConstructL() to create an instance of the appropriate list box view class for this list box. The returned instance is owned by this object, and does not have to have its second-phase constructor run. This function is called by CreateViewL().
Pointer to a newly constructed list box view for this object.
IMPORT_C CTextListBoxModel * | Model | ( | ) | const |
Gets the list box model.
Pointer to the model used by this list box
IMPORT_C TTypeUid::Ptr | MopSupplyObject | ( | TTypeUid | aUid | ) |
From CCoeControl.
Retrieves an object of the same type as that encapsulated in aId.
This function is used to allow controls to ask their owners for access to other objects that they own.
Other than in the case where NULL is returned, the object returned must be of the same object type - that is, the ETypeId member of the object pointed to by the pointer returned by this function must be equal to the iUid member of aUid.
Pointer to the type UID of the wanted object.
TTypeUid aUid | An encapsulated object type ID. |