1 /*

     2 * Copyright (c) 2007 - 2008 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  UI states class definition.

    15 *

    16 */

    17 

    18 

    19 #ifndef T_VTUISTATES_H

    20 #define T_VTUISTATES_H

    21 

    22 #include <e32base.h>

    23 

    24 #include "tvtuimediastate.h"

    25 #include "tvtuiaudiostate.h"

    26 

    27 class CVtEngModel;

    28 class MVtEngCameraPreferences;

    29 

    30 /**

    31  *  TVtUiStates

    32  *

    33  *  Contains information about Application UI's current status.

    34  *

    35  *  @since S60 v3.2

    36  */

    37 NONSHARABLE_CLASS( TVtUiStates ) : public TVtFlagContainer

    38     {

    39 

    40 public: // enumerations

    41 

    42     /**

    43     * Application execution state (will be set by the app state classes)

    44     */

    45     enum TVtUiExecState

    46         {

    47         EExecStateStarting,

    48         EExecStateRunning,

    49         EExecStateResetting,

    50         EExecStateFinalized

    51         };

    52 

    53 public:

    54 

    55     /**

    56      * Constructor.

    57      */

    58     TVtUiStates( CVtEngModel& aModel );

    59 

    60     /**

    61      * Updates UI states.

    62      */

    63     void Update();

    64 

    65     /**

    66      * Return whether or not ColorToneSetting

    67      * is supported by current camera.

    68      *

    69      * @return ETrue if at least one color tone setting is available,

    70      * EFalse otherwise.

    71      */

    72     TBool IsColorToneSettingAvailable() const;

    73 

    74     /**

    75      * Return whether or not WhiteBalanceSetting

    76      * is supported by current camera.

    77      *

    78      * @return ETrue if at least one white balance setting is available,

    79      * EFalse otherwise.

    80      */

    81     TBool IsWhiteBalanceSettingAvailable() const;

    82 

    83     /**

    84      * Return whether or not ontrast setting

    85      * is supported by current camera.

    86      *

    87      * @return ETrue if at contrast setting is available,

    88      * EFalse otherwise.

    89      */

    90     TBool IsContrastSettingAvailable() const;

    91 

    92     /**

    93      * Return whether or not brightness setting

    94      * is supported by current camera.

    95      *

    96      * @return ETrue if brightness setting is available,

    97      * EFalse otherwise.

    98      */

    99     TBool IsBrightnessSettingAvailable() const;

   100 

   101     /**

   102      * Returns reference to media state object

   103      *

   104      * @return Reference to media state object.

   105      */

   106     inline const TVtUiMediaState& MediaState() const;

   107 

   108     /**

   109      * Returns reference to audio state object

   110      *

   111      * @return Reference to audio state object.

   112      */

   113     inline const TVtUiAudioState& AudioState() const;

   114 

   115     /**

   116      * Sets or clears EIsCLIReceived

   117      *

   118      * @param aSet ETrue if setting will be set, EFalse otherwise.

   119      */

   120     inline void SetCLIReceived( TBool aSet );

   121 

   122     /**

   123      * Check if EIsCLIReceived is set

   124      *

   125      * @return ETrue if EIsCLIReceived is set EFalse otherwise

   126      */

   127     inline TBool IsCLIReceived() const;

   128 

   129     /**

   130      * Sets or clears EIsLayoutChangeNeeded

   131      *

   132      * @param aSet ETrue if setting will be set, EFalse otherwise.

   133      */

   134     inline void SetLayoutChangeNeeded( TBool aSet );

   135 

   136     /**

   137      * Check if EIsLayoutChangeNeeded is set

   138      *

   139      * @return ETrue if EIsLayoutChangeNeeded is set EFalse otherwise

   140      */

   141     inline TBool IsLayoutChangeNeeded() const;

   142 

   143     /**

   144      * Sets or clears EIsBlankControlAdded

   145      *

   146      * @param aSet ETrue if setting will be set, EFalse otherwise.

   147      */

   148     inline void SetBlankControlAdded( TBool aSet );

   149 

   150     /**

   151      * Check if EIsBlankControlAdded is set

   152      *

   153      * @return ETrue if EIsBlankControlAdded is set EFalse otherwise

   154      */

   155     inline TBool IsBlankControlAdded() const;

   156 

   157     /**

   158      * Sets or clears EIsLaunchOkOptionsMenu

   159      *

   160      * @param aSet ETrue if setting will be set, EFalse otherwise.

   161      */

   162     inline void SetLaunchOkOptionsMenu( TBool aSet );

   163 

   164     /**

   165      * Check if EIsLaunchOkOptionsMenu is set

   166      *

   167      * @return ETrue if EIsLaunchOkOptionsMenu is set EFalse otherwise

   168      */

   169     inline TBool IsLaunchOkOptionsMenu() const;

   170 

   171     /**

   172      * Sets or clears EIsDeviceLockOn

   173      *

   174      * @param aSet ETrue if setting will be set, EFalse otherwise.

   175      */

   176     inline void SetDeviceLockOn( TBool aSet );

   177 

   178     /**

   179      * Check if EIsDeviceLockOn is set

   180      *

   181      * @return ETrue if EIsDeviceLockOn is set EFalse otherwise

   182      */

   183     inline TBool IsDeviceLockOn() const;

   184 

   185     /**

   186      * Sets or clears EDetailsReceived

   187      *

   188      * @param aSet ETrue if setting will be set, EFalse otherwise.

   189      */

   190     inline void SetDetailsReceived( TBool aSet );

   191 

   192     /**

   193      * Check if EDetailsReceived is set

   194      *

   195      * @return ETrue if EDetailsReceived is set EFalse otherwise

   196      */

   197     inline TBool IsDetailsReceived() const;

   198 

   199     /**

   200      * Sets or clears EWaitingForFirstFrame

   201      *

   202      * @param aSet ETrue if setting will be set, EFalse otherwise.

   203      */

   204     inline void SetWaitingForFirstFrame( TBool aSet );

   205 

   206     /**

   207      * Check if EWaitingForFirstFrame is set

   208      *

   209      * @return ETrue if EWaitingForFirstFrame is set EFalse otherwise

   210      */

   211     inline TBool IsWaitingForFirstFrame() const;

   212 

   213     /**

   214      * Sets or clears EUseSQCif

   215      *

   216      * @param aSet ETrue if setting will be set, EFalse otherwise.

   217      */

   218     inline void SetUseSQCif( TBool aSet );

   219 

   220     /**

   221      * Check if EUseSQCif is set

   222      *

   223      * @return ETrue if EUseSQCif is set EFalse otherwise

   224      */

   225     inline TBool IsUseSQCif() const;

   226 

   227     /**

   228      * Sets or clears EIsViewFindersInitialPlaceContextPane

   229      *

   230      * @param aSet ETrue if setting will be set, EFalse otherwise.

   231      */

   232     inline void SetViewFindersInitialPlaceContextPane( TBool aSet );

   233 

   234     /**

   235      * Check if EIsViewFindersInitialPlaceContextPane is set

   236      *

   237      * @return ETrue if EIsViewFindersInitialPlaceContextPane is set EFalse

   238      * otherwise

   239      */

   240     inline TBool IsViewFindersInitialPlaceContextPane() const;

   241 

   242     /**

   243      * Sets or clears EViewFinderToMainPane

   244      *

   245      * @param aSet ETrue if setting will be set, EFalse otherwise.

   246      */

   247     inline void SetViewFinderToMainPane( TBool aSet );

   248 

   249     /**

   250      * Check if EViewFinderToMainPane is set

   251      *

   252      * @return ETrue if EViewFinderToMainPane is set EFalse otherwise

   253      */

   254     inline TBool IsViewFinderToMainPane() const;

   255 

   256     /**

   257      * Sets or clears EIsCaptureModeOn

   258      *

   259      * @param aSet ETrue if setting will be set, EFalse otherwise.

   260      */

   261     inline void SetCaptureModeOn( TBool aSet );

   262 

   263     /**

   264      * Check if EIsCaptureModeOn is set

   265      *

   266      * @return ETrue if EIsCaptureModeOn is set EFalse otherwise

   267      */

   268     inline TBool IsCaptureModeOn() const;

   269 

   270     /**

   271      * Sets or clears EIsThisApplicationForeground

   272      *

   273      * @param aSet ETrue if setting will be set, EFalse otherwise.

   274      */

   275     inline void SetThisApplicationForeground( TBool aSet );

   276 

   277     /**

   278      * Check if EIsThisApplicationForeground is set

   279      *

   280      * @return ETrue if EIsThisApplicationForeground is set EFalse otherwise

   281      */

   282     inline TBool IsThisApplicationForeground() const;

   283 

   284     /**

   285      * Sets or clears EIsDisableBlindSetting

   286      *

   287      * @param aSet ETrue if setting will be set, EFalse otherwise.

   288      */

   289     inline void SetDisableBlindSetting( TBool aSet );

   290 

   291     /**

   292      * Check if EIsDisableBlindSetting is set

   293      *

   294      * @return ETrue if EIsDisableBlindSetting is set EFalse otherwise

   295      */

   296     inline TBool IsDisableBlindSetting() const;

   297 

   298     /**

   299      * Sets or clears EExecShowCameraInUse

   300      *

   301      * @param aSet ETrue if setting will be set, EFalse otherwise.

   302      */

   303     inline void SetExecShowCameraInUse( TBool aSet );

   304 

   305     /**

   306      * Check if EExecShowCameraInUse is set

   307      *

   308      * @return ETrue if EExecShowCameraInUse is set EFalse otherwise

   309      */

   310     inline TBool IsExecShowCameraInUse() const;

   311 

   312      /**

   313      * Check if EIsZoomModeOn is set

   314      *

   315      * @return ETrue if EIsZoomModeOn is set EFalse otherwise

   316      */

   317     inline TBool IsZoomModeOn() const;

   318 

   319     /**

   320      * Sets or clears EIsZoomModeOn

   321      *

   322      * @param aSet ETrue if setting will be set, EFalse otherwise.

   323      */

   324     inline void SetZoomModeOn( TBool aSet );

   325 

   326     /**

   327     * Check if EIsWhiteBalanceModeOn is set

   328     *

   329     * @return ETrue if EIsWhiteBalanceModeOn is set EFalse otherwise

   330     */

   331     inline TBool IsWhiteBalanceModeOn() const;

   332 

   333     /**

   334      * Sets or clears EIsWhiteBalanceModeOn

   335      *

   336      * @param aSet ETrue if setting will be set, EFalse otherwise.

   337      */

   338     inline void SetWhiteBalanceModeOn( TBool aSet );

   339 

   340     /**

   341     * Check if EIsColorToneModeOn is set

   342     *

   343     * @return ETrue if EIsColorToneModeOn is set EFalse otherwise

   344     */

   345     inline TBool IsColorToneModeOn() const;

   346 

   347     /**

   348      * Sets or clears EIsColorToneModeOn

   349      *

   350      * @param aSet ETrue if setting will be set, EFalse otherwise.

   351      */

   352     inline void SetColorToneModeOn( TBool aSet );

   353 

   354     /**

   355     * Check if EBrightnessModeOn is set

   356     *

   357     * @return ETrue if EBrightnessModeOn is set EFalse otherwise

   358     */

   359     inline TBool IsBrightnessModeOn() const;

   360 

   361     /**

   362      * Sets or clears EBrightnessModeOn

   363      *

   364      * @param aSet ETrue if setting will be set, EFalse otherwise.

   365      */

   366     inline void SetBrightnessModeOn( TBool aSet );

   367 

   368     /**

   369      *  Check if EContrastModeOn is set

   370      *

   371      *  @return ETrue if EContrastModeOn is set EFalse otherwise

   372      */

   373     inline TBool IsContrastModeOn() const;

   374 

   375     /**

   376      * Sets or clears EContrastModeOn

   377      *

   378      * @param aSet ETrue if setting will be set, EFalse otherwise.

   379      */

   380     inline void SetContrastModeOn( TBool aSet );

   381 

   382     /**

   383      * Sets or clears EIsNumberEntryOpen

   384      *

   385      * @param aSet ETrue if setting will be set, EFalse otherwise.

   386      */

   387     inline void SetIsNumberEntryOpen( TBool aSet );

   388 

   389     /**

   390      * Check if EIsNumberEntryOpen is set

   391      *

   392      * @return ETrue if EIsNumberEntryOpen is set EFalse otherwise

   393      */

   394     inline TBool IsNumberEntryOpen() const;

   395 

   396     /**

   397      * Sets or clears EIsToolbarAvailable

   398      *

   399      * @param aSet ETrue if setting will be set, EFalse otherwise.

   400      */

   401     inline void SetIsToolbarAvailable( TBool aSet );

   402 

   403     /**

   404      * Check if IsToolbarAvailable is set

   405      *

   406      * @return ETrue if IsToolbarAvailable is set EFalse otherwise

   407      */

   408     inline TBool IsToolbarAvailable() const;

   409 

   410     /**

   411      * Sets or clears EIsWaitingCall

   412      *

   413      * @param aSet ETrue if setting will be set, EFalse otherwise.

   414      */

   415     inline void SetWaitingCall( TBool aSet );

   416 

   417 	/**

   418      * Check if there is waiting video/voice call.

   419      *

   420      * @return ETrue if waiting call is ongoing, EFalse otherwise

   421      */

   422     inline TBool IsWaitingCall() const;

   423 

   424      /**

   425      * Sets or clears EIsSelectingShare

   426      *

   427      * @param aSet ETrue if setting will be set, EFalse otherwise.

   428      */

   429      inline void SetSelectingShare( TBool aSet );

   430 

   431 	/**

   432      * Check if user is selecting file to be shared.

   433      *

   434      * @return ETrue if user is selecting file, EFalse otherwise

   435      */

   436     inline TBool IsSelectingShare() const;

   437 

   438      /**

   439      * Sets or clears EIsDialerOpen

   440      *

   441      * @param aSet ETrue if setting will be set, EFalse otherwise.

   442      */

   443     inline void SetIsDialerOpen( TBool aSet );

   444 

   445 	/**

   446      * Check if video DTMF dialer is open.

   447      *

   448      * @return ETrue if dialer is open, EFalse otherwise

   449      */

   450     inline TBool IsDialerOpen() const;

   451 

   452     /**

   453      * Sets or clears EIsFixedToolbarVisible

   454      *

   455      * @param aSet ETrue if setting will be set, EFalse otherwise.

   456      */

   457     inline void SetIsFixedToolbarVisible( TBool aSet );

   458 

   459 	/**

   460      * Check if fixed toolbar is visible.

   461      *

   462      * @return ETrue iftoolbar is visible, EFalse otherwise

   463      */

   464     inline TBool IsFixedToolbarVisible() const;

   465 

   466     /**

   467      * Sets or clears EIsDialerActivating

   468      *

   469      * @param aSet ETrue if setting will be set, EFalse otherwise.

   470      */

   471     inline void SetIsDialerActivating( TBool aSet );

   472 

   473 	/**

   474      * Check if dialer is being activated

   475      *

   476      * @return ETrue if dialer is being activated, EFalse otherwise

   477      */

   478     inline TBool IsDialerActivating() const;

   479 

   480     /**

   481      * Adjusts command activating reference count

   482      *

   483      * @param aSet ETrue if setting will be increased, EFalse if

   484      * decreased.

   485      */

   486     void SetIsCommandActivating( TBool aSet );

   487 

   488 	/**

   489      * Check if command activating ref.count is greater than zero

   490      *

   491      * @return ETrue if any command is being activated, EFalse otherwise

   492      */

   493     inline TBool IsCommandActivating() const;

   494 

   495     /**

   496      *  Check if EIsVolumeModeOn is set

   497      *

   498      *  @return ETrue if EIsVolumeModeOn is set EFalse otherwise

   499      */

   500     inline TBool IsVolumeModeOn() const;

   501 

   502     /**

   503      * Sets or clears EIsVolumeModeOn

   504      *

   505      * @param aSet ETrue if setting will be set, EFalse otherwise.

   506      */

   507     inline void SetVolumeModeOn( TBool aSet );

   508 

   509     /**

   510      *  Check if EIsVideoQualityModeOn is set

   511      *

   512      *  @return ETrue if EIsVideoQualityModeOn is set EFalse otherwise

   513      */

   514     inline TBool IsVideoQualityModeOn() const;

   515 

   516     /**

   517      * Sets or clears EIsVideoQualityModeOn

   518      *

   519      * @param aSet ETrue if setting will be set, EFalse otherwise.

   520      */

   521      

   522     inline void SetVideoQualityModeOn( TBool aSet );    

   523     /**

   524      * Sets or clears EIsFloatingToolbarVisible

   525      *

   526      * @param aSet ETrue if setting will be set, EFalse otherwise.

   527      */

   528     inline void SetIsFloatingToolbarVisible( TBool aSet );

   529 

   530     /**

   531      * Check if floating toolbar is visible.

   532      *

   533      * @return ETrue iftoolbar is visible, EFalse otherwise

   534      */

   535     inline TBool IsFloatingToolbarVisible() const;

   536 

   537     /**

   538     * Returns application's execution state.

   539     * @return Application's current execution state.

   540     */

   541     TVtUiExecState ExecState() const;

   542 

   543 private: // methods to be accessed only by certain classes (see friends)

   544 

   545     /**

   546     * Sets application's execution state.

   547     * @param aState Application's new execution state.

   548     */

   549     void SetExecState( const TVtUiExecState aState );

   550 

   551 private:

   552 

   553     // Enumeration for ui state flags.

   554     enum TFlags

   555         {

   556         /** Set if CLI is received */

   557         EIsCLIReceived = ( 1<<0 ),

   558 

   559         /** Set if layout change is needed */

   560         EIsLayoutChangeNeeded = ( 1<<1 ),

   561 

   562         /** Set if blank control has been added to control stack */

   563         EIsBlankControlAdded = ( 1<<2 ),

   564 

   565         /** Set if launch ok in options menu */

   566         EIsLaunchOkOptionsMenu = ( 1<<3 ),

   567 

   568         /** Set if device lock is on */

   569         EIsDeviceLockOn = ( 1<<4 ),

   570 

   571         /** Set if details have been received */

   572         EDetailsReceived = ( 1<<5 ),

   573 

   574         /** Set if waiting for first frame */

   575         EWaitingForFirstFrame = ( 1<<6 ),

   576 

   577         /** Set if SQCIF is being used */

   578         EUseSQCif = ( 1 << 7 ),

   579 

   580         /** Set if images was in context pane before freeze, unset if not */

   581         EViewFindersInitialPlaceContextPane = ( 1<<8 ),

   582 

   583         /** Set if viewfinder has to be moved to mainpane, when imageshare is

   584             ready */

   585         EViewFinderToMainPane = ( 1<<9 ),

   586 

   587         /** Set if capture mode is on, unset if off */

   588         EIsCaptureModeOn = ( 1<<10 ),

   589 

   590         /** Set if application on foreground */

   591         EIsThisApplicationForeground = ( 1<<11 ),

   592 

   593         /** Set if blind setting should be temporarily disabled.

   594             This is used in preventing blind bitmap from flashing

   595             while operations involving multiple engine commands/events

   596             take place (e.g. 'Swap image places' and layout switch). */

   597         EIsDisableBlindSetting = ( 1<<12 ),

   598 

   599         /** Set if camera in use note should be shown. */

   600         EExecShowCameraInUse = ( 1<<13 ),

   601 

   602         /** Set if zooming slider indicators is shown in navi pane.

   603             Toolbar also dims other toolbar controls except zoom

   604             mode control.*/

   605         EIsZoomModeOn = ( 1<<14 ),

   606 

   607         /** Set if contrast mode is on, unset if off */

   608         EIsContrastModeOn = ( 1<<15 ),

   609 

   610         /** Set if brightness mode is on, unset if off */

   611         EIsBrightnessModeOn = ( 1<<16 ),

   612 

   613         /** Set if number entry is open in UI (do not use this flag in new code)

   614          */

   615         EIsNumberEntryOpen = ( 1<<17 ),

   616 

   617         /** Set if toolbar is available in UI */

   618         EIsToolbarAvailable = ( 1<<18 ),

   619 

   620 		/** Set if waiting call exists */

   621         EIsWaitingCall = ( 1<<19 ),

   622 

   623         /** Set if initializing share */

   624         EIsSelectingShare = ( 1<<20 ),

   625 

   626         /** Set if initializing share */

   627         EIsDialerOpen = ( 1<<21 ),

   628 

   629         /** Set if white balance mode is on, unset if off */

   630         EIsWhiteBalanceModeOn = ( 1<<22 ),

   631 

   632         /** Set if color tone mode is on, unset if off */

   633         EIsColorToneModeOn = ( 1 << 23 ),

   634 

   635         /** Set if fixed toolar is visible, unset if not */

   636         EIsFixedToolbarVisible = ( 1 << 24 ),

   637 

   638         /** Set if dialer is being activated, unset if not */

   639         EIsDialerActivating = ( 1 << 25 ),

   640 

   641         /** Set if volume mode is on, unset if off */

   642         EIsVolumeModeOn = ( 1 << 26 ),

   643 

   644         /** Set if floating toolar is visible, unset if not */

   645         EIsFloatingToolbarVisible = ( 1 << 27 ),

   646         

   647         /** Set if video quality mode is on, unset if not */

   648         EIsVideoQualityModeOn = ( 1 << 28 )

   649         };

   650 

   651     // Engine media state

   652     TVtUiMediaState iMediaState;

   653 

   654     // Engine audio state

   655     TVtUiAudioState iAudioState;

   656 

   657     // Refrence to engine

   658     CVtEngModel& iModel;

   659 

   660     // Refrence to camera prefrences

   661     MVtEngCameraPreferences* iCameraPref;

   662 

   663     // Application execution state

   664     TVtUiExecState iExecState;

   665     

   666     // Reference count of command activating. Enables command to be set

   667     // active several times and action to take only when count is reset

   668     // back to zer0.

   669     TUint iCommandActivatingRefCount;

   670 

   671 private: // friends

   672 

   673     friend class TVtUiAppStateBase;

   674 

   675     };

   676 

   677 #include "tvtuistates.inl"

   678 

   679 #endif // T_VTUISTATES_H