1 /*

     2 * Copyright (c) 2004-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:  Interface to skin command iterator.

    15 *

    16 */

    17 

    18 

    19 #ifndef AKNSRLCOMMAND_H

    20 #define AKNSRLCOMMAND_H

    21 

    22 //  INCLUDES

    23 #include <AknsRlEffect.h>

    24 

    25 // CONSTANTS

    26 

    27 // DATA TYPES

    28 

    29 /**

    30 * Command data structure.

    31 *

    32 * @since 2.8

    33 */

    34 struct TAknsRlCommandData

    35     {

    36     /**

    37     * UID of the effect that this command executes.

    38     *

    39     * @since 2.8

    40     */

    41     TUid iEffectUid;

    42 

    43     /**

    44     * Layer configuration for this command.

    45     *

    46     * @since 2.8

    47     */

    48     TAknsRlRenderOpParam iLayerConf;

    49 

    50     /**

    51     * Pointer to the parameter iterator.

    52     * No ownership is vested in this structure.

    53     * If null-value is given, no parameters are used.

    54     *

    55     * @since 2.8

    56     */

    57     MAknsRlParameterIterator* iParamIterator;

    58     };

    59 

    60 // FORWARD DECLARATIONS

    61 

    62 // CLASS DECLARATION

    63 

    64 /**

    65 * Interface to skin command iterator.

    66 *

    67 * @since 2.8

    68 */

    69 class MAknsRlCommandIterator

    70     {

    71     public: // Constructors and destructor

    72 

    73         /**

    74         * Destructor for internal use.

    75         *

    76         * Destructor is reserved for internal use. Client code usually does

    77         * not destroy iterators.

    78         *

    79         * @since 2.8

    80         *

    81         * @internal

    82         */

    83         inline virtual ~MAknsRlCommandIterator() {}

    84 

    85     public: // New functions

    86 

    87         /**

    88         * Checks whether there are more commands available.

    89         *

    90         * @return @c ETrue if subsequent @c GetNextL should succeed,

    91         *   @c EFalse if @c GetNextL must not be called anymore.

    92         *

    93         * @since 2.8

    94         */

    95         virtual TBool HasNext() =0;

    96 

    97         /**

    98         * Gets the next command.

    99         *

   100         * @return Pointer to the command data. The ownership is not

   101         *   transferred. The data is guaranteed to be valid until

   102         *   the next call to @c HasNext, @c NextL, or the iterator is

   103         *   destroyed.

   104         *

   105         * @since 2.8

   106         */

   107         virtual const TAknsRlCommandData* NextL() =0;

   108 

   109     public: // Cleanup operation

   110 

   111         /**

   112         * Cleanup operation for internal use.

   113         *

   114         * @since 2.8

   115         *

   116         * @internal

   117         */

   118         IMPORT_C static void CleanupOperation( TAny* aItem );

   119     };

   120 

   121 #endif // AKNSRLCOMMAND_H

   122 

   123 // End of File