CAknNavigationControlContainer Class Reference

#include <mw/aknnavi.h>

class CAknNavigationControlContainer : public CAknControl

Inherits from

Public Member Enumerations
enumanonymous { ETypeId }
Public Member Functions
CAknNavigationControlContainer()
~CAknNavigationControlContainer()
IMPORT_C TIntColorScheme()
virtual IMPORT_C voidConstructFromResourceL(TResourceReader &)
IMPORT_C voidConstructL()
IMPORT_C CAknNavigationDecorator *ConstructNavigationDecoratorFromResourceL(TResourceReader &)
IMPORT_C CAknNavigationDecorator *CreateEditorIndicatorContainerL()
IMPORT_C CAknNavigationDecorator *CreateMessageLabelL(const TDesC &)
IMPORT_C CAknNavigationDecorator *CreateMessageLabelL(TResourceReader &)
IMPORT_C CAknNavigationDecorator *CreateNavigationImageL(const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C CAknNavigationDecorator *CreateNavigationImageL(TResourceReader &)
IMPORT_C CAknNavigationDecorator *CreateNavigationLabelL(const TDesC &)
IMPORT_C CAknNavigationDecorator *CreateNavigationLabelL(TResourceReader &)
IMPORT_C CAknNavigationDecorator *CreateTabGroupL()
IMPORT_C CAknNavigationDecorator *CreateTabGroupL(MAknTabObserver *)
IMPORT_C CAknNavigationDecorator *CreateTabGroupL(TResourceReader &)
IMPORT_C CAknNavigationDecorator *CreateTabGroupL(TResourceReader &, MAknTabObserver *)
IMPORT_C CAknNavigationDecorator *CreateVolumeIndicatorL(TInt)
TInt CurrentNaviWipeBitmap()
voidHandleGainingForegroundL()
voidHandleLosingForeground()
virtual IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
CFbsBitmap &NaviArrowBitmap(TInt)
CFbsBitmap *NaviColorBitmap()
TBool NaviWipeUsed()
voidNotifyNaviWipeStatusL()
IMPORT_C voidPop()
IMPORT_C voidPop(CAknNavigationDecorator *)
IMPORT_C voidPushDefaultL(TBool)
IMPORT_C voidPushL(CAknNavigationDecorator &)
IMPORT_C TIntReplaceL(CAknNavigationDecorator &, CAknNavigationDecorator &)
IMPORT_C CAknNavigationDecorator *ResourceDecorator()
voidSetBackgroundContextAttributes(CCoeControl *, TBool)
IMPORT_C voidSetPreferredNaviDecoratorLayoutStyle(TInt)
IMPORT_C CAknNavigationDecorator *Top()
IMPORT_C CAknNavigationDecorator *Top(TBool)
Protected Member Functions
virtual IMPORT_C CCoeControl *ComponentControl(TInt)
virtual IMPORT_C TIntCountComponentControls()
IMPORT_C voidHandleControlEventL(CCoeControl *, TCoeEvent)
virtual IMPORT_C voidHandleResourceChange(TInt)
TTypeUid::Ptr MopSupplyObject(TTypeUid)
virtual IMPORT_C voidSizeChanged()
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
Inherited Enumerations
CCoeControl:TZoomType
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::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::FocusChanged(TDrawNow)
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)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::MinimumSize()
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
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

A default control in the status pane's navigation pane.

Member Enumeration Documentation

Enum anonymous

EnumeratorValueDescription
ETypeId0x101F8740

Constructor & Destructor Documentation

CAknNavigationControlContainer ( )

IMPORT_CCAknNavigationControlContainer()

C++ default constructor.

This object does not own the contents of the navi pane controls stack.

~CAknNavigationControlContainer ( )

IMPORT_C~CAknNavigationControlContainer()

Destructor.

This object does not own the contents of the navi pane controls stack.

Member Function Documentation

ColorScheme ( )

IMPORT_C TIntColorScheme()[static]

Static method to return current color scheme.

Returns: Current color scheme value.

ComponentControl ( TInt )

IMPORT_C CCoeControl *ComponentControl(TIntaIndex)const [protected, virtual]

From CCoeControl.

Returns a control determined by control id.

ParameterDescription
aIndexIndex of a control to be returned.

Returns: Pointer to control.

ConstructFromResourceL ( TResourceReader & )

IMPORT_C voidConstructFromResourceL(TResourceReader &aReader)[virtual]

Constructs from a resource. Created object is owned by this object until ResourceDecorator() method is called. If the application does not fetch the object it is deleted in destructor.

ParameterDescription
aReaderResource reader.

ConstructL ( )

IMPORT_C voidConstructL()

Handles 2nd phase construction.

ConstructNavigationDecoratorFromResourceL ( TResourceReader & )

IMPORT_C CAknNavigationDecorator *ConstructNavigationDecoratorFromResourceL(TResourceReader &aReader)

Resource constructor that returns a new object to the application.

ParameterDescription
aReaderResource reader.

Returns: Navigation decorator object that contains navigation pane control read from resources.

CountComponentControls ( )

IMPORT_C TIntCountComponentControls()const [protected, virtual]

From CCoeControl.

Returns number of controls inside the context pane control.

Returns: Number of component controls.

CreateEditorIndicatorContainerL ( )

IMPORT_C CAknNavigationDecorator *CreateEditorIndicatorContainerL()

Creates editor indicator container control to the navi pane. The ownership of the object is transferred to the application.

Returns: Navigation decorator object that contains editor indicator container.

CreateMessageLabelL ( const TDesC & )

IMPORT_C CAknNavigationDecorator *CreateMessageLabelL(const TDesC &aText =  KNullDesC )

Creates and returns a new navigation decorator object containing help text. The ownership of the object is transferred to the application.

ParameterDescription
aTextHelp text label to be shown in the navigation pane.

Returns: Navigation decorator object that contains message label (=hint text).

CreateMessageLabelL ( TResourceReader & )

IMPORT_C CAknNavigationDecorator *CreateMessageLabelL(TResourceReader &aReader)

Creates from a resource and returns a new navigation decorator object containing help text. The ownership of the object is transferred to the application.

ParameterDescription
aReaderResource reader.

Returns: Navigation decorator object that contains message label (=hint text).

CreateNavigationImageL ( const CFbsBitmap *, const CFbsBitmap * )

IMPORT_C CAknNavigationDecorator *CreateNavigationImageL(const CFbsBitmap *aBitmap = NULL,
const CFbsBitmap *aMaskBitmap = NULL
)

Creates and returns a new navigation decorator object containing navigation image. The ownership of the returned object is transferred to the application. Moves ownership of aBitmap and aMaskBitmap to the navigation decorator object at the end of the method.

ParameterDescription
aBitmapImage to be shown in the navigation pane.
aMaskBitmapMask of the image to be shown in the navigation panel.

Returns: Navigation decorator object that contains navigation image.

CreateNavigationImageL ( TResourceReader & )

IMPORT_C CAknNavigationDecorator *CreateNavigationImageL(TResourceReader &aReader)

Creates from a resource and returns a new navigation decorator object containing navigation image. The ownership of the returned object is transferred to the application.

ParameterDescription
aReaderResource reader.

Returns: Navigation decorator object that contains navigation image.

CreateNavigationLabelL ( const TDesC & )

IMPORT_C CAknNavigationDecorator *CreateNavigationLabelL(const TDesC &aText =  KNullDesC )

Creates and returns a new navigation decorator object containing navigation label. The ownership of the object is transferred to the application.

ParameterDescription
aTextLabel text to the navigation pane.

Returns: Navigation decorator object that contains navigation label.

CreateNavigationLabelL ( TResourceReader & )

IMPORT_C CAknNavigationDecorator *CreateNavigationLabelL(TResourceReader &aReader)

Creates from a resource and returns a new navigation decorator object containing navigation label. The ownership of the object is transferred to the application.

ParameterDescription
aReaderResource reader.

Returns: Navigation decorator object that contains navigation label.

CreateTabGroupL ( )

IMPORT_C CAknNavigationDecorator *CreateTabGroupL()

Creates and returns a new navigation decorator object containing tab group. The ownership of the object is transferred to the application.

Returns: Navigation decorator object that contains tab group.

CreateTabGroupL ( MAknTabObserver * )

IMPORT_C CAknNavigationDecorator *CreateTabGroupL(MAknTabObserver *aObserver)

Creates and returns a new navigation decorator object containing tab group. The ownership of the object is transferred to the application.

ParameterDescription
aObserverPointer to tab group observer

Returns: Navigation decorator object that contains tab group.

CreateTabGroupL ( TResourceReader & )

IMPORT_C CAknNavigationDecorator *CreateTabGroupL(TResourceReader &aReader)

Creates from a resource and returns a new navigation decorator object containing tab group. The ownership of the object is transferred to the application.

ParameterDescription
aReaderResource reader.

Returns: Navigation decorator object that contains tab group.

CreateTabGroupL ( TResourceReader &, MAknTabObserver * )

IMPORT_C CAknNavigationDecorator *CreateTabGroupL(TResourceReader &aReader,
MAknTabObserver *aObserver
)

Creates from a resource and returns a new navigation decorator object containing tab group. The ownership of the object is transferred to the application.

ParameterDescription
aReaderResource reader.
aObserverPointer to tab group observer.

Returns: Navigation decorator object that contains tab group.

CreateVolumeIndicatorL ( TInt )

IMPORT_C CAknNavigationDecorator *CreateVolumeIndicatorL(TIntaResourceId)

Creates volume control indicator to the navi pane. The ownership of the object is transferred to the application.

DeprecatedNavi pane volume control is not supported anymore.

ParameterDescription
aResourceIdResource file id for the volume control

Returns: Navigation decorator object that contains volume indicator.

CurrentNaviWipeBitmap ( )

TInt CurrentNaviWipeBitmap()[static]

Gets current wipe bitmap for navi pane.

Returns: Wipe bitmap Id

HandleControlEventL ( CCoeControl *, TCoeEvent )

IMPORT_C voidHandleControlEventL(CCoeControl *aControl,
TCoeEventaEventType
)[protected]

From MCoeControlObserver.

Handles Control event.

ParameterDescription
aControlControl that caused the event.
aEventTypeType of the event.

HandleGainingForegroundL ( )

voidHandleGainingForegroundL()

Used to notify the navi pane when it gains foreground.

HandleLosingForeground ( )

voidHandleLosingForeground()

Used to notify the navi pane when it goes to background.

HandlePointerEventL ( const TPointerEvent & )

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

From CCoeControl.

Handles pointer events

ParameterDescription
aPointerEventThe pointer event.

HandleResourceChange ( TInt )

IMPORT_C voidHandleResourceChange(TIntaType)[protected, virtual]

From CCoeControl.

Handles a change to the control's resources of type aType which are shared across the environment, e.g. color scheme change.

ParameterDescription
aTypeEvent type.

MopSupplyObject ( TTypeUid )

TTypeUid::Ptr MopSupplyObject(TTypeUidaId)[protected]

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 aId.

ParameterDescription
aIdAn encapsulated object type ID.

Returns: Encapsulated pointer to the provided object. Note that the encapsulated pointer may be NULL.

NaviArrowBitmap ( TInt )

CFbsBitmap &NaviArrowBitmap(TIntaId)

This non-exported method returns reference to navi arrow bitmaps.

ParameterDescription
aIdId of the bitmap.

Returns: Reference to the navi arrow bitmap.

NaviColorBitmap ( )

CFbsBitmap *NaviColorBitmap()const

Gets navi bitmap.

Returns: Bitmap's colour.

NaviWipeUsed ( )

TBool NaviWipeUsed()const

Not used / implemented

Deprecated

Since
S60 3.0

Returns: EFalse

NotifyNaviWipeStatusL ( )

voidNotifyNaviWipeStatusL()

Used by the UI framework. Notifies context and signal panes wheter navi wipe graphichs is to be drawn or not.

Pop ( )

IMPORT_C voidPop()

Pops topmost object from the navigation pane's object stack. If editor indicator control is topmost, it is not popped. The next control is popped instead. It is not possible to pop editor indicator object with this method. Use Pop(CAknNavigationDecorator* aControl) or delete(aControl) instead if editor indicator control is needed to be popped.

Pop ( CAknNavigationDecorator * )

IMPORT_C voidPop(CAknNavigationDecorator *aControl)

Pops (remove) certain object from the navigation pane's object stack. The removed object does not need to be topmost.

ParameterDescription
aControlObject to be removed from the stack.

PushDefaultL ( TBool )

IMPORT_C voidPushDefaultL(TBoolaAllowDuplicates = EFalse)

Pushes default content (empty navigation pane) to the navigation pane's object stack. This operation also draws default content to the navigation pane.

ParameterDescription
aAllowDuplicatesIf this is ETrue, duplicate default navi pane contents are allowed.

PushL ( CAknNavigationDecorator & )

IMPORT_C voidPushL(CAknNavigationDecorator &aNaviPaneControl)

Pushes a navigation decorator object to the navigation pane's object stack. This operation also draws the control to the navigation pane. An object can be on the stack only once. If the object already exists in the stack it is moved to topmost object. Ownership is not transfered. Editor indicator control has priority over others. It is always at the top if it exists. In this case all other controls are pushed under the editor indicator object.

ParameterDescription
aNaviPaneControlObject to be added at the top of the stack.

ReplaceL ( CAknNavigationDecorator &, CAknNavigationDecorator & )

IMPORT_C TIntReplaceL(CAknNavigationDecorator &aToBeReplaced,
CAknNavigationDecorator &aReplacement
)

Replaces existing navigation decorator object in the navigation pane's object stack. Any object can be on the stack only once. If the replacement object already exists in the stack, previous copy is removed from the stack. Ownership is not transfered. Navi pane is redrawn if top item is changed.

ParameterDescription
aToBeReplacedAn object to be replaced.
aReplacementAn object that is put to the stack instead.

Returns: Error number. KErrNone if the operation succeeds. KErrNotFound if 'aToBeReplaced' object cannot be found from the stack.

ResourceDecorator ( )

IMPORT_C CAknNavigationDecorator *ResourceDecorator()

Returns the object constructed from resources with ConstrucFromResourcesL() -method to the application. Ownership of the object is transferred to the application.

Returns: Navigation Decorator object that was created from resources.

SetBackgroundContextAttributes ( CCoeControl *, TBool )

voidSetBackgroundContextAttributes(CCoeControl *aControl,
TBoolaNaviWipeUsed
)[static]

Not used / implemented

Deprecated

Since
S60 3.0

SetPreferredNaviDecoratorLayoutStyle ( TInt )

IMPORT_C voidSetPreferredNaviDecoratorLayoutStyle(TIntaLayoutStyle)

This method can be used to set preferred layout style for navi decorator objects that are pushed into navistack. Given layout is applied to objects only if that object supports it and status pane layout allows that mode to be used.

Since
3.1
ParameterDescription
aLayoutStyleCAknNavigationDecorator::ENaviControlLayoutNormal, CAknNavigationDecorator::ENaviControlLayoutNarrow or CAknNavigationDecorator::ENaviControlLayoutWide

SizeChanged ( )

IMPORT_C voidSizeChanged()[protected, virtual]

Reimplemented from CCoeControl::SizeChanged()

From CCoeControl.

Handles the size change events.

Top ( )

IMPORT_C CAknNavigationDecorator *Top()

Returns topmost object from navigation pane's object stack. Editor indicator object is transparent for this operation. If editor indicators exist on the navi pane, next object on the stack is returned.

Returns: Navigation decorator object that is topmost in navigation pane's object stack.

Top ( TBool )

IMPORT_C CAknNavigationDecorator *Top(TBoolaIgnoreFepEditorIndicator)const

Return topmost object from navigation pane's object stack. FEP Editor indicator object is transparent or visible for this operation depending on the given parameter value. If editor indicator object is to be ignored and it exist on the navi pane, next object on the stack is returned. Note that generally FEP does all the needed visibility etc. handling for FEP editor indicators, so by default applications should ignore FEP editor indicators.

Since
3.1
ParameterDescription
aIgnoreFepEditorIndicatorTells if editor indicator object is ignored.

Returns: Navigation decorator object that is topmost in navigation pane's object stack.