CQikMultiPageViewBase in Qikon

class CQikMultiPageViewBase : public CQikViewBase;

Description

A base class for views with multiple pages.

It is possible to create a view class that inherits directly from CQikViewBase but this class should be sufficient in most cases.

Derivation

MQUiConfigChangedObserver - The Ui config observer notifies about Ui config changes
MQikControlStateTranferrer - Transfers the state of a control (that cannot be moved from one layout to another) to the control that will be used in its place
MQikCommandHandler - Interface for classes responsible of executing commands

MQikCommandListOwner - Interface for classes adding commands

MQikCommandModelOwner - Interface for classes owning placeholders for command lists
MCoeControlObserver - Interface for a control to send events to its observer control

MQikRelayoutSensitiveControl - A mixin for controls that have a special behaviour when a view changes layouts
MQikContainer - A mixin for controls that allows other classes to add and remove controls via a generic API

MEikBorderedControl - Interface for bordered controls

MObjectProvider - An interface that allows an object to be part of a network of object providers

CBase - Base class for all classes to be instantiated on the heap

CCoeControl - Control base class from which all other controls are derived

CEikBorderedControl - A control which is drawn surrounded by a rectangular border

CQikContainerBase - A generic base class for container controls

CQikContainer - A concrete container control

CQikViewBase - A base class for views

CQikMultiPageViewBase - A base class for views with multiple pages

Members

Defined in CQikMultiPageViewBase:
ActivateL(), ActivatePageL(), ActivePageId(), AddControlLC(), BaseConstructL(), BeginUpdateLC(), Border(), CQikMultiPageViewBase(), CalculateRowInfo(), ConstructFromResourceL(), ConstructL(), ConstructPageL(), ConstructPageL(), ConstructPageWithoutActivationL(), ConstructPageWithoutActivationL(), ContainerWindow(), DeactivatePageL(), DeletePageL(), Draw(), EndUpdateL(), FocusChanged(), FocusedControl(), GetColorUseListL(), GetHelpContext(), GetTextDrawer(), HandleCommandL(), HandleControlArrayEventL(), HandleControlEventL(), HandleErrorL(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleResourceChange(), HandleUiConfigChangedL(), HasBorder(), InitializeFromResourceL(), InitializeViewFromResourceL(), InitializeViewFromResourceL(), InputCapabilities(), MakeVisible(), MinimumSize(), MopSupplyObject(), OfferKeyEventL(), Page(), Page(), PersistsAfterRelayout(), PositionChanged(), PreferredUiConfigMode(), PrepareForFocusGainL(), PrepareForFocusLossL(), PrepareForViewActivation(), RelayoutFinishedL(), ReleaseControls(), ReleasePageL(), RemoveControl(), RequestRelayout(), SaveL(), SetAdjacent(), SetBorder(), SetBorder(), SetContainerWindowL(), SetDimmed(), SetInitialFocusL(), SetNeighbor(), SetPageCommandListL(), SetParent(), SetTextBaselineSpacing(), SizeChanged(), TabActivatedL(), TextBaselineOffset(), TransferPersistentControlStateL(), ViewActivatedL(), ViewConstructL(), ViewDeactivated(), ViewScreenDeviceChangedL(), ViewScreenModeCompatible(), WriteInternalStateL(), ~CQikMultiPageViewBase()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CCoeControl:
AccumulatedZoom(), ActivateGc(), BackedUpWindow(), Background(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), Components(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawBackground(), DrawDeferred(), DrawForeground(), DrawNow(), DrawableWindow(), EAbsoluteZoom, ERelativeZoom, EnableDragEvents(), FindBackground(), FindFontProvider(), GetColor(), GetGc(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandleRedrawEvent(), HitTest(), IgnoreEventsUntilNextPointerUp(), Index(), InitComponentArrayL(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), LayoutManager(), MaximumWidth(), Observer(), OverrideColorL(), OwnsWindow(), Parent(), Position(), PositionRelativeToScreen(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), Reserved_CCoeControl_10(), Reserved_CCoeControl_11(), Reserved_CCoeControl_12(), Reserved_CCoeControl_13(), ResetGc(), ScreenFont(), SetAllowStrayPointers(), SetBackground(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetControlContext(), SetCornerAndSize(), SetExtent(), SetExtentToWholeScreen(), SetFocus(), SetFocusing(), SetFontProviderL(), SetGc(), SetGloballyCapturing(), SetHitTest(), SetMaximumWidth(), SetMopParent(), SetNonFocusing(), SetObserver(), SetPointerCapture(), SetPosition(), SetRect(), SetSize(), SetSizeWithoutNotification(), SetUniqueHandle(), SetZoomFactorL(), Size(), SystemGc(), TZoomType, TextDrawer(), UniqueHandle(), Window(), ZoomWithType(), iCoeEnv, iContext, iPosition, iSize

Inherited from CEikBorderedControl:
ComponentControl(), CountComponentControls(), iBorder

Inherited from CQikContainer:
ClosestFocusingControl()

Inherited from CQikContainerBase:
ControlsOwnedExternally(), HandlesRelayoutRequests(), HorizontalWrappingEnabled(), IsRelayoutInProgress(), RowBasedMode(), SetDebugMode(), SetHandleRelayoutRequests(), SetHorizontalWrappingEnabled(), SetPersistsAfterRelayout(), SetRelayoutInProgress(), SetRowBasedMode(), SetVerticalWrappingEnabled(), VerticalWrappingEnabled()

Inherited from CQikViewBase:
ActivatePreviousViewL(), ActivateTabL(), ActiveTabId(), AddTabL(), CQikViewBase_Reserved_4(), CategoryHandleForCommandId(), CategoryModel(), CommandIdForCategoryHandle(), ControlProvider(), Controls(), CurrentCategoryHandle(), ECancel, ESave, ETypeId, EViewActivatedL, EViewCategoryAdded, EViewConstructL, EViewInitializeViewFromResourceL, EViewRequestFocusL, EViewSaveL, EViewSetInitialFocusL, EmbeddedLinkEnabled(), GetCompatibleViewConfigData(), GetCurrentViewConfigData(), IsCommandListActive(), IsDefaultView(), IsTabDimmed(), ParentView(), PerformLayout(), PreemptViewConstructionL(), RemoveTabL(), RequestFocusL(), ResetBackBehavior(), SaveThenDnlToL(), SelectCategoryL(), SetAppTitleIconL(), SetAppTitleNameL(), SetCategoryModel(), SetCategoryModelAsCommandsL(), SetEmbeddedLinkEnabled(), SetLayoutManagerL(), SetParentView(), SetTabDimmed(), SetTabIndex(), SetTabResponsiveWhenActive(), SetViewModeL(), SetViewToolbarL(), TSaveMode, TViewError, Tab(), TabCount(), ViewConstructFromResourceL(), ViewContext(), ViewId(), ViewMode(), ViewToolbar(), ViewToolbarResourceId(), anonymous, iQikAppUi, iViewConfigList, operator class MCoeView &(), operator class MCoeView *()

Inherited from MCoeControlObserver:
EEventInteractionRefused, EEventPrepareFocusTransition, EEventRequestCancel, EEventRequestExit, EEventRequestFocus, EEventStateChanged, TCoeEvent

Inherited from MObjectProvider:
MopGetObject(), MopGetObjectNoChaining()

Inherited from MQikCommandHandler:
HandleAttemptDimmedSelectionL()

Inherited from MQikCommandListOwner:
MapCommandHandler()

Inherited from MQikCommandModelOwner:
DynInitOrDeleteCommandL(), FindCompatibleUiConfig()

IMPORT_C ~CQikMultiPageViewBase();

Description

Destructor

virtual IMPORT_C void ConstructL();

Description

Second phase construction. This function completes the construction of a newly allocated CQikMultiPageViewBase instance. Usually the concrete implementation of the view class calls this method in its own ConstructL() method. The BaseConstructL() method is called from within this method.

protected: IMPORT_C CQikMultiPageViewBase(CQikAppUi &aAppUi, const TVwsViewId aParentViewId);

Description

Constructor.

Parameters


CQikAppUi &aAppUi

A reference to a CQikAppUi .

const TVwsViewId aParentViewId

A view id of the parent view. This should be the logical view that is normally activated when a go back command is issued. This view will be activated when calling ActivatePreviousViewL() unless we DNL:ed to this view from another application. If this is the applications default view you should normally pass KNullViewId as the parameter. KNullViewId will activate the system default view. Returns the logical view that should be activated when ActivatePreviousViewL()

Description

Constructs a page. Note, the page is owned by the view, so the returned container must never be deleted nor put on the cleanup stack.

Parameters

`const TDesC &aUri`	The URI for a `CQikContent` .
`TInt aPageId`	The ID of the page to construct.
`const TDesC &aCaption`	The caption of the page.

Return value

CQikContainerBase *

The constructed page.

Panic codes

EQikPanicIllegalPageId

DEBUG_BUILDS: The max number of layouts has been reached. RELEASE_BUILDS: Does nothing.

IMPORT_C CQikContainerBase *ConstructPageL(TInt aPageId, const TDesC &aCaption=KNullDesC, CFbsBitmap *aBitmap=0, CFbsBitmap *aMask=0);

Description

Constructs a page. Note, the page is owned by the view, so the returned container should never be deleted nor put on the cleanup stack.

Parameters

`TInt aPageId`	The ID of the page to construct.
`const TDesC &aCaption`	The caption of the page.
`CFbsBitmap *aBitmap`	The bitmap that will be used as an icon.
`CFbsBitmap *aMask`	The mask of `aBitmap` .

Return value

CQikContainerBase *

The constructed page.

Panic codes

EQikPanicIllegalPageId

DEBUG_BUILDS: The max number of layouts has been breached. RELEASE_BUILDS: Does nothing.

IMPORT_C CQikContainerBase *ConstructPageWithoutActivationL(const TDesC &aUri, TInt aPageId, const TDesC &aCaption=KNullDesC);

Description

Constructs a page without activating it. The user is responsible for calling ActivatePageL() . Note, the page is owned by the view, so the returned container must never be deleted nor put on the cleanup stack.

Parameters

`const TDesC &aUri`	The URI for a `CQikContent` .
`TInt aPageId`	The ID of the page to construct.
`const TDesC &aCaption`	The caption of the page.

Return value

CQikContainerBase *

The constructed page.

Panic codes

EQikPanicIllegalPageId

DEBUG_BUILDS: The max number of layouts has been breached. RELEASE_BUILDS: Does nothing.

IMPORT_C CQikContainerBase *ConstructPageWithoutActivationL(TInt aPageId, const TDesC &aCaption=KNullDesC, CFbsBitmap *aBitmap=0, CFbsBitmap *aMask=0);

Description

Constructs a page without activating it. The user is responsible for calling ActivatePageL() . Note, the page is owned by the view, so the returned container must never be deleted nor put on the cleanup stack.

Parameters

`TInt aPageId`	The ID of the page to construct.
`const TDesC &aCaption`	The caption of the page.
`CFbsBitmap *aBitmap`	The bitmap that will be used as an icon.
`CFbsBitmap *aMask`	The mask of `aBitmap` .

Return value

CQikContainerBase *

The constructed page.

Panic codes

EQikPanicIllegalPageId

DEBUG_BUILDS: The max number of layouts has been breached. RELEASE_BUILDS: Does nothing.

IMPORT_C TInt ReleasePageL(TInt aPageId);

Description

Removes a page.

The page and its controls is not deleted. The state of the controls remain.

This function removes the tab, moves all controls to the RQikReleasedControlsArray , removes the current layout manager and deletes the command list. All this is done for the specified page.

A more simple solution is to just dim or make the tab invisible by using the interface class MQikTab . Call Tab() and use the returned interface MQikTab to set the visual state of the tab.

Parameters


TInt aPageId

The ID of the page to remove.

Return value

TInt

KErrNone if no error.

Description

Deletes a page and all its controls.

Parameters


TInt aPageId

The ID of the page to delete.

Return value

TInt

KErrNone if no error.

IMPORT_C TInt ActivePageId() const;

Description

Gets the ID of the active page.

Return value

TInt

The ID of the active page, or KErrNotFound if no active page.

IMPORT_C void DeactivatePageL(TInt aPageId);

Description

Deactivates a page and activates the page with the lowest ID.

Parameters


TInt aPageId

The ID of the page to deactivate.

IMPORT_C CQikContainerBase *Page(TInt aPageId);

Description

Gets a page. The page ID numbers needs not to be in sequence, can be random unique numbers.

Parameters


TInt aPageId

The ID of the page.

Return value

CQikContainerBase *

The page asked for or NULL if it can not be found.

IMPORT_C const CQikContainerBase *Page(TInt aPageId) const;

Description

Gets a page. The page ID numbers needs not to be in sequence, can be random unique numbers.

Parameters


TInt aPageId

The ID of the page.

Return value

const CQikContainerBase *

The page asked for or NULL if it can not be found.

IMPORT_C void SetPageCommandListL(TInt aPageId, TInt aCommandlistResource, TInt aUiConfigMode=KUiConfigMaskAll);

Description

Sets the command list for a specific page.

Parameters

`TInt aPageId`	The specific page to apply this too.
`TInt aCommandlistResource`	The QIK_COMMAND_LIST resource ID.
`TInt aUiConfigMode`	The ui-config ID that identifies the CommandList to which the Commands is inserted.

IMPORT_C void ActivatePageL(TInt aPageId);

Description

Activates a page.

Parameters


TInt aPageId

The ID of the page to activate.

virtual IMPORT_C void InitializeViewFromResourceL(TInt aViewResourceId);

Description

Wraps aViewresourceId into a TQikViewConfigData and forward the call to InitializeViewFromResourceL() .

Parameters


TInt aViewResourceId

The layout resource ID.

Description

Initializes the controls and layout of a view. It starts by releasing the current controls. It then creates the new controls and layout using the requested page layout. Controls that were released and that are part of the new layout are reused if possible. When finished, RequestRelayoutL() is called.

This method is called automatically by ViewConstructFromResourceL() . It is also called automatically by HandleUiConfigChangedL() when the ui configuration changes and there is another resource specified for the layout in the new ui configuration.

The default implementation reads a resource of type QIK_VIEW

Parameters

const TQikViewConfigData &aViewConfigData

The resource for the view and information about which UI configuration mode to use.

Description

Will be called by the framework when a view or tab has been activated if no control is already focused. This default implementation tries to set focus on first focusable control. Override this if you want to handle initial focus in derived classes.

Description

Releases all controls prior to a relayout.

Parameters


RQikReleasedControlsArray &aReleasedControls

The array with controls that are released due to a relayout.

Description

Returns the control currently in focus.

Return value

CCoeControl *

The control currently in focus.

protected: IMPORT_C void BaseConstructL();

Description

Initialises the view with standard values. The concrete implementation of the view class must make sure that this method is called during the construction phase. Either by calling the CQikViewBase::ConstructL() method from its own ConstructL() method or by calling this method directly, that is CQikViewBase::BaseConstructL() .

Description

This method is called from the framework when a tab is activated.

This function must not be called manually. If this is overloaded in a sub-class, remember to call this method from that implementation. This function activates and turns on the visibility of the activated page.

Parameters


TInt aTabId

The ID of the tab that was activated.

Description

Handles updates of size and position. All pages is updated with the current position and size. SizeChanged() of the base class is called first of all from within this method.

Description

Writes the internal state of the control to the provided stream.

Parameters


RWriteStream &aWriteStream

Text.

virtual IMPORT_C TKeyResponse OfferKeyEventL(const TKeyEvent &aKeyEvent, TEventCode aType);

Description

Parameters

`const TKeyEvent &aKeyEvent`
`TEventCode aType`

Return value

TKeyResponse

Description

Parameters


TBool aVisible

Description

Parameters


TTypeUid aId

Return value

TTypeUid::Ptr

Description

Parameters

`CCoeTextDrawerBase *&aTextDrawer`
`const CCoeControl *aDrawingControl`
`TInt aKey`

Description

Parameters


TResourceReader &aReader

Description

Parameters

const CCoeControl *aChildControl

Return value

TBool

Description

Return value

TSize

Description

Parameters


CArrayFix< TCoeColorUse > &aColorUseList

Description

Parameters


TInt aType

Description

Return value

TBool

Description

Parameters


TInt aAdjacent

Description

Parameters


TBool aDimmed

Description

Parameters

const CCoeControl &aContainer

Description

Parameters


CCoeControl *aNeighbor

Description

Parameters


TCoeHelpContext &aContext

Description

Parameters


CCoeControl *aParent

Return value

TInt

Description

Parameters

const TSize &aSize

Return value

TInt

Description

Parameters


TInt aSpacing

Description

Return value

TCoeInputCapabilities

Description

Return value

const CCoeControl &

Description

Parameters

`TResourceReader &aReader`
`MQikControlProvider &aProvider`

Class CQikMultiPageViewBase

Description

Derivation

Members

Construction and destruction