classicui_pub/stylus_popup_menu_api/inc/aknstyluspopupmenu.h
branchRCL_3
changeset 18 fcdfafb36fe7
parent 12 941195f2d488
equal deleted inserted replaced
17:a1caeb42b3a3 18:fcdfafb36fe7
     1 /*
     1 /*
     2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 * Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
    52         EPositionTypeRightTop = 0,
    52         EPositionTypeRightTop = 0,
    53         EPositionTypeLeftTop,
    53         EPositionTypeLeftTop,
    54         EPositionTypeRightBottom,
    54         EPositionTypeRightBottom,
    55         EPositionTypeLeftBottom      
    55         EPositionTypeLeftBottom      
    56         };
    56         };
       
    57 
       
    58     enum TStylusPopupMode
       
    59         {
       
    60         EConsumeKeyEvents = 0x01 // Consumes key events
       
    61         };
       
    62 
    57     /**
    63     /**
    58      * Two-phased constructor
    64      * Two-phased constructor
    59      *
    65      *
    60      * @param aObserver Menu observer (not owned) that handles 
    66      * @param aObserver Menu observer (not owned) that handles 
    61      *                  stylus popup events.
    67      *                  stylus popup events.
    69     
    75     
    70     /**
    76     /**
    71      * Two-phased constructor
    77      * Two-phased constructor
    72      *
    78      *
    73      * @param aObserver Menu observer (not owned) that handles 
    79      * @param aObserver Menu observer (not owned) that handles 
       
    80      *                  stylus popup events.
       
    81      * @param aPoint The position where stylus was tapped
       
    82      * @param aPopup Preview popup from which stylus popup
       
    83      *               menu was launched, can be NULL.
       
    84      * @param aFlags Optional parameters
       
    85      */
       
    86 
       
    87     static CAknStylusPopUpMenu* NewL( MEikMenuObserver* aObserver,
       
    88             const TPoint& aPoint,
       
    89             CAknPreviewPopUpController* aPopup,
       
    90             const TInt aFlags );
       
    91 
       
    92     /**
       
    93      * Two-phased constructor
       
    94      *
       
    95      * @param aObserver Menu observer (not owned) that handles
    74      *                  stylus popup events.
    96      *                  stylus popup events.
    75      * @param aPoint The position where stylus was tapped
    97      * @param aPoint The position where stylus was tapped
    76      */
    98      */
    77     IMPORT_C static CAknStylusPopUpMenu* NewL( MEikMenuObserver* aObserver, 
    99     IMPORT_C static CAknStylusPopUpMenu* NewL( MEikMenuObserver* aObserver, 
    78                                          const TPoint& aPoint );
   100                                          const TPoint& aPoint );
   154      * 
   176      * 
   155      * @internal
   177      * @internal
   156      * @since s60 v5.2
   178      * @since s60 v5.2
   157      */
   179      */
   158     void Clear();
   180     void Clear();
       
   181     
       
   182     /**
       
   183      * Hides the stylus popup menu.
       
   184      *
       
   185      * @internal
       
   186      * @since S60 v5.2
       
   187      */
       
   188     void HideMenu();
   159 
   189 
   160 // from base class CCoeControl
   190 // from base class CCoeControl
   161 
   191 
   162     /**
   192     /**
   163      * Constructs the menu from resource.
   193      * Constructs the menu from resource.
   186      * @param aObserver Menu observer (not owned) that handles 
   216      * @param aObserver Menu observer (not owned) that handles 
   187      *                  stylus popup events.
   217      *                  stylus popup events.
   188      * @param aPoint The position where stylus was tapped
   218      * @param aPoint The position where stylus was tapped
   189      * @param aPopup Preview popup from which stylus popup
   219      * @param aPopup Preview popup from which stylus popup
   190      *               menu was launched, can be NULL.
   220      *               menu was launched, can be NULL.
       
   221      * @param aFlags Optional parameters
   191      */
   222      */
   192     CAknStylusPopUpMenu( MEikMenuObserver* aObserver, const TPoint& aPoint,
   223     CAknStylusPopUpMenu( MEikMenuObserver* aObserver, const TPoint& aPoint,
   193                          CAknPreviewPopUpController* aPopup );
   224                          CAknPreviewPopUpController* aPopup,
       
   225                          const TInt aFlags = 0 );
   194 
   226 
   195     /**
   227     /**
   196      * 2nd phase constructor
   228      * 2nd phase constructor
   197      */
   229      */
   198     void ConstructL();
   230     void ConstructL();
   272     
   304     
   273     /**
   305     /**
   274      * Used to track if object has been deleted while calling client callback.
   306      * Used to track if object has been deleted while calling client callback.
   275      */
   307      */
   276     TBool* iIsDeleted;
   308     TBool* iIsDeleted;
       
   309 
       
   310     /**
       
   311      * Mode flags.
       
   312      */
       
   313     TInt iModeFlags;
   277     };
   314     };
   278 
   315 
   279 
   316 
   280 #endif // CAKNSTYLUSPOPUPMENU_H
   317 #endif // CAKNSTYLUSPOPUPMENU_H