fepstub/UiPlugins/AknFepUiInterface/inc/AknFepUiWordPopupContent.h
author hgs
Wed, 23 Jun 2010 04:57:58 +0800
changeset 24 fc42a86c98e3
permissions -rw-r--r--
201025
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2007 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
*       Interface through which the FEP can use pop up bubble components
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
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
#ifndef __AKN_FEP_UI_INTERFACE_WORD_POPUP_CONTENT_H
hgs
parents:
diff changeset
    31
#define __AKN_FEP_UI_INTERFACE_WORD_POPUP_CONTENT_H
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
#include <e32base.h>
hgs
parents:
diff changeset
    34
#include <eikcmobs.h>
hgs
parents:
diff changeset
    35
#include <avkon.hrh>
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
hgs
parents:
diff changeset
    39
class MAknFepUiWordPopupContent 
hgs
parents:
diff changeset
    40
	{
hgs
parents:
diff changeset
    41
public:
hgs
parents:
diff changeset
    42
    // Enum copied from CAknFepExactWordPopupContent
hgs
parents:
diff changeset
    43
    enum TArrowDirection
hgs
parents:
diff changeset
    44
            {
hgs
parents:
diff changeset
    45
            EUpwards,       //!< The arrow included in the popup points upwards
hgs
parents:
diff changeset
    46
            EDownwards      //!< The arrow included in the popup points downwards
hgs
parents:
diff changeset
    47
			};
hgs
parents:
diff changeset
    48
public: 
hgs
parents:
diff changeset
    49
	virtual ~MAknFepUiWordPopupContent() = 0;
hgs
parents:
diff changeset
    50
public:
hgs
parents:
diff changeset
    51
		/**
hgs
parents:
diff changeset
    52
        * Sets the text to be shown in the popup
hgs
parents:
diff changeset
    53
        */
hgs
parents:
diff changeset
    54
        virtual void SetTextL( const TDesC& aText ) = 0;
hgs
parents:
diff changeset
    55
        
hgs
parents:
diff changeset
    56
        /**
hgs
parents:
diff changeset
    57
        * Sets the direction of the arrow included in the popup. This should be used as a hint
hgs
parents:
diff changeset
    58
        * about the direction to tap to select the word shown in the popup.
hgs
parents:
diff changeset
    59
        */
hgs
parents:
diff changeset
    60
        virtual void SetArrowDirection( TArrowDirection aDirection ) = 0;
hgs
parents:
diff changeset
    61
		/**
hgs
parents:
diff changeset
    62
        * Sets the delay used before showing the preview popup. The default 
hgs
parents:
diff changeset
    63
        * delay is one second.
hgs
parents:
diff changeset
    64
        * @param aDelay Delay in microseconds.
hgs
parents:
diff changeset
    65
        */
hgs
parents:
diff changeset
    66
		virtual void SetPopUpShowDelay( const TTimeIntervalMicroSeconds32& aDelay ) = 0;
hgs
parents:
diff changeset
    67
       
hgs
parents:
diff changeset
    68
        /**
hgs
parents:
diff changeset
    69
        * Sets the preview popup visible after specified delay. If the popup
hgs
parents:
diff changeset
    70
        * is already visible it is hidden immediately and shown again after the
hgs
parents:
diff changeset
    71
        * showing delay. Popup is automatically hidden after its hiding delay
hgs
parents:
diff changeset
    72
        * unless the delay is zero in which case the popup is shown infinitely.
hgs
parents:
diff changeset
    73
        */
hgs
parents:
diff changeset
    74
        virtual void ShowPopUp() = 0;
hgs
parents:
diff changeset
    75
        
hgs
parents:
diff changeset
    76
        /**
hgs
parents:
diff changeset
    77
        * Hides the popup immediately.
hgs
parents:
diff changeset
    78
        */
hgs
parents:
diff changeset
    79
        virtual void HidePopUp() = 0;
hgs
parents:
diff changeset
    80
        
hgs
parents:
diff changeset
    81
        /**
hgs
parents:
diff changeset
    82
        * Sets the position of preview popup. Popup's size is determined by the
hgs
parents:
diff changeset
    83
        * size of its content. The popup is placed left and down from the given 
hgs
parents:
diff changeset
    84
        * point. If fixed mode is used then this function has no effect.
hgs
parents:
diff changeset
    85
        * @param aPoint Popup's position.
hgs
parents:
diff changeset
    86
        */
hgs
parents:
diff changeset
    87
        virtual void SetPosition( const TPoint& aPoint ) = 0;
hgs
parents:
diff changeset
    88
hgs
parents:
diff changeset
    89
        /**
hgs
parents:
diff changeset
    90
        * Updates popup's size to reflect a change in content's size.
hgs
parents:
diff changeset
    91
        * Should be called if the size of the content is changed dynamically.
hgs
parents:
diff changeset
    92
        */
hgs
parents:
diff changeset
    93
        virtual void UpdateContentSize() = 0;
hgs
parents:
diff changeset
    94
        
hgs
parents:
diff changeset
    95
        /**
hgs
parents:
diff changeset
    96
        * Returns the popup's size.
hgs
parents:
diff changeset
    97
        */
hgs
parents:
diff changeset
    98
        virtual TSize Size() const = 0;   
hgs
parents:
diff changeset
    99
        
hgs
parents:
diff changeset
   100
        /**
hgs
parents:
diff changeset
   101
        * Returns true if the popup is visible.
hgs
parents:
diff changeset
   102
        */
hgs
parents:
diff changeset
   103
        virtual TBool IsPopUpVisible() = 0;   
hgs
parents:
diff changeset
   104
    };
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
#endif