classicui_plat/editors_api/inc/aknedstsobs.h
author hgs
Tue, 17 Aug 2010 18:16:43 +0800
changeset 53 3c67ea82fafc
parent 45 667edd0b8678
permissions -rw-r--r--
201033
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
45
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2005 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:  Interface for handling control's state change.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#if !defined(__AKNEDSTSOBS_H__)
hgs
parents:
diff changeset
    21
#define __AKNEDSTSOBS_H__
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
// FORWARD DECLERATIONS
hgs
parents:
diff changeset
    24
class CAknEdwinState;
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
// CLASS DECLERATION
hgs
parents:
diff changeset
    28
/**
hgs
parents:
diff changeset
    29
* Interface for handling control's state change.
hgs
parents:
diff changeset
    30
* 
hgs
parents:
diff changeset
    31
* @since Series 60 0.9
hgs
parents:
diff changeset
    32
*/
hgs
parents:
diff changeset
    33
class MAknEdStateObserver
hgs
parents:
diff changeset
    34
	{
hgs
parents:
diff changeset
    35
public:
hgs
parents:
diff changeset
    36
	/** 
hgs
parents:
diff changeset
    37
    * Observer event types.
hgs
parents:
diff changeset
    38
    */
hgs
parents:
diff changeset
    39
	enum EAknEdwinStateEvent
hgs
parents:
diff changeset
    40
        {
hgs
parents:
diff changeset
    41
        /** The state has been updated */ 
hgs
parents:
diff changeset
    42
        EAknEdwinStateEventStateUpdate, 
hgs
parents:
diff changeset
    43
        /** The input mode has been updated */     
hgs
parents:
diff changeset
    44
        EAknEdwinStateInputModeUpdate,
hgs
parents:
diff changeset
    45
        /** The case mode has been updated */   
hgs
parents:
diff changeset
    46
        EAknEdwinStateCaseModeUpdate,
hgs
parents:
diff changeset
    47
        /** The local language has been updated */    
hgs
parents:
diff changeset
    48
        EAknEdwinStateLocalLanguageUpdate, 
hgs
parents:
diff changeset
    49
        /** The flags have been updated */  
hgs
parents:
diff changeset
    50
        EAknEdwinStateFlagsUpdate,
hgs
parents:
diff changeset
    51
        /** The edwin state needs to be sync'ed */
hgs
parents:
diff changeset
    52
        EAknSyncEdwinState,
hgs
parents:
diff changeset
    53
        /** Cursor position has changed in editor */
hgs
parents:
diff changeset
    54
        EAknCursorPositionChanged,
hgs
parents:
diff changeset
    55
        /** VKB/HW activation request */
hgs
parents:
diff changeset
    56
        EAknActivatePenInputRequest,
hgs
parents:
diff changeset
    57
        /** Prompt Text has changed */
hgs
parents:
diff changeset
    58
        EAknEdwinStatePromptUpdate,
hgs
parents:
diff changeset
    59
        /** editor is destroyed */
hgs
parents:
diff changeset
    60
        EAknEdwinDestroy,
hgs
parents:
diff changeset
    61
        /** VKB/HW close request */
hgs
parents:
diff changeset
    62
        EAknClosePenInputRequest
hgs
parents:
diff changeset
    63
        };
hgs
parents:
diff changeset
    64
public:
hgs
parents:
diff changeset
    65
	/**
hgs
parents:
diff changeset
    66
    * Handles an state event from a observed control.
hgs
parents:
diff changeset
    67
    * Pure virtual function that is called when a control, for which this
hgs
parents:
diff changeset
    68
    * control is the observer, calls @c ReportAknedstateEventL().
hgs
parents:
diff changeset
    69
    * It should be implemented by the observer control and should handle all
hgs
parents:
diff changeset
    70
    * state events sent by controls it observed. 
hgs
parents:
diff changeset
    71
    * @param aAknEdwinState The control that sent the event.
hgs
parents:
diff changeset
    72
    * @param aEventType The event type defined in @c EAknEdwinStateEvent.
hgs
parents:
diff changeset
    73
    */
hgs
parents:
diff changeset
    74
	virtual void HandleAknEdwinStateEventL(CAknEdwinState* aAknEdwinState,
hgs
parents:
diff changeset
    75
		EAknEdwinStateEvent aEventType) = 0;
hgs
parents:
diff changeset
    76
	};
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
#endif