1 /*

     2 * Copyright (c) 2006 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:  VT UI Component API definition.

    15 *

    16 */

    17 

    18 

    19 #ifndef M_VTUICOMPONENT_H

    20 #define M_VTUICOMPONENT_H

    21 

    22 #include <e32base.h>

    23 

    24 class CCoeControl;

    25 

    26 /**

    27  *  MVtUiComponent

    28  *

    29  *  UI component API definition.

    30  *

    31  *  @since S60 v3.2

    32  */

    33 class MVtUiComponent

    34     {

    35 

    36 public: // enumerations

    37 

    38     /**

    39      * Component Ids.

    40      */

    41     enum TComponentId

    42         {

    43         /** NULL component Id */

    44         EComponentIdNull =                  0,

    45         /** Toobar component Id */

    46         EComponentIdToolbar =               ( 1 << 0 ),

    47         /** Number entry component Id */

    48         EComponentIdNumberEntry =           ( 1 << 1 ),

    49         /** Video quality component id */

    50         EComponentIdVideoQuality  =         ( 1 << 2 ),

    51         /** White balance feature id */

    52         EComponentIdWhiteBalance =          ( 1 << 3 ),

    53         /** Color tone component id */

    54         EComponentIdColorTone =             ( 1 << 4 ),

    55         /** Brightness component id */

    56         EVComponentIdBrightness =           ( 1 << 5 ),

    57         /** Contrast component id */

    58         EVComponentIdContrast =             ( 1 << 6 ),

    59         /** Dialer component id  */

    60         EComponentIdDialer =                ( 1 << 7 ),

    61         /** Volume component id  */

    62         EComponentIdVolume =                ( 1 << 8 ),

    63         /** Zoom component id  */

    64         EComponentIdZoom =                  ( 1 << 9 )

    65         };

    66 

    67 public: // public methods

    68 

    69     /**

    70      * Returns component id.

    71      *

    72      * @return Component's id.

    73      */

    74     virtual TComponentId ComponentId() const = 0;

    75 

    76     /**

    77      * Returns this component as a CCoeControl.

    78      *

    79      * @return Component as a pointer to CCoeControl or NULL if this component

    80      * is not inherited from CCoeControl.

    81      */

    82     virtual CCoeControl* ComponentAsControl() = 0;

    83 

    84     /**

    85      * Activates component.

    86      */

    87     virtual void DoActivateL() = 0;

    88 

    89     /**

    90      * Deactivates component.

    91      */

    92     virtual void DoDeactivateL() = 0;

    93 

    94     };

    95 

    96 #endif // M_VTUICOMPONENT_H