blob: 836551ea5af9b243a4ed134d33128f6fad6f244a [file] [log] [blame]
// Copyright 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.
#ifndef UI_BASE_WINDOW_OPEN_DISPOSITION_H_
#define UI_BASE_WINDOW_OPEN_DISPOSITION_H_
#include "ui/base/ui_base_export.h"
// DEPRECATED: Instead of introducing new references to this enum, use
// the generated ui::mojom::WindowOpenDisposition in
// ui/base/mojo/window_open_disposition.mojom.h.
enum class WindowOpenDisposition {
UNKNOWN,
CURRENT_TAB,
// Indicates that only one tab with the url should exist in the same window.
SINGLETON_TAB,
NEW_FOREGROUND_TAB,
NEW_BACKGROUND_TAB,
NEW_POPUP,
NEW_WINDOW,
SAVE_TO_DISK,
OFF_THE_RECORD,
IGNORE_ACTION,
// Activates an existing tab containing the url, rather than navigating.
// This is similar to SINGLETON_TAB, but searches across all windows from
// the current profile and anonymity (instead of just the current one);
// closes the current tab on switching if the current tab was the NTP with
// no session history; and behaves like CURRENT_TAB instead of
// NEW_FOREGROUND_TAB when no existing tab is found.
SWITCH_TO_TAB,
// Update when adding a new disposition.
MAX_VALUE = SWITCH_TO_TAB
};
namespace ui {
// Translates event flags from a click on a link into the user's desired
// window disposition. For example, a middle click would mean to open
// a background tab.
UI_BASE_EXPORT WindowOpenDisposition DispositionFromClick(bool middle_button,
bool alt_key,
bool ctrl_key,
bool meta_key,
bool shift_key);
// Translates event flags into what kind of disposition they represents.
// For example, a middle click would mean to open a background tab.
// event_flags are the flags as understood by ui::MouseEvent.
UI_BASE_EXPORT WindowOpenDisposition DispositionFromEventFlags(int event_flags);
} // namespace ui
#endif // UI_BASE_WINDOW_OPEN_DISPOSITION_H_