Collapse all Symbian^3 Application Developer Library

CMsgHeader Class Reference

class CMsgHeader : public CMsgFormComponent

Defines header control container for message editors/viewers.

Inherits from

CMsgHeader
- CMsgFormComponent
  - CEikBorderedControl
    - CAknControl
      - CCoeControl
        
        CBase

Public Member Functions
	~CMsgHeader ()
CCoeControl *	ComponentControl ( TInt )
TInt	CountComponentControls ()
void	Draw (const TRect &)
TBool	HitRegionContains (const TPoint &, const CCoeControl &)
CMsgHeader *	NewL (const CCoeControl &, const TMargins &)
void	SetAndGetSizeL ( TSize &, TBool )

Protected Member Functions
void	FocusChanged ( TDrawNow )
void	SizeChanged ()

Private Member Functions
	CMsgHeader ()
	CMsgHeader (const TMargins &)
void	ConstructL (const CCoeControl &)

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::ConstructFromResourceL(TResourceReader &)
	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::MinimumSize()
	CCoeControl::MopSupplyObject(TTypeUid)
	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::HandlePointerEventL(const TPointerEvent &)
	CEikBorderedControl::HasBorder()const
	CEikBorderedControl::SetAdjacent(TInt)
	CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
	CEikBorderedControl::SetBorder(TInt)
	CEikBorderedControl::WriteInternalStateL(RWriteStream &)const
	CMsgFormComponent::AddControlL(CMsgBaseControl *,TInt,TInt)
	CMsgFormComponent::BaseConstructL(const CCoeControl &)
	CMsgFormComponent::CMsgFormComponent(const TMargins &)
	CMsgFormComponent::ChangeFocusTo(TInt,TDrawNow)
	CMsgFormComponent::Component(TInt)const
	CMsgFormComponent::ComponentIndexFromId(TInt)const
	CMsgFormComponent::ControlFromPosition(TPoint,TBool)const
	CMsgFormComponent::CountMsgControls()const
	CMsgFormComponent::CurrentFocus()const
	CMsgFormComponent::CurrentLineRect()
	CMsgFormComponent::FirstFocusableControl(TInt,TMsgFocusDirection)
	CMsgFormComponent::FocusedControl()const
	CMsgFormComponent::HandleResourceChange(TInt)
	CMsgFormComponent::Margins()const
	CMsgFormComponent::MsgControl(TInt)const
	CMsgFormComponent::NotifyControlsForEvent(TMsgViewEvent,TInt)
	CMsgFormComponent::OfferKeyEventL(const TKeyEvent &,TEventCode)
	CMsgFormComponent::RemoveControlL(TInt)
	CMsgFormComponent::ResetControls()
	CMsgFormComponent::VirtualExtension()
	CMsgFormComponent::VirtualHeight()
	CMsgFormComponent::~CMsgFormComponent()

Inherited Enumerations
	CCoeControl:TZoomType

Private Attributes
CMsgCaptionedHighlight *	iFrame
CMsgDummyHeaderCleaner *	iHeaderCleaner

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize
	CEikBorderedControl::iBorder
	CMsgFormComponent::iControls
	CMsgFormComponent::iCurrentFocus
	CMsgFormComponent::iMargins

Constructor & Destructor Documentation

CMsgHeader()

CMsgHeader

(

)

[private]

Constructor (not available).

CMsgHeader(const TMargins &)

CMsgHeader

(

const TMargins &

aMargins

)

[private]

Constructor.

Parameters

const TMargins & aMargins

~CMsgHeader()

~CMsgHeader

(

)

[virtual]

Destructor.

Member Functions Documentation

ComponentControl(TInt)

CCoeControl *

ComponentControl

(

TInt

aIndex

)

const [virtual]

Returns a control of index aIndex.

Parameters

TInt aIndex

ConstructL(const CCoeControl &)

void

ConstructL

(

const CCoeControl &

aParent

)

[private]

2nd phase constructor.

Parameters

const CCoeControl & aParent

CountComponentControls()

TInt

CountComponentControls

(

)

const [virtual]

Returns a number of controls.

Draw(const TRect &)

void

Draw

(

const TRect &

aRect

)

const [virtual]

Draws the header.

Parameters

const TRect & aRect

FocusChanged(TDrawNow)

void

FocusChanged

(

TDrawNow

aDrawNow

)

[protected, virtual]

This is called when the focus of the control is changed.

Parameters

TDrawNow aDrawNow

HitRegionContains(const TPoint &, const CCoeControl &)

TBool	HitRegionContains	(	const TPoint &	aPoint,
			const CCoeControl &	aControl
		)	const

Evaluates whether control is "hit" by touch event.

Parameters

const TPoint & aPoint
const CCoeControl & aControl

NewL(const CCoeControl &, const TMargins &)

CMsgHeader *	NewL	(	const CCoeControl &	aParent,
			const TMargins &	aMargins
		)	[static]

Factory method that creates this control.

Parameters

const CCoeControl & aParent
const TMargins & aMargins

SetAndGetSizeL(TSize &, TBool)

void	SetAndGetSizeL	(	TSize &	aSize,
			TBool	aInit
		)	[virtual]

Calculates and sets the size for the header and returns new size as reference aSize. If aInit == ETrue, sets also size for the controls by calling their SetAndGetSizeL functions.

Parameters

TSize & aSize
TBool aInit

SizeChanged()

void

SizeChanged

(

)

[protected, virtual]

Sets new position for all the controls.

Member Data Documentation

CMsgCaptionedHighlight * iFrame

CMsgCaptionedHighlight *

iFrame

[private]

CMsgDummyHeaderCleaner * iHeaderCleaner

CMsgDummyHeaderCleaner *

iHeaderCleaner

[private]