uifw/EikStd/coctlinc/aknitemactionmenuregister.h
branchRCL_3
changeset 9 aabf2c525e0f
parent 0 2f259fa3e83a
child 10 9f56a4e1b8ab
equal deleted inserted replaced
4:8ca85d2f0db7 9:aabf2c525e0f
    23 class MAknCollection;
    23 class MAknCollection;
    24 class MAknCollectionObserver;
    24 class MAknCollectionObserver;
    25 class CAknItemActionMenuRegisterArray;
    25 class CAknItemActionMenuRegisterArray;
    26 class CAknItemActionMenu;
    26 class CAknItemActionMenu;
    27 class MObjectProvider;
    27 class MObjectProvider;
       
    28 class CAknView;
    28 
    29 
    29 /**
    30 /**
    30  * Item action menu register.
    31  * Item action menu register.
    31  *
    32  *
    32  * @lib eikcoctl
    33  * @lib eikcoctl
   237      * Returns the pointer to overriding object menu bar.
   238      * Returns the pointer to overriding object menu bar.
   238      * 
   239      * 
   239      * @return Overriding object menu bar.
   240      * @return Overriding object menu bar.
   240      */
   241      */
   241     CEikMenuBar* OverridingObjectMenuBar();
   242     CEikMenuBar* OverridingObjectMenuBar();
       
   243     
       
   244     /**
       
   245      * Returns pointer to component that owns the current view. This is either
       
   246      * application UI, active view or a dialog. This component is the one that
       
   247      * owns the possible menubar.
       
   248      * 
       
   249      * @return Current view owner.
       
   250      */
       
   251     MObjectProvider* Owner() const;
       
   252     
       
   253     /**
       
   254      * Returns pointer to currently active view.
       
   255      * 
       
   256      * @param aAppUi Application UI.
       
   257      * @return Active view or NULL.
       
   258      */
       
   259     CAknView* View( CAknAppUi* aAppUi ) const;
       
   260     
       
   261     /**
       
   262      * Returns pointer to current application UI.
       
   263      * 
       
   264      * @return Application UI or NULL.
       
   265      */
       
   266     static CAknAppUi* AppUI();
       
   267     
   242 
   268 
   243     /**
   269     /**
   244      * Registers collection to item action menu.
   270      * Registers collection to item action menu.
   245      * Creates and sets item action menu to menu bar
   271      * Creates and sets item action menu to menu bar
   246      * if one is not found. If menu bar is not found, item action menu
   272      * if one is not found. If menu bar is not found, item action menu
   270      */
   296      */
   271     void AddRegisterEntryL(
   297     void AddRegisterEntryL(
   272             CEikMenuBar& aMenuBar, CAknItemActionMenu& aItemActionMenu );
   298             CEikMenuBar& aMenuBar, CAknItemActionMenu& aItemActionMenu );
   273 
   299 
   274     /**
   300     /**
   275      * Adds observers with aMenuBar to item action menu.
   301      * Adds observers that have the same owner and aItemAction to the menu.
   276      * 
   302      * 
   277      * @param aMenuBar Menu bar.
       
   278      * @param aItemActionMenu Item action menu.
   303      * @param aItemActionMenu Item action menu.
   279      */
   304      */
   280     void AddObserversToItemActionMenuL(
   305     void AddObserversToItemActionMenuL( CAknItemActionMenu& aItemActionMenu );
   281             CEikMenuBar* aMenuBar, CAknItemActionMenu& aItemActionMenu );
       
   282 
   306 
   283     /**
   307     /**
   284      * Creates register instance. 
   308      * Creates register instance. 
   285      *
   309      *
   286      * @return Item action menu register instance.
   310      * @return Item action menu register instance.
   318         /**
   342         /**
   319          * C++ constructor.
   343          * C++ constructor.
   320          */
   344          */
   321         TAknUnregisteredObserverData(
   345         TAknUnregisteredObserverData(
   322                 CEikMenuBar* aMenuBar,
   346                 CEikMenuBar* aMenuBar,
   323                 MAknCollectionObserver& aObserver );
   347                 MAknCollectionObserver& aObserver,
       
   348                 MObjectProvider* aOwner );
   324 
   349 
   325     public:
   350     public:
   326         /**
   351         /**
   327          * Reference to menu bar.
   352          * Reference to menu bar.
   328          */
   353          */
   330 
   355 
   331         /**
   356         /**
   332          * Observer.
   357          * Observer.
   333          */
   358          */
   334         MAknCollectionObserver& iObserver;
   359         MAknCollectionObserver& iObserver;
       
   360         
       
   361         /**
       
   362          * Current menubar owner.
       
   363          */
       
   364         MObjectProvider* iOwner;
   335         };
   365         };
   336 
   366 
   337     /**
   367     /**
   338      * Menu bar owner that is currently being constructed.
   368      * Menu bar owner that is currently being constructed.
   339      * Not own.
   369      * Not own.