CAknPopupField Class Reference
class CAknPopupField : public CEikBorderedControl
|
Represents a combo box type control, used to implement the Series 60 pop-up field.
Nested Classes and Structures
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::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::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::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::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::WriteInternalStateNowL(RWriteStream &)const
|
|
CCoeControl::ZoomWithType()const
|
|
CCoeControl::operator=(const CCoeControl &)
|
|
CCoeControl::~CCoeControl()
|
|
CEikBorderedControl::Border()const
|
|
CEikBorderedControl::CEikBorderedControl()
|
|
CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
|
|
CEikBorderedControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
|
|
CEikBorderedControl::HasBorder()const
|
|
CEikBorderedControl::SetAdjacent(TInt)
|
|
CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
|
|
CEikBorderedControl::SetBorder(TInt)
|
|
CEikBorderedControl::WriteInternalStateL(RWriteStream &)const
|
Constructor & Destructor Documentation
CAknPopupField()
IMPORT_C
|
CAknPopupField
|
(
|
)
|
|
~CAknPopupField()
IMPORT_C
|
~CAknPopupField
|
(
|
)
|
|
Member Functions Documentation
ActivateSelectionListL()
IMPORT_C void
|
ActivateSelectionListL
|
(
|
)
|
|
Causes a list of pre-defined values to appear. Use this method to activate the pop-up field from a menu option command. Note that the desired control must be focused on before it can be activated.
AttemptExitCallbackL(TAny *)
TInt
|
AttemptExitCallbackL
|
(
|
TAny
*
|
aThis
|
)
|
[private, static]
|
AttemptExitL(TBool)
void
|
AttemptExitL
|
(
|
TBool
|
aAccept
|
)
|
[private]
|
Re-defined method of the base class. Gets called when the user tries to select a value. If required, an editor is created to allow the user to input the user defined value. Otherwise, the normal selection behaviour of popup list is activated.
Parameters
TBool
aAccept
|
If ETrue, popup list was accepted; if EFalse, popup list was cancelled
|
ChangeMode(EAknPopupFieldSelectionMode)
Changes the mode of the popupfield to one of the EAknPopupFieldSelectionMode's
CloseSelectionListL()
IMPORT_C void
|
CloseSelectionListL
|
(
|
)
|
|
Closes the selection list
CommonConstructL()
void
|
CommonConstructL
|
(
|
)
|
[protected]
|
ComponentControl(TInt)
IMPORT_C
CCoeControl
*
|
ComponentControl
|
(
|
TInt
|
aIndex
|
)
|
const [protected, virtual]
|
From
CCoeControl
.
Gets an indexed component of a compound control.
Parameters
TInt
aIndex
|
Control index.
|
ConfigureDecorator()
void
|
ConfigureDecorator
|
(
|
)
|
[private]
|
Configures the decoration according to the currently set flags. Should be called whenever the flags are changed.
ConstructCommandButtonL()
void
|
ConstructCommandButtonL
|
(
|
)
|
[private]
|
Create the command button that will be used to show the other choices indicator.
ConstructFromResourceL(TResourceReader &)
IMPORT_C void
|
ConstructFromResourceL
|
(
|
TResourceReader
&
|
aReader
|
)
|
[virtual]
|
From
CCoeControl
.
Constructs the control from a resource file.
Parameters
TResourceReader
& aReader
|
The resource reader pointing to the popup field resource.
|
ConstructL()
IMPORT_C void
|
ConstructL
|
(
|
)
|
|
Handles 2nd phase construction.
ConstructLabelL()
void
|
ConstructLabelL
|
(
|
)
|
[private]
|
Create the label that will show the currently selected value.
ConstructLayoutDecoratorL()
void
|
ConstructLayoutDecoratorL
|
(
|
)
|
[private]
|
Configures the layout decoration according to the radio button flag Should be called whenever the flags are changed.
ConstructSelectionListL()
void
|
ConstructSelectionListL
|
(
|
)
|
[private]
|
Create the selection list box that will fill the expanded popup field
CountComponentControls()
IMPORT_C
TInt
|
CountComponentControls
|
(
|
)
|
const [protected, virtual]
|
From
CCoeControl
.
Gets the number of controls contained in a compound control.
CreateCbaL()
void
|
CreateCbaL
|
(
|
)
|
[private]
|
Creates the CBA for use when the selection list is active
CreatePopoutL()
void
|
CreatePopoutL
|
(
|
)
|
[private]
|
Create the popup list. Warn the user if there are no entries in the list.
DestroyPopout()
void
|
DestroyPopout
|
(
|
)
|
[private]
|
Destroy the popup list and remove it from the stack
DoAttemptExitL()
void
|
DoAttemptExitL
|
(
|
)
|
[private]
|
DoSizeChangedL()
void
|
DoSizeChangedL
|
(
|
)
|
[private]
|
Draw(const TRect &)
IMPORT_C void
|
Draw
|
(
|
const
TRect
&
|
aRect
|
)
|
const [protected, virtual]
|
Parameters
const
TRect
& aRect
|
Rectangle in which the Cone framework believes drawing is needed.
|
ExtensionInterface(TUid)
IMPORT_C void *
|
ExtensionInterface
|
(
|
TUid
|
aInterface
|
)
|
[private, virtual]
|
FocusChanged(TDrawNow)
IMPORT_C void
|
FocusChanged
|
(
|
TDrawNow
|
aDrawNow
|
)
|
[protected, virtual]
|
Parameters
TDrawNow
aDrawNow
|
Contains the value that was passed to it by SetFocus().
|
HandleControlEventL(CCoeControl *, TCoeEvent)
IMPORT_C void
|
HandleControlEventL
|
(
|
CCoeControl
*
|
aControl,
|
|
TCoeEvent
|
aEvent
|
|
)
|
[protected]
|
Parameters
CCoeControl
* aControl
|
The control that sent the event.
|
TCoeEvent aEvent
|
The event type.
|
HandleHorizontalKeyEventL(TUint)
Handles a horizontal key event
HandleInteractionConfirmedL()
TBool
|
HandleInteractionConfirmedL
|
(
|
)
|
[private]
|
Handles the case where the selection list is closed. If necessary, update the value of the text label that is displayed.
HandleListBoxEventL(CEikListBox *, TListBoxEvent)
IMPORT_C void
|
HandleListBoxEventL
|
(
|
CEikListBox
*
|
aListBox,
|
|
TListBoxEvent
|
aEventType
|
|
)
|
[protected]
|
From
MEikListBoxObserver
.
Processes key events from the listbox. Responds to
EEventEnterKeyPressed
to accept the pop-up.
Parameters
CEikListBox
* aListBox
|
Listbox being observed.
|
TListBoxEvent aEventType
|
Event observed.
|
HandlePointerEventL(const TPointerEvent &)
IMPORT_C void
|
HandlePointerEventL
|
(
|
const TPointerEvent &
|
aPointerEvent
|
)
|
[virtual]
|
From
CCoeControl
.
Handles pointer events of popup field list.
Parameters
const TPointerEvent & aPointerEvent
|
The pointer event to be handled.
|
HandleResourceChange(TInt)
IMPORT_C void
|
HandleResourceChange
|
(
|
TInt
|
aType
|
)
|
[virtual]
|
From
CCoeControl
.
Handles a change to the control's resources.
Parameters
TInt
aType
|
The type of the resource change.
|
InitialiseRadioButtonBitmapsL()
void
|
InitialiseRadioButtonBitmapsL
|
(
|
)
|
[private]
|
Set up the bitmap array for the "not pushed" and "pushed in" states
IsEmpty()
TBool
|
IsEmpty
|
(
|
)
|
const [private]
|
Checks to see if the popupfield is empty
IsInvalid()
TBool
|
IsInvalid
|
(
|
)
|
const [private]
|
Checks to see if the popupfield is invalid
MinimumSize()
IMPORT_C
TSize
|
MinimumSize
|
(
|
)
|
[virtual]
|
From
CCoeControl
.
Determines the minimum size of the control.
MopSupplyObject(TTypeUid)
From
CCoeControl
.
Retrieves an object of the same type as that encapsulated in
aId
.
Parameters
TTypeUid
aId
|
An encapsulated object type ID.
|
NumLines()
IMPORT_C
TInt
|
NumLines
|
(
|
)
|
const
|
OfferKeyEventL(const TKeyEvent &, TEventCode)
Parameters
const
TKeyEvent
& aKeyEvent
|
The key event.
|
TEventCode
aType
|
The type of key event.
|
ProcessCommandL(TInt)
IMPORT_C void
|
ProcessCommandL
|
(
|
TInt
|
aCommandId
|
)
|
[protected]
|
From
MEikCommandObserver
.
Processes events from the softkeys. Responds to
EAknSoftkeyOk
and
EAknSoftkeyCancel
to accept or cancel the pop-up.
Parameters
TInt
aCommandId
|
Event Id from the soft-key.
|
Reserved_1()
IMPORT_C void
|
Reserved_1
|
(
|
)
|
[private]
|
Reserved_2()
IMPORT_C void
|
Reserved_2
|
(
|
)
|
[private, virtual]
|
SetAllowsUserDefinedEntry(TBool)
IMPORT_C void
|
SetAllowsUserDefinedEntry
|
(
|
TBool
|
aAllows
|
)
|
|
Sets a flag that enables user defined entry. Note that flag can also be set from resources, but this method allows behaviour to be changed at runtime.
Parameters
TBool
aAllows
|
if ETrue sets a flag.
|
SetEmptyListNoteL(TInt, CAknNoteDialog::TTimeout, CAknNoteDialog::TTone)
Sets the note to be displayed when the selection list has no items available.
Parameters
TInt
aResourceId
|
Resource id for the note.
|
CAknNoteDialog::TTimeout
aTimeout = CAknNoteDialog::EShortTimeout
|
= CAknNoteDialog::EShortTimeout Timeout for the note.
|
CAknNoteDialog::TTone
aTone = CAknNoteDialog::ENoTone
|
= CAknNoteDialog::ENoTone Tone for the note.
|
SetEmptyTextL(const TDesC &)
IMPORT_C void
|
SetEmptyTextL
|
(
|
const
TDesC
&
|
aEmptyText
|
)
|
|
Sets the empty list note text. This note is displayed when the selection list has no items available.
Parameters
const
TDesC
& aEmptyText
|
The empty list note text.
|
SetFont(const CFont *)
IMPORT_C void
|
SetFont
|
(
|
const
CFont
*
|
aFont
|
)
|
|
Sets the font of the contained label.
Parameters
const
CFont
* aFont
|
Font definition used to set the font of the contained label.
|
SetFormFieldRect(TRect)
IMPORT_C void
|
SetFormFieldRect
|
(
|
TRect
|
aFormFieldRect
|
)
|
|
Sets a form field rectangle so that a popup field can correctly position the label.
Parameters
TRect
aFormFieldRect
|
The form field rectangle.
|
SetInvalidTextL(const TDesC &)
IMPORT_C void
|
SetInvalidTextL
|
(
|
const
TDesC
&
|
aInvalidText
|
)
|
|
Sets the text for view state when none of the elements in the list are available.
Parameters
const
TDesC
& aInvalidText
|
The invalid text.
|
SetMaxNumberOfLinesPermitted(TInt)
IMPORT_C void
|
SetMaxNumberOfLinesPermitted
|
(
|
TInt
|
aMaxNoLines
|
)
|
|
/** Sets the maximium number of lines that can be displayed.
Parameters
TInt
aMaxNoLines
|
The maximum number of lines.
|
SetOtherTextL(const TDesC &)
IMPORT_C void
|
SetOtherTextL
|
(
|
const
TDesC
&
|
aOtherText
|
)
|
|
Sets the text to be added to the bottom of the array to enter user defined data.
Parameters
const
TDesC
& aOtherText
|
Text to the bottom of the selection array.
|
SetPopupFieldObserver(MAknPopupFieldObserver *)
Sets an observer of this class to receive events from popup field.
SetQueryValueL(MAknQueryValue *)
Used by the client to set the query value. It is used to represent the user defined query value in this popup field control.
Parameters
MAknQueryValue
* aValue
|
Pointer to query value, ownership is not passed.
|
SetScrollBarSelectionL()
void
|
SetScrollBarSelectionL
|
(
|
)
|
[private]
|
set the scroll bar selection
SetShowIndicatorsL(TBool)
IMPORT_C void
|
SetShowIndicatorsL
|
(
|
TBool
|
aShowIndicators
|
)
|
|
Sets a flag that determines whether the indicators are shown. In practice the indicators have the appearance of radio buttons.
Parameters
TBool
aShowIndicators
|
If ETrue, indicators are displayed.
|
SetUpScrollBarL()
void
|
SetUpScrollBarL
|
(
|
)
|
[private]
|
setup the scroll bar within the selection list box
ShowEmptyListNoteL()
void
|
ShowEmptyListNoteL
|
(
|
)
|
[private]
|
display a note when the selection list has no items available
SizeChanged()
IMPORT_C void
|
SizeChanged
|
(
|
)
|
[protected, virtual]
|
From
CCoeControl
.
Responds to changes to the size and position of the contents of this control.
Member Enumerations Documentation
Enum EAknFormMode
Form mode for the popup field.
Enumerators
EAknFormModeView
|
View mode.
|
EAknFormModeEdit
|
Editable mode.
|
EAknFormModeViewWideWithGraphic
|
View mode with graphic.
|
EAknFormModeViewWideWithoutGraphic
|
View mode without graphic.
|
EAknFormModeEditWideWithGraphic
|
Edit mode with graphic.
|
EAknFormModeEditWideWithoutGraphic
|
Edit mode without graphic.
|
Enum EAknPopupFieldSelectionMode
Selection mode of the popup field.
Enumerators
EAknPopupFieldLabelMode
|
Label mode. In Label mode popup field is minimized and popup field looks identical to a list item. When it receives the selection key press it is changed to
EAknPopupFieldSelectionListMode
and the pre-defined list is displayed.
|
EAknPopupFieldSelectionListMode
|
Selection list mode. In this selection mode pre-defined popup selection list is displayed.
|
Member Data Documentation
CAsyncCallBack * iAttemptExitAsync
Active object for calling
AttemptExitCallbackL
asynchronously. Own.
CAknPopupFieldBitmapButton * iButton
Bitmap button for the popup field. Own.
CEikButtonGroupContainer * iCba
CEikButtonGroupContainer *
|
iCba
|
[protected]
|
Button group container for the popup field. Own.
TAknDesCArrayDecorator
iDecorator
TAknDesCArrayDecorator
|
iDecorator
|
[protected]
|
Selection array for the popup field.
TInt
iEmptyNoteResourceId
TInt
|
iEmptyNoteResourceId
|
[protected]
|
Resource id for the empty note.
CAknNoteDialog::TTimeout
iEmptyNoteTimeout
Timeout for the empty tone.
CAknNoteDialog::TTone
iEmptyNoteTone
HBufC * iEmptyText
HBufC
*
|
iEmptyText
|
[protected]
|
The empty list note text. Own.
CAknPopupFieldExtension * iExtension
CAknPopupFieldExtension *
|
iExtension
|
[private]
|
TInt
iFlags
Flags for the popup field.
EAknFormMode
iFormMode
Enumeration representing form mode values.
HBufC * iInvalidText
HBufC
*
|
iInvalidText
|
[protected]
|
The invalid text. Used in the view state when none of the elements in the list are available. Own.
CEikLabel * iLabel
Label of the popup field. Own.
CAknListBoxLayoutDecorator * iLayoutDecorator
CAknListBoxLayoutDecorator *
|
iLayoutDecorator
|
[protected]
|
Contains a popup field selection array and a leading text that will be inserted before the text from the descriptor array entry. Own.
TInt
iMaxNoLines
TInt
|
iMaxNoLines
|
[protected]
|
Maximum number of items in selection array.
MAknPopupFieldObserver * iObserver
Observer for receiving events from the popup field. Not own.
HBufC * iOtherText
HBufC
*
|
iOtherText
|
[protected]
|
Text to the bottom of the selection array. Own.
CAknFormGraphicStyleListBox * iSelectionList
List box for the popup field usage. Own.
EAknPopupFieldSelectionMode
iSelectionMode
Enumeration representing selection mode values.
MAknQueryValue * iValue
Query value for the popup field. Not own.
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.