Line data Source code
1 : /*
2 : * DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/nsISHistoryInternal.idl
3 : */
4 :
5 : #ifndef __gen_nsISHistoryInternal_h__
6 : #define __gen_nsISHistoryInternal_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
17 : class nsIBFCacheEntry; /* forward declaration */
18 :
19 : class nsISHContainer; /* forward declaration */
20 :
21 : class nsISHEntry; /* forward declaration */
22 :
23 : class nsISHistoryListener; /* forward declaration */
24 :
25 : class nsISHTransaction; /* forward declaration */
26 :
27 : class nsIDocShell; /* forward declaration */
28 :
29 : class nsIURI; /* forward declaration */
30 :
31 : #define NS_SHISTORY_INTERNAL_CID \
32 : { 0x3dfb2f54, 0x378d, 0x4d3c, \
33 : { 0xa9, 0xf9, 0x95, 0xdd, 0x26, 0x73, 0x24, 0x8c } }
34 : #define NS_SHISTORY_INTERNAL_CONTRACTID "@mozilla.org/browser/shistory-internal;1"
35 : #include "nsTArrayForwardDeclare.h"
36 :
37 : /* starting interface: nsISHistoryInternal */
38 : #define NS_ISHISTORYINTERNAL_IID_STR "3dfb2f54-378d-4d3c-a9f9-95dd2673248c"
39 :
40 : #define NS_ISHISTORYINTERNAL_IID \
41 : {0x3dfb2f54, 0x378d, 0x4d3c, \
42 : { 0xa9, 0xf9, 0x95, 0xdd, 0x26, 0x73, 0x24, 0x8c }}
43 :
44 2 : class NS_NO_VTABLE nsISHistoryInternal : public nsISupports {
45 : public:
46 :
47 : NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISHISTORYINTERNAL_IID)
48 :
49 : /* void addEntry (in nsISHEntry aEntry, in boolean aPersist); */
50 : NS_IMETHOD AddEntry(nsISHEntry *aEntry, bool aPersist) = 0;
51 :
52 : /* readonly attribute nsISHTransaction rootTransaction; */
53 : NS_IMETHOD GetRootTransaction(nsISHTransaction * *aRootTransaction) = 0;
54 :
55 : /* void setRootDocShell (in nsIDocShell rootDocShell); */
56 : NS_IMETHOD SetRootDocShell(nsIDocShell *rootDocShell) = 0;
57 :
58 : /* void updateIndex (); */
59 : NS_IMETHOD UpdateIndex(void) = 0;
60 :
61 : /* void replaceEntry (in long aIndex, in nsISHEntry aReplaceEntry); */
62 : NS_IMETHOD ReplaceEntry(int32_t aIndex, nsISHEntry *aReplaceEntry) = 0;
63 :
64 : /* boolean notifyOnHistoryReload (in nsIURI aReloadURI, in unsigned long aReloadFlags); */
65 : NS_IMETHOD NotifyOnHistoryReload(nsIURI *aReloadURI, uint32_t aReloadFlags, bool *_retval) = 0;
66 :
67 : /* void evictOutOfRangeContentViewers (in long aIndex); */
68 : NS_IMETHOD EvictOutOfRangeContentViewers(int32_t aIndex) = 0;
69 :
70 : /* void evictExpiredContentViewerForEntry (in nsIBFCacheEntry aEntry); */
71 : NS_IMETHOD EvictExpiredContentViewerForEntry(nsIBFCacheEntry *aEntry) = 0;
72 :
73 : /* void evictAllContentViewers (); */
74 : NS_IMETHOD EvictAllContentViewers(void) = 0;
75 :
76 : /* void addToExpirationTracker (in nsIBFCacheEntry aEntry); */
77 : NS_IMETHOD AddToExpirationTracker(nsIBFCacheEntry *aEntry) = 0;
78 :
79 : /* void removeFromExpirationTracker (in nsIBFCacheEntry aEntry); */
80 : NS_IMETHOD RemoveFromExpirationTracker(nsIBFCacheEntry *aEntry) = 0;
81 :
82 : /* [noscript,notxpcom] void RemoveDynEntries (in long aIndex, in nsISHContainer aContainer); */
83 : NS_IMETHOD_(void) RemoveDynEntries(int32_t aIndex, nsISHContainer *aContainer) = 0;
84 :
85 : /* [noscript,notxpcom] void RemoveEntries (in nsDocshellIDArray aIDs, in long aStartIndex); */
86 : NS_IMETHOD_(void) RemoveEntries(nsTArray<nsID> & aIDs, int32_t aStartIndex) = 0;
87 :
88 : };
89 :
90 : NS_DEFINE_STATIC_IID_ACCESSOR(nsISHistoryInternal, NS_ISHISTORYINTERNAL_IID)
91 :
92 : /* Use this macro when declaring classes that implement this interface. */
93 : #define NS_DECL_NSISHISTORYINTERNAL \
94 : NS_IMETHOD AddEntry(nsISHEntry *aEntry, bool aPersist) override; \
95 : NS_IMETHOD GetRootTransaction(nsISHTransaction * *aRootTransaction) override; \
96 : NS_IMETHOD SetRootDocShell(nsIDocShell *rootDocShell) override; \
97 : NS_IMETHOD UpdateIndex(void) override; \
98 : NS_IMETHOD ReplaceEntry(int32_t aIndex, nsISHEntry *aReplaceEntry) override; \
99 : NS_IMETHOD NotifyOnHistoryReload(nsIURI *aReloadURI, uint32_t aReloadFlags, bool *_retval) override; \
100 : NS_IMETHOD EvictOutOfRangeContentViewers(int32_t aIndex) override; \
101 : NS_IMETHOD EvictExpiredContentViewerForEntry(nsIBFCacheEntry *aEntry) override; \
102 : NS_IMETHOD EvictAllContentViewers(void) override; \
103 : NS_IMETHOD AddToExpirationTracker(nsIBFCacheEntry *aEntry) override; \
104 : NS_IMETHOD RemoveFromExpirationTracker(nsIBFCacheEntry *aEntry) override; \
105 : NS_IMETHOD_(void) RemoveDynEntries(int32_t aIndex, nsISHContainer *aContainer) override; \
106 : NS_IMETHOD_(void) RemoveEntries(nsTArray<nsID> & aIDs, int32_t aStartIndex) override;
107 :
108 : /* Use this macro when declaring the members of this interface when the
109 : class doesn't implement the interface. This is useful for forwarding. */
110 : #define NS_DECL_NON_VIRTUAL_NSISHISTORYINTERNAL \
111 : nsresult AddEntry(nsISHEntry *aEntry, bool aPersist); \
112 : nsresult GetRootTransaction(nsISHTransaction * *aRootTransaction); \
113 : nsresult SetRootDocShell(nsIDocShell *rootDocShell); \
114 : nsresult UpdateIndex(void); \
115 : nsresult ReplaceEntry(int32_t aIndex, nsISHEntry *aReplaceEntry); \
116 : nsresult NotifyOnHistoryReload(nsIURI *aReloadURI, uint32_t aReloadFlags, bool *_retval); \
117 : nsresult EvictOutOfRangeContentViewers(int32_t aIndex); \
118 : nsresult EvictExpiredContentViewerForEntry(nsIBFCacheEntry *aEntry); \
119 : nsresult EvictAllContentViewers(void); \
120 : nsresult AddToExpirationTracker(nsIBFCacheEntry *aEntry); \
121 : nsresult RemoveFromExpirationTracker(nsIBFCacheEntry *aEntry); \
122 : nsresult_(void) RemoveDynEntries(int32_t aIndex, nsISHContainer *aContainer); \
123 : nsresult_(void) RemoveEntries(nsTArray<nsID> & aIDs, int32_t aStartIndex);
124 :
125 : /* Use this macro to declare functions that forward the behavior of this interface to another object. */
126 : #define NS_FORWARD_NSISHISTORYINTERNAL(_to) \
127 : NS_IMETHOD AddEntry(nsISHEntry *aEntry, bool aPersist) override { return _to AddEntry(aEntry, aPersist); } \
128 : NS_IMETHOD GetRootTransaction(nsISHTransaction * *aRootTransaction) override { return _to GetRootTransaction(aRootTransaction); } \
129 : NS_IMETHOD SetRootDocShell(nsIDocShell *rootDocShell) override { return _to SetRootDocShell(rootDocShell); } \
130 : NS_IMETHOD UpdateIndex(void) override { return _to UpdateIndex(); } \
131 : NS_IMETHOD ReplaceEntry(int32_t aIndex, nsISHEntry *aReplaceEntry) override { return _to ReplaceEntry(aIndex, aReplaceEntry); } \
132 : NS_IMETHOD NotifyOnHistoryReload(nsIURI *aReloadURI, uint32_t aReloadFlags, bool *_retval) override { return _to NotifyOnHistoryReload(aReloadURI, aReloadFlags, _retval); } \
133 : NS_IMETHOD EvictOutOfRangeContentViewers(int32_t aIndex) override { return _to EvictOutOfRangeContentViewers(aIndex); } \
134 : NS_IMETHOD EvictExpiredContentViewerForEntry(nsIBFCacheEntry *aEntry) override { return _to EvictExpiredContentViewerForEntry(aEntry); } \
135 : NS_IMETHOD EvictAllContentViewers(void) override { return _to EvictAllContentViewers(); } \
136 : NS_IMETHOD AddToExpirationTracker(nsIBFCacheEntry *aEntry) override { return _to AddToExpirationTracker(aEntry); } \
137 : NS_IMETHOD RemoveFromExpirationTracker(nsIBFCacheEntry *aEntry) override { return _to RemoveFromExpirationTracker(aEntry); } \
138 : NS_IMETHOD_(void) RemoveDynEntries(int32_t aIndex, nsISHContainer *aContainer) override { return _to RemoveDynEntries(aIndex, aContainer); } \
139 : NS_IMETHOD_(void) RemoveEntries(nsTArray<nsID> & aIDs, int32_t aStartIndex) override { return _to RemoveEntries(aIDs, aStartIndex); }
140 :
141 : /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
142 : #define NS_FORWARD_SAFE_NSISHISTORYINTERNAL(_to) \
143 : NS_IMETHOD AddEntry(nsISHEntry *aEntry, bool aPersist) override { return !_to ? NS_ERROR_NULL_POINTER : _to->AddEntry(aEntry, aPersist); } \
144 : NS_IMETHOD GetRootTransaction(nsISHTransaction * *aRootTransaction) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetRootTransaction(aRootTransaction); } \
145 : NS_IMETHOD SetRootDocShell(nsIDocShell *rootDocShell) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetRootDocShell(rootDocShell); } \
146 : NS_IMETHOD UpdateIndex(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->UpdateIndex(); } \
147 : NS_IMETHOD ReplaceEntry(int32_t aIndex, nsISHEntry *aReplaceEntry) override { return !_to ? NS_ERROR_NULL_POINTER : _to->ReplaceEntry(aIndex, aReplaceEntry); } \
148 : NS_IMETHOD NotifyOnHistoryReload(nsIURI *aReloadURI, uint32_t aReloadFlags, bool *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->NotifyOnHistoryReload(aReloadURI, aReloadFlags, _retval); } \
149 : NS_IMETHOD EvictOutOfRangeContentViewers(int32_t aIndex) override { return !_to ? NS_ERROR_NULL_POINTER : _to->EvictOutOfRangeContentViewers(aIndex); } \
150 : NS_IMETHOD EvictExpiredContentViewerForEntry(nsIBFCacheEntry *aEntry) override { return !_to ? NS_ERROR_NULL_POINTER : _to->EvictExpiredContentViewerForEntry(aEntry); } \
151 : NS_IMETHOD EvictAllContentViewers(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->EvictAllContentViewers(); } \
152 : NS_IMETHOD AddToExpirationTracker(nsIBFCacheEntry *aEntry) override { return !_to ? NS_ERROR_NULL_POINTER : _to->AddToExpirationTracker(aEntry); } \
153 : NS_IMETHOD RemoveFromExpirationTracker(nsIBFCacheEntry *aEntry) override { return !_to ? NS_ERROR_NULL_POINTER : _to->RemoveFromExpirationTracker(aEntry); } \
154 : NS_IMETHOD_(void) RemoveDynEntries(int32_t aIndex, nsISHContainer *aContainer) override; \
155 : NS_IMETHOD_(void) RemoveEntries(nsTArray<nsID> & aIDs, int32_t aStartIndex) override;
156 :
157 : #if 0
158 : /* Use the code below as a template for the implementation class for this interface. */
159 :
160 : /* Header file */
161 : class nsSHistoryInternal : public nsISHistoryInternal
162 : {
163 : public:
164 : NS_DECL_ISUPPORTS
165 : NS_DECL_NSISHISTORYINTERNAL
166 :
167 : nsSHistoryInternal();
168 :
169 : private:
170 : ~nsSHistoryInternal();
171 :
172 : protected:
173 : /* additional members */
174 : };
175 :
176 : /* Implementation file */
177 : NS_IMPL_ISUPPORTS(nsSHistoryInternal, nsISHistoryInternal)
178 :
179 : nsSHistoryInternal::nsSHistoryInternal()
180 : {
181 : /* member initializers and constructor code */
182 : }
183 :
184 : nsSHistoryInternal::~nsSHistoryInternal()
185 : {
186 : /* destructor code */
187 : }
188 :
189 : /* void addEntry (in nsISHEntry aEntry, in boolean aPersist); */
190 : NS_IMETHODIMP nsSHistoryInternal::AddEntry(nsISHEntry *aEntry, bool aPersist)
191 : {
192 : return NS_ERROR_NOT_IMPLEMENTED;
193 : }
194 :
195 : /* readonly attribute nsISHTransaction rootTransaction; */
196 : NS_IMETHODIMP nsSHistoryInternal::GetRootTransaction(nsISHTransaction * *aRootTransaction)
197 : {
198 : return NS_ERROR_NOT_IMPLEMENTED;
199 : }
200 :
201 : /* void setRootDocShell (in nsIDocShell rootDocShell); */
202 : NS_IMETHODIMP nsSHistoryInternal::SetRootDocShell(nsIDocShell *rootDocShell)
203 : {
204 : return NS_ERROR_NOT_IMPLEMENTED;
205 : }
206 :
207 : /* void updateIndex (); */
208 : NS_IMETHODIMP nsSHistoryInternal::UpdateIndex()
209 : {
210 : return NS_ERROR_NOT_IMPLEMENTED;
211 : }
212 :
213 : /* void replaceEntry (in long aIndex, in nsISHEntry aReplaceEntry); */
214 : NS_IMETHODIMP nsSHistoryInternal::ReplaceEntry(int32_t aIndex, nsISHEntry *aReplaceEntry)
215 : {
216 : return NS_ERROR_NOT_IMPLEMENTED;
217 : }
218 :
219 : /* boolean notifyOnHistoryReload (in nsIURI aReloadURI, in unsigned long aReloadFlags); */
220 : NS_IMETHODIMP nsSHistoryInternal::NotifyOnHistoryReload(nsIURI *aReloadURI, uint32_t aReloadFlags, bool *_retval)
221 : {
222 : return NS_ERROR_NOT_IMPLEMENTED;
223 : }
224 :
225 : /* void evictOutOfRangeContentViewers (in long aIndex); */
226 : NS_IMETHODIMP nsSHistoryInternal::EvictOutOfRangeContentViewers(int32_t aIndex)
227 : {
228 : return NS_ERROR_NOT_IMPLEMENTED;
229 : }
230 :
231 : /* void evictExpiredContentViewerForEntry (in nsIBFCacheEntry aEntry); */
232 : NS_IMETHODIMP nsSHistoryInternal::EvictExpiredContentViewerForEntry(nsIBFCacheEntry *aEntry)
233 : {
234 : return NS_ERROR_NOT_IMPLEMENTED;
235 : }
236 :
237 : /* void evictAllContentViewers (); */
238 : NS_IMETHODIMP nsSHistoryInternal::EvictAllContentViewers()
239 : {
240 : return NS_ERROR_NOT_IMPLEMENTED;
241 : }
242 :
243 : /* void addToExpirationTracker (in nsIBFCacheEntry aEntry); */
244 : NS_IMETHODIMP nsSHistoryInternal::AddToExpirationTracker(nsIBFCacheEntry *aEntry)
245 : {
246 : return NS_ERROR_NOT_IMPLEMENTED;
247 : }
248 :
249 : /* void removeFromExpirationTracker (in nsIBFCacheEntry aEntry); */
250 : NS_IMETHODIMP nsSHistoryInternal::RemoveFromExpirationTracker(nsIBFCacheEntry *aEntry)
251 : {
252 : return NS_ERROR_NOT_IMPLEMENTED;
253 : }
254 :
255 : /* [noscript,notxpcom] void RemoveDynEntries (in long aIndex, in nsISHContainer aContainer); */
256 : NS_IMETHODIMP_(void) nsSHistoryInternal::RemoveDynEntries(int32_t aIndex, nsISHContainer *aContainer)
257 : {
258 : return NS_ERROR_NOT_IMPLEMENTED;
259 : }
260 :
261 : /* [noscript,notxpcom] void RemoveEntries (in nsDocshellIDArray aIDs, in long aStartIndex); */
262 : NS_IMETHODIMP_(void) nsSHistoryInternal::RemoveEntries(nsTArray<nsID> & aIDs, int32_t aStartIndex)
263 : {
264 : return NS_ERROR_NOT_IMPLEMENTED;
265 : }
266 :
267 : /* End of implementation class template. */
268 : #endif
269 :
270 :
271 : #endif /* __gen_nsISHistoryInternal_h__ */
|
