camerauis/cameraapp/generic/inc/cameracontroller/mcamsettingprovider.h
branchRCL_3
changeset 24 bac7acad7cb3
parent 0 1ddebce53859
equal deleted inserted replaced
23:61bc0f252b2b 24:bac7acad7cb3
       
     1 /*
       
     2 * Copyright (c) 2007 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:  Camera setting provider interface.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CAM_MCAMSETTINGPROVIDER_H
       
    20 #define CAM_MCAMSETTINGPROVIDER_H
       
    21 
       
    22 #include "camcameracontrollersettings.h"
       
    23 
       
    24 /**
       
    25  *  MCamSettingProvider mixin.
       
    26  */
       
    27 class MCamSettingProvider
       
    28   {
       
    29   public:
       
    30     
       
    31     /**
       
    32     * Get given camera parameters.
       
    33     * The associated data is returned in the TAny pointer.
       
    34     * Actual data type depends on the parameter id and is documented in
       
    35     * TCamCameraParamId documentation.
       
    36     *
       
    37     * These parameters represent overall settings of camera, e.g.
       
    38     * image quality and format, viewfinder size etc. The setting version
       
    39     * (ProvideCameraSettingL) is used to get more exact settings like
       
    40     * flash mode, exposure compensation setting etc.
       
    41     *
       
    42     * @param aParamId   Id of the parameter which the user is interested in.
       
    43     * @param aParamData Pointer to the parameter data structure. The actual
       
    44     *                   data type depends on parameter id.
       
    45     * @see TCamCameraParamId
       
    46     */
       
    47     virtual void 
       
    48       ProvideCameraParamL( 
       
    49         const NCamCameraController::TCamCameraParamId& aParamId,
       
    50               TAny*                                    aParamData ) = 0;
       
    51 
       
    52     /**
       
    53     * Get given camera setting.
       
    54     * The associated data is returned in the TAny pointer.
       
    55     * Actual data type depends on the setting id and is documented in
       
    56     * TCamCameraSettingId documentation.
       
    57     * 
       
    58     * This method is used to get specific settings for camera, e.g.
       
    59     * exposure compensation, white balance etc. Some of these settings
       
    60     * still combine mode and value, so TAny pointer is used to be able
       
    61     * to return setting data of variable size and type.
       
    62     *
       
    63     * @see TCamCameraSettingId
       
    64     */
       
    65     virtual void 
       
    66       ProvideCameraSettingL( 
       
    67         const NCamCameraController::TCamCameraSettingId& aSettingId,
       
    68               TAny*                                      aSettingData ) = 0;
       
    69 
       
    70     /**
       
    71     * Provide the currently pending setting changes.
       
    72     *
       
    73     */
       
    74     virtual void 
       
    75       ProvidePendingSettingChangesL( 
       
    76         RArray<NCamCameraController::TCamCameraSettingId>& aSettingIds ) = 0;
       
    77         
       
    78     /**
       
    79     * Number of currently pending setting changes.
       
    80     */
       
    81     virtual TInt PendingSettingChangeCount() const = 0;
       
    82 
       
    83     /**
       
    84     * Set the supported ISO rates.
       
    85     */
       
    86     virtual void SetSupportedISORatesL( const RArray<TInt>& aSupportedIsoRates ) = 0;
       
    87     
       
    88     /**
       
    89     * Virtual destructor.
       
    90     * Need to be defined in order to be able to gracefully delete
       
    91     * inherited class entities through MCamSettingProvider pointer.
       
    92     * If not declared here, User-42 panic occurs on delete.
       
    93     */
       
    94     virtual ~MCamSettingProvider() {};
       
    95   };
       
    96 
       
    97 #endif // CAM_MCAMSETTINGPROVIDER_H
       
    98 
       
    99 // end of file