1 /*

     2  * Copyright (C) 2007 Holger Hans Peter Freyther

     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  *

     8  * 1.  Redistributions of source code must retain the above copyright

     9  *     notice, this list of conditions and the following disclaimer. 

    10  * 2.  Redistributions in binary form must reproduce the above copyright

    11  *     notice, this list of conditions and the following disclaimer in the

    12  *     documentation and/or other materials provided with the distribution. 

    13  * 3.  Neither the name of Apple, Inc. ("Apple") nor the names of

    14  *     its contributors may be used to endorse or promote products derived

    15  *     from this software without specific prior written permission. 

    16  *

    17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY

    18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

    19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

    20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY

    21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

    22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

    23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

    24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

    25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF

    26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    27  */

    28 

    29 #ifndef WEBKIT_PAGE_H

    30 #define WEBKIT_PAGE_H

    31 

    32 #include <gtk/gtk.h>

    33 

    34 #include "webkitgtkdefines.h"

    35 #include "webkitgtksettings.h"

    36 

    37 G_BEGIN_DECLS

    38 

    39 #define WEBKIT_TYPE_PAGE            (webkit_page_get_type())

    40 #define WEBKIT_PAGE(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), WEBKIT_TYPE_PAGE, WebKitPage))

    41 #define WEBKIT_PAGE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),  WEBKIT_TYPE_PAGE, WebKitPageClass))

    42 #define WEBKIT_IS_PAGE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), WEBKIT_TYPE_PAGE))

    43 #define WEBKIT_IS_PAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),  WEBKIT_TYPE_PAGE))

    44 #define WEBKIT_PAGE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),  WEBKIT_TYPE_PAGE, WebKitPageClass))

    45 

    46 

    47 typedef enum {

    48     WEBKIT_ACCEPT_NAVIGATION_REQUEST,

    49     WEBKIT_IGNORE_NAVIGATION_REQUEST,

    50     WEBKIT_DOWNLOAD_NAVIGATION_REQUEST

    51 } WEBKIT_NAVIGATION_REQUEST_RESPONSE;

    52 

    53 

    54 

    55 struct _WebKitPage {

    56     GtkContainer parent;

    57 };

    58 

    59 struct _WebKitPageClass {

    60     GtkContainerClass parent;

    61 

    62     /*

    63      * default handler/virtual methods

    64      * DISCUSS: create_page needs a request and should we make this a signal with default handler? this would

    65      * require someone doing a g_signal_stop_emission_by_name

    66      * WebUIDelegate has nothing for create_frame, WebPolicyDelegate as well...

    67      */

    68     WebKitPage*  (*create_page)  (WebKitPage* page);

    69 

    70     /*

    71      * TODO: FIXME: Create something like WebPolicyDecisionListener_Protocol instead

    72      */

    73     WEBKIT_NAVIGATION_REQUEST_RESPONSE (*navigation_requested) (WebKitPage* page, WebKitFrame* frame, WebKitNetworkRequest* request);

    74 

    75     /*

    76      * TODO: DISCUSS: Should these be signals as well?

    77      */

    78     gchar* (*choose_file) (WebKitPage* page, WebKitFrame* frame, const gchar* old_file);

    79     void   (*java_script_alert) (WebKitPage* page, WebKitFrame* frame, const gchar* alert_message);

    80     gboolean   (*java_script_confirm) (WebKitPage* page, WebKitFrame* frame, const gchar* confirm_message);

    81     gchar* (*java_script_prompt) (WebKitPage* page, WebKitFrame* frame, const gchar* message, const gchar* default_value);

    82     void   (*java_script_console_message) (WebKitPage*, const gchar* message, unsigned int line_number, const gchar* source_id);

    83 

    84     /*

    85      * internal

    86      */

    87     void   (*set_scroll_adjustments) (WebKitPage*, GtkAdjustment*, GtkAdjustment*);

    88 };

    89 

    90 WEBKIT_API GType

    91 webkit_page_get_type (void);

    92 

    93 WEBKIT_API GtkWidget*

    94 webkit_page_new (void);

    95 

    96 WEBKIT_API void

    97 webkit_page_set_settings (WebKitPage* page, WebKitSettings* settings);

    98 

    99 WEBKIT_API WebKitSettings*

   100 webkit_page_get_settings (WebKitPage* page);

   101 

   102 WEBKIT_API gboolean

   103 webkit_page_can_cut (WebKitPage* page);

   104 

   105 WEBKIT_API gboolean

   106 webkit_page_can_copy (WebKitPage* page);

   107 

   108 WEBKIT_API gboolean

   109 webkit_page_can_paste (WebKitPage* page);

   110 

   111 WEBKIT_API void

   112 webkit_page_cut (WebKitPage* page);

   113 

   114 WEBKIT_API void

   115 webkit_page_copy (WebKitPage* page);

   116 

   117 WEBKIT_API void

   118 webkit_page_paste (WebKitPage* page);

   119 

   120 WEBKIT_API gboolean

   121 webkit_page_can_go_backward (WebKitPage* page);

   122 

   123 WEBKIT_API gboolean

   124 webkit_page_can_go_forward (WebKitPage* page);

   125 

   126 WEBKIT_API void

   127 webkit_page_go_backward (WebKitPage* page);

   128 

   129 WEBKIT_API void

   130 webkit_page_go_forward (WebKitPage* page);

   131 

   132 WEBKIT_API void

   133 webkit_page_stop_loading (WebKitPage* page);

   134 

   135 WEBKIT_API void

   136 webkit_page_open (WebKitPage* page, const gchar* url);

   137 

   138 WEBKIT_API void

   139 webkit_page_reload (WebKitPage *page);

   140 

   141 WEBKIT_API void

   142 webkit_page_load_string (WebKitPage* page, const gchar* content, const gchar* content_mime_type, const gchar* content_encoding, const gchar* base_url);

   143 

   144 WEBKIT_API void

   145 webkit_page_load_html_string (WebKitPage* page, const gchar* content, const gchar* base_url);

   146 

   147 WEBKIT_API WebKitFrame*

   148 webkit_page_get_main_frame (WebKitPage* page);

   149 

   150 WEBKIT_API void

   151 webkit_page_execute_script(WebKitPage* page, const gchar* script);

   152 G_END_DECLS

   153 

   154 #endif