CAknMessageQueryControl Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknmessagequerycontrol.h>

Inherits CAknControl.

Detailed Description

Interface to control to implement message queries, to be contained within CAknMessageQueryDialog.

Public Member Functions

 CAknMessageQueryControl ()
 C++ default constructor.
 ~CAknMessageQueryControl ()
 Destructor.
IMPORT_C void ConstructFromResourceL (TResourceReader &aReader)
 Constructs controls from a resource file.
IMPORT_C void SetMessageTextL (TDesC *aMessage)
 Sets the message text.
TInt Lines () const
 Gets the number of lines.
TKeyResponse OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode)
 Handles key events.
void SetMessageTextWithFormattingL (TDesC *aMessage, RArray< TDesC * > *aFormatTextArray, RArray< TInt > *aFormatTextLocationArray, RArray< TMsgQueryTag > *aFormatTypeArray)
 Formats message text with links and bold text.
TInt CurrentLink () const
 Fetches the current link chosen by the UI.
IMPORT_C TBool LinkHighLighted () const
 Determines whether the link is highlighted.
void SetListQLayout (TBool aListQLayout)
 When set, controls knows that it is in listquery dialog where max.
TBool LinkTappedL (TInt aPos)
 Determines if a link is tapped.
TSize MinimumSize ()
 From CCoeControl.
TInt CountComponentControls () const
 From CCoeControl.
CCoeControl * ComponentControl (TInt anIndex) const
 From CCoeControl.
void SizeChanged ()
 From CCoeControl.
virtual void ActivateL ()
 From CCoeControl.
void HandlePointerEventL (const TPointerEvent &aPointerEvent)
 From CCoeControl.

Protected Member Functions

IMPORT_C void Draw (const TRect &aRect) const
 From CCoeControl.
TRect LayoutRect () const
 Get a layout rectangle (shift up and left by margins).

Constructor & Destructor Documentation

CAknMessageQueryControl::CAknMessageQueryControl (   ) 
 

C++ default constructor.

CAknMessageQueryControl::~CAknMessageQueryControl (   ) 
 

Destructor.

Member Function Documentation

virtual void CAknMessageQueryControl::ActivateL (   )  [virtual]
 

From CCoeControl.

Sets control as ready to be drawn. This function calls CCoeControl::ActivateL().

CCoeControl* CAknMessageQueryControl::ComponentControl ( TInt  anIndex  )  const
 

From CCoeControl.

Gets the specified component of a compound control. It returns one of the control's component controls, identified by anIndex.

Parameters:
anIndex The index of the control to get.
Returns:
The component control with an index of anIndex.
IMPORT_C void CAknMessageQueryControl::ConstructFromResourceL ( TResourceReader &  aReader  ) 
 

Constructs controls from a resource file.

Parameters:
aReader The resource reader with which to access AVKON_MESSAGE_QUERY resource.
TInt CAknMessageQueryControl::CountComponentControls (   )  const
 

From CCoeControl.

Gets the number of controls contained in a compound control.

Returns:
The number of component controls contained by this control.
TInt CAknMessageQueryControl::CurrentLink (   )  const
 

Fetches the current link chosen by the UI.

Returns:
The index of the link or -1 if no link is chosen.
IMPORT_C void CAknMessageQueryControl::Draw ( const TRect &  aRect  )  const [protected]
 

From CCoeControl.

Draw a control.

Parameters:
aRect The region of the control to be redrawn. Not used.
void CAknMessageQueryControl::HandlePointerEventL ( const TPointerEvent &  aPointerEvent  ) 
 

From CCoeControl.

Handles pointer events

TRect CAknMessageQueryControl::LayoutRect (   )  const [protected]
 

Get a layout rectangle (shift up and left by margins).

Returns:
The layout rectangle.
TInt CAknMessageQueryControl::Lines (   )  const [inline]
 

Gets the number of lines.

Returns:
Number of lines.
IMPORT_C TBool CAknMessageQueryControl::LinkHighLighted (   )  const
 

Determines whether the link is highlighted.

Returns:
ETrue if the link is highlighted.
TBool CAknMessageQueryControl::LinkTappedL ( TInt  aPos  ) 
 

Determines if a link is tapped.

Parameters:
aPos Position of the character tapped.
Returns:
ETrue if a link is tapped.
TSize CAknMessageQueryControl::MinimumSize (   ) 
 

From CCoeControl.

Sets the control's minimum required size.

Returns:
The minimum size required by the control.
TKeyResponse CAknMessageQueryControl::OfferKeyEventL ( const TKeyEvent &  aKeyEvent,
TEventCode 
) 
 

Handles key events.

Parameters:
aKeyEvent The key event.
Returns:
Indicates whether or not the key event was used by this control.
void CAknMessageQueryControl::SetListQLayout ( TBool  aListQLayout  ) 
 

When set, controls knows that it is in listquery dialog where max.

lines is 3 and background is not drawn

IMPORT_C void CAknMessageQueryControl::SetMessageTextL ( TDesC *  aMessage  ) 
 

Sets the message text.

Parameters:
aMessage Message text.
void CAknMessageQueryControl::SetMessageTextWithFormattingL ( TDesC *  aMessage,
RArray< TDesC * > *  aFormatTextArray,
RArray< TInt > *  aFormatTextLocationArray,
RArray< TMsgQueryTag > *  aFormatTypeArray
) 
 

Formats message text with links and bold text.

To be called from CAknMessageQueryDialog.

Parameters:
aFormatTextArray Pointer to text to be formatted
aFormatTextLocationArray Start index of the text
aFormatTypeArray Format type
void CAknMessageQueryControl::SizeChanged (   ) 
 

From CCoeControl.

Responds to size changes to sets the size and position of the contents of this control.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top