![[Index]](../../../../_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../_stock/btn_next_wt.gif){kind=small}
|
|
| ||
|
|
|||
Location:
QikSoundSelector.h
Link against: qikctl.lib
class CQikSoundSelector : public CCoeControl, public MQikCommandListOwner, public MQikCommandHandler, public MQikSoundPlayerObserver;
This class provides a sound selector control.
This allows the user to choose a sound to play.
MQikSoundPlayerObserver - Mixin class for the observer of the class MQikCommandHandler - Interface for classes responsible of executing commandsMQikCommandListOwner - Interface for classes adding commandsMObjectProvider - An interface that allows an object to be part of a network of object providersCBase - Base class for all classes to be instantiated on the heapCCoeControl - Control base class from which all other controls are derivedCQikSoundSelector - This class provides a sound selector controlDefined in CQikSoundSelector:
AddCustomSoundL(), AddCustomSoundL(), AddFixedSequenceSoundsL(), AddTypeL(), CQikSoundSelector(), ComponentControl(), ConstructFromResourceL(), ConstructL(), CountComponentControls(), EAutomaticConsumeOnly, EExcludeFindAudioFileHistory, EIncludeAlarmFileSounds, EIncludeAlarmSounds, EIncludeEventSounds, EIncludeFindAudioFileOption, EIncludeFixedSequenceSounds, EIncludeRingSounds, EIncludeSilentOption, EIncludeTones, ESoundSelectorAlarm, ESoundSelectorClockAlarm, ESoundSelectorError, ESoundSelectorEvent, ESoundSelectorMessage, ESoundSelectorRing, ESoundSelectorTones, FocusChanged(), GetChoiceList(), GetColorUseListL(), GetSound(), HandleCommandL(), HandlePointerEventL(), HandleResourceChange(), MapCommandHandler(), MinimumSize(), OfferKeyEventL(), PlayComplete(), PrepareForFocusGainL(), PrepareForFocusLossL(), SetAllowedMimeTypesL(), SetDefaultSoundL(), SetDimmed(), SetSound(), SetSound(), SetSoundOptionL(), SetSoundPriority(), SetSoundVolume(), SetTypeL(), SizeChanged(), StopSoundL(), TFixedSequenceSoundTypes, TFlags, TSoundSelectorTypes, ~CQikSoundSelector()
Inherited from CBase:
Delete(),
Extension_(),
operator new()
Inherited from CCoeControl:
AccumulatedZoom(),
ActivateGc(),
ActivateL(),
BackedUpWindow(),
Background(),
CapturesPointer(),
ClaimPointerGrab(),
CloseWindow(),
Components(),
ControlContext(),
ControlEnv(),
CopyControlContextFrom(),
CreateBackedUpWindowL(),
CreateWindowL(),
DeactivateGc(),
DrawBackground(),
DrawDeferred(),
DrawForeground(),
DrawNow(),
DrawableWindow(),
EAbsoluteZoom,
ERelativeZoom,
EnableDragEvents(),
FindBackground(),
FindFontProvider(),
GetColor(),
GetGc(),
GetHelpContext(),
GrabbingComponent(),
HandleComponentControlsResourceChange(),
HandleControlArrayEventL(),
HandlePointerBufferReadyL(),
HandleRedrawEvent(),
HasBorder(),
HitTest(),
IgnoreEventsUntilNextPointerUp(),
Index(),
InitComponentArrayL(),
InputCapabilities(),
IsActivated(),
IsBackedUp(),
IsBeingDestroyed(),
IsBlank(),
IsDimmed(),
IsFocused(),
IsNonFocusing(),
IsReadyToDraw(),
IsVisible(),
LayoutManager(),
MakeVisible(),
MaximumWidth(),
MopSupplyObject(),
Observer(),
OverrideColorL(),
OwnsWindow(),
Parent(),
Position(),
PositionChanged(),
PositionRelativeToScreen(),
Rect(),
RecursivelyMergedInputCapabilities(),
ReportEventL(),
RequestRelayout(),
Reserved_CCoeControl_10(),
Reserved_CCoeControl_11(),
Reserved_CCoeControl_12(),
Reserved_CCoeControl_13(),
ResetGc(),
ScreenFont(),
SetAdjacent(),
SetAllowStrayPointers(),
SetBackground(),
SetBlank(),
SetCanDrawOutsideRect(),
SetComponentsToInheritVisibility(),
SetContainerWindowL(),
SetControlContext(),
SetCornerAndSize(),
SetExtent(),
SetExtentToWholeScreen(),
SetFocus(),
SetFocusing(),
SetFontProviderL(),
SetGc(),
SetGloballyCapturing(),
SetHitTest(),
SetLayoutManagerL(),
SetMaximumWidth(),
SetMopParent(),
SetNeighbor(),
SetNonFocusing(),
SetObserver(),
SetParent(),
SetPointerCapture(),
SetPosition(),
SetRect(),
SetSize(),
SetSizeWithoutNotification(),
SetTextBaselineSpacing(),
SetUniqueHandle(),
SetZoomFactorL(),
Size(),
SystemGc(),
TZoomType,
TextBaselineOffset(),
TextDrawer(),
UniqueHandle(),
Window(),
WriteInternalStateL(),
ZoomWithType(),
iCoeEnv,
iContext,
iPosition,
iSize
Inherited from MObjectProvider:
MopGetObject(),
MopGetObjectNoChaining()
Inherited from MQikCommandHandler:
HandleAttemptDimmedSelectionL()
IMPORT_C CQikSoundSelector();
Default constructor that partially builds a sound selector control. Complete construction with a call to either ConstructFromResourceL() to initialise the sound selector from a resource file, or a call to ConstructL() if no resource file is used.
IMPORT_C void ConstructL();
Completes construction of the CQikSoundSelector . Sets the sound selector's icon and observer and initialises the choice list.
|
IMPORT_C void SetSoundOptionL(TInt aFlags);
Second part of the construction process. It finishes building the CQikSoundSelector .
|
IMPORT_C void SetDefaultSoundL(TInt aSoundNameStrResourceId, const TBaSystemSoundType &aDefaultToneUid);
|
IMPORT_C TInt AddCustomSoundL(const TFileName &aSoundFile);
|
|
IMPORT_C TInt AddCustomSoundL(const TFileName &aSoundFile, const TDesC &aLabelName);
|
|
| Interface status: | deprecated |
IMPORT_C void AddFixedSequenceSoundsL(TFixedSequenceSoundTypes aSoundType);
This has been deprecated, see SetTypeL() and AddTypeL()
|
![[Top]](../../../../_stock/arrow_up_2.gif){kind=icon}
SetTypeLAddTypeLIMPORT_C void SetTypeL(const TSoundSelectorTypes &aType) const;
Used to set the soundselector to be of a specific type (one of CQikSoundSelector::TSoundSelectorTypes). This method sets the correct volume and priority for the specific type, and adds all sounds associated with the type.
|
IMPORT_C void AddTypeL(const TSoundSelectorTypes &aType) const;
Used to add sounds of a specific type to the soundselector. Does not set volume or priority.
|
IMPORT_C void SetAllowedMimeTypesL(const MDesC16Array &aMimeTypes);
|
IMPORT_C void SetSoundPriority(const TInt aPriority, const TMdaPriorityPreference aPriorityPreference);
Allows the client to set what range of volume the media server has access to when the sample is played.
|
IMPORT_C void SetSoundVolume(const TInt aVolume);
Specifies the volume the sample is played back at.
|
IMPORT_C TInt SetSound(const TDesC &aSound);
Sets the currently selected sound.
|
|
IMPORT_C TInt SetSound(const TBaSystemSoundInfo &aSoundInfo);
Sets the sound.
|
|
IMPORT_C void GetSound(TDes &aSound) const;
Gets the currently selected sound from the choice list.
|
IMPORT_C CEikChoiceList *GetChoiceList();
Gets the choice list associated with the sound selector control.
|
IMPORT_C void StopSoundL();
Programmatically stop a sound that is currently playing. Does nothing if no sound is playing. Suitable to call from a the ViewDeactivated() function of the view hosting the soundselector.
|
virtual IMPORT_C void ConstructFromResourceL(TResourceReader &aReader);
This function completes construction of a newly-allocated sound selector, getting specification from a resource.
|
virtual IMPORT_C TSize MinimumSize();
Sets the control’s minimum required size.
|
virtual IMPORT_C void SetDimmed(TBool aDimmed);
Sets the control's dim state. Dimming usually indicates a control cannot accept user input. This function sets a flag within the control which indicates whether or not the control is dimmed.
|
virtual IMPORT_C void GetColorUseListL(CArrayFix< TCoeColorUse > &aColorUseList) const;
Gets the list of logical colors used to draw the container. The list includes an explanation of how each color is used, and is appended to aColorUseList .
|
virtual IMPORT_C void HandleResourceChange(TInt aType);
Handles a change to the control’s resources. The types of type aType of resources handled are those which are shared across the environment; colors or fonts for example.
|
virtual IMPORT_C void PrepareForFocusGainL();
Notifier called upon before the control gains focus.
virtual IMPORT_C void PrepareForFocusLossL();
Notifier called upon before the control loses focus.
virtual IMPORT_C MQikCommandHandler *MapCommandHandler(CQikCommand &aCommand);
From MQikCommandListOwner
|
|
virtual IMPORT_C void HandleCommandL(CQikCommand &aCommand);
From MQikCommandHandler
|
virtual IMPORT_C void PlayComplete(TInt aError);
Called when playing has ended of any reason
|
protected: virtual IMPORT_C TInt CountComponentControls() const;
Gets the number of controls contained in a compound control.
|
protected: virtual IMPORT_C CCoeControl *ComponentControl(TInt aIndex) const;
Gets the specified component of a compound control.
|
|
protected: virtual IMPORT_C void SizeChanged();
Responds to size changes to sets the size and position of the contents of this control.
protected: virtual IMPORT_C void FocusChanged(TDrawNow aDrawNow);
Responds to a change in focus. This function is called whenever a control gains or loses focus as a result of a call to SetFocus() . A typical use of FocusChanged() is to change the appearance of the control to indicate whether or not it has focus, for example by drawing a focus rectangle around it.
|
protected: virtual IMPORT_C void HandlePointerEventL(const TPointerEvent &aPointerEvent);
Handles pointer events. This function gets called whenever a pointer event occurs in the control
|
protected: virtual IMPORT_C TKeyResponse OfferKeyEventL(const TKeyEvent &aKeyEvent, TEventCode aType);
Handles key events.
|
|
|
TFlags
|
| Interface status: | deprecated |
TFixedSequenceSoundTypes
This enumeration has been deprecated.
|
TSoundSelectorTypes
New enumeration for the qiksoundselector. Replaces the old TFixedSequenceSoundTypes.
|
|
© Copyright Symbian Software Ltd 2006. All rights reserved. UIQ 3 SDK 9 May 2006 |
|
![[Previous]](../../../../_stock/btn_prev.gif){kind=small}
![[Top]](../../../../_stock/btn_top.gif)
![[Next]](../../../../_stock/btn_next.gif){kind=small}