epoc32/include/mw/aknintermediate.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
#ifndef __AKNINTERMEDIATE__
williamr@2
    19
#define __AKNINTERMEDIATE__
williamr@2
    20
williamr@2
    21
/** Intermediate state
williamr@2
    22
 *
williamr@2
    23
 * To implement intermediate states:
williamr@2
    24
 * 1) add iAvkonEnv->RegisterIntermediateState(this) to dialog's ActivateL()
williamr@2
    25
 * 2) add iAvkonEnv->UnRegisterIntermediateState(this) to destructor
williamr@2
    26
 * 3) derive your control from MAknIntermediateState.
williamr@2
    27
 * 4) implement CloseState() method. It should call TryExitL() or something.
williamr@2
    28
 * (NOTE, the method is NOT L-method, so use T_RAPD(err, TryExitL(buttonid));
williamr@2
    29
 *
williamr@2
    30
 * This will cause your intermediate states to close automatically when
williamr@2
    31
 * you swap to another application.
williamr@2
    32
 */
williamr@2
    33
williamr@2
    34
class MAknIntermediateState
williamr@2
    35
    {
williamr@2
    36
public:
williamr@2
    37
    virtual void CloseState() = 0;
williamr@2
    38
    };
williamr@2
    39
williamr@2
    40
#endif