Source/WebKit2/WebProcess/InjectedBundle/API/efl/ewk_page.h

   1 /*
   2  * Copyright (C) 2015 Ryuan Choi <ryuan.choi@gmail.com>.  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 INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 /**
  27  * @file    ewk_page.h
  28  * @brief   Describes the Ewk_Page API.
  29  */
  30
  31 #ifndef ewk_page_h
  32 #define ewk_page_h
  33
  34 #include <Eina.h>
  35 #include <JavaScriptCore/JSBase.h>
  36
  37 typedef struct EwkPage Ewk_Page;
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 struct EwkPageClient {
  44     int version;
  45     void *data;
  46
  47     /**
  48      * Callbacks to report load finished.
  49      *
  50      * @param page page to be finished
  51      * @param data data of a page client
  52      */
  53     void (*load_finished)(Ewk_Page *page, void *data);
  54 };
  55 typedef struct EwkPageClient Ewk_Page_Client;
  56
  57 /**
  58  * Gets a global JavaScript execution context for the page.
  59  *
  60  * @param page page to get a global JavaScript execution context
  61  *
  62  * This function return global JavaScript execution context to extend javascript functionality.
  63  */
  64 EAPI JSGlobalContextRef ewk_page_js_global_context_get(const Ewk_Page *page);
  65
  66 /**
  67  * Register a page client which contains several callbacks to the page.
  68  *
  69  * @param page page to attach page client
  70  * @param client page client to add to the page
  71  *
  72  * This function registers a client, which contains several callbacks receiving events
  73  * from WebProcess side, to a @p page.
  74  *
  75  * @see ewk_page_client_unregister
  76  */
  77 EAPI void ewk_page_client_register(Ewk_Page *page, const Ewk_Page_Client *client);
  78
  79 /**
  80  * Unregister a client from the page.
  81  *
  82  * @param page page to unregister client
  83  * @param client page client which contains version, data and callbacks
  84  *
  85  * @see ewk_page_client_register
  86  */
  87 EAPI void ewk_page_client_unregister(Ewk_Page *page, const Ewk_Page_Client *client);
  88
  89 #ifdef __cplusplus
  90 }
  91 #endif
  92
  93 #endif // ewk_page_h