blob: 813fd13860a863cd1e6e5bfec38d15f798418673 [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.
#include <memory>
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "ui/base/accelerators/accelerator.h"
#include "ui/views/focus/focus_manager.h"
#include "ui/views/view.h"
namespace views {
class FocusSearch;
class ViewTracker;
// 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 {
~AccessiblePaneView() override;
// 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.
bool SetPaneFocus(View* initial_focus);
bool pane_has_focus() const { return pane_has_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:
FocusTraversable* GetPaneFocusTraversable() override;
bool AcceleratorPressed(const ui::Accelerator& accelerator) override;
void SetVisible(bool flag) override;
void GetAccessibleNodeData(ui::AXNodeData* node_data) override;
void RequestFocus() override;
// Overridden from FocusChangeListener:
void OnWillChangeFocus(View* focused_before, View* focused_now) override;
void OnDidChangeFocus(View* focused_before, View* focused_now) override;
// Overridden from FocusTraversable:
FocusSearch* GetFocusSearch() override;
FocusTraversable* GetFocusTraversableParent() override;
View* GetFocusTraversableParentView() override;
// For testing only.
const ui::Accelerator& home_key() const { return home_key_; }
const ui::Accelerator& end_key() const { return end_key_; }
const ui::Accelerator& escape_key() const { return escape_key_; }
const ui::Accelerator& left_key() const { return left_key_; }
const ui::Accelerator& right_key() const { return right_key_; }
// A subclass can override this to provide a default focusable child
// other than the first focusable child.
virtual View* GetDefaultFocusableChild();
// Returns the parent of |v|. Subclasses can override this if
// they need custom focus search behavior.
View* GetParentForFocusSearch(View* v);
// Returns true if |v| is contained within the hierarchy rooted at |root|
// for the purpose of focus searching. Subclasses can override this if
// they need custom focus search behavior.
bool ContainsForFocusSearch(View* root, const View* v);
// Remove pane focus.
void RemovePaneFocus();
View* GetFirstFocusableChild();
View* GetLastFocusableChild();
FocusManager* focus_manager() const { return focus_manager_; }
// When finishing navigation by pressing ESC, it is allowed to surrender the
// focus to another window if if |allow| is set and no previous view can be
// found.
void set_allow_deactivate_on_esc(bool allow) {
allow_deactivate_on_esc_ = allow;
bool pane_has_focus_ = false;
// If true, the panel should be de-activated upon escape when no active view
// is known where to return to.
bool allow_deactivate_on_esc_ = false;
// Save the focus manager rather than calling GetFocusManager(),
// so that we can remove focus listeners in the destructor.
FocusManager* focus_manager_ = nullptr;
// 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.
std::unique_ptr<FocusSearch> focus_search_;
// Registered accelerators
ui::Accelerator home_key_{ui::VKEY_HOME, ui::EF_NONE};
ui::Accelerator end_key_{ui::VKEY_END, ui::EF_NONE};
ui::Accelerator escape_key_{ui::VKEY_ESCAPE, ui::EF_NONE};
ui::Accelerator left_key_{ui::VKEY_LEFT, ui::EF_NONE};
ui::Accelerator right_key_{ui::VKEY_RIGHT, ui::EF_NONE};
// Holds the last focused view that's not within this pane.
std::unique_ptr<ViewTracker> last_focused_view_tracker_;
friend class AccessiblePaneViewFocusSearch;
base::WeakPtrFactory<AccessiblePaneView> method_factory_{this};
} // namespace views