CAknPopupHeadingPane Class Reference
#include
<mw/aknPopupHeadingPane.h>
Link against: glxcommoncommandhandlers.lib
| class CAknPopupHeadingPane : public CAknControl |
| 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::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::MopSupplyObject(TTypeUid) |
| | 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
Header control for queries. Defines properties of the header of the pop-up menu.
Member Enumeration Documentation
Enum THeadingPaneLayout
Enumeration for different layouts
| Enumerator | Value | Description |
|---|
| EQueryHeadingPane | |
Query mode layout for heading pane
|
| EListHeadingPane | |
List mode layout for heading pane
|
| EColourSelectionGridHeadingPane | |
Heading pane for colour selection list. - Since
- 3.0
|
| EMessageQueryHeadingPane | |
Heading pane for message query. - Since
- 3.0
|
Constructor & Destructor Documentation
CAknPopupHeadingPane ( )
| IMPORT_C | CAknPopupHeadingPane | ( | ) | |
~CAknPopupHeadingPane ( )
| IMPORT_C | ~CAknPopupHeadingPane | ( | ) | |
Member Function Documentation
CancelAnimation ( )
| IMPORT_C TInt | CancelAnimation | ( | ) | |
Cancel the animation. Calls RBitmapAnim::CommandReply(EBitmapAnimCommandStopAnimation).
Returns: A value defined by the animation writer. The value may, in some cases, be defined to be an error code.
ConstructFromResourceL ( TResourceReader & )
From CCoeControl. Constructs heading pane from a resource file. Current resource reader position must point to AVKON_HEADING resource.
| Parameter | Description | | aReader | The resource reader with which to access the header resource values. |
ConstructL ( TPtrC )
| IMPORT_C void | ConstructL | ( | TPtrC | aText | ) | |
Completes the construction of the CAknPopupHeadingPane object. Layout is set to EQueryHeadingPane by default.
| Parameter | Description | | aText | Header text. |
HandlePointerEventL ( const TPointerEvent & )
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
HandleResourceChange ( TInt )
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.
MinimumSize ( )
| IMPORT_C TSize | MinimumSize | ( | ) | [virtual] |
From CCoeControl. Get the minimum required size of heading pane.
Returns: The minimum required size of heading pane.
Prompt ( )
Get pointer to the prompt control.
Returns: A pointer to the prompt control.
PromptText ( )
| IMPORT_C TPtr | PromptText | ( | ) | const |
SetHeaderAnimationL ( TInt )
| IMPORT_C void | SetHeaderAnimationL | ( | TInt | aResourceId | ) | |
Set header animation by reading BMPANIM_DATA resource.
| Parameter | Description | | aResourceId | A resource identifier for the header animation. |
SetHeaderImageL ( CEikImage * )
| IMPORT_C void | SetHeaderImageL | ( | CEikImage * | aImage | ) | |
| Parameter | Description | | aImage | A header image. |
SetHeaderImageOwnedL ( CEikImage * )
| IMPORT_C void | SetHeaderImageOwnedL | ( | CEikImage * | aImage | ) | |
Set header image. Gets the ownership of the image.
| Parameter | Description | | aImage | A header image. |
SetLayout ( THeadingPaneLayout )
Set layout of the heading pane.
| Parameter | Description | | aLayout | A layout of the heading pane. |
SetPageL ( TInt, TInt )
| void | SetPageL | ( | TInt | aCurrent, |
| | TInt | aMax = 0 |
| | ) | |
SetSkinFrameCenterId ( const TAknsItemID & )
| IMPORT_C void | SetSkinFrameCenterId | ( | const TAknsItemID & | aFrameCenterId | ) | |
SetSkinFrameId ( const TAknsItemID & )
| IMPORT_C void | SetSkinFrameId | ( | const TAknsItemID & | aFrameId | ) | |
Set heading frame ids. These can be used to override default ids.
| Parameter | Description | | aFrameId | / aFrameCenterId Ids of heading's frame.. |
SetTextL ( TPtrC )
| IMPORT_C void | SetTextL | ( | TPtrC | aText | ) | |
| Parameter | Description | | aText | A header text. |
SetTouchObserver ( MAknHeadingPaneTouchObserver * )
| void | SetTouchObserver | ( | MAknHeadingPaneTouchObserver * | aTouchObserver | ) | |
Set the heading pane touch observer. The observer must derive from MAknHeadingPaneTouchObserver and implement method HandleHeadingPanePointerEventL().
SizeChanged ( )
| IMPORT_C void | SizeChanged | ( | ) | [virtual] |
From CCoeControl. Responds to size changes to sets the size and position of the contents of the heading pane.
StartAnimationL ( )
| IMPORT_C void | StartAnimationL | ( | ) | |