CEikMenuButton Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib avkon.lib

Capability Information

Required Capabilities

None

#include <eikmnbut.h>

Inherits CEikCommandButton.

Detailed Description

This class implements a command button that, when pressed, raises a Menu pane.

This class does NOT implement S60 look-and-feel and is not skinned.


Public Member Functions
IMPORT_C  CEikMenuButton ()
  C++ constructor.
IMPORT_C  ~CEikMenuButton ()
  destructor
IMPORT_C void  ConstructFromResourceL (TResourceReader &aReader)
  2nd phase constructor using a MNBUT resource struct
IMPORT_C void  LaunchPopupMenuL (MEikMenuObserver *aObserver)
  Launch the related menu pane.
IMPORT_C void  SetMenuPaneId (TInt aMenuPaneId)
  Set the menu pane id to be launched when the control is activated.
IMPORT_C void  Animate ()
  Triggers the change of appearance of the button that is associated with the button being pressed.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl.

Protected Member Functions
IMPORT_C void  WriteInternalStateL (RWriteStream &aWriteStream) const
  From CCoeControl.

Constructor & Destructor Documentation

IMPORT_C CEikMenuButton::CEikMenuButton (   ) 
 

C++ constructor.

IMPORT_C CEikMenuButton::~CEikMenuButton (   ) 
 

destructor

Member Function Documentation

IMPORT_C void CEikMenuButton::Animate (   )  [virtual]
 

Triggers the change of appearance of the button that is associated with the button being pressed.

Reimplemented from CEikButtonBase.

IMPORT_C void CEikMenuButton::ConstructFromResourceL (  TResourceReader &  aReader  ) 
 

2nd phase constructor using a MNBUT resource struct

Parameters:
aReader  A constructed resource reader.

Reimplemented from CEikCommandButton.

IMPORT_C void CEikMenuButton::HandlePointerEventL (  const TPointerEvent &  aPointerEvent  ) 
 

From CCoeControl.

Framework method called when a pointer event is found to be within this control's boundaries. The default implementation causes the associated menu to be presented to the screen.

Parameters:
aPointerEvent  Pointer event to process

Reimplemented from CEikCommandButton.

IMPORT_C void CEikMenuButton::LaunchPopupMenuL (  MEikMenuObserver *  aObserver  ) 
 

Launch the related menu pane.

Parameters:
aObserver  Mandatory supplied menu observer pointer.
IMPORT_C void CEikMenuButton::SetMenuPaneId (  TInt  aMenuPaneId  ) 
 

Set the menu pane id to be launched when the control is activated.

Parameters:
aMenuPaneId  Resource ID of the menu pane to be launched
IMPORT_C void CEikMenuButton::WriteInternalStateL (  RWriteStream &  aWriteStream  )  const [protected]
 

From CCoeControl.

Serialize the state of the control to the given stream

Parameters:
aWriteStream  Stream to write to

Reimplemented from CEikCommandButtonBase.

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