blob: 609aecca2e8b6c99b855b5722f6d30b27912e28c [file] [log] [blame]
/*
* Copyright 2006, The Android Open Source Project
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
// TODO: change name to WebFrame.h
#ifndef WEBFRAME_H
#define WEBFRAME_H
#include "FrameLoaderClient.h"
#include "PlatformString.h"
#include "WebCoreRefObject.h"
#include <jni.h>
namespace WebCore {
class HistoryItem;
class Image;
class Page;
class RenderPart;
class ResourceHandle;
class ResourceRequest;
}
namespace android {
class WebCoreResourceLoader;
class WebViewCore;
// one instance of WebFrame per Page for calling into Java's BrowserFrame
class WebFrame : public WebCoreRefObject {
public:
// these ids need to be in sync with the constants in BrowserFrame.java
enum RAW_RES_ID {
NODOMAIN = 1,
LOADERROR,
DRAWABLEDIR,
};
WebFrame(JNIEnv* env, jobject obj, jobject historyList, WebCore::Page* page);
~WebFrame();
// helper function
static WebFrame* getWebFrame(const WebCore::Frame* frame);
virtual WebCoreResourceLoader* startLoadingResource(WebCore::ResourceHandle*,
const WebCore::ResourceRequest& request,
bool synchronous);
void reportError(int errorCode, const WebCore::String& description,
const WebCore::String& failingUrl);
void loadStarted(WebCore::Frame* frame);
void transitionToCommitted(WebCore::Frame* frame);
void didFinishLoad(WebCore::Frame* frame);
void addHistoryItem(WebCore::HistoryItem* item);
void removeHistoryItem(int index);
void updateHistoryIndex(int newIndex);
void setTitle(const WebCore::String& title);
void windowObjectCleared(WebCore::Frame* frame);
void setProgress(float newProgress);
const WebCore::String userAgentForURL(const WebCore::KURL* url);
void didReceiveIcon(WebCore::Image* icon);
void didReceiveTouchIconURL(const WebCore::String& url);
void updateVisitedHistory(const WebCore::KURL& url, bool reload);
virtual bool canHandleRequest(const WebCore::ResourceRequest& request);
WebCore::Frame* createWindow(bool dialog, bool userGesture);
void requestFocus() const;
void closeWindow(WebViewCore* webViewCore);
void decidePolicyForFormResubmission(WebCore::FramePolicyFunction func);
void setUserAgent(WebCore::String userAgent) { mUserAgent = userAgent; }
WebCore::String getRawResourceFilename(RAW_RES_ID) const;
float density() const;
/**
* When the user initiates a click (via trackball, enter-press, or touch),
* we set mUserInitiatedClick to true. If a load happens due to this click,
* then we ask the application if it wants to override
* the load. Otherwise, we attempt to load the resource internally.
* We also check it to determine whether or not to allow webkit to request
* a scroll. If it was user initated, the scroll is allowed.
*/
void setUserInitiatedClick(bool userInitiatedClick) { mUserInitiatedClick = userInitiatedClick; }
bool userInitiatedClick() { return mUserInitiatedClick; }
WebCore::Page* page() const { return mPage; }
private:
struct JavaBrowserFrame;
JavaBrowserFrame* mJavaFrame;
WebCore::Page* mPage;
WebCore::String mUserAgent;
bool mUserInitiatedClick;
};
} // namespace android
#endif // WEBFRAME_H