blob: a94c4af9c590f350f3500b8c5279e5ef50613cfd [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.
#pragma once
#include "base/hash_tables.h"
#include "base/memory/scoped_ptr.h"
#include "base/memory/weak_ptr.h"
#include "ui/base/models/accelerator.h"
#include "views/focus/focus_manager.h"
#include "views/view.h"
namespace views {
class FocusSearch;
// This class provides keyboard access to any view that extends it, typically
// a toolbar. The user sets focus to a control in this view by pressing
// F6 to traverse all panes, or by pressing a shortcut that jumps directly
// to this pane.
class VIEWS_EXPORT AccessiblePaneView : public View,
public FocusChangeListener,
public FocusTraversable {
virtual ~AccessiblePaneView();
// Set focus to the pane with complete keyboard access.
// Focus will be restored to the last focused view if the user escapes.
// If |initial_focus| is not NULL, that control will get
// the initial focus, if it's enabled and focusable. Returns true if
// the pane was able to receive focus.
virtual bool SetPaneFocus(View* initial_focus);
// Set focus to the pane with complete keyboard access, with the
// focus initially set to the default child. Focus will be restored
// to the last focused view if the user escapes.
// Returns true if the pane was able to receive focus.
virtual bool SetPaneFocusAndFocusDefault();
// Overridden from View:
virtual FocusTraversable* GetPaneFocusTraversable() OVERRIDE;
virtual bool AcceleratorPressed(const ui::Accelerator& accelerator)
virtual void SetVisible(bool flag) OVERRIDE;
virtual void GetAccessibleState(ui::AccessibleViewState* state) OVERRIDE;
// Overridden from FocusChangeListener:
virtual void OnWillChangeFocus(View* focused_before,
View* focused_now) OVERRIDE;
virtual void OnDidChangeFocus(View* focused_before,
View* focused_now) OVERRIDE;
// Overridden from FocusTraversable:
virtual FocusSearch* GetFocusSearch() OVERRIDE;
virtual FocusTraversable* GetFocusTraversableParent() OVERRIDE;
virtual View* GetFocusTraversableParentView() OVERRIDE;
// A subclass can override this to provide a default focusable child
// other than the first focusable child.
virtual View* GetDefaultFocusableChild();
// Remove pane focus.
virtual void RemovePaneFocus();
void RestoreLastFocusedView();
View* GetFirstFocusableChild();
View* GetLastFocusableChild();
bool pane_has_focus_;
base::WeakPtrFactory<AccessiblePaneView> method_factory_;
// Save the focus manager rather than calling GetFocusManager(),
// so that we can remove focus listeners in the destructor.
FocusManager* focus_manager_;
// Our custom focus search implementation that traps focus in this
// pane and traverses all views that are focusable for accessibility,
// not just those that are normally focusable.
scoped_ptr<FocusSearch> focus_search_;
// Registered accelerators
ui::Accelerator home_key_;
ui::Accelerator end_key_;
ui::Accelerator escape_key_;
ui::Accelerator left_key_;
ui::Accelerator right_key_;
} // namespace views