Support global keyboard commands on Chrome OS.

ash/accelerators/accelerator_controller.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef ASH_ACCELERATORS_ACCELERATOR_CONTROLLER_H_
 #define ASH_ACCELERATORS_ACCELERATOR_CONTROLLER_H_
 
 #include <map>
 #include <set>
 
@@ skipping 20 matching lines @@
 class VolumeControlDelegate;
 
 // AcceleratorController provides functions for registering or unregistering
 // global keyboard accelerators, which are handled earlier than any windows. It
 // also implements several handlers as an accelerator target.
 class ASH_EXPORT AcceleratorController : public ui::AcceleratorTarget {
  public:
   AcceleratorController();
   virtual ~AcceleratorController();
 
+  // A list of possible ways in which an accelerator should be restricted before
+  // processing. Any target registered with this controller should respect
+  // restrictions by calling |GetCurrentAcceleratorRestriction| during
+  // processing.
+  enum AcceleratorProcessingRestriction {
+    // Process the accelerator normally.
+    RESTRICTION_NONE,
+
+    // Don't process the accelerator.
+    RESTRICTION_PREVENT_PROCESSING,
+
+    // Don't process the accelerator and prevent propagation to other targets.
+    RESTRICTION_PREVENT_PROCESSING_AND_PROPAGATION
+  };
+
   // Registers a global keyboard accelerator for the specified target. If
   // multiple targets are registered for an accelerator, a target registered
   // later has higher priority.
   void Register(const ui::Accelerator& accelerator,
                 ui::AcceleratorTarget* target);
 
   // Unregisters the specified keyboard accelerator for the specified target.
   void Unregister(const ui::Accelerator& accelerator,
                   ui::AcceleratorTarget* target);
 
@@ skipping 13 matching lines @@
 
   // Returns true if the |accelerator| is one of the |reserved_actions_|.
   bool IsReservedAccelerator(const ui::Accelerator& accelerator) const;
 
   // Performs the specified action. The |accelerator| may provide additional
   // data the action needs. Returns whether an action was performed
   // successfully.
   bool PerformAction(int action,
                      const ui::Accelerator& accelerator);
 
+  // Returns the restriction for the current context.
+  AcceleratorProcessingRestriction GetCurrentAcceleratorRestriction();
+
   // Overridden from ui::AcceleratorTarget:
   virtual bool AcceleratorPressed(const ui::Accelerator& accelerator) OVERRIDE;
   virtual bool CanHandleAccelerators() const OVERRIDE;
 
   void SetBrightnessControlDelegate(
       scoped_ptr<BrightnessControlDelegate> brightness_control_delegate);
   void SetImeControlDelegate(
       scoped_ptr<ImeControlDelegate> ime_control_delegate);
   void SetScreenshotDelegate(
       scoped_ptr<ScreenshotDelegate> screenshot_delegate);
@@ skipping 18 matching lines @@
   FRIEND_TEST_ALL_PREFIXES(AcceleratorControllerTest,
                            DontRepeatToggleFullscreen);
 
   // Initializes the accelerators this class handles as a target.
   void Init();
 
   // Registers the specified accelerators.
   void RegisterAccelerators(const AcceleratorData accelerators[],
                             size_t accelerators_length);
 
+  // Get the accelerator restriction for the given action. Supply an |action|
+  // of -1 to get restrictions that apply for the current context.
+  AcceleratorProcessingRestriction GetAcceleratorProcessingRestriction(
+      int action);
+
   void SetKeyboardBrightnessControlDelegate(
       scoped_ptr<KeyboardBrightnessControlDelegate>
       keyboard_brightness_control_delegate);
 
   scoped_ptr<ui::AcceleratorManager> accelerator_manager_;
 
   // TODO(derat): BrightnessControlDelegate is also used by the system tray;
   // move it outside of this class.
   scoped_ptr<BrightnessControlDelegate> brightness_control_delegate_;
   scoped_ptr<ImeControlDelegate> ime_control_delegate_;
@@ skipping 27 matching lines @@
   std::set<int> actions_allowed_in_app_mode_;
   // Actions disallowed if there are no windows.
   std::set<int> actions_needing_window_;
 
   DISALLOW_COPY_AND_ASSIGN(AcceleratorController);
 };
 
 }  // namespace ash
 
 #endif  // ASH_ACCELERATORS_ACCELERATOR_CONTROLLER_H_