Class CQikViewDialog

class CQikViewDialog : public CQikMultiPageViewBase;

Description

A view that can be invoked like a dialog

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
• CQikViewDialog - A view that can be invoked like a dialog

Members

Defined in CQikViewDialog:
ActivateL(), ActivatePageL(), AddControlLC(), BeginUpdateLC(), Border(), CQikViewDialog(), CQikViewDialog(), CalculateRowInfo(), CloseDialog(), ConstructFromResourceL(), ConstructL(), ContainerWindow(), Draw(), EndUpdateL(), ExecuteLD(), FocusChanged(), FocusedControl(), GetColorUseListL(), GetHelpContext(), GetTextDrawer(), HandleCommandL(), HandleControlArrayEventL(), HandleControlEventL(), HandleErrorL(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleResourceChange(), HandleUiConfigChangedL(), HasBorder(), InitializeFromResourceL(), InitializeViewFromResourceL(), InitializeViewFromResourceL(), InputCapabilities(), Launched(), MakeVisible(), MinimumSize(), MopSupplyObject(), OfferKeyEventL(), PersistsAfterRelayout(), PositionChanged(), PreferredUiConfigMode(), PrepareForFocusGainL(), PrepareForFocusLossL(), PrepareForViewActivation(), PrepareL(), PrepareLC(), RelayoutFinishedL(), ReleaseControls(), RemoveControl(), RequestRelayout(), RetCode(), RunL(), RunLD(), SaveL(), SetAdjacent(), SetBorder(), SetBorder(), SetContainerWindowL(), SetDimmed(), SetForcedExitCommandId(), SetInitialFocusL(), SetNeighbor(), SetParent(), SetTextBaselineSpacing(), SizeChanged(), TabActivatedL(), TextBaselineOffset(), TransferPersistentControlStateL(), ViewActivatedL(), ViewConstructL(), ViewDeactivated(), ViewId(), ViewScreenDeviceChangedL(), ViewScreenModeCompatible(), WriteInternalStateL(), ~CQikViewDialog()

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 CQikMultiPageViewBase:
ActivePageId(), BaseConstructL(), ConstructPageL(), ConstructPageWithoutActivationL(), DeactivatePageL(), DeletePageL(), Page(), ReleasePageL(), SetPageCommandListL()

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(), 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()

virtual ~CQikViewDialog();

Description

Destructor. Panics with VIEWDLG-2 should the view-dialog be currently launched.

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

Description

Constructor. Passes the parameters to the CQikMultiPageViewBase::CQikMultiPageViewBase() constructor.

Parameters

CQikAppUi &aAppUi const TVwsViewId &aParentViewId

protected: IMPORT_C CQikViewDialog();

Description

Constructor. Creates a parentless View.

virtual IMPORT_C void ConstructL();

Description

See also:

• CQikMultiPageViewBase::ConstructL()

IMPORT_C TInt ExecuteLD();

Description

Execute the dialog, and destroys it. This single call encapsulates both CQikViewDialog::PrepareLC and CQikViewDialog::RunLD

Example usage:

Return value

TInt The return code as set by CQikViewDialog::CloseDialog()

IMPORT_C void PrepareLC();

Description

Prepares the dialog. This places the view-dialog on the cleanup-stack, to be destroyed by CQikViewDialog::RunLD. This calls CQikViewBase::BaseConstructL(), and then does a synchronous view construction. Subclasses will receive a CQikViewBase::ViewConstructL() for the view-dialog, which call CQikviewDialog::BaseViewConstructL() before constructing.

IMPORT_C TInt RunLD();

Description

Launch the view-dialog as a dialog. This function returns when the dialog has been dismissed. This method pops and destroys the view-dialog, which was pushed with CQikViewDialog::PrepareLC

Return value

TInt The return code as set by CQikViewDialog::CloseDialog()

IMPORT_C void PrepareL();

Description

Prepares the dialog. This calls CQikViewBase::BaseConstructL(), and then does a synchronous view construction. Subclasses will receive a CQikViewBase::ViewConstructL() for the view-dialog, which call CQikviewDialog::BaseViewConstructL() before constructing.

IMPORT_C TInt RunL();

Description

Launch the view-dialog as a dialog. This function returns when the dialog has been dismissed. The view-dialog is not destroyed; this function is for use with CQikViewDialog::PrepareL, on sleeping view-dialogs.

Return value

TInt The return code as set by CQikViewDialog::CloseDialog()

IMPORT_C void SetForcedExitCommandId(TInt aCommandId);

Description

Parameters

TInt aCommandId

virtual IMPORT_C void HandleCommandL(CQikCommand &aCommand);

Description

To be overridden by derived classes. Handles commands in the view-dialog. The default implementation attempts to close the dialog, should it be launched, if the command type is Yes, No, Done or Cancel.

Overriding implementations are responsible for calling CQikViewDialog::CloseDialog should a command that dismisses the dialog be encountered.

Parameters

CQikCommand &aCommand

virtual IMPORT_C TVwsViewId ViewId() const;

Description

To be overridden by derived classes going to be used as a true view

Return value

TVwsViewId KNullViewId

protected: IMPORT_C TBool Launched() const;

Description

Query if the view-dialog is currently "launched" as a dialog

Return value

TBool

protected: IMPORT_C TInt RetCode() const;

Description

Query the return value as set by CQikViewDialog::CloseDialog

Return value

TInt

protected: IMPORT_C TInt CloseDialog(TInt aRetCode);

Description

Asynchronously initiates the closure the dialog with the specified return-code

Parameters

TInt aRetCode

Return value

TInt TInt KErrNotReady if the dialog is not CQikViewDialog::Launched(), else KErrNone

IMPORT_C void ActivatePageL(TInt aPageId);

Description

Parameters

TInt aPageId

See also:

• CQikMultiPageViewBase::ActivatePageL()

virtual IMPORT_C void InitializeViewFromResourceL(TInt aViewResourceId);

Description

Parameters

TInt aViewResourceId

See also:

• CQikMultiPageViewBase::InitializeViewFromResourceL()

virtual IMPORT_C void InitializeViewFromResourceL(const TQikViewConfigData &aViewConfigData);

Description

Parameters

const TQikViewConfigData &aViewConfigData

See also:

• CQikMultiPageViewBase::InitializeViewFromResourceL()

virtual IMPORT_C void SetInitialFocusL();

Description

See also:

• CQikMultiPageViewBase::SetInitialFocusL()

virtual IMPORT_C void ReleaseControls(RQikReleasedControlsArray &aReleasedControls);

Description

Parameters

RQikReleasedControlsArray &aReleasedControls

See also:

• CQikMultiPageViewBase::ReleaseControls

virtual IMPORT_C CCoeControl *FocusedControl();

Description

Return value

CCoeControl *

See also:

• CQikMultiPageViewBase::FocusedControl()

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

Description

Parameters

const TKeyEvent &aKeyEvent TEventCode aType

Return value

TKeyResponse

See also:

• CQikMultiPageViewBase::OfferKeyEventL()

virtual IMPORT_C void MakeVisible(TBool aVisible);

Description

Parameters

TBool aVisible

See also:

• CQikMultiPageViewBase::MakeVisible()

virtual IMPORT_C TTypeUid::Ptr MopSupplyObject(TTypeUid aId);

Description

Parameters

TTypeUid aId

Return value

TTypeUid::Ptr

See also:

• CQikMultiPageViewBase::MopSupplyObject()

virtual IMPORT_C void GetTextDrawer(CCoeTextDrawerBase *&aTextDrawer, const CCoeControl *aDrawingControl, TInt aKey) const;

Description

Parameters

CCoeTextDrawerBase *&aTextDrawer const CCoeControl *aDrawingControl TInt aKey

See also:

• CQikMultiPageViewBase::GetTextDrawer()

virtual IMPORT_C void ConstructFromResourceL(TResourceReader &aReader);

Description

Parameters

TResourceReader &aReader

See also:

• CQikMultiPageViewBase::ConstructFromResourceL()

virtual IMPORT_C TBool RequestRelayout(const CCoeControl *aChildControl);

Description

Parameters

const CCoeControl *aChildControl

Return value

TBool

See also:

• CQikMultiPageViewBase::RequestRelayout()

virtual IMPORT_C TSize MinimumSize();

Description

Return value

TSize

See also:

• CQikMultiPageViewBase::MinimumSize()

virtual IMPORT_C void GetColorUseListL(CArrayFix< TCoeColorUse > &aColorUseList) const;

Description

Parameters

CArrayFix< TCoeColorUse > &aColorUseList

See also:

• CQikMultiPageViewBase::GetColorUseListL()

virtual IMPORT_C void HandleResourceChange(TInt aType);

Description

Parameters

TInt aType

See also:

• CQikMultiPageViewBase::HandleResourceChange()

virtual IMPORT_C void PrepareForFocusGainL();

Description

See also:

• CQikMultiPageViewBase::PrepareForFocusGainL()

virtual IMPORT_C void PrepareForFocusLossL();

Description

See also:

• CQikMultiPageViewBase::PrepareForFocusLossL()

virtual IMPORT_C TBool HasBorder() const;

Description

Return value

TBool

See also:

• CQikMultiPageViewBase::HasBorder()

virtual IMPORT_C void SetAdjacent(TInt aAdjacent);

Description

Parameters

TInt aAdjacent

See also:

• CQikMultiPageViewBase::SetAdjacent()

virtual IMPORT_C void SetDimmed(TBool aDimmed);

Description

Parameters

TBool aDimmed

See also:

• CQikMultiPageViewBase::SetDimmed()

virtual IMPORT_C void SetContainerWindowL(const CCoeControl &aContainer);

Description

Parameters

const CCoeControl &aContainer

See also:

• CQikMultiPageViewBase::SetContainerWindowL()

virtual IMPORT_C void ActivateL();

Description

See also:

• CQikMultiPageViewBase::ActivateL()

virtual IMPORT_C void SetNeighbor(CCoeControl *aNeighbor);

Description

Parameters

CCoeControl *aNeighbor

See also:

• CQikMultiPageViewBase::SetNeighbor()

virtual IMPORT_C void GetHelpContext(TCoeHelpContext &aContext) const;

Description

Parameters

TCoeHelpContext &aContext

See also:

• CQikMultiPageViewBase::GetHelpContext()

virtual IMPORT_C TInt SetParent(CCoeControl *aParent);

Description

Parameters

CCoeControl *aParent

Return value

TInt

See also:

• CQikMultiPageViewBase::SetParent()

virtual IMPORT_C TInt TextBaselineOffset(const TSize &aSize) const;

Description

Parameters

const TSize &aSize

Return value

TInt

See also:

• CQikMultiPageViewBase::TextBaselineOffset()

virtual IMPORT_C void SetTextBaselineSpacing(TInt aSpacing);

Description

Parameters

TInt aSpacing

See also:

• CQikMultiPageViewBase::SetTextBaselineSpacing()

virtual IMPORT_C TCoeInputCapabilities InputCapabilities() const;

Description

Return value

TCoeInputCapabilities

See also:

• CQikMultiPageViewBase::InputCapabilities()

virtual IMPORT_C const CCoeControl &ContainerWindow() const;

Description

Return value

const CCoeControl &

See also:

• CQikMultiPageViewBase::ContainerWindow()

virtual IMPORT_C void InitializeFromResourceL(TResourceReader &aReader, MQikControlProvider &aProvider);

Description

Parameters

TResourceReader &aReader MQikControlProvider &aProvider

See also:

• CQikMultiPageViewBase::InitializeFromResourceL()

virtual IMPORT_C void BeginUpdateLC();

Description

See also:

• CQikMultiPageViewBase::BeginUpdateLC()

virtual IMPORT_C void EndUpdateL();

Description

See also:

• CQikMultiPageViewBase::EndUpdateL()

virtual IMPORT_C void AddControlLC(CCoeControl *aControl, TInt aComponentId=KErrNotFound);

Description

Parameters

CCoeControl *aControl TInt aComponentId

See also:

• CQikMultiPageViewBase::AddControlLC()

virtual IMPORT_C TInt RemoveControl(CCoeControl &aControl);

Description

Parameters

CCoeControl &aControl

Return value

TInt

See also:

• CQikMultiPageViewBase::RemoveControl()

virtual IMPORT_C TBool PersistsAfterRelayout() const;

Description

Return value

TBool

See also:

• MQikRelayoutSensitiveControl::PersistsAfterRelayout()

virtual IMPORT_C void SetBorder(TGulBorder::TBorderType aBorderType);

Description

Parameters

TGulBorder::TBorderType aBorderType

See also:

• MEikBorderedControl::SetBorder()

virtual IMPORT_C void SetBorder(TInt aBorderType);

Description

Parameters

TInt aBorderType

See also:

• MEikBorderedControl::SetBorder()

virtual IMPORT_C TGulBorder Border() const;

Description

Return value

TGulBorder

See also:

• MEikBorderedControl::Border()

virtual IMPORT_C void HandleControlEventL(CCoeControl *aControl, TCoeEvent aEventType);

Description

Parameters

CCoeControl *aControl TCoeEvent aEventType

See also:

• MCoeControlObserver::HandleControlEventL()

virtual IMPORT_C TBool ViewScreenModeCompatible(TInt aScreenMode);

Description

Parameters

TInt aScreenMode

Return value

TBool

See also:

• CQikMultiPageViewBase::ViewScreenModeCompatible()

virtual IMPORT_C void TransferPersistentControlStateL(const CCoeControl &aOldControl, CCoeControl &aNewControl) const;

Description

Parameters

const CCoeControl &aOldControl CCoeControl &aNewControl

See also:

• MQikControlStateTransferrer::TransferPersistentControlStateL()

protected: virtual IMPORT_C void TabActivatedL(TInt aTabId);

Description

Parameters

TInt aTabId

See also:

• CQikMultiPageViewBase::TabActivatedL()

protected: virtual IMPORT_C void SizeChanged();

Description

See also:

• CQikMultiPageViewBase::SizeChanged()

protected: virtual IMPORT_C void WriteInternalStateL(RWriteStream &aWriteStream) const;

Description

Parameters

RWriteStream &aWriteStream

See also:

• CQikMultiPageViewBase::WriteInternalStateL()

protected: virtual IMPORT_C void HandlePointerEventL(const TPointerEvent &aPointerEvent);

Description

Parameters

const TPointerEvent &aPointerEvent

See also:

• CQikMultiPageViewBase::HandlePointerEventL()

protected: virtual IMPORT_C void HandleControlArrayEventL(CCoeControlArray::TEvent aEvent, const CCoeControlArray *aArray, CCoeControl *aControl, TInt aControlId);

Description

Parameters

CCoeControlArray::TEvent aEvent const CCoeControlArray *aArray CCoeControl *aControl