15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef UI_BASE_ACCELERATORS_ACCELERATOR_MANAGER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UI_BASE_ACCELERATORS_ACCELERATOR_MANAGER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <list> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <utility> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/base/accelerators/accelerator.h" 145d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "ui/base/ui_base_export.h" 15d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles)#include "ui/events/event_constants.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace ui { 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The AcceleratorManger is used to handle keyboard accelerators. 205d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)class UI_BASE_EXPORT AcceleratorManager { 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum HandlerPriority { 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) kNormalPriority, 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) kHighPriority, 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AcceleratorManager(); 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~AcceleratorManager(); 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Register a keyboard accelerator for the specified target. If multiple 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // targets are registered for an accelerator, a target registered later has 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // higher priority. 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |accelerator| is the accelerator to register. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |priority| denotes the priority of the handler. 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE: In almost all cases, you should specify kNormalPriority for this 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // parameter. Setting it to kHighPriority prevents Chrome from sending the 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // shortcut to the webpage if the renderer has focus, which is not desirable 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // except for very isolated cases. 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |target| is the AcceleratorTarget that handles the event once the 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // accelerator is pressed. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note that we are currently limited to accelerators that are either: 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // - a key combination including Ctrl or Alt 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // - the escape key 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // - the enter key 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // - any F key (F1, F2, F3 ...) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // - any browser specific keys (as available on special keyboards) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Register(const Accelerator& accelerator, 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HandlerPriority priority, 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AcceleratorTarget* target); 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Unregister the specified keyboard accelerator for the specified target. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Unregister(const Accelerator& accelerator, AcceleratorTarget* target); 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Unregister all keyboard accelerator for the specified target. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void UnregisterAll(AcceleratorTarget* target); 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Activate the target associated with the specified accelerator. 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // First, AcceleratorPressed handler of the most recently registered target 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is called, and if that handler processes the event (i.e. returns true), 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this method immediately returns. If not, we do the same thing on the next 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // target, and so on. 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if an accelerator was activated. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Process(const Accelerator& accelerator); 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the AcceleratorTarget that should be activated for the specified 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // keyboard accelerator, or NULL if no view is registered for that keyboard 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // accelerator. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AcceleratorTarget* GetCurrentTarget(const Accelerator& accelertor) const; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether the given |accelerator| has a priority handler associated with it. 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool HasPriorityHandler(const Accelerator& accelerator) const; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The accelerators and associated targets. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::list<AcceleratorTarget*> AcceleratorTargetList; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This construct pairs together a |bool| (denoting whether the list contains 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a priority_handler at the front) with the list of AcceleratorTargets. 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::pair<bool, AcceleratorTargetList> AcceleratorTargets; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::map<Accelerator, AcceleratorTargets> AcceleratorMap; 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AcceleratorMap accelerators_; 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(AcceleratorManager); 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace ui 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // UI_BASE_ACCELERATORS_ACCELERATOR_MANAGER_H_ 88