contentstorage/extinc/cahandler.h
author hgs
Tue, 23 Mar 2010 23:42:03 +0200
changeset 87 9d806967057c
parent 85 7feec50967db
permissions -rw-r--r--
201007
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
85
7feec50967db 201003_02
hgs
parents:
diff changeset
     1
/*
7feec50967db 201003_02
hgs
parents:
diff changeset
     2
 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
7feec50967db 201003_02
hgs
parents:
diff changeset
     3
 * All rights reserved.
7feec50967db 201003_02
hgs
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
7feec50967db 201003_02
hgs
parents:
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
7feec50967db 201003_02
hgs
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
7feec50967db 201003_02
hgs
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
7feec50967db 201003_02
hgs
parents:
diff changeset
     8
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
     9
 * Initial Contributors:
7feec50967db 201003_02
hgs
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
7feec50967db 201003_02
hgs
parents:
diff changeset
    11
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    12
 * Contributors:
7feec50967db 201003_02
hgs
parents:
diff changeset
    13
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    14
 * Description:  ?Description
7feec50967db 201003_02
hgs
parents:
diff changeset
    15
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    16
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    17
7feec50967db 201003_02
hgs
parents:
diff changeset
    18
#ifndef C_CAHANDLER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    19
#define C_CAHANDLER_H
7feec50967db 201003_02
hgs
parents:
diff changeset
    20
7feec50967db 201003_02
hgs
parents:
diff changeset
    21
#include <e32base.h>
7feec50967db 201003_02
hgs
parents:
diff changeset
    22
7feec50967db 201003_02
hgs
parents:
diff changeset
    23
class CCaInnerEntry;
7feec50967db 201003_02
hgs
parents:
diff changeset
    24
7feec50967db 201003_02
hgs
parents:
diff changeset
    25
/**
7feec50967db 201003_02
hgs
parents:
diff changeset
    26
 *  ?one_line_short_description
7feec50967db 201003_02
hgs
parents:
diff changeset
    27
 *  ?more_complete_description
7feec50967db 201003_02
hgs
parents:
diff changeset
    28
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    29
 *  @code
7feec50967db 201003_02
hgs
parents:
diff changeset
    30
 *   ?good_class_usage_example(s)
7feec50967db 201003_02
hgs
parents:
diff changeset
    31
 *  @endcode
7feec50967db 201003_02
hgs
parents:
diff changeset
    32
 *
7feec50967db 201003_02
hgs
parents:
diff changeset
    33
 *  @lib ?library
7feec50967db 201003_02
hgs
parents:
diff changeset
    34
 *  @since S60 ?S60_version *** for example, S60 v3.0
7feec50967db 201003_02
hgs
parents:
diff changeset
    35
 */
7feec50967db 201003_02
hgs
parents:
diff changeset
    36
class CCaHandler: public CBase
7feec50967db 201003_02
hgs
parents:
diff changeset
    37
    {
7feec50967db 201003_02
hgs
parents:
diff changeset
    38
7feec50967db 201003_02
hgs
parents:
diff changeset
    39
public:
7feec50967db 201003_02
hgs
parents:
diff changeset
    40
7feec50967db 201003_02
hgs
parents:
diff changeset
    41
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    42
     * Destructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    43
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    44
    IMPORT_C virtual ~CCaHandler();
7feec50967db 201003_02
hgs
parents:
diff changeset
    45
7feec50967db 201003_02
hgs
parents:
diff changeset
    46
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    47
     * Query support for item type.
7feec50967db 201003_02
hgs
parents:
diff changeset
    48
     * @since S60 v5.0
7feec50967db 201003_02
hgs
parents:
diff changeset
    49
     * @param aType Type.
7feec50967db 201003_02
hgs
parents:
diff changeset
    50
     * @return ETrue if handler supports this type, EFalse otherwise.
7feec50967db 201003_02
hgs
parents:
diff changeset
    51
     * @capability None.
7feec50967db 201003_02
hgs
parents:
diff changeset
    52
     * @throws None.
7feec50967db 201003_02
hgs
parents:
diff changeset
    53
     * @panic None.
7feec50967db 201003_02
hgs
parents:
diff changeset
    54
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    55
    IMPORT_C virtual TBool SupportsType( const TDesC& aType );
7feec50967db 201003_02
hgs
parents:
diff changeset
    56
7feec50967db 201003_02
hgs
parents:
diff changeset
    57
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    58
     * Handle command.
7feec50967db 201003_02
hgs
parents:
diff changeset
    59
     * @since S60 v5.0
7feec50967db 201003_02
hgs
parents:
diff changeset
    60
     * @param aItem Item of supported type.
7feec50967db 201003_02
hgs
parents:
diff changeset
    61
     * @param aCommand Command.
7feec50967db 201003_02
hgs
parents:
diff changeset
    62
     * this status will be completed with the resulting error code.
7feec50967db 201003_02
hgs
parents:
diff changeset
    63
     * @capability None.
7feec50967db 201003_02
hgs
parents:
diff changeset
    64
     * @throws This implementation throws KErrNotSupported.
7feec50967db 201003_02
hgs
parents:
diff changeset
    65
     * @panic None.
7feec50967db 201003_02
hgs
parents:
diff changeset
    66
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    67
    IMPORT_C virtual void HandleCommandL( CCaInnerEntry& aEntry,
7feec50967db 201003_02
hgs
parents:
diff changeset
    68
            const TDesC8& aCommand );
7feec50967db 201003_02
hgs
parents:
diff changeset
    69
7feec50967db 201003_02
hgs
parents:
diff changeset
    70
protected:
7feec50967db 201003_02
hgs
parents:
diff changeset
    71
7feec50967db 201003_02
hgs
parents:
diff changeset
    72
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    73
     * Constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    74
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    75
    IMPORT_C CCaHandler();
7feec50967db 201003_02
hgs
parents:
diff changeset
    76
7feec50967db 201003_02
hgs
parents:
diff changeset
    77
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    78
     * Base constructor.
7feec50967db 201003_02
hgs
parents:
diff changeset
    79
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    80
    IMPORT_C void BaseConstructL();
7feec50967db 201003_02
hgs
parents:
diff changeset
    81
7feec50967db 201003_02
hgs
parents:
diff changeset
    82
private:
7feec50967db 201003_02
hgs
parents:
diff changeset
    83
    // data
7feec50967db 201003_02
hgs
parents:
diff changeset
    84
7feec50967db 201003_02
hgs
parents:
diff changeset
    85
    class TData;
7feec50967db 201003_02
hgs
parents:
diff changeset
    86
7feec50967db 201003_02
hgs
parents:
diff changeset
    87
    /**
7feec50967db 201003_02
hgs
parents:
diff changeset
    88
     * Private data.
7feec50967db 201003_02
hgs
parents:
diff changeset
    89
     */
7feec50967db 201003_02
hgs
parents:
diff changeset
    90
    TData* iData;
7feec50967db 201003_02
hgs
parents:
diff changeset
    91
7feec50967db 201003_02
hgs
parents:
diff changeset
    92
    };
7feec50967db 201003_02
hgs
parents:
diff changeset
    93
7feec50967db 201003_02
hgs
parents:
diff changeset
    94
#endif // C_CAHANDLER_H