| class CFormattedCellListBoxData : public CListBoxData |
CFormattedCellListBoxData can draw list items. This is similar class than CColumnListBoxData, but it can more freely layout the list items; more parameters can be used to position the elements. In particular, the position of the elements is free, and not tied to fixed width columns.
This class is used to draw most of the S60 list and grid layouts.
It also handles truncation of the text elements, centering and cropping of images, z-order/overlapping cells, bi-directional text drawing, backgrounds for lists, highlight drawing, various text and image properties and finally the parts of the separator lines that are inside list items.
This is a very low level class. The less you use this class, the better. Applications should be using CAknSelectionListDialog or CAknMarkableListDialog or CAknListQueryDialog to use lists. There are enough predefined list layouts available, so there should be no need for applications to use this class. See Style Guide for more information. Use of this class may cause your application to not look ok when properties of the device change.
avkon
| Protected Member Functions | |
|---|---|
| CFormattedCellListBoxData() | |
| IMPORT_C void | ConstructLD() |
| IMPORT_C void | ConstructLD(const TAknsItemID &) |
| IMPORT_C void | DrawFormatted(TListItemProperties, CWindowGc &, const TDesC *, const TRect &, TBool, const TColors &) |
| void | DrawFormattedSimple(TListItemProperties &, CWindowGc &, const TDesC *, const TRect &, TBool, const TColors &) |
| CFormattedCellListBoxDataExtension * | Extension() |
| CFormattedCellListBoxDataExtension * | Extension() |
| Private Member Functions | |
|---|---|
| TInt | AddActualFontL(const CFont *) |
| void | AddSubCellL(TInt) |
| SSubCell & | At(TInt) |
| const SSubCell & | At(TInt) |
| void | BitBltColored(CWindowGc &, TBool, const CGulIcon *, TInt, TBool, const TRect &) |
| void | CheckIfSubCellsIntersect(TAknTextLineLayout *, TBool *, const TDesC &, const TRect &) |
| const TColors & | Colors(TInt, TInt) |
| void | DoConstructL(const TAknsItemID &) |
| void | DrawFormattedOld(TListItemProperties &, CWindowGc &, const TDesC *, const TRect &, TBool, const TColors &) |
| TInt | FindSubCellIndex(TInt &, TInt) |
| void | FindSubCellIndexOrAddL(TInt &, TInt) |
| TInt | LastSubCell() |
| void | SetUnderlineStyle(TListItemProperties, CWindowGc &, TInt) |
| Private Attributes | |
|---|---|
| TColors | defaultcolors |
| CFormattedCellListBoxDataExtension * | iExtension |
| CArrayPtr< CGulIcon > * | iIconArray |
| CArrayFix< SSubCell > * | iSubCellArray |
| Inherited Attributes | |
|---|---|
| CListBoxData::iBoldFont | |
| CListBoxData::iBoldItalicFont | |
| CListBoxData::iItalicFont | |
| CListBoxData::iNormalFont | |
| CListBoxData::iSearchString | |
| IMPORT_C void | AboutToDrawHighlightAnim | ( | ) | const |
This method should be called before drawing animated highlight. It will sync the animation with the background under the current highlight (only when current item index has changed).
| TInt | AddActualFontL | ( | const CFont * | aBaseFont | ) | [private] |
| const CFont * aBaseFont |
| void | BitBltColored | ( | CWindowGc & | aGc, |
| TBool | aHighlight, | |||
| const CGulIcon * | aIcon, | |||
| TInt | aSubcell, | |||
| TBool | aColorIcon, | |||
| const TRect & | aGraphicRect | |||
| ) | const [private] | |||
| void | CheckIfSubCellsIntersect | ( | TAknTextLineLayout * | aLayouts, |
| TBool * | aResults, | |||
| const TDesC & | aText, | |||
| const TRect & | aItemRect | |||
| ) | const [private] | |||
| TAknTextLineLayout * aLayouts | |
| TBool * aResults | |
| const TDesC & aText | |
| const TRect & aItemRect |
| IMPORT_C void | ConstructLD | ( | ) | [protected] |
Second phase constructor. Highlight animation will be created by default (if it is provided by the skin).
| IMPORT_C void | ConstructLD | ( | const TAknsItemID & | aAnimationIID | ) | [protected] |
Second phase constructor for subclasses that want to override highlight animation creation.
| const TAknsItemID & aAnimationIID | Skin ItemID of the constructed animation. Passing KAknsIIDNone will disable highlight animation. |
| IMPORT_C CCoeControl * | Control | ( | ) | const |
Ability for a skin subsystem to access Mop chain through current listbox control.
Symbian 2.0
Current listbox instance or NULL.
| void | CreatePictographInterfaceL | ( | ) |
Creates pictograph interface. Only effective in Japanese variant. Called by the listbox.
| IMPORT_C TUint32 | CurrentItemTextWasClipped | ( | ) | const |
Tells whether current item has clipped text cells S60 3.2
bitfield of clipped subcells
| TInt | CurrentMarqueeItemIndex | ( | ) |
Gets the current list item index that is / was drawn by marquee.
Index of the item that is / was drawn by marquee.
| void | DoConstructL | ( | const TAknsItemID & | aAnimationIID | ) | [private] |
| const TAknsItemID & aAnimationIID |
| IMPORT_C void | Draw | ( | TListItemProperties | aProperties, |
| CWindowGc & | aGc, | |||
| const TDesC * | aText, | |||
| const TRect & | aRect, | |||
| TBool | aHighlight, | |||
| const TColors & | aColors | |||
| ) | const [virtual] | |||
From CListBoxData.
Draw() is the most important method in CEikFormattedCellListBoxData. This is the only method that needs to be implemented in this class and it draws the whole list item.
| TListItemProperties aProperties | Properties attached to the list item. |
| CWindowGc & aGc | Graphics Context used for drawing the list item. |
| const TDesC * aText | A text string describing the list item cells. |
| const TRect & aRect | The area of the screen for the whole list item. |
| TBool aHighlight | Whether the list item is selected. |
| const TColors & aColors | The colours used for drawing the item. |
| void | DrawDefaultHighlight | ( | CWindowGc & | aGc, |
| const TRect & | aItemRect, | |||
| TBool | aHighlight | |||
| ) | const | |||
Renders a default animated highlight.
| IMPORT_C void | DrawFormatted | ( | TListItemProperties | aProperties, |
| CWindowGc & | aGc, | |||
| const TDesC * | aText, | |||
| const TRect & | aRect, | |||
| TBool | aHighlight, | |||
| const TColors & | aColors | |||
| ) | const [protected] | |||
Main drawing algorithm used for drawing S60 list item. Draw() method should call this method after clearing the list item area and drawing the highlight.
panic
EAknPanicFormattedCellListInvalidBitmapIndex The defined bitmap index is invalid.
panic
EAknPanicOutOfRange The defined index is out of the range.
| TListItemProperties aProperties | Properties attached to the list item. |
| CWindowGc & aGc | Graphics Context used for drawing the list item. |
| const TDesC * aText | A text string describing the list item cells. |
| const TRect & aRect | The area of the screen for the whole list item. |
| TBool aHighlight | Whether the list item is selected. |
| const TColors & aColors | The colors used for drawing the item. |
| void | DrawFormattedOld | ( | TListItemProperties & | aProperties, |
| CWindowGc & | aGc, | |||
| const TDesC * | aText, | |||
| const TRect & | aItemRect, | |||
| TBool | aHighlight, | |||
| const TColors & | aColors | |||
| ) | const [private] | |||
| void | DrawFormattedSimple | ( | TListItemProperties & | aProperties, |
| CWindowGc & | aGc, | |||
| const TDesC * | aText, | |||
| const TRect & | aRect, | |||
| TBool | aHighlight, | |||
| const TColors & | aColors | |||
| ) | const [protected] | |||
Draws list items.
| TListItemProperties & aProperties | Properties attached to the list item. |
| CWindowGc & aGc | Graphics Context used for drawing the list item. |
| const TDesC * aText | A text string describing the list item cells. |
| const TRect & aRect | The area of the screen for the whole list item. |
| TBool aHighlight | Whether the list item is selected. |
| const TColors & aColors | The colors used for drawing the item. |
| IMPORT_C TBool | DrawHighlightAnim | ( | CBitmapContext & | aGc, |
| const TRect & | aRect | |||
| ) | const | |||
The preferred method for drawing highlight animation in derived classes. Before calling this method you should check that highlight animation exists by calling HasHighlightAnim. In case of draw failure you should default to normal skinned highlight drawing. For example:
TBool drawOk = EFalse;
if( HasHighlightAnim() ) { drawOk = DrawHighlightAnim( gc, rect ); }
if( !drawOk ) { ...do normal skinned draw }
The draw status, ETrue if drawing was ok, EFalse otherwise.
3.1
| CBitmapContext & aGc | Graphics context for blitting animation frame |
| const TRect & aRect | Target rect for blitting animation frame |
| void | DrawPopupFrame | ( | CWindowGc & | aGc | ) | const |
Draws a popup frame.
| CWindowGc & aGc | Graphics context used for drawing. |
| void | DrawPopupHighlight | ( | CWindowGc & | aGc, |
| const TRect & | aItemRect, | |||
| TBool | aHighlight | |||
| ) | const | |||
Renders a popup animated highlight.
| void | DrawSettingHighlight | ( | CWindowGc & | aGc, |
| const TRect & | aItemRect, | |||
| TBool | aHighlight | |||
| ) | const | |||
Renders a settings animated highlight.
| IMPORT_C void | EnableMarqueeL | ( | TBool | aEnable | ) |
Enables or disables marquee.
| TBool aEnable | ETrue if On, EFalse if Off. |
| void | EnableStretching | ( | const TBool | aEnabled | ) |
| const TBool aEnabled |
| CFormattedCellListBoxDataExtension * | Extension | ( | ) | [protected] |
Gets list box extension, which is used for adding more funtionality to list boxes without destroying compatibility with previous versions.
Pointer to the list box extension.
| CFormattedCellListBoxDataExtension * | Extension | ( | ) | const [protected] |
Gets list box extension, which is used for adding more funtionality to list boxes without destroying compatibility with previous versions.
Pointer to the list box extension.
| TInt | FindSubCellIndex | ( | TInt & | aArrayIndex, |
| TInt | aSubCell | |||
| ) | const [private] | |||
| void | FindSubCellIndexOrAddL | ( | TInt & | aArrayIndex, |
| TInt | aSubCell | |||
| ) | [private] | |||
| void | FocusGained | ( | ) |
Function that is called when the owning control has gained the focus. Causes that animation is continued because the control is visible and focused.
| void | FocusLost | ( | ) |
Function that is called when the owning control has lost the focus. Causes the animation to pause, even if the control is partially visible.
| IMPORT_C CFont * | Font | ( | const TListItemProperties & | aItemProperties, |
| TInt | aSubCellIndex | |||
| ) | const | |||
Font access to the font used in subcell.
Font used in subcell.
| const TListItemProperties & aItemProperties | Not used in code. |
| TInt aSubCellIndex | Index number of the subcell. |
| TSize | GetSubCellIconSize | ( | TInt | aIndex | ) |
Gets the size of the subcell's icon.
| TInt aIndex |
| void | HandleResourceChange | ( | TInt | aType | ) |
Handles the skin change situation. Causes change of animation.
| TInt aType | Type of resource change. |
| IMPORT_C TBool | HasHighlightAnim | ( | ) | const |
ETrue if highlight animation exists, EFalse otherwise.
3.1
| IMPORT_C const CAknsEffectAnim * | HighlightAnim | ( | ) | const |
Gets animation used for drawing the list highlight. May return NULL, in which case the normal skinned highlight should be drawn. This pointer is valid only during the draw -> you should not store it locally outside draw scope.
Animation used for drawing the list highlight.
| IMPORT_C CArrayPtr< CGulIcon > * | IconArray | ( | ) | const |
Gets the icon array used when drawing bitmaps for the listbox items.
| TBool | IsBackgroundDrawingEnabled | ( | ) | const |
Checks if the list is transparent and drawing the background that would fall behind it.
EFalse if transparent, ETrue otherwise.
| IMPORT_C TBool | IsMarqueeOn | ( | ) |
Determines if marquee is on.
Flag indicating if marquee is on (ETrue on, EFalse off)
| TBool | IsScrollbarBackgroundDrawingEnabled | ( | ) | const |
Is the listbox drawing the background behind the scrollbar or not.
ETrue if background is drawn after scrollbar, EFalse otherwise.
| TBool | KineticScrollingEnabled | ( | ) | const |
Returns ETrue if kinetic scrolling is enabled.
| IMPORT_C CAknLayoutData * | LayoutData | ( | ) | const |
Gets layout data needed for separator lines drawing.
Layout data.
| IMPORT_C TBool | LayoutInit | ( | ) | const |
Gets LayOutInit flag used for drawing separator lines in lists.
| IMPORT_C CFormattedCellListBoxData * | NewL | ( | ) | [static] |
Two-phased constructor.
Pointer to a new formatted cell listbox data object.
| IMPORT_C TBool | RespectFocus | ( | ) | const |
Gets RespectFocus flag.
RespectFocus flag. ETrue if list item highlights are only shown when the list is has been focused on.
| IMPORT_C const CFont * | RowAndSubCellFont | ( | TInt | aRow, |
| TInt | aSubCellIndex | |||
| ) | const | |||
Gets font attached to the row and cell.
Font handle.
| IMPORT_C TAknSeparatorLinePosition | SeparatorLinePosition | ( | ) | const |
Gets separator line position.
Position of separator line.
| IMPORT_C void | SetBackgroundSkinStyle | ( | const TAknsItemID * | aId, |
| const TRect & | aRect | |||
| ) | ||||
Modify properties of the skin context (background).
Symbian 2.0
| const TAknsItemID * aId | Skin background identifier. |
| const TRect & aRect | Skin background rectangle. |
| void | SetClippedByWrap | ( | TUint32 | aClippedCells, |
| TBool | aUseClippedByWrap | |||
| ) | ||||
| void | SetConditionalSubCellL | ( | TInt | aSubCell, |
| const TAknTextLineLayout & | aTextLayout, | |||
| TInt | aAffectedSubCell | |||
| ) | ||||
Support for new layouts.
| TInt aSubCell | |
| const TAknTextLineLayout & aTextLayout | |
| TInt aAffectedSubCell |
| IMPORT_C void | SetControl | ( | CCoeControl * | aControlOrNull | ) |
Ability for a skin subsystem to access mop chain through current listbox control.
Symbian 2.0
| CCoeControl * aControlOrNull | Current listbox instance or NULL. Cannot be other control than the current listbox! |
| void | SetCurrentItemIndex | ( | TInt | aIndex | ) |
Sets the current list item index (not for marquee). Since Symbian 3.0 causes highlight animation to change its background (only if the current item index changes). Don't call this method if the index is not the current item index.
| TInt aIndex | Index number of list item. |
| void | SetCurrentMarqueeItemIndex | ( | TInt | aIndex | ) |
Sets the current list item index that was drawn by marquee.
| TInt aIndex | Index of list item. |
| IMPORT_C void | SetDrawBackground | ( | const TBool | aDrawBackground | ) |
Enables or disables transparency effect i.e. does the listbox draw its own background or not.
| const TBool aDrawBackground | EFalse enables transparency, ETrue disables. |
| void | SetDrawScrollbarBackground | ( | const TBool | aDrawBackground | ) |
Enables or disables drawing background after scrollbar.
| const TBool aDrawBackground | Default is ETrue which means that Scrollbar is drawn first. |
| void | SetESSHighlightedTextColor | ( | TAknsQsnTextColorsIndex | aIndex | ) |
Set a highlighted text color if enhanced skin support is available.
| TAknsQsnTextColorsIndex aIndex |
| void | SetESSTextColor | ( | TAknsQsnTextColorsIndex | aIndex | ) |
Sets a text color if enhanced skin support is available.
| TAknsQsnTextColorsIndex aIndex |
| void | SetFeedbackForAllItems | ( | TBool | aFeedbackForAllItems | ) |
| TBool aFeedbackForAllItems |
| void | SetGraphicSubCellL | ( | TInt | aSubCell, |
| const TAknWindowLineLayout & | aGraphicLayout | |||
| ) | ||||
Set window line layout for the defined sub cell.
| TInt aSubCell | |
| const TAknWindowLineLayout & aGraphicLayout |
| IMPORT_C void | SetGraphicsSubCellL | ( | TInt | aSubCellIndex, |
| TBool | aIsGraphics | |||
| ) | ||||
Sets whether drawing algorithm considers the text string in list item as unicode text string displayable on the screen, or as string representation of an index to icon array.
| IMPORT_C void | SetHighlightAnimBackgroundDrawer | ( | MListBoxAnimBackgroundDrawer * | aDrawer | ) |
Sets the observer for overriding default highlight input layer drawing functionality. Note that you should still call AboutToDrawHighlightAnim (it will call the observer if it is set).
| MListBoxAnimBackgroundDrawer * aDrawer | Highlight animation drawer. |
| IMPORT_C void | SetIconArray | ( | CArrayPtr< CGulIcon > * | aArray | ) |
SetIconArray sets the icon array used when drawing bitmaps. The array can be modified (no need to call this method when modifying), even in MdcaPoint() or MdcaCount() methods of MDesCArray class. See also CTextListBoxModel::SetItemTextArray().
The most common way to crash a listbox is by forgetting to call this method, or the list item string for graphics cell is not an index of a bitmap.
| IMPORT_C void | SetIconArrayL | ( | CArrayPtr< CGulIcon > * | aArray | ) |
Sets the icon array used when drawing bitmaps. The array can be modified (no need to call this method when modifying), even in MdcaPoint() or MdcaCount() methods of MDesCArray class. See also CTextListBoxModel::SetItemTextArray().
The most common way to crash a listbox is by forgetting to call this method, or the list item string for graphics cell is not an index of a bitmap.
| IMPORT_C void | SetItemCellSize | ( | const TSize & | aSize | ) |
Changes item cell size and resizes highlight animation. Called by list when item cell size changes. If you are using non-standard highlight sizes make sure to sync the list item cell size.
| const TSize & aSize | New cell size. |
| IMPORT_C void | SetLayoutInit | ( | TBool | aValue | ) |
Sets LayOutInit flag used for drawing separator lines in lists.
| TBool aValue |
| IMPORT_C void | SetListEndSkinStyle | ( | const TAknsItemID * | listEndId, |
| const TRect & | aRect | |||
| ) | ||||
Modify properties of the skin context (list ending)*
Symbian 2.0
| const TAknsItemID * listEndId | List ending skin background identifier. |
| const TRect & aRect | List ending background area from LAF. |
| IMPORT_C void | SetMarqueeParams | ( | const TInt | aLoops, |
| const TInt | aScrollAmount, | |||
| const TInt | aScrollDelay, | |||
| const TInt | aInterval | |||
| ) | ||||
Customizes marquee default behavior. Use this before enabling marquee ( EnableMarqueeL() ), otherwise marquee behavior will change during animation.
S60 2.8
| const TInt aLoops | Max number of loops to be executed (default 1). |
| const TInt aScrollAmount | The amount of pixels scrolled per frame (default 6). |
| const TInt aScrollDelay | The delay between each loop (in microseconds, default 1000000 microseconds). |
| const TInt aInterval | The interval between frame updates after the initial delay, in microseconds. |
| IMPORT_C void | SetNotAlwaysDrawnSubCellL | ( | TInt | aSubCellIndex, |
| TBool | aIsNotAlwaysDrawn | |||
| ) | ||||
Sets whether drawing algorithm always draws the cell.
| IMPORT_C void | SetNumberCellL | ( | TInt | aSubCellIndex, |
| TBool | aIsNumberCell | |||
| ) | ||||
Sets whether the cell is used for numbers.
Symbian 2.0
| IMPORT_C void | SetRespectFocus | ( | TBool | aBool | ) |
Sets RespectFocus flag.
| TBool aBool | Value of RespectFocus flag. ETrue means that the list item highlight is only shown if list is focused on. |
| IMPORT_C void | SetSeparatorLinePosition | ( | TAknSeparatorLinePosition | aPosition | ) |
Sets position of listbox separator line.
| TAknSeparatorLinePosition aPosition | Position in which separator line is placed. |
| IMPORT_C void | SetSkinEnabledL | ( | TBool | aEnabled | ) |
Sets whether skins are enabled on this list. The default value is determined from global setting from CAknAppUi.
Symbian 2.0
| TBool aEnabled | If ETrue skins are set enabled. If EFalse skins are set disabled. |
| IMPORT_C void | SetSkinHighlightFrame | ( | const TAknsItemID * | aFrameId, |
| const TAknsItemID * | aFrameCenterId | |||
| ) | ||||
Set list higlight skin style.
Symbian 2.0
| const TAknsItemID * aFrameId | The id for the frame. |
| const TAknsItemID * aFrameCenterId | The id for the frame center. |
| IMPORT_C void | SetSkinParentPos | ( | const TPoint & | aPos | ) |
Modify position of the parent for list default context.
Symbian 2.0
| const TPoint & aPos | The new position. |
| IMPORT_C void | SetSkinPopupFrame | ( | const TAknsItemID * | aFrameId, |
| const TAknsItemID * | aFrameCenterId | |||
| ) | ||||
Set popup skin style.
Symbian 2.0
| const TAknsItemID * aFrameId | The id for the frame. |
| const TAknsItemID * aFrameCenterId | The id for the frame center. |
| IMPORT_C void | SetSkinPopupFramePosition | ( | const TRect & | aOuterRect, |
| const TRect & | aInnerRect | |||
| ) | ||||
Set popup skin frame position.
Symbian 2.0
| IMPORT_C void | SetSkinStyle | ( | const TAknsItemID * | aId, |
| const TRect & | aTileRect | |||
| ) | ||||
Modify properties of the skin context (AB-column).
Symbian 2.0
| const TAknsItemID * aId | Skin background identifier. |
| const TRect & aTileRect | Skin background area from LAF. |
| void | SetStretchableConditionalSubCellL | ( | TInt | aSubCell, |
| const TAknTextComponentLayout & | aNormalLayout, | |||
| const TAknTextComponentLayout & | aStretchedLayout, | |||
| TInt | aNormalSubCell, | |||
| TInt | aStretchedSubCell | |||
| ) | ||||
| void | SetStretchableGraphicSubCellL | ( | TInt | aSubCell, |
| const TAknWindowComponentLayout & | aNormalLayout, | |||
| const TAknWindowComponentLayout & | aStretchedLayout | |||
| ) | ||||
| TInt aSubCell | |
| const TAknWindowComponentLayout & aNormalLayout | |
| const TAknWindowComponentLayout & aStretchedLayout |
| void | SetStretchableTextSubCellL | ( | TInt | aSubCell, |
| const TAknTextComponentLayout & | aNormalLayout, | |||
| const TAknTextComponentLayout & | aStretchedLayout | |||
| ) | ||||
| TInt aSubCell | |
| const TAknTextComponentLayout & aNormalLayout | |
| const TAknTextComponentLayout & aStretchedLayout |
| IMPORT_C void | SetSubCellAlignmentL | ( | TInt | aSubCellIndex, |
| CGraphicsContext::TTextAlign | aAlign | |||
| ) | ||||
Sets the alignment attached to the cell.
| TInt aSubCellIndex | Index number of the subcell. |
| CGraphicsContext::TTextAlign aAlign | Alignment that is attached to the cell |
| IMPORT_C void | SetSubCellBaselinePosL | ( | TInt | aSubCellIndex, |
| TInt | aPos | |||
| ) | ||||
Sets baseline position from top of the cell.
| IMPORT_C void | SetSubCellColorsL | ( | TInt | aSubCellIndex, |
| const TColors & | aColors | |||
| ) | ||||
Sets colours attached to the cell.
| IMPORT_C void | SetSubCellFontForRowL | ( | TInt | aRowIndex, |
| TInt | aSubCellIndex, | |||
| const CFont * | aFont | |||
| ) | ||||
Sets the font attached to the cell for each row separately.
| IMPORT_C void | SetSubCellFontL | ( | TInt | aSubCellIndex, |
| const CFont * | aFont | |||
| ) | ||||
Sets the font attached to the cell.
| IMPORT_C void | SetSubCellIconSize | ( | TInt | aIndex, |
| TSize | aSize | |||
| ) | ||||
Sets the size of the subcell's icon.
| IMPORT_C void | SetSubCellMarginsL | ( | TInt | aSubCellIndex, |
| TMargins | aMargins | |||
| ) | ||||
Sets margins for the content inside the cell.
| IMPORT_C void | SetSubCellPositionL | ( | TInt | aSubCellIndex, |
| TPoint | aPosition | |||
| ) | ||||
Sets cell position inside an item.
| void | SetSubCellRealTextSize | ( | TInt | aSubCellIndex, |
| TSize | aRealSize | |||
| ) | const | |||
| IMPORT_C void | SetSubCellRightSeparatorStyleL | ( | TInt | aSubCell, |
| CGraphicsContext::TPenStyle | aStyle | |||
| ) | ||||
Sets whether vertical line is drawn to the right side of the cell.
| TInt aSubCell | Index number of the subcell. |
| CGraphicsContext::TPenStyle aStyle | Style of a pen used to draw a line for the right side of the cell. |
| IMPORT_C void | SetSubCellSizeL | ( | TInt | aSubCellIndex, |
| TSize | aSize | |||
| ) | ||||
Sets cell size in pixels.
| IMPORT_C void | SetSubCellTextClipGapL | ( | TInt | aSubCellIndex, |
| TInt | aGap | |||
| ) | ||||
Sets the amount of pixels truncation grows a text element.
| IMPORT_C void | SetSubcellUnderlined | ( | TBitFlags32 | aUnderlinedCells | ) |
Enables or disables underlining per text subcell only if TListItemProperties also has underlining enabled. If this method is not called and TListItemProperties has underlining enabled, drawing will revert to old style where only first text subcell will be underlined.
S60 3.1
| TBitFlags32 aUnderlinedCells | Bitmask of cells to be underlined. |
| void | SetTextSubCellL | ( | TInt | aSubCell, |
| const TAknTextLineLayout & | aTextLayout | |||
| ) | ||||
Support for new layouts.
Set text line layout for the defined sub cell.
| TInt aSubCell | |
| const TAknTextLineLayout & aTextLayout |
| IMPORT_C void | SetTransparentSubCellL | ( | TInt | aSubCellIndex, |
| TBool | aIsTransparent | |||
| ) | ||||
Modifies whether the cell can overlap with one of the previous cells.
| void | SetUnderlineStyle | ( | TListItemProperties | aProperties, |
| CWindowGc & | aGc, | |||
| TInt | aSubCell | |||
| ) | const [private] | |||
| TListItemProperties aProperties | |
| CWindowGc & aGc | |
| TInt aSubCell |
| void | SetWordWrappedSubcellIndices | ( | TInt | aFirstIndex, |
| TInt | aSecondIndex | |||
| ) | ||||
Disables logical-to-visual conversion in subcells between indexes.
| void | SetupSkinContextL | ( | ) |
Create and set the defaul skin context. Needed by the dynamic skin support.
| IMPORT_C MAknsControlContext * | SkinBackgroundContext | ( | ) | const |
Access to the background context of the listbox.
Symbian 2.0
Skin background context.
| IMPORT_C TBool | SkinEnabled | ( | ) | const |
SkinEnabled checks whether skins are enabled on this list.
Symbian 2.0
ETrue if enabled, EFalse if disabled.
| IMPORT_C CGraphicsContext::TTextAlign | SubCellAlignment | ( | TInt | aSubCellIndex | ) | const |
Gets the alignment attached to the cell.
Alignment of the text.
| TInt aSubCellIndex | Index number of the subcell. |
| IMPORT_C TInt | SubCellBaselinePos | ( | TInt | aSubCellIndex | ) | const |
Gets baseline position from top of the cell.
Baseline y-position.
| TInt aSubCellIndex | Index number of the subcell. |
| IMPORT_C const TColors & | SubCellColors | ( | TInt | aSubCellIndex | ) | const |
Gets colours attached to the cell.
Text and background colors.
| TInt aSubCellIndex | Index number of the subcell. |
| IMPORT_C const CFont * | SubCellFont | ( | TInt | aSubCellIndex | ) | const |
Gets font attached to the cell.
Handle to the attached font.
| TInt aSubCellIndex | Index number of the subcell. |
| IMPORT_C TBool | SubCellIsGraphics | ( | TInt | aSubCellIndex | ) | const |
Checks whetherdrawing algorithm considers the text string in list item as unicode text string displayable on the screen, or as string representation of an index to icon array.
ETrue if graphics cell, EFalse if text cell.
| TInt aSubCellIndex | Index number of the subcell. |
| IMPORT_C TBool | SubCellIsNotAlwaysDrawn | ( | TInt | aSubCellIndex | ) | const |
Checks whether drawing algorithm always draws the cell or whether empty string in list item can disable the drawing of the cell.
ETrue when empty string disables cell, EFalse if always drawn.
| TInt aSubCellIndex | Index number of the subcell. |
| IMPORT_C TBool | SubCellIsNumberCell | ( | TInt | aSubCellIndex | ) | const |
Checks whether the cell is used for numbers.
Symbian 2.0
ETrue if enabled, EFalse if disabled.
| TInt aSubCellIndex | Index number of the subcell. |
| IMPORT_C TBool | SubCellIsTransparent | ( | TInt | aSubCellIndex | ) | const |
Determines whether this cell can overlap with one of the previous cells.
ETrue if cell overlaps another one, EFalse if cell allocates area from other cells.
| TInt aSubCellIndex | Index number of the subcell. |
| IMPORT_C TMargins | SubCellMargins | ( | TInt | aSubCellIndex | ) | const |
Gets margins used for the content inside the cell.
Margins in pixels.
| TInt aSubCellIndex | Index number of the subcell. |
| IMPORT_C TPoint | SubCellPosition | ( | TInt | aSubCellIndex | ) | const |
Gets cell position inside an item.
Cell position.
| TInt aSubCellIndex | Index number of the subcell. |
| TSize | SubCellRealTextSize | ( | TInt | aSubCellIndex | ) | const |
| TInt aSubCellIndex |
| IMPORT_C CGraphicsContext::TPenStyle | SubCellRightSeparatorStyle | ( | TInt | aColumn | ) | const |
Checks whether vertical line is drawn to the right side of the cell.
Style of pen used to draw a line for the right side of the cell.
| TInt aColumn | Index number of the subcell. |
| IMPORT_C TSize | SubCellSize | ( | TInt | aSubCellIndex | ) | const |
Gets cell size in pixels.
Cell size.
| TInt aSubCellIndex | Index number of the subcell. |
| IMPORT_C TInt | SubCellTextClipGap | ( | TInt | aSubCellIndex | ) | const |
Gets the amount of pixels text margins is grown if it is truncated. This is usually very small number used to make the layout look more balanced when text is truncated. (the glyph used for truncation is almost empty and on narrow text elements, it looks odd if the truncated text element is exactly same size as non-truncated version.)
Amount of pixels that are used for growing the text margins in truncation.
| TInt aSubCellIndex | Index number of the subcell. |
| void | SubCellsMightIntersect | ( | const TBool | aMightIntersect | ) |
| const TBool aMightIntersect |
| void | ToggleDropShadows | ( | const TBool | aEnable | ) |
| const TBool aEnable |
| void | UseHighlightIconSwapping | ( | TBool | aUse | ) |
enables certain highlight skinning for radibutton / checkbox set style lists
should be used only by avkon internally
S60 3.1
| TBool aUse |
| IMPORT_C void | UseLogicalToVisualConversion | ( | TBool | aUseConversion | ) |
Enable or disable logical to visual reordering in listbox data text drawing. By default, it is enabled. This has any effect only when bidirectional text is rendered.
If you convert text to visual order prior to passing it to the listbox (for example by wrapping text to lines with methods in AknBidiTextUtils), then you should disable conversion in listbox by calling this method.
Symbian 2.0
| TBool aUseConversion | Enable (ETrue) or disable (EFalse) conversion. |
| IMPORT_C TBool | UseSubCellColors | ( | TInt | aSubCell | ) | const |
Indicates if sub cell is using its own colors rather than common colors.
Boolean indicating whether own colors enabled. ETrue enabled, EFalse disabled.
| TInt aSubCell | Index number of the subcell. |
| TBool | UsesScalableLayoutData | ( | ) | const |
Checks if the list box uses scalable layouts.