include/WebView.h

/*
        This file is a part of Awesomium, a library that makes it easy for 
        developers to embed web-content in their applications.

        Copyright (C) 2009 Khrona. All rights reserved. Awesomium is a trademark of Khrona.
*/

#ifndef __WEBVIEW_H__
#define __WEBVIEW_H__

#include "WebViewListener.h"
#include "WebKeyboardEvent.h"
#include <map>

#if defined(_WIN32)
#pragma warning( disable: 4251 )
#endif

class WebViewWaitState;
class WebViewProxy;
class JSValueFutureImpl;
class FutureValueCallback;
class CheckKeyboardFocusCallback;
class WindowOpenCallback;
namespace base { class Thread; }
class LockImpl;
namespace WebViewEvents { class InvokeCallback; }

namespace Awesomium {

class WebCore;

enum MouseButton {
        LEFT_MOUSE_BTN,
        MIDDLE_MOUSE_BTN,
        RIGHT_MOUSE_BTN
};

enum URLFilteringMode {
        UFM_BLACKLIST, 

        UFM_WHITELIST,

        // No filtering
        UFM_NONE
};

struct _OSMExport Rect {
        int x, y, width, height;

        Rect();
        Rect(int x, int y, int width, int height);
        bool isEmpty() const;
};

typedef std::map<std::string, std::string> HeaderDefinition;

class _OSMExport WebView
{
public:

        void destroy();

        void setListener(WebViewListener* listener);

        WebViewListener* getListener();

        void loadURL(const std::string& url, const std::wstring& frameName = L"", const std::string& username = "", const std::string& password = "");

        void loadURL(const std::wstring& url, const std::wstring& frameName = L"", const std::string& username = "", const std::string& password = "");

        void loadHTML(const std::string& html, const std::wstring& frameName = L"");

        void loadHTML(const std::wstring& html, const std::wstring& frameName = L"");

        void loadFile(const std::string& file, const std::wstring& frameName = L"");

        void goToHistoryOffset(int offset);

        void executeJavascript(const std::string& javascript, const std::wstring& frameName = L"");

        void executeJavascript(const std::wstring& javascript, const std::wstring& frameName = L"");

        Awesomium::FutureJSValue executeJavascriptWithResult(const std::string& javascript, const std::wstring& frameName = L"");

        Awesomium::FutureJSValue executeJavascriptWithResult(const std::wstring& javascript, const std::wstring& frameName = L"");

        void callJavascriptFunction(const std::wstring& object, const std::wstring& function, const JSArguments& args, const std::wstring& frameName = L"");

        void createObject(const std::wstring& objectName);

        void destroyObject(const std::wstring& objectName);

        void setObjectProperty(const std::wstring& objectName, const std::wstring& propName, const JSValue& value);

        void setObjectCallback(const std::wstring& objectName, const std::wstring& callbackName);

        bool isDirty();
        
        void render(unsigned char* destination, int destRowSpan, int destDepth, Awesomium::Rect* renderedRect = 0);

        void injectMouseMove(int x, int y);

        void injectMouseDown(Awesomium::MouseButton button);

        void injectMouseUp(Awesomium::MouseButton button);

        void injectMouseWheel(int scrollAmount);

        void injectKeyboardEvent(const WebKeyboardEvent& keyboardEvent);

        void cut();

        void copy();

        void paste();

        void selectAll();

        void deselectAll();

        void getContentAsText(std::wstring& result, int maxChars);

        void zoomIn();

        void zoomOut();

        void resetZoom();

        void resize(int width, int height);

        void unfocus();

        void focus();

        void setTransparent(bool isTransparent);

        void setURLFilteringMode(URLFilteringMode mode);

        void addURLFilter(const std::wstring& filter);

        void clearAllURLFilters();
        
        void setHeaderDefinition(const std::string& name, const Awesomium::HeaderDefinition& definition);

        void addHeaderRewriteRule(const std::wstring& rule, const std::string& name);

        void removeHeaderRewriteRule(const std::wstring& rule);

        void removeHeaderRewriteRulesByDefinitionName(const std::string& name);

        void setOpensExternalLinksInCallingFrame(bool isEnabled);

protected:
        WebView(int width, int height, bool isTransparent, bool enableAsyncRendering, int maxAsyncRenderPerSec, base::Thread* coreThread);
        ~WebView();

        void startup();
        void setDirty(bool val = true);
        void setAsyncDirty(bool val = true);
        void setFinishRender();
        void setFinishShutdown();
        void setFinishGetContentText();
        void setFinishResize();

        void resolveJSValueFuture(int requestID, Awesomium::JSValue* result);
        void handleFutureJSValueCallback(const Awesomium::JSArguments& args);
        void nullifyFutureJSValueCallbacks();
        void handleCheckKeyboardFocus(bool isFocused);
        void openExternalLink(const std::string& url, const std::wstring& source);

        base::Thread* coreThread;
        WebViewProxy* viewProxy;
        WebViewWaitState* waitState;
        WebViewListener* listener;
        LockImpl* dirtinessLock;
        bool dirtiness, isKeyboardFocused;
        LockImpl* jsValueFutureMapLock;
        std::map<int, JSValueFutureImpl*> jsValueFutureMap;

        const bool enableAsyncRendering;

        friend class WebCore;
        friend class ::WebViewProxy;
        friend class ::FutureValueCallback;
        friend class ::CheckKeyboardFocusCallback;
        friend class ::WindowOpenCallback;
};

}

#endif

---