1// Copyright (c) 2012 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef CONTENT_PUBLIC_BROWSER_NAVIGATION_TYPE_H_
6#define CONTENT_PUBLIC_BROWSER_NAVIGATION_TYPE_H_
7
8namespace content {
9
10// Indicates different types of navigations that can occur that we will handle
11// separately.
12enum NavigationType {
13  // Unknown type.
14  NAVIGATION_TYPE_UNKNOWN,
15
16  // A new page was navigated in the main frame.
17  NAVIGATION_TYPE_NEW_PAGE,
18
19  // Renavigating to an existing navigation entry. The entry is guaranteed to
20  // exist in the list, or else it would be a new page or IGNORE navigation.
21  NAVIGATION_TYPE_EXISTING_PAGE,
22
23  // The same page has been reloaded as a result of the user requesting
24  // navigation to that same page (like pressing Enter in the URL bar). This
25  // is not the same as an in-page navigation because we'll actually have a
26  // pending entry for the load, which is then meaningless.
27  NAVIGATION_TYPE_SAME_PAGE,
28
29  // In page navigations are when the reference fragment changes. This will
30  // be in the main frame only (we won't even get notified of in-page
31  // subframe navigations). It may be for any page, not necessarily the last
32  // committed one (for example, whey going back to a page with a ref).
33  NAVIGATION_TYPE_IN_PAGE,
34
35  // A new subframe was manually navigated by the user. We will create a new
36  // NavigationEntry so they can go back to the previous subframe content
37  // using the back button.
38  NAVIGATION_TYPE_NEW_SUBFRAME,
39
40  // A subframe in the page was automatically loaded or navigated to such that
41  // a new navigation entry should not be created. There are two cases:
42  //  1. Stuff like iframes containing ads that the page loads automatically.
43  //     The user doesn't want to see these, so we just update the existing
44  //     navigation entry.
45  //  2. Going back/forward to previous subframe navigations. We don't create
46  //     a new entry here either, just update the last committed entry.
47  // These two cases are actually pretty different, they just happen to
48  // require almost the same code to handle.
49  NAVIGATION_TYPE_AUTO_SUBFRAME,
50
51  // Nothing happened. This happens when we get information about a page we
52  // don't know anything about. It can also happen when an iframe in a popup
53  // navigated to about:blank is navigated. Nothing needs to be done.
54  NAVIGATION_TYPE_NAV_IGNORE,
55};
56
57}  // namespace content
58
59#endif  // CONTENT_PUBLIC_BROWSER_NAVIGATION_TYPE_H_
60