blob: 3dc2f0e900ab7fb62b7f49e152501e034cc3d1ec [file] [log] [blame]
// Copyright (c) 2011 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.
// This class describe a keyboard accelerator (or keyboard shortcut).
// Keyboard accelerators are registered with the FocusManager.
// It has a copy constructor and assignment operator so that it can be copied.
// It also defines the < operator so that it can be used as a key in a std::map.
#pragma once
#include <string>
#include "base/string16.h"
#include "ui/base/models/accelerator.h"
#include "views/events/event.h"
#include "views/views_export.h"
namespace views {
class VIEWS_EXPORT Accelerator : public ui::Accelerator {
Accelerator() : ui::Accelerator() {}
Accelerator(ui::KeyboardCode keycode, int modifiers)
: ui::Accelerator(keycode, modifiers) {}
Accelerator(ui::KeyboardCode keycode,
bool shift_pressed, bool ctrl_pressed, bool alt_pressed) {
key_code_ = keycode;
modifiers_ = 0;
if (shift_pressed)
modifiers_ |= ui::EF_SHIFT_DOWN;
if (ctrl_pressed)
modifiers_ |= ui::EF_CONTROL_DOWN;
if (alt_pressed)
modifiers_ |= ui::EF_ALT_DOWN;
virtual ~Accelerator() {}
bool IsShiftDown() const {
return (modifiers_ & ui::EF_SHIFT_DOWN) == ui::EF_SHIFT_DOWN;
bool IsCtrlDown() const {
return (modifiers_ & ui::EF_CONTROL_DOWN) == ui::EF_CONTROL_DOWN;
bool IsAltDown() const {
return (modifiers_ & ui::EF_ALT_DOWN) == ui::EF_ALT_DOWN;
// Returns a string with the localized shortcut if any.
string16 GetShortcutText() const;
// An interface that classes that want to register for keyboard accelerators
// should implement.
class VIEWS_EXPORT AcceleratorTarget {
// This method should return true if the accelerator was processed.
virtual bool AcceleratorPressed(const Accelerator& accelerator) = 0;
virtual ~AcceleratorTarget() {}