classicui_plat/intermediate_state_api/inc/aknintermediate.h
author hgs
Fri, 23 Jul 2010 17:08:56 +0800
changeset 45 667edd0b8678
permissions -rw-r--r--
201029
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
45
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef __AKNINTERMEDIATE__
hgs
parents:
diff changeset
    19
#define __AKNINTERMEDIATE__
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
/** Intermediate state
hgs
parents:
diff changeset
    22
 *
hgs
parents:
diff changeset
    23
 * To implement intermediate states:
hgs
parents:
diff changeset
    24
 * 1) add iAvkonEnv->RegisterIntermediateState(this) to dialog's ActivateL()
hgs
parents:
diff changeset
    25
 * 2) add iAvkonEnv->UnRegisterIntermediateState(this) to destructor
hgs
parents:
diff changeset
    26
 * 3) derive your control from MAknIntermediateState.
hgs
parents:
diff changeset
    27
 * 4) implement CloseState() method. It should call TryExitL() or something.
hgs
parents:
diff changeset
    28
 * (NOTE, the method is NOT L-method, so use T_RAPD(err, TryExitL(buttonid));
hgs
parents:
diff changeset
    29
 *
hgs
parents:
diff changeset
    30
 * This will cause your intermediate states to close automatically when
hgs
parents:
diff changeset
    31
 * you swap to another application.
hgs
parents:
diff changeset
    32
 */
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
class MAknIntermediateState
hgs
parents:
diff changeset
    35
    {
hgs
parents:
diff changeset
    36
public:
hgs
parents:
diff changeset
    37
    virtual void CloseState() = 0;
hgs
parents:
diff changeset
    38
    };
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
#endif