ui/views/controls/menu/menu_model_adapter.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_VIEWS_CONTROLS_MENU_MENU_MODEL_ADAPTER_H_
   6 #define UI_VIEWS_CONTROLS_MENU_MENU_MODEL_ADAPTER_H_
   7
   8 #include <map>
   9
  10 #include "ui/views/controls/menu/menu_delegate.h"
  11
  12 namespace ui {
  13 class MenuModel;
  14 }
  15
  16 namespace views {
  17 class MenuItemView;
  18
  19 // This class wraps an instance of ui::MenuModel with the
  20 // views::MenuDelegate interface required by views::MenuItemView.
  21 class VIEWS_EXPORT MenuModelAdapter : public MenuDelegate {
  22  public:
  23   // The caller retains ownership of the ui::MenuModel instance and
  24   // must ensure it exists for the lifetime of the adapter.
  25   explicit MenuModelAdapter(ui::MenuModel* menu_model);
  26   virtual ~MenuModelAdapter();
  27
  28   // Populate a MenuItemView menu with the ui::MenuModel items
  29   // (including submenus).
  30   virtual void BuildMenu(MenuItemView* menu);
  31
  32   // Convenience for creating and populating a menu. The caller owns the
  33   // returned MenuItemView.
  34   MenuItemView* CreateMenu();
  35
  36   void set_triggerable_event_flags(int triggerable_event_flags) {
  37     triggerable_event_flags_ = triggerable_event_flags;
  38   }
  39   int triggerable_event_flags() const { return triggerable_event_flags_; }
  40
  41   // Creates a menu item for the specified entry in the model and adds it as
  42   // a child to |menu| at the specified |menu_index|.
  43   static MenuItemView* AddMenuItemFromModelAt(ui::MenuModel* model,
  44                                               int model_index,
  45                                               MenuItemView* menu,
  46                                               int menu_index,
  47                                               int item_id);
  48
  49   // Creates a menu item for the specified entry in the model and appends it as
  50   // a child to |menu|.
  51   static MenuItemView* AppendMenuItemFromModel(ui::MenuModel* model,
  52                                                int model_index,
  53                                                MenuItemView* menu,
  54                                                int item_id);
  55
  56  protected:
  57   // Create and add a menu item to |menu| for the item at index |index| in
  58   // |model|. Subclasses override this to allow custom items to be added to the
  59   // menu.
  60   virtual MenuItemView* AppendMenuItem(MenuItemView* menu,
  61                                        ui::MenuModel* model,
  62                                        int index);
  63
  64   // views::MenuDelegate implementation.
  65   virtual void ExecuteCommand(int id) OVERRIDE;
  66   virtual void ExecuteCommand(int id, int mouse_event_flags) OVERRIDE;
  67   virtual bool IsTriggerableEvent(MenuItemView* source,
  68                                   const ui::Event& e) OVERRIDE;
  69   virtual bool GetAccelerator(int id,
  70                               ui::Accelerator* accelerator) const OVERRIDE;
  71   virtual base::string16 GetLabel(int id) const OVERRIDE;
  72   virtual const gfx::FontList* GetLabelFontList(int id) const OVERRIDE;
  73   virtual bool IsCommandEnabled(int id) const OVERRIDE;
  74   virtual bool IsItemChecked(int id) const OVERRIDE;
  75   virtual void SelectionChanged(MenuItemView* menu) OVERRIDE;
  76   virtual void WillShowMenu(MenuItemView* menu) OVERRIDE;
  77   virtual void WillHideMenu(MenuItemView* menu) OVERRIDE;
  78
  79  private:
  80   // Implementation of BuildMenu().
  81   void BuildMenuImpl(MenuItemView* menu, ui::MenuModel* model);
  82
  83   // Container of ui::MenuModel pointers as encountered by preorder
  84   // traversal.  The first element is always the top-level model
  85   // passed to the constructor.
  86   ui::MenuModel* menu_model_;
  87
  88   // Mouse event flags which can trigger menu actions.
  89   int triggerable_event_flags_;
  90
  91   // Map MenuItems to MenuModels.  Used to implement WillShowMenu().
  92   std::map<MenuItemView*, ui::MenuModel*> menu_map_;
  93
  94   DISALLOW_COPY_AND_ASSIGN(MenuModelAdapter);
  95 };
  96
  97 }  // namespace views
  98
  99 #endif  // UI_VIEWS_CONTROLS_MENU_MENU_MODEL_ADAPTER_H_