CAknTabGroup Class Reference
#include
<mw/akntabgrp.h>
| class CAknTabGroup : public CAknControl |
| Public Member Functions |
|---|
| ~CAknTabGroup() |
| IMPORT_C TInt | ActiveTabId() |
| IMPORT_C TInt | ActiveTabIndex() |
| IMPORT_C TInt | AddTabL(TResourceReader &) |
| IMPORT_C void | AddTabL(TInt, const TDesC &) |
| IMPORT_C void | AddTabL(TInt, const TDesC &, const CFbsBitmap *, const CFbsBitmap *) |
| IMPORT_C void | AddTabL(TInt, const CFbsBitmap *, const CFbsBitmap *) |
| IMPORT_C void | DeleteTabL(TInt) |
| IMPORT_C void | DimTab(TInt, TBool) |
| virtual IMPORT_C void | GetColorUseListL(CArrayFix< TCoeColorUse > &) |
| virtual IMPORT_C void | HandleControlEventL(CCoeControl *, TCoeEvent) |
| virtual IMPORT_C void | HandleNaviDecoratorEventL(TInt) |
| virtual IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| virtual void | HandleResourceChange(TInt) |
| virtual IMPORT_C TBool | IsTabDimmed(TInt) |
| virtual IMPORT_C TSize | MinimumSize() |
| IMPORT_C CAknTabGroup * | NewL(const CCoeControl &) |
| IMPORT_C CAknTabGroup * | NewLC(const CCoeControl &) |
| virtual IMPORT_C TKeyResponse | OfferKeyEventL(const TKeyEvent &, TEventCode) |
| virtual IMPORT_C void | PrepareContext(CWindowGc &) |
| IMPORT_C void | ReplaceTabL(TResourceReader &) |
| IMPORT_C void | ReplaceTabL(TInt, const TDesC &) |
| IMPORT_C void | ReplaceTabL(TInt, const TDesC &, const CFbsBitmap *, const CFbsBitmap *) |
| IMPORT_C void | ReplaceTabL(TInt, const CFbsBitmap *, const CFbsBitmap *) |
| IMPORT_C void | ReplaceTabTextL(TInt, const TDesC &) |
| IMPORT_C void | SetActiveTabById(TInt) |
| IMPORT_C void | SetActiveTabByIndex(TInt) |
| void | SetDecoratorLayout(TBool) |
| void | SetNarrowTabLayoutL(TBool, TBool) |
| void | SetNaviArrowsVisible(TBool) |
| IMPORT_C void | SetObserver(MAknTabObserver *) |
| IMPORT_C void | SetTabFixedWidthL(TInt) |
| IMPORT_C void | SetTabMultiColorMode(TInt, TBool) |
| virtual IMPORT_C TInt | TabCount() |
| virtual IMPORT_C TInt | TabIdFromIndex(TInt) |
| virtual IMPORT_C TInt | TabIndexFromId(TInt) |
| Inherited Functions |
|---|
| | CAknControl::CAknControl() |
| | CAknControl::~CAknControl() |
| | CBase::CBase() |
| | CBase::Delete(CBase *) |
| | CBase::Extension_(TUint,TAny *&,TAny *) |
| | CBase::operator new(TUint) |
| | CBase::operator new(TUint,TAny *) |
| | CBase::operator new(TUint,TLeave) |
| | CBase::operator new(TUint,TLeave,TUint) |
| | CBase::operator new(TUint,TUint) |
| | CBase::~CBase() |
| | CCoeControl::AccumulatedZoom()const |
| | CCoeControl::ActivateGc()const |
| | CCoeControl::ActivateL() |
| | CCoeControl::BackedUpWindow()const |
| | CCoeControl::Background()const |
| | CCoeControl::CCoeControl() |
| | CCoeControl::CCoeControl(CCoeEnv *) |
| | CCoeControl::CCoeControl(const CCoeControl &) |
| | CCoeControl::CCoeControlArray |
| | CCoeControl::CapturesPointer()const |
| | CCoeControl::ClaimPointerGrab(TBool) |
| | CCoeControl::ClaimPointerGrab(TInt,TBool) |
| | CCoeControl::CloseWindow() |
| | CCoeControl::ComponentArrayExists()const |
| | CCoeControl::Components() |
| | CCoeControl::Components()const |
| | CCoeControl::ConstructFromResourceL(TResourceReader &) |
| | CCoeControl::ControlContext()const |
| | CCoeControl::ControlEnv()const |
| | CCoeControl::CopyControlContextFrom(const CCoeControl *) |
| | CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &) |
| | CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode) |
| | CCoeControl::CreateWindowL() |
| | CCoeControl::CreateWindowL(RWindowGroup *) |
| | CCoeControl::CreateWindowL(RWindowTreeNode &) |
| | CCoeControl::CreateWindowL(const CCoeControl *) |
| | CCoeControl::CustomGc()const |
| | CCoeControl::DeactivateGc()const |
| | CCoeControl::DrawBackground(const TRect &)const |
| | CCoeControl::DrawDeferred()const |
| | CCoeControl::DrawForeground(const TRect &)const |
| | CCoeControl::DrawNow()const |
| | CCoeControl::DrawNow(const TRect &)const |
| | CCoeControl::DrawableWindow()const |
| | CCoeControl::EnableDragEvents() |
| | CCoeControl::EnableReportControlStateChange(TBool) |
| | CCoeControl::EnableWindowTransparency() |
| | CCoeControl::FindBackground()const |
| | CCoeControl::FindFontProvider()const |
| | CCoeControl::GetColor(TInt,TRgb &)const |
| | CCoeControl::GetGc()const |
| | CCoeControl::GetHelpContext(TCoeHelpContext &)const |
| | CCoeControl::GrabbingComponent()const |
| | CCoeControl::GrabbingComponent(TInt)const |
| | CCoeControl::HandleComponentControlsResourceChange(TInt) |
| | CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt) |
| | CCoeControl::HandlePointerBufferReadyL() |
| | CCoeControl::HandleRedrawEvent(const TRect &)const |
| | CCoeControl::HasBorder()const |
| | CCoeControl::HitTest()const |
| | CCoeControl::IgnoreEventsUntilNextPointerUp() |
| | CCoeControl::Index(const CCoeControl *)const |
| | CCoeControl::InitComponentArrayL() |
| | CCoeControl::InputCapabilities()const |
| | CCoeControl::IsActivated()const |
| | CCoeControl::IsBackedUp()const |
| | CCoeControl::IsBeingDestroyed()const |
| | CCoeControl::IsBlank()const |
| | CCoeControl::IsDimmed()const |
| | CCoeControl::IsFocused()const |
| | CCoeControl::IsNonFocusing()const |
| | CCoeControl::IsReadyToDraw()const |
| | CCoeControl::IsVisible()const |
| | CCoeControl::LayoutManager()const |
| | CCoeControl::MakeVisible(TBool) |
| | CCoeControl::MaximumWidth()const |
| | CCoeControl::MopSupplyObject(TTypeUid) |
| | CCoeControl::NotifyFontChange(const CCoeFontProvider *) |
| | CCoeControl::Observer()const |
| | CCoeControl::OverrideColorL(TInt,TRgb) |
| | CCoeControl::OwnsWindow()const |
| | CCoeControl::Parent() |
| | CCoeControl::Parent()const |
| | CCoeControl::Position()const |
| | CCoeControl::PositionChanged() |
| | CCoeControl::PositionRelativeToScreen()const |
| | CCoeControl::PrepareForFocusGainL() |
| | CCoeControl::PrepareForFocusLossL() |
| | CCoeControl::ProcessPointerBufferReadyL() |
| | CCoeControl::ProcessPointerEventL(const TPointerEvent &) |
| | CCoeControl::Rect()const |
| | CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const |
| | CCoeControl::RecursivelyMergedInputCapabilities()const |
| | CCoeControl::RefetchPixelMappingL() |
| | CCoeControl::RemoveFromParent() |
| | CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent) |
| | CCoeControl::RequestRelayout(const CCoeControl *) |
| | CCoeControl::ResetGc()const |
| | CCoeControl::ScreenFont(const TCoeFont &)const |
| | CCoeControl::SetAdjacent(TInt) |
| | CCoeControl::SetAllowStrayPointers() |
| | CCoeControl::SetBackground(const MCoeControlBackground *) |
| | CCoeControl::SetBlank() |
| | CCoeControl::SetCanDrawOutsideRect() |
| | CCoeControl::SetComponentsToInheritVisibility(TBool) |
| | CCoeControl::SetContainerWindowL(RBackedUpWindow &) |
| | CCoeControl::SetContainerWindowL(RWindow &) |
| | CCoeControl::SetContainerWindowL(const CCoeControl &) |
| | CCoeControl::SetControlContext(MCoeControlContext *) |
| | CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &) |
| | CCoeControl::SetCustomGc(CWindowGc *) |
| | CCoeControl::SetDimmed(TBool) |
| | CCoeControl::SetExtent(const TPoint &,const TSize &) |
| | CCoeControl::SetExtentToWholeScreen() |
| | CCoeControl::SetFocus(TBool,TDrawNow) |
| | CCoeControl::SetFocusing(TBool) |
| | CCoeControl::SetFontProviderL(const CCoeFontProvider &) |
| | CCoeControl::SetGc(CWindowGc *)const |
| | CCoeControl::SetGloballyCapturing(TBool) |
| | CCoeControl::SetHitTest(const MCoeControlHitTest *) |
| | CCoeControl::SetLayoutManagerL(MCoeLayoutManager *) |
| | CCoeControl::SetMaximumWidth(TInt) |
| | CCoeControl::SetMopParent(MObjectProvider *) |
| | CCoeControl::SetNeighbor(CCoeControl *) |
| | CCoeControl::SetNonFocusing() |
| | CCoeControl::SetObserver(MCoeControlObserver *) |
| | CCoeControl::SetParent(CCoeControl *) |
| | CCoeControl::SetPointerCapture(TBool) |
| | CCoeControl::SetPosition(const TPoint &) |
| | CCoeControl::SetRect(const TRect &) |
| | CCoeControl::SetSize(const TSize &) |
| | CCoeControl::SetSizeWithoutNotification(const TSize &) |
| | CCoeControl::SetTextBaselineSpacing(TInt) |
| | CCoeControl::SetUniqueHandle(TInt) |
| | CCoeControl::SetZoomFactorL(TInt,TZoomType) |
| | CCoeControl::Size()const |
| | CCoeControl::SystemGc()const |
| | CCoeControl::TextBaselineOffset(const TSize &)const |
| | CCoeControl::TextDrawer(TInt)const |
| | CCoeControl::UniqueHandle()const |
| | CCoeControl::Window()const |
| | CCoeControl::WriteInternalStateL(RWriteStream &)const |
| | CCoeControl::WriteInternalStateNowL(RWriteStream &)const |
| | CCoeControl::ZoomWithType()const |
| | CCoeControl::operator=(const CCoeControl &) |
| | CCoeControl::~CCoeControl() |
Detailed Description
Tab group functionality for navigation pane.
Member Enumeration Documentation
Enum TDirection
Directions in which the tab group focus can be moved.
| Enumerator | Value | Description |
|---|
| ELeft | | |
| ERight | | |
Constructor & Destructor Documentation
Member Function Documentation
ActiveTabId ( )
| IMPORT_C TInt | ActiveTabId | ( | ) | const |
Returns the ID of the currently active (highlighted) tab.
Returns: ID of the highlighted tab.
ActiveTabIndex ( )
| IMPORT_C TInt | ActiveTabIndex | ( | ) | const |
Returns the index of the currently active (highlighted) tab.
Returns: Index of the highlighted tab.
AddTabL ( TResourceReader & )
Add a tab to the tab group from resources.
| Parameter | Description | | aReader | Resource reader. |
Returns: ID of the added tab.
AddTabL ( TInt, const TDesC & )
| IMPORT_C void | AddTabL | ( | TInt | aTabId, |
| | const TDesC & | aText |
| | ) | |
Add a tab to the tab group.
| Parameter | Description | | aTabId | ID of the tab to be added. |
AddTabL ( TInt, const TDesC &, const CFbsBitmap *, const CFbsBitmap * )
Add a tab to the tab group.
| Parameter | Description | | aTabId | ID of the tab. |
| aTabBitmap | Bitmap for the tab. Ownership of the bitmap is taken. |
| aMask | Bitmap's mask. Ownership of the mask is taken. |
AddTabL ( TInt, const CFbsBitmap *, const CFbsBitmap * )
Add a tab to the tab group.
| Parameter | Description | | aTabId | ID of the tab. |
| aTabBitmap | Bitmap for the tab. Ownership of the bitmap is taken. |
| aMask | Bitmap's mask. Ownership of the mask is taken. |
ComponentControl ( TInt )
| IMPORT_C CCoeControl * | ComponentControl | ( | TInt | aIndex | ) | const [protected, virtual] |
Returns a component control determined by control index.
| Parameter | Description | | aIndex | Index of a control to be returned. |
Returns: Pointer to the control.
CountComponentControls ( )
| IMPORT_C TInt | CountComponentControls | ( | ) | const [protected, virtual] |
Returns number of controls inside this control.
Returns: Number of component controls.
DeleteTabL ( TInt )
| IMPORT_C void | DeleteTabL | ( | TInt | aTabId | ) | |
Delete a tab from the tab group.
| Parameter | Description | | aTabId | ID of the tab to be deleted. |
DimTab ( TInt, TBool )
| IMPORT_C void | DimTab | ( | TInt | aTabId, |
| | TBool | aDimmed |
| | ) | |
Sets a tab dimmed/not dimmed.
| Parameter | Description | | aTabId | ID of the tab. |
| aDimmed | ETrue to set the tab dimmed, EFalse otherwise. |
FocusChanged ( TDrawNow )
| IMPORT_C void | FocusChanged | ( | TDrawNow | aDrawNow | ) | [protected, virtual] |
This is called when the focus is changed.
| Parameter | Description | | aDrawNow | Whether or not to draw the control. |
GetColorUseListL ( CArrayFix< TCoeColorUse > & )
Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used. Appends the list into aColorUseList.
| Parameter | Description | | aColorUseList | The color list. |
HandleControlEventL ( CCoeControl *, TCoeEvent )
| IMPORT_C void | HandleControlEventL | ( | CCoeControl * | aControl, |
| | TCoeEvent | aEventType |
| | ) | [virtual] |
Handles an event from an observed control.
| Parameter | Description | | aControl | Control that caused the event. |
| aEventType | Type of the event. |
HandleNaviDecoratorEventL ( TInt )
| IMPORT_C void | HandleNaviDecoratorEventL | ( | TInt | aEventID | ) | [virtual] |
HandlePointerEventL ( const TPointerEvent & )
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Handles pointer events in tabs.
| Parameter | Description | | aPointerEvent | Pointer event to be handled. |
HandleResourceChange ( TInt )
| void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
Handles a change to the control's resources.
| Parameter | Description | | aType | The type of resource change. |
IsTabDimmed ( TInt )
| IMPORT_C TBool | IsTabDimmed | ( | TInt | aTabId | ) | const [virtual] |
Used to check whether or not a tab is dimmed.
| Parameter | Description | | aTabId | ID of the tab. |
Returns: ETrue if the tab is dimmed, EFalse otherwise.
MinimumSize ( )
| IMPORT_C TSize | MinimumSize | ( | ) | [virtual] |
Return minimum size of the control.
Returns: Minimum size of the control.
NewL ( const CCoeControl & )
| Parameter | Description | | aParent | Parent control. |
NewLC ( const CCoeControl & )
Creates new tab group and pushes it to the clean up stack.
| Parameter | Description | | aParent | Parent control. |
OfferKeyEventL ( const TKeyEvent &, TEventCode )
| Parameter | Description | | aKeyEvent | The key event. |
| aType | The type of the event. |
Returns: Indicates whether or not the key event was used by this control.
PrepareContext ( CWindowGc & )
| IMPORT_C void | PrepareContext | ( | CWindowGc & | aGc | ) | const [virtual] |
Allows to modify graphics context before Draw.
| Parameter | Description | | aGc | Graphics context to be modified. |
ReplaceTabL ( TResourceReader & )
Replaces a tab with a new one from resources. Tab with same ID is replaced.
| Parameter | Description | | aReader | Resource reader. |
ReplaceTabL ( TInt, const TDesC & )
| IMPORT_C void | ReplaceTabL | ( | TInt | aTabId, |
| | const TDesC & | aText |
| | ) | |
Replaces a tab with a new one.
| Parameter | Description | | aTabId | ID of the tab to be replaced. |
ReplaceTabL ( TInt, const TDesC &, const CFbsBitmap *, const CFbsBitmap * )
Replaces a tab with a new one.
| Parameter | Description | | aTabId | ID of the tab to be replaced. |
| aTabBitmap | Bitmap for the tab. Ownership of the bitmap is taken. |
| aMask | Bitmap's mask. Ownership of the mask is taken. |
ReplaceTabL ( TInt, const CFbsBitmap *, const CFbsBitmap * )
Replaces a tab with a new one.
| Parameter | Description | | aTabId | ID of the tab to be replaced. |
| aTabBitmap | Bitmap for the tab. Ownership of the bitmap is taken. |
| aMask | Bitmap's mask. Ownership of the mask is taken. |
ReplaceTabTextL ( TInt, const TDesC & )
| IMPORT_C void | ReplaceTabTextL | ( | TInt | aTabId, |
| | const TDesC & | aTabText |
| | ) | |
Replaces a tab text with a new one.
| Parameter | Description | | aTabId | ID of the tab containing the text to be replaced. |
| aTabText | New tab text. |
ReverseTabOrderL ( )
| void | ReverseTabOrderL | ( | ) | [protected] |
Reverse the order of tabs in tab array.
SetActiveTabById ( TInt )
| IMPORT_C void | SetActiveTabById | ( | TInt | aTabId | ) | |
Activate (highlight) a tab.
| Parameter | Description | | aTabId | ID of the tab to be highlighted. |
SetActiveTabByIndex ( TInt )
| IMPORT_C void | SetActiveTabByIndex | ( | TInt | aTabIndex | ) | |
Activate (highlight) a tab.
| Parameter | Description | | aTabIndex | Index of the tab to be highlighted. |
SetDecoratorLayout ( TBool )
| void | SetDecoratorLayout | ( | TBool | aNarrow | ) | |
Sets the navigation decorator layout so that it corresponds the current tab group layout.
| Parameter | Description | | aNarrow | ETrue if narrow tab group layout is used, EFalse if normal layout is used. |
SetNarrowTabLayoutL ( TBool, TBool )
| void | SetNarrowTabLayoutL | ( | TBool | aNarrow, |
| | TBool | aUseAnimation = EFalse |
| | ) | |
SetNaviArrowsVisible ( TBool )
| void | SetNaviArrowsVisible | ( | TBool | aVisible | ) | |
SetObserver ( MAknTabObserver * )
Sets the tab observer for this tab group.
| Parameter | Description | | aObserver | Tab observer to set. |
SetTabFixedWidthL ( TInt )
| IMPORT_C void | SetTabFixedWidthL | ( | TInt | aWidth | ) | |
Set width of each tab. This width determines what tab layout is used. To get a specific tab layout, use the following constants:
KTabWidthWithOneTab One tab layout
KTabWidthWithTwoTabs Two tabs layout
KTabWidthWithThreeTabs Three tabs layout
KTabWidthWithFourTabs Four tabs layout
KTabWidthWithTwoLongTabs Two long tabs layout
KTabWidthWithThreeLongTabs Three long tabs layout
See also: aknconsts.h.
| Parameter | Description | | aWidth | Width of each tab, |
SetTabMultiColorMode ( TInt, TBool )
| IMPORT_C void | SetTabMultiColorMode | ( | TInt | aTabId, |
| | TBool | aMultiColor |
| | ) | |
Sets the multi-color drawing mode of a tab. This should be called after adding a tab to the tab group if the icon in the tab should be drawn as multi-colored. The tab icon will be drawn using a color specified in the active skin if multi-color mode is not defined.
This function should be called right after a tab containing a multi-color icon is added to the tab group.
| Parameter | Description | | aTabId | ID of the tab. |
| aMultiColor | ETrue to set the multi-color mode on, EFalse to turn it off. |
SizeChanged ( )
| IMPORT_C void | SizeChanged | ( | ) | [protected, virtual] |
Handles the size change events.
TabCount ( )
| IMPORT_C TInt | TabCount | ( | ) | const [virtual] |
Number of tabs in the tab group.
Returns: Number of tabs in the tab group.
TabIdFromIndex ( TInt )
| IMPORT_C TInt | TabIdFromIndex | ( | TInt | aTabIndex | ) | const [virtual] |
| Parameter | Description | | aTabIndex | Index of a tab. |
TabIndexFromId ( TInt )
| IMPORT_C TInt | TabIndexFromId | ( | TInt | aTabId | ) | const [virtual] |
Returns the index of a tab.
| Parameter | Description | | aTabId | ID of a tab. |
Returns: Index of the tab.