CAknSliderSettingPage Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None


#include <aknslidersettingpage.h>

Inherits CAknSettingPage.


Public Member Functions

IMPORT_C  CAknSliderSettingPage (TInt aResourceID, TInt &aSliderValue)
  Simple constructor depending only on a single resource Id.
IMPORT_C  CAknSliderSettingPage (const TDesC *aSettingTitleText, TInt aSettingNumber, TInt aControlType, TInt aEditorResourceId, TInt aSettingPageResourceId, TInt &aSliderValue)
  Constructor that allows separate setting page and editor resources.
IMPORT_C CAknSlider SliderControl ()
  Access method for the contained slider control.
virtual IMPORT_C void  ConstructL ()
  2nd stage contructor
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl.

Protected Member Functions

virtual IMPORT_C void  SizeChanged ()
  From CCoeControl This routine is called as part of the set-up of the control.
virtual IMPORT_C void  Draw (const TRect &aRect) const
virtual IMPORT_C void  WriteInternalStateL (RWriteStream &aWriteStream) const
  Writes the internal state of the control and its components to aStream.
virtual IMPORT_C  ~CAknSliderSettingPage ()
  C++ destructor.
virtual IMPORT_C void  UpdateSettingL ()
  Called when something has changed and the client's object needs to have its value updated.
virtual IMPORT_C void  AcceptSettingL ()
  Called when the user accepts a setting and the setting page is about to be dismissed.
virtual IMPORT_C void  RestoreOriginalSettingL ()
  Called when the user rejects the setting.

Constructor & Destructor Documentation

IMPORT_C CAknSliderSettingPage::CAknSliderSettingPage TInt  aResourceID,
TInt &  aSliderValue
 

Simple constructor depending only on a single resource Id.

Editor resource is given via the link in the setting page resource.

Parameters:
aSettingPageResourceId  Setting Page to use (if present)
aSliderValue  ref. to external slider value
IMPORT_C CAknSliderSettingPage::CAknSliderSettingPage const TDesC *  aSettingTitleText,
TInt  aSettingNumber,
TInt  aControlType,
TInt  aEditorResourceId,
TInt  aSettingPageResourceId,
TInt &  aSliderValue
 

Constructor that allows separate setting page and editor resources.

This constructor allows the use of setting page using only the editor resource. Other combinations are also possible

In all cases the number (if supplied i.e. <> 0 ) is used.

Editor Resource Setting Page Resource present present Both are used (but text & number overridden) = 0 present Editor resource is used via SP resource (Effectively like the other constructor) present = 0 Default Avkon SP resource if used + this editor resource = 0 = 0 uses default resource for both SP and editor. This is OK if: i) control type is present, ii) a default resource exists ( OK for text, integer, date, time, duration )

Note: THe first argument is a TDesC* (rather than TDesC&) because the other constructor cannot initialize such a member without allocation or having an internal dummy buffer.

Rules for text and numbers: The rules are the same for both: (non-zero length) text or number other than EAknSettingPageNoOrdinalDisplayed if given in this constructor will not override resource (unless that is zero length or EAknSettingPageNoOrdinalDisplayed). Note, however, that text or number given via the specific API for setting them, WILL override resource. It is assumed that number from resource is very rare. Special text is somewhat more likely.

Parameters:
aSettingTitleText  Text at top of setting pane (not copied to object until ExecuteLD is called)
aSettingNumber  Number at top left (if present)
aControlType  Determines the type constructed and how its resource is read
aEditorResourceId  Editor resource to use in the setting page (if present)
aSettingPageResourceId  Setting Page to use (if present)
aSliderValue  Reference to integer holding the slider value
virtual IMPORT_C CAknSliderSettingPage::~CAknSliderSettingPage  )  [protected, virtual]
 

C++ destructor.


Member Function Documentation

virtual IMPORT_C void CAknSliderSettingPage::AcceptSettingL  )  [protected, virtual]
 

Called when the user accepts a setting and the setting page is about to be dismissed.

The latest value of the setting is written to the client's object

Reimplemented from CAknSettingPage.

virtual IMPORT_C void CAknSliderSettingPage::ConstructL  )  [virtual]
 

2nd stage contructor

Reimplemented from CAknSettingPage.

virtual IMPORT_C void CAknSliderSettingPage::Draw const TRect &  aRect  )  const [protected, virtual]
 

Reimplemented from CAknSettingPage.

IMPORT_C void CAknSliderSettingPage::HandlePointerEventL const TPointerEvent &  aPointerEvent  ) 
 

From CCoeControl.

Reimplemented from CAknSettingPage.

virtual IMPORT_C void CAknSliderSettingPage::RestoreOriginalSettingL  )  [protected, virtual]
 

Called when the user rejects the setting.

A backup copy may need to be restored if UpdateWhenChanged flag was set

Reimplemented from CAknSettingPage.

virtual IMPORT_C void CAknSliderSettingPage::SizeChanged  )  [protected, virtual]
 

From CCoeControl This routine is called as part of the set-up of the control.

It is the place to put layout code.

Reimplemented from CAknSettingPage.

IMPORT_C CAknSlider* CAknSliderSettingPage::SliderControl  ) 
 

Access method for the contained slider control.

No transfer of ownership

Returns:
Reference ptr to the contained CAknSlider object
virtual IMPORT_C void CAknSliderSettingPage::UpdateSettingL  )  [protected, virtual]
 

Called when something has changed and the client's object needs to have its value updated.

Reimplemented from CAknSettingPage.

virtual IMPORT_C void CAknSliderSettingPage::WriteInternalStateL RWriteStream &  aWriteStream  )  const [protected, virtual]
 

Writes the internal state of the control and its components to aStream.

Does nothing in release mode. Designed to be overidden and base called by subclasses.

Parameters:
aWriteSteam  A connected write stream

Reimplemented from CAknSettingPage.


The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2008
Back to top