Berkelium

include/berkelium/WindowDelegate.hpp

Go to the documentation of this file.

/*  Berkelium - Embedded Chromium
 *  WindowDelegate.hpp
 *
 *  Copyright (c) 2009, Patrick Reiter Horn
 *  All rights reserved.
 *
 *  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.
 *  * Neither the name of Sirikata nor the names of its contributors may
 *    be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER
 * 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.
 */

#ifndef _BERKELIUM_WINDOW_DELEGATE_HPP_
#define _BERKELIUM_WINDOW_DELEGATE_HPP_

#include "berkelium/WeakString.hpp"
#include "berkelium/Rect.hpp"
#include "berkelium/ScriptVariant.hpp"
#include "berkelium/Window.hpp"

namespace Berkelium {

class WindowImpl;
class Widget;
class Window;
class Cursor;

struct ContextMenuEventArgs {
  enum MediaType {
      MediaTypeNone,
      MediaTypeImage,
      MediaTypeVideo,
      MediaTypeAudio,
  };
  enum EditFlags {
      CanDoNone = 0x0,
      CanUndo = 0x1,
      CanRedo = 0x2,
      CanCut = 0x4,
      CanCopy = 0x8,
      CanPaste = 0x10,
      CanDelete = 0x20,
      CanSelectAll = 0x40,
  };

  MediaType mediaType;

  int mouseX, mouseY;

  URLString linkUrl, srcUrl, pageUrl, frameUrl;
  WideString selectedText;

  bool isEditable;

  int editFlags;
};

enum ScriptAlertType {
    JavascriptAlert = 0,
    JavascriptConfirm = 1,
    JavascriptPrompt = 2
};

enum FileChooserType {
    FileOpen = 0,
    FileOpenMultiple = 1,
    FileOpenFolder = 2,
    FileSaveAs = 3
};

class BERKELIUM_EXPORT WindowDelegate {
public:
    virtual ~WindowDelegate() {}

    virtual void onAddressBarChanged(Window *win, URLString newURL) {}
    virtual void onStartLoading(Window *win, URLString newURL) {}
    virtual void onLoad(Window *win) {}
    virtual void onCrashedWorker(Window *win) {}
    virtual void onCrashedPlugin(Window *win, WideString pluginName) {}
    virtual void onProvisionalLoadError(Window *win, URLString url,
                                        int errorCode, bool isMainFrame) {}
    virtual void onConsoleMessage(Window *win, WideString message,
                                  WideString sourceId, int line_no) {}
    virtual void onScriptAlert(Window *win, WideString message,
                              WideString defaultValue, URLString url,
                              int flags, bool &success, WideString &value) {}
    virtual void freeLastScriptAlert(WideString lastValue) {}
    virtual void onNavigationRequested(Window *win, URLString newUrl,
                                       URLString referrer, bool isNewWindow,
                                       bool &cancelDefaultAction) {
        // Override to permit popup windows only if you support onCreatedWindow.
        if (isNewWindow) cancelDefaultAction = true;
    }
    virtual void onLoadingStateChanged(Window *win, bool isLoading) {}
    virtual void onTitleChanged(Window *win, WideString title) {}
    virtual void onTooltipChanged(Window *win, WideString text) {}

    virtual void onCrashed(Window *win) {}
    virtual void onUnresponsive(Window *win) {}
    virtual void onResponsive(Window *win) {}

    virtual void onExternalHost(
        Window *win,
        WideString message,
        URLString origin,
        URLString target) {}

    virtual void onCreatedWindow(Window *win, Window *newWindow,
                                 const Rect &initialRect) {}

    virtual void onPaint(
        Window *win,
        const unsigned char *sourceBuffer,
        const Rect &sourceBufferRect,
        size_t numCopyRects,
        const Rect *copyRects,
        int dx, int dy,
        const Rect &scrollRect) {}

    virtual void onWidgetCreated(Window *win, Widget *newWidget, int zIndex) {}
    virtual void onWidgetDestroyed(Window *win, Widget *wid) {}

    virtual void onWidgetResize(
        Window *win,
        Widget *wid,
        int newWidth,
        int newHeight) {}

    virtual void onWidgetMove(
        Window *win,
        Widget *wid,
        int newX,
        int newY) {}

    virtual void onWidgetPaint(
        Window *win,
        Widget *wid,
        const unsigned char *sourceBuffer,
        const Rect &sourceBufferRect,
        size_t numCopyRects,
        const Rect *copyRects,
        int dx, int dy,
        const Rect &scrollRect) {}

    virtual void onCursorUpdated(Window *win, const Cursor& newCursor) {}

    virtual void onShowContextMenu(Window *win,
                                   const ContextMenuEventArgs& args) {}

    virtual void onJavascriptCallback(Window *win, void* replyMsg, URLString origin, WideString funcName, Script::Variant *args, size_t numArgs) {
        if (replyMsg) {
            win->synchronousScriptReturn(replyMsg, Script::Variant());
        }
    }

    virtual void onRunFileChooser(Window *win, int mode, WideString title, FileString defaultFile) {
        win->filesSelected(NULL);
    }

    virtual void onResizeRequested(
        Window *win,
        int x,
        int y,
        int newWidth,
        int newHeight) {
    }

/**************************
   Might want messages for:
- StartDragging(const WebDropData& drop_data,
                WebKit::WebDragOperationsMask allowed_ops);
- UpdateDragCursor(WebKit::WebDragOperation operation);
- TakeFocus(bool reverse)
- Close
- UpdateTargetURL
- UpdateEncoding
**************************/

};

}

#endif

---