MCL/sf/app/radio: comparison fmradio/fmradio/inc/fmradioappui.h

equal deleted inserted replaced

-:108d9820af01
+:3cb097cb90f8
 * Description:  Definition of class FMRadioAppUi. Provides command
 *                      and callback interfaces to control the engine and the
 *                     application views.
 *
 */
 #ifndef FMRADIOAPPUI_H
 #define FMRADIOAPPUI_H
 // INCLUDES
 * Interface to tell when dialog was terminated
 *
 *    @since 2.6
 */
 class MInformationNoteInterface
-	{
+{
-	public:
+public:
+/**
-		/**
 * tells when dialog was terminated
 */
-		virtual void DialogTerminated() = 0;
+virtual void DialogTerminated() = 0;
+};
-	};
 /**
 * Information note for headset key events. Enabling functionality to disable new dialog creation
 * when dialog is active
 *
 *    @since 2.6
 */
 class CFMInformationNote: public CAknInformationNote
-	{
+{
-	public:
+public:
-		/**
+/**
 * default constructor.
 */
-		CFMInformationNote( MInformationNoteInterface& aObserver);
+CFMInformationNote( MInformationNoteInterface& aObserver);
-		/**
+/**
 * Destructor.
 */
-		virtual ~CFMInformationNote();
+virtual ~CFMInformationNote();
-	private:
+private:
-		// Dialog event observer
+// Dialog event observer
-		MInformationNoteInterface& iDialogObserver;
+MInformationNoteInterface& iDialogObserver;
-	};
+};
 /**
 * Instantiates the application views. It also acts as the default command handler for the
 *  application. Part of the standard application framework.
 *
 {
 EDirectionUp,
 EDirectionNone,
 EDirectionDown
 };
+enum TRadioState
+{
+EFMRadioStateOff = 0,            // Radio off
+EFMRadioStateOffForPhoneCall,    // Radio off because a phone call
+EFMRadioStateOffBeforePhoneCall, // Radio was off + phone call going on -> no resume
+EFMRadioStateOn,
+EFMRadioStateRecording,
+EFMRadioStateBusyRadioOn,
+EFMRadioStateBusyRadioOff,
+EFMRadioStateBusySeek,
+EFMRadioStateBusyMute,
+EFMRadioStateBusyVolume,
+EFMRadioStateBusyManualTune,
+EFMRadioStateBusyScanLocalStations,
+EFMRadioStateExiting
+};
 public: // Constructors and destructor
 /**
 * EPOC default constructor.
 */
 void ConstructL();
+/**
+* C++ default constructor.
+*/
+CFMRadioAppUi();
 /**
 * Destructor.
 */
 virtual ~CFMRadioAppUi();
 * From CEikAppUi, takes care of command handling.
 * @since 2.6
 * @param aCommand command to be handled
 */
 void HandleCommandL( TInt aCommand );
 /**
 * Notification interface from RadioEngine. Used to inform
 * us when requests have completed.
 * @since 2.6
 * @param aEventCode code corresponding to the event being propogated
 * @param aErrorCode error code of the event being propogated
 */
 void HandleRadioEngineCallBack( MRadioEngineStateChangeCallback::TFMRadioNotifyEvent aEventCode, TInt aErrorCode );
 public: // new functions
-	/**
+/**
-		* Returns a pointer to the radio engine
+* Returns a pointer to the radio engine
-	    *
+*
-	    * @return Radio engine
+* @return Radio engine
-		*/
+*/
-	CRadioEngine* RadioEngine();
+CRadioEngine* RadioEngine();
 /**
 * Returns a reference to Back Stepping wrapper
 *
 * @return Reference to Back Stepping wrapper
 */
 CFMRadioBackSteppingServiceWrapper& BackSteppingWrapper() const;
-	/**
+/**
-	     * Returns a pointer to FMRadio's document, cannot be null.
+* Returns a pointer to FMRadio's document, cannot be null.
-	     *
+*
-	     * @return A pointer to a CFMRadioDocument object.
+* @return A pointer to a CFMRadioDocument object.
-	     */
+*/
-	CFMRadioDocument* Document() const;
+CFMRadioDocument* Document() const;
 /**
-		* Checks if current screen orientation is landscape
+* Checks if current screen orientation is landscape
-	    *
+*
-	    * @return ETrue if orientation is landscape, otherwise EFalse
+* @return ETrue if orientation is landscape, otherwise EFalse
-		*/
+*/
-		TBool IsLandscapeOrientation() const;
+TBool IsLandscapeOrientation() const;
-	/**
+/**
-	* Handles offline mode at startup.
+* Handles offline mode at startup.
-	*/
+*/
-	void HandleOfflineModeAtStartUpL();
+void HandleOfflineModeAtStartUpL();
 /**
 * Handles start up foreground event.
 */
 void HandleStartupForegroundEventL();
 /**
 * Nunber of channels stored in presets.
 * @return number of channels in presets
 */
 TInt NumberOfChannelsStored() const;
 /**
-	 * Returns the UID of the currently active local view. KNullUid if none
+* Returns the UID of the currently active local view. KNullUid if none
-	 * active (construction/destruction).
+* active (construction/destruction).
-	 * @return UID of the currently active local view, KNullUid if none
+* @return UID of the currently active local view, KNullUid if none
-	 * active.
+* active.
-	 */
+*/
-	TUid ActiveView() const;
+TUid ActiveView() const;
-	/**
+/**
-	* Return startup scanning wizard status.
+* Return startup scanning wizard status.
-	* @return running status
+* @return running status
-	*/
+*/
-	TBool IsStartupWizardRunning() const;
+TBool IsStartupWizardRunning() const;
-	/**
+/**
-	* Set startup scanning wizard status.
+* Set startup scanning wizard status.
-	* @param aRunningState running state
+* @param aRunningState running state
-	*/
+*/
-	void SetStartupWizardRunning( const TBool aRunningState );
+void SetStartupWizardRunning( const TBool aRunningState );
-	/**
+/**
 * Tune to the specified frequency
 * @since 2.6
 * @param aFrequency the frequency to be tuned
 */
 void TuneL(TInt aFrequency);
 /**
 * @return mirrored layout state
 */
 TBool IsLayoutMirrored() const;
-		/**
+/**
-		* Show currently active volume popup control
+* Show currently active volume popup control
-		*/
+*/
-		void ShowVolumePopupL();
+void ShowVolumePopupL();
-		/**
+/**
-		 * From MChannelListHandler
+* From MChannelListHandler
-		 * Updates channels array in appui
+* Updates channels array in appui
-		 * @param aOperation tells which operation is made to array
+* @param aOperation tells which operation is made to array
-		 * @param aIndex tells affecting index
+* @param aIndex tells affecting index
-		 * @param aMovedToNewIndex optional during move operation
+* @param aMovedToNewIndex optional during move operation
-		 */
+*/
-		void UpdateChannelsL( TMoveoperations aOperation,
+void UpdateChannelsL( TMoveoperations aOperation,
-				TInt aIndex,
+TInt aIndex,
-				TInt aMovedToNewIndex  );
+TInt aMovedToNewIndex  );
-		/**
+/**
-		 * From MChannelListHandler
+* From MChannelListHandler
-		 * Add a new channel to list of channels
+* Add a new channel to list of channels
-		 * @param aChannelName Name of the channel to be saved
+* @param aChannelName Name of the channel to be saved
-		 * @param aChannelFreq Channel frequency
+* @param aChannelFreq Channel frequency
-		 */
+*/
-		void AddChannelToListL( const TDesC& aChannelName, TInt aChannelFreq );
+void AddChannelToListL( const TDesC& aChannelName, TInt aChannelFreq );
-		/**
+/**
-		 * From MChannelListHandler
+* From MChannelListHandler
-		 * Accessory method to channels array
+* Accessory method to channels array
-		 */
+*/
-		CArrayFixFlat<TChannelInformation>* Channels();
+RPointerArray<CFMRadioPreset>& Channels();
-		void AutoTuneInMainView ( TBool aTune );
+void AutoTuneInMainView ( TBool aTune );
 /**
 * status of the startup wizard state
 * @return wizard status
 */
 TBool IsStartupWizardHandled() const;
 /*
 * Returns a pointer to the currently active volume popup control
 * @return active volume popup
 */
 CAknVolumePopup* ActiveVolumePopup() const;
+/*
+* Get current radio state.
+		 * @return TRadioState state of the radio
+*/
+CFMRadioAppUi::TRadioState CFMRadioAppUi::RadioState() const;
 protected:
 /**
 * From CEikAppUi HandleWsEventL
 */
 void HandleWsEventL(const TWsEvent& aEvent,CCoeControl* aDestination);
 /**
 * From base class CCoeAppUi
-	*/
+*/
-	void HandleForegroundEventL( TBool aForeground );
+void HandleForegroundEventL( TBool aForeground );
 private: // Functions from base classes
 /**
 * Handles a change to the application's resources
 * @param aType The type of changed resource
 */
 void HandleResourceChangeL( TInt aType );
 /**
-		* Updates the landscape data. This is done separately
+* Updates the landscape data. This is done separately
-		* and not in IsLandscapeOrientation method as
+* and not in IsLandscapeOrientation method as
-		* IsLandscapeOrientation MUST NOT do a window server flush
+* IsLandscapeOrientation MUST NOT do a window server flush
-		*/
+*/
-		void UpdateLandscapeInformation();
+void UpdateLandscapeInformation();
 private: // new functions
 /**
 * All leaving function calls are made here, so that nothing is left on the stack if the ConstructL leaves
 * The reason for this behaviour is that the UI framework doesn't handle leaves from the AppUi correctly.
 * Displays an error note with the text contained in the passed in reference
 * @since 2.6
 * @param aErrorNote id of the text to display in the error note
 */
 void DisplayErrorNoteL( TInt aErrorNote );
 /**
 * Displays an information note with the text contained in the passed in reference
 * @since 2.6
 * @param aInfoNote id of the text to display in the error note
 */
 void DisplayInformationNoteL( TInt aInfoNote );
 /**
 * Return the numeric key value corresponding to the key code
 * @since 2.6
 * @param aCode the Symbian key code
 * @return the numeric key value
 void HandleFlightmodeDisabledCallback();
 /**
 * Processes "volume update failed" callback
 * @since 2.6
 */
 void HandleVolumeUpdateFailedCallback();
 /**
 * Handles mute keypress from main view
 *
 */
 void HandleMuteCommand();
 */
 TFMRadioRegionSetting HandleRegionsAtStartUpL();
 /**
 * Request tuner control from engine
 */
 void RequestTunerControl() const;
 /**
 * Is offline profile activated when radio audio was disabled.
 * @return ETrue, if offline profile activated when radio
-*         audio was disabled. EFalse otherwise.
+* audio was disabled. EFalse otherwise.
 */
 TBool IsOfflineProfileActivatedWhenRadioAudioDisabled() const;
 /**
 * Sets the toolbar visibility.
 * @param aVisible
 */
 /**
 * A call back function for processing start up foreground event.
 *
 * @param aSelfPtr  Pointer to self.
 * @return Always 0.
 */
 static TInt StaticStartupForegroundCallback( TAny* aSelfPtr );
 private:
 /**
 * Called when volume level should be changed.
 * Set volume control visible.
 * @param aVolumeChange: +1 change volume up
 *                       -1 change volume down
 */
 void FMRadioSvkChangeVolumeL( TInt aVolumeChange );
 /**
 * Called when volume was changed last time 2 seconds ago or
 * timer was started 2 seconds ago. The remove control timer
 * is started when ChangeVolumeL() is called
 * or when started through CMmsSvkEvents::StartRemoveTimerL()
 */
 void FMRadioSvkRemoveVolumeL( );
 void FMRadioHeadsetEvent(TAccessoryEvent aEvent);
 /**
 * From MFMRadioGlobalConfirmationQueryObserver
 *
 * @see MFMRadioGlobalConfirmationQueryObserver::GlobalConfirmationQueryDismissedL(TInt aSoftKey)
 */
 void GlobalConfirmationQueryDismissedL( TInt aSoftKey );
 /**
 *From MCoeControlObserver. To handle the volume events.
 */
 void HandleControlEventL( CCoeControl* aControl, TCoeEvent aEventType );
 /**
 * From MInformationNoteInterface. To handle dialog terminated events.
 */
 void DialogTerminated();
 /**
 * Gets the Channels array
 */
 void GetChannelsArrayL();
-		/**
+/**
-		* Check available IAD updates
+* Check available IAD updates
-		*/
+*/
-		void HandleIADUpdateCheckL();
+void HandleIADUpdateCheckL();
-		// from base class MIAUpdateObserver
+// from base class MIAUpdateObserver
-	void CheckUpdatesComplete( TInt aErrorCode, TInt aAvailableUpdates );
+void CheckUpdatesComplete( TInt aErrorCode, TInt aAvailableUpdates );
-	void UpdateComplete( TInt aErrorCode, CIAUpdateResult* aResultDetails );
+void UpdateComplete( TInt aErrorCode, CIAUpdateResult* aResultDetails );
-	void UpdateQueryComplete( TInt aErrorCode, TBool aUpdateNow );
+void UpdateQueryComplete( TInt aErrorCode, TBool aUpdateNow );
-	/**
+/**
-	 * Processes the tail of the command
+* Processes the tail of the command
-	 * @param aTail The tail to be processed
+* @param aTail The tail to be processed
-	 */
+*/
-	void ProcessCommandTailL( const TDesC8& aTail );
+void ProcessCommandTailL( const TDesC8& aTail );
 // from base class CEikAppUi
 MCoeMessageObserver::TMessageResponse HandleMessageL(
 TUint32 aClientHandleOfTargetWindowGroup,
 TUid aMessageUid,
 const TDesC8& aMessageParameters );
 TBool ProcessCommandParametersL( TApaCommand aCommand,
 TFileName& aDocumentName,
 const TDesC8& aTail );
 /**
 * Check if Active Idle app is on foreground.
 *
 * @return ETrue if idle app is in the foreground, EFalse otherwise.
 */
 TBool IsIdleAppForeground();
 /**
 * Check if Active Idle is enabled.
 *
 * @return ETrue if active idle is in the enabled, EFalse otherwise.
 */
 /**
 * Handles the possibly pending view activation
 */
 void HandlePendingViewActivationL();
 private:
-enum TInterfaceState
-{
-EFMRadioStateOff = 0, 			// Radio off
-EFMRadioStateOffForPhoneCall,	// Radio off because a phone call
-EFMRadioStateOffBeforePhoneCall,// Radio was off + phone call going on -> no resume
-EFMRadioStateOn,
-EFMRadioStateRecording,
-EFMRadioStateBusyRadioOn,
-EFMRadioStateBusyRadioOff,
-EFMRadioStateBusyScanUp,
-EFMRadioStateBusyScanDown,
-EFMRadioStateBusySeek,
-EFMRadioStateBusyMute,
-EFMRadioStateBusyVolume,
-EFMRadioStateBusyManualTune,
-EFMRadioStateBusyScanLocalStations,
-EFMRadioStateExiting
-};
 /**
 * State to indicate the mute status
 */
 enum TFMMuteStatus
 {
 EFMUninitialized = 0,       // Uninitialized value
 EFMUnmuted,                 // Unmute state
 EFMMuted                    // Mute state
 };
 // System's volume indicator
 CAknVolumePopup* iIhfVolumePopupControl;
 CAknVolumePopup* iHeadsetVolumePopupControl;
 CAknVolumePopup* iActiveVolumePopupControl;
 CRadioEngine*   iRadioEngine;
-TInt iCurrentRadioState;
+TRadioState iCurrentRadioState;
 CFMRadioScanLocalStationsView* iScanLocalStationsView;
 CFMRadioChannelListView* iChannelListView;
 CFMRadioMainView* iMainView;
 //all the possible radio UI states
 TInt iFMRadioVariationFlags;
 */
 TBool iShowingLocalOfflineContinueQuery;
 /**
 * Is the local or global offline query activated.
-	*/
+*/
 TBool iOfflineQueryDialogActivated;
-	/**
-	* Is the start up of application ongoing.
-	*/
-	TBool iStartUp;
 /**
-		* Is the screen orientation landscape
+* Is the start up of application ongoing.
-		*/
+*/
-		TBool iLandscape;
+TBool iStartUp;
+/**
+* Is the screen orientation landscape
+*/
+TBool iLandscape;
 CAlfEnv* iAlfEnv; // Owned
 // flag to indicate wizard handling
 TBool iStartupWizardHandled;
 // flag for startup wizard status
 TBool iStartupWizardRunning;
 // connect headset query
 CAknQueryDialog* iConnectHeadsetQuery;
 // flag to indicate if automatic tune is activated from startup wizard
 TBool iTuneFromWizardActivated;
-	// akn information note ptr to check that dialog has dismissed from display
+// akn information note ptr to check that dialog has dismissed from display
-	TBool iInfoNoteOn;
+TBool iInfoNoteOn;
-	// global note for headset status when radio is background
+// global note for headset status when radio is background
-	CAknGlobalNote* iConnectHeadsetGlobalNote;
+CAknGlobalNote* iConnectHeadsetGlobalNote;
-	// flag for previous mute status
+// flag for previous mute status
 TFMMuteStatus iMuteStatusBeforeRadioInit;
-	// Channels list
+// Channels list
-	CArrayFixFlat<TChannelInformation>* iChannels;
+RPointerArray<CFMRadioPreset> iChannels;
-	// IAD client object. Owned.
+// IAD client object. Owned.
-	CIAUpdate* iUpdate;
+CIAUpdate* iUpdate;
-	// Parameters for IAD update. Owned.
+// Parameters for IAD update. Owned.
-	CIAUpdateParameters* iParameters;
+CIAUpdateParameters* iParameters;
-	TBool iAutoTune;
-	TBool iAutoTuneUnmute;
 // The backstepping wrapper. Owned.
 CFMRadioBackSteppingServiceWrapper* iBsWrapper;
 // Is feature manager initialized, used for uninitializing feature manager
 TBool iFeatureManagerInitialized;
 // own, for active idle setting
 CRepository* iSettingsRepository;
 // Callback for processing start up foreground event.

branch	RCL_3
changeset 6	3cb097cb90f8
parent 5	108d9820af01
child 13	4f2584af5a29