CAknColourSelectionGrid Class Reference

API published in: S60 2nd Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <akncolourselectiongrid.h>

Inherits CAknDialog, and MEikListBoxObserver.

Detailed Description

Colour selection grid.

This class can be used when application offers to user possibility to choose colour. There is also possibility to select nothing.

use example:

TBool noneExist = ETrue; TBool noneChosen = EFalse; TRgb colour = KRgbDarkGray; CArrayFixFlat<TRgb>* colours = new(ELeave) CArrayFixFlat<TRgb>(6);

colours->AppendL(KRgbBlack); colours->AppendL(KRgbDarkGray);

CAknColourSelectionGrid *d = CAknColourSelectionGrid::NewL( colours, noneExist, noneChosen, colour);

d->ExecuteLD();


Public Member Functions
IMPORT_C TBool  ExecuteLD ()
  ExecuteLD() runs dialog, waits user to make his choise and destroys dialog.
IMPORT_C  ~CAknColourSelectionGrid ()
  Destructor.
void  HandleControlEventL (CCoeControl *aControl, TCoeEvent aEventType)
  From MCoeControlObserver Handles control events from nonebutton.
void  HandleDialogPageEventL (TInt aEventID)
  From MDialogPageObserver Handles dialogpage events.

Static Public Member Functions
static IMPORT_C CAknColourSelectionGrid *  NewL (CArrayFixFlat< TRgb > *aColours, TBool aNoneExist, TBool &aNoneChosen, TRgb &aColourChosen)
  Two-phased constructor.

Constructor & Destructor Documentation

IMPORT_C CAknColourSelectionGrid::~CAknColourSelectionGrid (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C TBool CAknColourSelectionGrid::ExecuteLD (   ) 
 

ExecuteLD() runs dialog, waits user to make his choise and destroys dialog.

void CAknColourSelectionGrid::HandleControlEventL (  CCoeControl *  aControl,
TCoeEvent  aEventType
) 
 

From MCoeControlObserver Handles control events from nonebutton.

Parameters:
aControl  Pointer to observed control
aEventType  type of event to be handled

Reimplemented from CEikDialog.

void CAknColourSelectionGrid::HandleDialogPageEventL (  TInt  aEventID  )  [virtual]
 

From MDialogPageObserver Handles dialogpage events.

Parameters:
aEventID  event to be handled

Reimplemented from CEikDialog.

static IMPORT_C CAknColourSelectionGrid* CAknColourSelectionGrid::NewL (  CArrayFixFlat< TRgb > *  aColours,
TBool  aNoneExist,
TBool &  aNoneChosen,
TRgb &  aColourChosen
)  [static]
 

Two-phased constructor.

NewL() Creates dialog

Parameters:
aColours  array of colors for grid
aNoneExist  boolean flag does none exist in dialog
aNoneChosen  Dialog sets boolean value is none chosen If value is EFalse in start, some colour will be active in start
aColourChosen  Dialog sets the value of color chosen If starting value aNoneChosen is EFalse, starting value of aColours tells witch colour is active when grid starts
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top