epoc32/include/mw/aknedstsobs.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2005 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@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.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:  Interface for handling control's state change.
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
#if !defined(__AKNEDSTSOBS_H__)
williamr@2
    21
#define __AKNEDSTSOBS_H__
williamr@2
    22
williamr@2
    23
// FORWARD DECLERATIONS
williamr@2
    24
class CAknEdwinState;
williamr@2
    25
williamr@2
    26
williamr@2
    27
// CLASS DECLERATION
williamr@2
    28
/**
williamr@2
    29
* Interface for handling control's state change.
williamr@2
    30
* 
williamr@2
    31
* @since Series 60 0.9
williamr@2
    32
*/
williamr@2
    33
class MAknEdStateObserver
williamr@2
    34
	{
williamr@2
    35
public:
williamr@2
    36
	/** 
williamr@2
    37
    * Observer event types.
williamr@2
    38
    */
williamr@2
    39
	enum EAknEdwinStateEvent
williamr@2
    40
        {
williamr@2
    41
        /** The state has been updated */ 
williamr@2
    42
        EAknEdwinStateEventStateUpdate, 
williamr@2
    43
        /** The input mode has been updated */     
williamr@2
    44
        EAknEdwinStateInputModeUpdate,
williamr@2
    45
        /** The case mode has been updated */   
williamr@2
    46
        EAknEdwinStateCaseModeUpdate,
williamr@2
    47
        /** The local language has been updated */    
williamr@2
    48
        EAknEdwinStateLocalLanguageUpdate, 
williamr@2
    49
        /** The flags have been updated */  
williamr@2
    50
        EAknEdwinStateFlagsUpdate,
williamr@2
    51
        /** The edwin state needs to be sync'ed */
williamr@2
    52
        EAknSyncEdwinState,
williamr@2
    53
        /** Cursor position has changed in editor */
williamr@2
    54
        EAknCursorPositionChanged,
williamr@2
    55
        /** VKB/HW activation request */
williamr@2
    56
        EAknActivatePenInputRequest,
williamr@2
    57
        /** Prompt Text has changed */
williamr@4
    58
        EAknEdwinStatePromptUpdate,
williamr@4
    59
        /** editor is destroyed */
williamr@4
    60
        EAknEdwinDestroy,
williamr@4
    61
        /** VKB/HW close request */
williamr@4
    62
        EAknClosePenInputRequest
williamr@2
    63
        };
williamr@2
    64
public:
williamr@2
    65
	/**
williamr@2
    66
    * Handles an state event from a observed control.
williamr@2
    67
    * Pure virtual function that is called when a control, for which this
williamr@2
    68
    * control is the observer, calls @c ReportAknedstateEventL().
williamr@2
    69
    * It should be implemented by the observer control and should handle all
williamr@2
    70
    * state events sent by controls it observed. 
williamr@2
    71
    * @param aAknEdwinState The control that sent the event.
williamr@2
    72
    * @param aEventType The event type defined in @c EAknEdwinStateEvent.
williamr@2
    73
    */
williamr@2
    74
	virtual void HandleAknEdwinStateEventL(CAknEdwinState* aAknEdwinState,
williamr@2
    75
		EAknEdwinStateEvent aEventType) = 0;
williamr@2
    76
	};
williamr@2
    77
williamr@2
    78
#endif