mmuifw_plat/mul_widget_api/inc/mul/mulevent.h
branchRCL_3
changeset 26 0e9bb658ef58
equal deleted inserted replaced
25:4ea6f81c838a 26:0e9bb658ef58
       
     1 /*
       
     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Event class.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef T_MULEVENT_H
       
    20 #define T_MULEVENT_H
       
    21 
       
    22 namespace Alf
       
    23 {
       
    24     enum TMulEventType
       
    25         {
       
    26         ETypeHighlight= 200, 		        /*!< A message regarding an item getting highlighted.
       
    27                                          *  Data for the event will be the highlighted index(int).*/
       
    28         ETypeSelect,			        /*!< a message regarding an item getting selected.
       
    29                                          *  Data for the event will be the selected index(int).*/
       
    30         ETypeDoubleTap,			        /*!< a message regarding an item getting double tapped.
       
    31                                          *  Data for the event will be the selected index(int).*/
       
    32         ETypeMark,		                /*!< a message regarding start/stop of marking.
       
    33                                          *  Data for the event will be marking state(TMulMarkState).*/
       
    34         ETypeFastScroll,	            /*!< a message regarding start/stop of fast scrolling
       
    35                                          *  Data for the event will be fast scrolling state(TMulFastScrollState).*/
       
    36         ETypePrimaryValueChange,		/*!< a message regarding slider primary value getting changed
       
    37                                          *  Data for the event will be previous & current value 
       
    38                                          *  encapsulated within TMulSliderPos.*/
       
    39         ETypeSecondaryValueChange,	    /*!< a message regarding slider secondary value getting changed
       
    40                                          *  Data for the event will be previous & current value 
       
    41                                          *  encapsulated within TMulSliderPos.*/
       
    42         ETypeAction,                     /*!< a message regarding an action item being selected
       
    43                                          *  Data for the action event will be encapsulated within TMulActionItem.*/
       
    44                                          
       
    45         ETypeRemove,                     /*!< a message regarding an item has to be removed.
       
    46                                          * Data for the event will be the highlighted index(int).*/
       
    47                                          
       
    48         ECustomEventMarqueeFinished,     /*!< A message regarding marquee Finished.
       
    49                                          *  no custom data required.*/
       
    50         
       
    51         ECustomEventMarqueeStart,        /*!< A message regarding marquee started.
       
    52                                          *  no custom data required.*/ 
       
    53                                          
       
    54         ECustomEventIconClick,            /*!< A message regarding clicking on icon.
       
    55                                          *  no custom data required.*/ 
       
    56                                          
       
    57         EMulEventReorder,                 /*!< Data for the event will be previous and current index
       
    58                                          *  encapsulated within MulReorderValues .*/               
       
    59 
       
    60         EMulEventSwap,                    /*!< Data for the event will be previous and current index
       
    61                                          *  encapsulated within MulReorderValues .*/
       
    62 
       
    63         EMulEditorUpdated,                /*!< A message regarding plain text editor of an item is changed.
       
    64                                          *  Data for the event will be the item index(int).*/
       
    65                                                                                          
       
    66         ECustomHighlightClearTransition,  /*!< A message regarding transition after clear focus and before set focus finished.
       
    67                                            *  no custom data required.*/
       
    68         
       
    69         ECustomHighlightFocusTransition,   /*!< A message regarding transition after set focus finished.
       
    70                                             *no custom data required.*/
       
    71                                            
       
    72         ETypeItemMarked,                    /*!< a message regarding an item getting marked.
       
    73                                              * Data for the event will be the marked index(int).*/
       
    74                                                  
       
    75         ETypeItemUnmarked,                  	 /*!< a message regarding an item getting unmarked.
       
    76                                             	 * Data for the event will be the unmarked index(int).*/
       
    77                                          
       
    78         ECustomEventTitleMarqueeFinished,     	 /*!< A message regarding title marquee Finished.
       
    79                                          	  	 * no custom data required.*/
       
    80                                          
       
    81         ECustomEventDetailMarqueeStart,    		/*!< A message regarding detail marquee started.
       
    82                                             	 *  no custom data required.*/ 
       
    83                                             	 
       
    84         ECustomEventContinuousScroll, 			/*!< A message regarding Continuous Scrolling.
       
    85                                          		*  Data for the event is the View Start Position.*/
       
    86        
       
    87         ESliderDrag, 				  			/*!< A message regarding Slider starting the drag
       
    88                                          		*/
       
    89 			                                   
       
    90 		EVideoIconSelect,          				/*!< A message regarding there was tap on the video icon of the Coverflow widget full screen template.
       
    91 			                                   	*  no custom data required.*/  
       
    92 			                                   	
       
    93 		ECustomEventVisiblePageIndexChanged,	/*!< a message regarding change of visible page
       
    94                                                	* Data for the event will be the first index of the new visible page.*/ 
       
    95                                                	
       
    96 		ETypeSwitchUiStateOnDrag,                /*!< a message to switch off the ui when drag starts.
       
    97                                                	* no custom data required. This event is specific to coverflow widget*/
       
    98 		
       
    99 		ECustomEventIconRelease,                /*!< A message regarding release on icon.
       
   100                                                 * no custom data required. */   
       
   101 		
       
   102 		ETypePinch,                             /*!< A message regarding a multitouch pinch gesture identified in coverflow */  
       
   103 		
       
   104 		ETypeItemRemoved                        /*!< A message regarding a remove operation completed. Requested by photos for refreshing
       
   105                                                      the HDMI view when an item is deleted, No custom data  */ 
       
   106         };
       
   107                                                        
       
   108         
       
   109     /*! @enum TMulMarkState
       
   110      * Marking state of the widget.
       
   111      */
       
   112     enum TMulMarkState
       
   113         {
       
   114         EMarkStart,         /*!< A state which indicates that the marking has started.*/
       
   115         EMarkStop           /*!< A state which indicates that the marking has stopped.*/
       
   116         };
       
   117         
       
   118     /*! @enum TMulFastScrollState
       
   119      * Fast Scroll State of the widget.
       
   120      */
       
   121     enum TMulFastScrollState
       
   122         {
       
   123         EScrollStart,       /*!< A state which indicates that the fast scrolling has started.*/
       
   124         EScrollSmallIcon,   /*!< A state which indicates that the fast scrolling is using 
       
   125                              *   the smaller size of the thumbnails.*/
       
   126         EScrollLargeIcon,   /*!< A state which indicates that the fast scrolling is using 
       
   127                              *   the larger size of the thumbnails.*/
       
   128         EScrollStop         /*!< A state which indicates that the fast scrolling has stopped.*/
       
   129         };
       
   130         
       
   131     /*! @struct TMulSliderPos 
       
   132      * The structure holds the data change details of the slider. It stores both the previous
       
   133      * value and current value of the slider thumb.
       
   134      */
       
   135     struct MulSliderPos
       
   136         {
       
   137         /* @var Original value of the slider thumb.*/
       
   138         int mPreviousValue;     
       
   139         
       
   140         /* @var New value of the slider thumb.*/
       
   141         int mCurrentValue;      
       
   142         };
       
   143     
       
   144    struct MulReorderValues
       
   145         {
       
   146         /* @var old value of the item index.*/
       
   147         int mOldIndex;     
       
   148         
       
   149         /* @var New value of the item index */
       
   150         int mNewIndex;      
       
   151         };    
       
   152    
       
   153    struct MulDoubleTapData
       
   154        {
       
   155        TPoint mDoubleTapPoint;
       
   156        TInt mTapVisualIndex;
       
   157        MulDoubleTapData() {
       
   158        mDoubleTapPoint.SetXY(0,0);
       
   159        mTapVisualIndex = -1 ;
       
   160        }
       
   161        }; // end of structure
       
   162        
       
   163         
       
   164 }//namespacealf
       
   165 #endif // T_MULEVENT_H