PageRenderTime 283ms CodeModel.GetById 161ms app.highlight 3ms RepoModel.GetById 118ms app.codeStats 0ms

/gecko_api/include/nsIHistoryEntry.h

http://firefox-mac-pdf.googlecode.com/
C++ Header | 141 lines | 69 code | 31 blank | 41 comment | 0 complexity | ec67bb2cb4a57c7c162bb64ad97868b9 MD5 | raw file
  1/*
  2 * DO NOT EDIT.  THIS FILE IS GENERATED FROM /builds/tinderbox/XR-Trunk/Darwin_8.8.4_Depend/mozilla/docshell/shistory/public/nsIHistoryEntry.idl
  3 */
  4
  5#ifndef __gen_nsIHistoryEntry_h__
  6#define __gen_nsIHistoryEntry_h__
  7
  8
  9#ifndef __gen_nsISupports_h__
 10#include "nsISupports.h"
 11#endif
 12
 13/* For IDL files that don't want to include root IDL files. */
 14#ifndef NS_NO_VTABLE
 15#define NS_NO_VTABLE
 16#endif
 17class nsIURI; /* forward declaration */
 18
 19
 20/* starting interface:    nsIHistoryEntry */
 21#define NS_IHISTORYENTRY_IID_STR "a41661d4-1417-11d5-9882-00c04fa02f40"
 22
 23#define NS_IHISTORYENTRY_IID \
 24  {0xa41661d4, 0x1417, 0x11d5, \
 25    { 0x98, 0x82, 0x00, 0xc0, 0x4f, 0xa0, 0x2f, 0x40 }}
 26
 27class NS_NO_VTABLE NS_SCRIPTABLE nsIHistoryEntry : public nsISupports {
 28 public: 
 29
 30  NS_DECLARE_STATIC_IID_ACCESSOR(NS_IHISTORYENTRY_IID)
 31
 32  /** 
 33     * A readonly property that returns the URI
 34     * of the current entry. The object returned is
 35     * of type nsIURI
 36     */
 37  /* readonly attribute nsIURI URI; */
 38  NS_SCRIPTABLE NS_IMETHOD GetURI(nsIURI * *aURI) = 0;
 39
 40  /** 
 41     * A readonly property that returns the title
 42     * of the current entry.  The object returned
 43     * is a encoded string
 44     */
 45  /* readonly attribute wstring title; */
 46  NS_SCRIPTABLE NS_IMETHOD GetTitle(PRUnichar * *aTitle) = 0;
 47
 48  /** 
 49     * A readonly property that returns a boolean
 50     * flag which indicates if the entry was created as a 
 51     * result of a subframe navigation. This flag will be
 52     * 'false' when a frameset page is visited for
 53     * the first time. This flag will be 'true' for all
 54     * history entries created as a result of a subframe
 55     * navigation.
 56     */
 57  /* readonly attribute boolean isSubFrame; */
 58  NS_SCRIPTABLE NS_IMETHOD GetIsSubFrame(PRBool *aIsSubFrame) = 0;
 59
 60};
 61
 62  NS_DEFINE_STATIC_IID_ACCESSOR(nsIHistoryEntry, NS_IHISTORYENTRY_IID)
 63
 64/* Use this macro when declaring classes that implement this interface. */
 65#define NS_DECL_NSIHISTORYENTRY \
 66  NS_SCRIPTABLE NS_IMETHOD GetURI(nsIURI * *aURI); \
 67  NS_SCRIPTABLE NS_IMETHOD GetTitle(PRUnichar * *aTitle); \
 68  NS_SCRIPTABLE NS_IMETHOD GetIsSubFrame(PRBool *aIsSubFrame); 
 69
 70/* Use this macro to declare functions that forward the behavior of this interface to another object. */
 71#define NS_FORWARD_NSIHISTORYENTRY(_to) \
 72  NS_SCRIPTABLE NS_IMETHOD GetURI(nsIURI * *aURI) { return _to GetURI(aURI); } \
 73  NS_SCRIPTABLE NS_IMETHOD GetTitle(PRUnichar * *aTitle) { return _to GetTitle(aTitle); } \
 74  NS_SCRIPTABLE NS_IMETHOD GetIsSubFrame(PRBool *aIsSubFrame) { return _to GetIsSubFrame(aIsSubFrame); } 
 75
 76/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
 77#define NS_FORWARD_SAFE_NSIHISTORYENTRY(_to) \
 78  NS_SCRIPTABLE NS_IMETHOD GetURI(nsIURI * *aURI) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetURI(aURI); } \
 79  NS_SCRIPTABLE NS_IMETHOD GetTitle(PRUnichar * *aTitle) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetTitle(aTitle); } \
 80  NS_SCRIPTABLE NS_IMETHOD GetIsSubFrame(PRBool *aIsSubFrame) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetIsSubFrame(aIsSubFrame); } 
 81
 82#if 0
 83/* Use the code below as a template for the implementation class for this interface. */
 84
 85/* Header file */
 86class nsHistoryEntry : public nsIHistoryEntry
 87{
 88public:
 89  NS_DECL_ISUPPORTS
 90  NS_DECL_NSIHISTORYENTRY
 91
 92  nsHistoryEntry();
 93
 94private:
 95  ~nsHistoryEntry();
 96
 97protected:
 98  /* additional members */
 99};
100
101/* Implementation file */
102NS_IMPL_ISUPPORTS1(nsHistoryEntry, nsIHistoryEntry)
103
104nsHistoryEntry::nsHistoryEntry()
105{
106  /* member initializers and constructor code */
107}
108
109nsHistoryEntry::~nsHistoryEntry()
110{
111  /* destructor code */
112}
113
114/* readonly attribute nsIURI URI; */
115NS_IMETHODIMP nsHistoryEntry::GetURI(nsIURI * *aURI)
116{
117    return NS_ERROR_NOT_IMPLEMENTED;
118}
119
120/* readonly attribute wstring title; */
121NS_IMETHODIMP nsHistoryEntry::GetTitle(PRUnichar * *aTitle)
122{
123    return NS_ERROR_NOT_IMPLEMENTED;
124}
125
126/* readonly attribute boolean isSubFrame; */
127NS_IMETHODIMP nsHistoryEntry::GetIsSubFrame(PRBool *aIsSubFrame)
128{
129    return NS_ERROR_NOT_IMPLEMENTED;
130}
131
132/* End of implementation class template. */
133#endif
134
135// {A41661D5-1417-11D5-9882-00C04FA02F40}
136#define NS_HISTORYENTRY_CID \
137{0xa41661d5, 0x1417, 0x11d5, {0x98, 0x82, 0x0, 0xc0, 0x4f, 0xa0, 0x2f, 0x40}}
138#define NS_HISTORYENTRY_CONTRACTID \
139    "@mozilla.org/browser/history-entry;1"
140
141#endif /* __gen_nsIHistoryEntry_h__ */