Home | History | Annotate | Download | only in menu
      1 // Copyright 2014 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_RUNNER_IMPL_INTERFACE_H_
      6 #define UI_VIEWS_CONTROLS_MENU_MENU_RUNNER_IMPL_INTERFACE_H_
      7 
      8 #include "ui/views/controls/menu/menu_runner.h"
      9 
     10 namespace views {
     11 
     12 class MenuItemView;
     13 
     14 namespace internal {
     15 
     16 // An abstract interface for menu runner implementations.
     17 // Invoke Release() to destroy. Release() deletes immediately if the menu isn't
     18 // showing. If the menu is showing Release() cancels the menu and when the
     19 // nested RunMenuAt() call returns deletes itself and the menu.
     20 class MenuRunnerImplInterface {
     21  public:
     22   // Creates a concrete instance for running |menu_model|.
     23   // |run_types| is a bitmask of MenuRunner::RunTypes.
     24   static MenuRunnerImplInterface* Create(ui::MenuModel* menu_model,
     25                                          int32 run_types);
     26 
     27   // Returns true if we're in a nested message loop running the menu.
     28   virtual bool IsRunning() const = 0;
     29 
     30   // See description above class for details.
     31   virtual void Release() = 0;
     32 
     33   // Runs the menu. See MenuRunner::RunMenuAt for more details.
     34   virtual MenuRunner::RunResult RunMenuAt(Widget* parent,
     35                                           MenuButton* button,
     36                                           const gfx::Rect& bounds,
     37                                           MenuAnchorPosition anchor,
     38                                           int32 run_types)
     39       WARN_UNUSED_RESULT = 0;
     40 
     41   // Hides and cancels the menu.
     42   virtual void Cancel() = 0;
     43 
     44   // Returns the time from the event which closed the menu - or 0.
     45   virtual base::TimeDelta GetClosingEventTime() const = 0;
     46 
     47  protected:
     48   // Call Release() to delete.
     49   virtual ~MenuRunnerImplInterface() {}
     50 };
     51 
     52 }  // namespace internal
     53 }  // namespace views
     54 
     55 #endif  // UI_VIEWS_CONTROLS_MENU_MENU_RUNNER_IMPL_INTERFACE_H_
     56