CAknNavigationControlContainer Class Reference
class CAknNavigationControlContainer : public CAknControl |
A default control in the status pane's navigation pane.
Inherits from
- CAknNavigationControlContainer
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::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() |
Constructor & Destructor Documentation
CAknNavigationControlContainer()
IMPORT_C | CAknNavigationControlContainer | ( | ) | |
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 Functions Documentation
ColorScheme()
IMPORT_C TInt | ColorScheme | ( | ) | [static] |
Static method to return current color scheme.
ComponentControl(TInt)
IMPORT_C CCoeControl * | ComponentControl | ( | TInt | aIndex | ) | const [protected, virtual] |
From CCoeControl.
Returns a control determined by control id.
Parameters
TInt aIndex | Index of a control to be returned. |
ConstructFromResourceL(TResourceReader &)
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.
ConstructL()
IMPORT_C void | ConstructL | ( | ) | |
Handles 2nd phase construction.
ConstructNavigationDecoratorFromResourceL(TResourceReader &)
Resource constructor that returns a new object to the application.
CountComponentControls()
IMPORT_C TInt | CountComponentControls | ( | ) | const [protected, virtual] |
From CCoeControl.
Returns number of controls inside the context pane control.
CreateEditorIndicatorContainerL()
Creates editor indicator container control to the navi pane. The ownership of the object is transferred to the application.
CreateMessageLabelL(const TDesC &)
Creates and returns a new navigation decorator object containing help text. The ownership of the object is transferred to the application.
Parameters
const TDesC & aText =
KNullDesC
| Help text label to be shown in the navigation pane. |
CreateMessageLabelL(TResourceReader &)
Creates from a resource and returns a new navigation decorator object containing help text. The ownership of the object is transferred to the application.
CreateNavigationImageL(const CFbsBitmap *, const CFbsBitmap *)
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.
Parameters
const CFbsBitmap * aBitmap = NULL | Image to be shown in the navigation pane. |
const CFbsBitmap * aMaskBitmap = NULL | Mask of the image to be shown in the navigation panel. |
CreateNavigationImageL(TResourceReader &)
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.
CreateNavigationLabelL(const TDesC &)
Creates and returns a new navigation decorator object containing navigation label. The ownership of the object is transferred to the application.
CreateNavigationLabelL(TResourceReader &)
Creates from a resource and returns a new navigation decorator object containing navigation label. The ownership of the object is transferred to the application.
CreateTabGroupL()
Creates and returns a new navigation decorator object containing tab group. The ownership of the object is transferred to the application.
CreateTabGroupL(MAknTabObserver *)
Creates and returns a new navigation decorator object containing tab group. The ownership of the object is transferred to the application.
Parameters
MAknTabObserver * aObserver | Pointer to tab group observer |
CreateTabGroupL(TResourceReader &)
Creates from a resource and returns a new navigation decorator object containing tab group. The ownership of the object is transferred to the application.
CreateTabGroupL(TResourceReader &, MAknTabObserver *)
Creates from a resource and returns a new navigation decorator object containing tab group. The ownership of the object is transferred to the application.
Parameters
TResourceReader & aReader | Resource reader. |
MAknTabObserver * aObserver | Pointer to tab group observer. |
CreateVolumeIndicatorL(TInt)
Creates volume control indicator to the navi pane. The ownership of the object is transferred to the application.
Navi pane volume control is not supported anymore.
Parameters
TInt aResourceId | Resource file id for the volume control |
CurrentNaviWipeBitmap()
TInt
| CurrentNaviWipeBitmap | ( | ) | [static] |
Gets current wipe bitmap for navi pane.
Draw(const TRect &)
IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [private, virtual] |
DrawDefaultNaviSolid(CWindowGc &, const TRect &)
Checks wheter default navi solid bitmap can be drawn to navipane and draws it if it is possible.
Parameters
CWindowGc & aGc | Used graphics context. |
const TRect & aRect | Rect of the navipane. |
DrawDefaultNaviWipe(CWindowGc &, const TRect &)
Checks wheter default navi wipe bitmap can be drawn to navipane and draws it if it is possible.
Parameters
CWindowGc & aGc | Used graphics context. |
const TRect & aRect | Rect of the navipane. |
DrawSkinnedNaviSolid(CWindowGc &, const TRect &, MAknsSkinInstance *, MAknsControlContext *)
Checks wheter skinned navi solid bitmap can be drawn to navipane and draws it if it is possible. Also skinned background bitmap is drawn.
DrawSkinnedNaviWipe(CWindowGc &, const TRect &, MAknsSkinInstance *, MAknsControlContext *)
Checks wheter skinned navi wipe bitmap can be drawn to navipane and draws it if it is possible. Also skinned background bitmap is drawn.
ExtensionInterface(TUid)
IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
HandleControlEventL(CCoeControl *, TCoeEvent)
IMPORT_C void | HandleControlEventL | ( | CCoeControl * | aControl, |
| TCoeEvent | aEventType |
| ) | [protected] |
Parameters
CCoeControl * aControl | Control that caused the event. |
TCoeEvent aEventType | Type of the event. |
HandleGainingForegroundL()
void | HandleGainingForegroundL | ( | ) | |
Used to notify the navi pane when it gains foreground.
HandleLosingForeground()
void | HandleLosingForeground | ( | ) | |
Used to notify the navi pane when it goes to background.
HandlePointerEventL(const TPointerEvent &)
IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Parameters
const TPointerEvent & aPointerEvent | The pointer event. |
HandleResourceChange(TInt)
IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [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.
HandleVisibilityOfNonFepOwnedIndicatorControl(CAknNavigationDecorator *, TBool)
IsFepOwnedEditorIndicatorControl(CAknNavigationDecorator *)
LoadNaviColorBitmapL()
void | LoadNaviColorBitmapL | ( | ) | [private] |
MopSupplyObject(TTypeUid)
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.
Parameters
TTypeUid aId | An encapsulated object type ID. |
NaviArrowBitmap(TInt)
This non-exported method returns reference to navi arrow bitmaps.
Parameters
TInt aId | Id of the bitmap. |
NaviWipeUsed()
TBool
| NaviWipeUsed | ( | ) | const |
NotifyNaviWipeStatusL()
void | NotifyNaviWipeStatusL | ( | ) | |
Used by the UI framework. Notifies context and signal panes wheter navi wipe graphichs is to be drawn or not.
Pop()
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 *)
Pops (remove) certain object from the navigation pane's object stack. The removed object does not need to be topmost.
PushDefaultL(TBool)
IMPORT_C void | PushDefaultL | ( | TBool | aAllowDuplicates = EFalse | ) | |
Pushes default content (empty navigation pane) to the navigation pane's object stack. This operation also draws default content to the navigation pane.
Parameters
TBool aAllowDuplicates = EFalse | If this is ETrue, duplicate default navi pane contents are allowed. |
PushL(CAknNavigationDecorator &)
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.
ReplaceL(CAknNavigationDecorator &, CAknNavigationDecorator &)
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.
ResourceDecorator()
Returns the object constructed from resources with ConstrucFromResourcesL() -method to the application. Ownership of the object is transferred to the application.
SetBackgroundContextAttributes(CCoeControl *, TBool)
void | SetBackgroundContextAttributes | ( | CCoeControl * | aControl, |
| TBool | aNaviWipeUsed |
| ) | [static] |
SetContainerWindowNonFading(TBool)
void | SetContainerWindowNonFading | ( | TBool | aNonFading | ) | [private] |
SetPreferredNaviDecoratorLayoutStyle(TInt)
IMPORT_C void | SetPreferredNaviDecoratorLayoutStyle | ( | TInt | aLayoutStyle | ) | |
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.
Parameters
TInt aLayoutStyle | CAknNavigationDecorator::ENaviControlLayoutNormal, CAknNavigationDecorator::ENaviControlLayoutNarrow or CAknNavigationDecorator::ENaviControlLayoutWide |
SizeChanged()
IMPORT_C void | SizeChanged | ( | ) | [protected, virtual] |
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.
Top(TBool)
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.
Parameters
TBool aIgnoreFepEditorIndicator | Tells if editor indicator object is ignored. |
VolumePopupRect()
TRect
| VolumePopupRect | ( | ) | [private] |
Member Type Definitions Documentation
Typedef CAknNaviPaneStack
Member Data Documentation
CAknNavigationControlContainerExtension * iExtension
CAknNavigationControlContainerExtension * | iExtension | [private] |
CFbsBitmap * iNaviArrowBitmap
CAknNavigationDecorator * iNaviDecoratorFromResource
CAknNaviPaneStack * iNaviPaneControls
CEikStatusPaneBase * iStatusPane
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.