7795e83708108e013fd7aebada047fe7035f7ff5
[WebKit-https.git] / WebKit / win / WebHistoryItem.h
1 /*
2  * Copyright (C) 2006, 2007 Apple Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef WebHistoryItem_H
27 #define WebHistoryItem_H
28
29 #include "IWebHistoryItem.h"
30 #include "IWebHistoryItemPrivate.h"
31 #include "IWebIconDatabase.h"
32
33 #include <CoreFoundation/CoreFoundation.h>
34 #include <WebCore/BString.h>
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/RefPtr.h>
37
38 namespace WebCore {
39     class HistoryItem;
40 }
41
42 //-----------------------------------------------------------------------------
43
44 class WebHistoryItem : public IWebHistoryItem, IWebHistoryItemPrivate
45 {
46 public:
47     static WebHistoryItem* createInstance();
48     static WebHistoryItem* createInstance(PassRefPtr<WebCore::HistoryItem>);
49 protected:
50     WebHistoryItem(PassRefPtr<WebCore::HistoryItem>);
51     ~WebHistoryItem();
52
53 public:
54     // IUnknown
55     virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID riid, void** ppvObject);
56     virtual ULONG STDMETHODCALLTYPE AddRef(void);
57     virtual ULONG STDMETHODCALLTYPE Release(void);
58
59     // IWebHistoryItem
60     virtual HRESULT STDMETHODCALLTYPE initWithURLString( 
61         /* [in] */ BSTR urlString,
62         /* [in] */ BSTR title,
63         /* [in] */ DATE lastVisited);
64     
65     virtual HRESULT STDMETHODCALLTYPE originalURLString( 
66         /* [retval][out] */ BSTR *url);
67     
68     virtual HRESULT STDMETHODCALLTYPE URLString( 
69         /* [retval][out] */ BSTR *url);
70     
71     virtual HRESULT STDMETHODCALLTYPE title( 
72         /* [retval][out] */ BSTR *pageTitle);
73     
74     virtual HRESULT STDMETHODCALLTYPE lastVisitedTimeInterval( 
75         /* [retval][out] */ DATE *lastVisited);
76     
77     virtual HRESULT STDMETHODCALLTYPE setAlternateTitle( 
78         /* [in] */ BSTR title);
79     
80     virtual HRESULT STDMETHODCALLTYPE alternateTitle( 
81         /* [retval][out] */ BSTR* title);
82     
83     virtual HRESULT STDMETHODCALLTYPE icon( 
84         /* [out, retval] */ OLE_HANDLE *hBitmap);
85
86     // IWebHistoryItemPrivate
87     virtual HRESULT STDMETHODCALLTYPE initFromDictionaryRepresentation(void* dictionary);
88     virtual HRESULT STDMETHODCALLTYPE dictionaryRepresentation(void** dictionary);
89     virtual HRESULT STDMETHODCALLTYPE visitCount(int *count);
90     virtual HRESULT STDMETHODCALLTYPE setVisitCount(int count);
91     virtual HRESULT STDMETHODCALLTYPE hasURLString(BOOL* hasURL);
92     virtual HRESULT STDMETHODCALLTYPE mergeAutoCompleteHints(IWebHistoryItem* otherItem);
93     virtual HRESULT STDMETHODCALLTYPE setLastVisitedTimeInterval(DATE time);
94     virtual HRESULT STDMETHODCALLTYPE setTitle(BSTR title);
95     virtual HRESULT STDMETHODCALLTYPE RSSFeedReferrer(BSTR* url);
96     virtual HRESULT STDMETHODCALLTYPE setRSSFeedReferrer(BSTR url);
97     virtual HRESULT STDMETHODCALLTYPE hasPageCache(BOOL *hasCache);
98     virtual HRESULT STDMETHODCALLTYPE setHasPageCache(BOOL hasCache);
99     virtual HRESULT STDMETHODCALLTYPE target(BSTR* target);
100     virtual HRESULT STDMETHODCALLTYPE isTargetItem(BOOL* result);
101     virtual HRESULT STDMETHODCALLTYPE children(unsigned* childCount, SAFEARRAY** children);
102
103     // WebHistoryItem
104     WebCore::HistoryItem* historyItem() const;
105 protected:
106     ULONG m_refCount;
107
108     RefPtr<WebCore::HistoryItem> m_historyItem;
109     WebCore::BString m_alternateTitle;
110 };
111
112 #endif