1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
// Copyright (c) 2010 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 CHROME_BROWSER_UI_BROWSER_NAVIGATOR_H_
#define CHROME_BROWSER_UI_BROWSER_NAVIGATOR_H_
#pragma once
#include <string>
#include "chrome/common/page_transition_types.h"
#include "gfx/rect.h"
#include "googleurl/src/gurl.h"
#include "webkit/glue/window_open_disposition.h"
class Browser;
class Profile;
class TabContentsWrapper;
namespace browser {
// Parameters that tell Navigate() what to do.
//
// Some basic examples:
//
// Simple Navigate to URL in current tab:
// browser::NavigateParams params(browser, GURL("http://www.google.com/"),
// PageTransition::LINK);
// browser::Navigate(¶ms);
//
// Open bookmark in new background tab:
// browser::NavigateParams params(browser, url, PageTransition::AUTO_BOOKMARK);
// params.disposition = NEW_BACKGROUND_TAB;
// browser::Navigate(¶ms);
//
// Opens a popup TabContents:
// browser::NavigateParams params(browser, popup_contents);
// params.source_contents = source_contents;
// browser::Navigate(¶ms);
//
// See browser_navigator_browsertest.cc for more examples.
//
struct NavigateParams {
NavigateParams(Browser* browser,
const GURL& a_url,
PageTransition::Type a_transition);
NavigateParams(Browser* browser, TabContentsWrapper* a_target_contents);
~NavigateParams();
// The URL/referrer to be loaded. Ignored if |target_contents| is non-NULL.
GURL url;
GURL referrer;
// [in] A TabContents to be navigated or inserted into the target Browser's
// tabstrip. If NULL, |url| or the homepage will be used instead. When
// non-NULL, Navigate() assumes it has already been navigated to its
// intended destination and will not load any URL in it (i.e. |url| is
// ignored).
// Default is NULL.
// [out] The TabContents in which the navigation occurred or that was
// inserted. Guaranteed non-NULL except for note below:
// Note: If this field is set to NULL by the caller and Navigate() creates
// a new TabContents, this field will remain NULL and the TabContents
// deleted if the TabContents it created is not added to a TabStripModel
// before Navigate() returns.
TabContentsWrapper* target_contents;
// [in] The TabContents that initiated the Navigate() request if such context
// is necessary. Default is NULL, i.e. no context.
// [out] If NULL, this value will be set to the selected TabContents in the
// originating browser prior to the operation performed by Navigate().
// However, if the originating page is from a different profile (e.g. an
// OFF_THE_RECORD page originating from a non-OTR window), then
// |source_contents| is reset to NULL.
TabContentsWrapper* source_contents;
// The disposition requested by the navigation source. Default is
// CURRENT_TAB. What follows is a set of coercions that happen to this value
// when other factors are at play:
//
// [in]: Condition: [out]:
// NEW_BACKGROUND_TAB target browser tabstrip is empty NEW_FOREGROUND_TAB
// CURRENT_TAB " " " NEW_FOREGROUND_TAB
// OFF_THE_RECORD target browser profile is incog. NEW_FOREGROUND_TAB
//
// If disposition is NEW_BACKGROUND_TAB, TabStripModel::ADD_SELECTED is
// removed from |tabstrip_add_types| automatically.
// If disposition is one of NEW_WINDOW, NEW_POPUP, NEW_FOREGROUND_TAB or
// SINGLETON_TAB, then TabStripModel::ADD_SELECTED is automatically added to
// |tabstrip_add_types|.
WindowOpenDisposition disposition;
// The transition type of the navigation. Default is PageTransition::LINK
// when target_contents is specified in the constructor.
PageTransition::Type transition;
// The index the caller would like the tab to be positioned at in the
// TabStrip. The actual index will be determined by the TabHandler in
// accordance with |add_types|. Defaults to -1 (allows the TabHandler to
// decide).
int tabstrip_index;
// A bitmask of values defined in TabStripModel::AddTabTypes. Helps
// determine where to insert a new tab and whether or not it should be
// selected, among other properties. Default is ADD_SELECTED.
int tabstrip_add_types;
// If non-empty, the new tab is an app tab.
std::string extension_app_id;
// If non-empty, specifies the desired initial position and size of the
// window if |disposition| == NEW_POPUP.
// TODO(beng): Figure out if this can be used to create Browser windows
// for other callsites that use set_override_bounds, or
// remove this comment.
gfx::Rect window_bounds;
// True if the target window should be made visible at the end of the call
// to Navigate(). This activates the window if it was already visible.
// Default is false.
// If disposition is NEW_WINDOW or NEW_POPUP, |show_window| is set to true
// automatically.
bool show_window;
// True if the paths of the target content's URL and |url| should be ignored
// when locating a singleton tab.
bool ignore_path;
// [in] Specifies a Browser object where the navigation could occur or the
// tab could be added. Navigate() is not obliged to use this Browser if
// it is not compatible with the operation being performed. If NULL,
// |profile| should be specified to find or create a matching Browser.
// [out] Specifies the Browser object where the navigation occurred or the
// tab was added. Guaranteed non-NULL unless the disposition did not
// require a navigation, in which case this is set to NULL
// (SUPPRESS_OPEN, SAVE_TO_DISK, IGNORE_ACTION).
// Note: If |show_window| is set to false and a new Browser is created by
// Navigate(), the caller is responsible for showing it so that its
// window can assume responsibility for the Browser's lifetime (Browser
// objects are deleted when the user closes a visible browser window).
Browser* browser;
// If |browser| == NULL, specifies a Profile to use when finding or
// creating a Browser.
Profile* profile;
private:
NavigateParams();
};
// Navigates according to the configuration specified in |params|.
void Navigate(NavigateParams* params);
} // namespace browser
#endif // CHROME_BROWSER_UI_BROWSER_NAVIGATOR_H_
|
