PageRenderTime 243ms CodeModel.GetById 141ms app.highlight 1ms RepoModel.GetById 99ms app.codeStats 1ms

/gecko_sdk/idl/nsIHistoryEntry.idl

http://firefox-mac-pdf.googlecode.com/
IDL | 93 lines | 15 code | 12 blank | 66 comment | 0 complexity | eedf2c6f74c48543449106ac436be834 MD5 | raw file
 1/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 2/* ***** BEGIN LICENSE BLOCK *****
 3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 4 *
 5 * The contents of this file are subject to the Mozilla Public License Version
 6 * 1.1 (the "License"); you may not use this file except in compliance with
 7 * the License. You may obtain a copy of the License at
 8 * http://www.mozilla.org/MPL/
 9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *   Radha Kulkarni <radha@netscape.com>
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either of the GNU General Public License Version 2 or later (the "GPL"),
27 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38
39/**
40 * An interface to individual entries in session history. Each 
41 * document or frame will have a nsIHistoryEntry associated with 
42 * it. nsIHistoryEntry provides access to information like URI, 
43 * title and frame traversal status for that document.
44 * This interface is accessible from javascript.
45 * 
46 * @status FROZEN
47 */
48#include "nsISupports.idl"
49
50interface nsIURI;
51
52[scriptable, uuid(A41661D4-1417-11D5-9882-00C04FA02F40)]
53interface nsIHistoryEntry : nsISupports 
54{
55
56    /** 
57     * A readonly property that returns the URI
58     * of the current entry. The object returned is
59     * of type nsIURI
60     */
61    readonly attribute nsIURI URI;
62
63    /** 
64     * A readonly property that returns the title
65     * of the current entry.  The object returned
66     * is a encoded string
67     */
68    readonly attribute wstring title;
69
70    /** 
71     * A readonly property that returns a boolean
72     * flag which indicates if the entry was created as a 
73     * result of a subframe navigation. This flag will be
74     * 'false' when a frameset page is visited for
75     * the first time. This flag will be 'true' for all
76     * history entries created as a result of a subframe
77     * navigation.
78     */
79    readonly attribute boolean isSubFrame;
80
81};
82
83
84%{ C++
85// {A41661D5-1417-11D5-9882-00C04FA02F40}
86#define NS_HISTORYENTRY_CID \
87{0xa41661d5, 0x1417, 0x11d5, {0x98, 0x82, 0x0, 0xc0, 0x4f, 0xa0, 0x2f, 0x40}}
88
89#define NS_HISTORYENTRY_CONTRACTID \
90    "@mozilla.org/browser/history-entry;1"
91
92%}
93