WebKit/gtk/webkit/webkitwebview.h
changeset 0 4f2f89ce4247
equal deleted inserted replaced
-1:000000000000 0:4f2f89ce4247
       
     1 /*
       
     2  * Copyright (C) 2007 Holger Hans Peter Freyther
       
     3  * Copyright (C) 2007, 2008 Alp Toker <alp@atoker.com>
       
     4  * Copyright (C) 2008 Collabora Ltd.
       
     5  *
       
     6  * This library is free software; you can redistribute it and/or
       
     7  * modify it under the terms of the GNU Library General Public
       
     8  * License as published by the Free Software Foundation; either
       
     9  * version 2 of the License, or (at your option) any later version.
       
    10  *
       
    11  * This library is distributed in the hope that it will be useful,
       
    12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
       
    13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
       
    14  * Library General Public License for more details.
       
    15  *
       
    16  * You should have received a copy of the GNU Library General Public License
       
    17  * along with this library; see the file COPYING.LIB.  If not, write to
       
    18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
       
    19  * Boston, MA 02110-1301, USA.
       
    20  */
       
    21 
       
    22 #ifndef webkitwebview_h
       
    23 #define webkitwebview_h
       
    24 
       
    25 #include <gtk/gtk.h>
       
    26 #include <libsoup/soup.h>
       
    27 #include <JavaScriptCore/JSBase.h>
       
    28 
       
    29 #include <webkit/webkitdefines.h>
       
    30 #include <webkit/webkitdom.h>
       
    31 #include <webkit/webkitwebbackforwardlist.h>
       
    32 #include <webkit/webkitwebframe.h>
       
    33 #include <webkit/webkitwebhistoryitem.h>
       
    34 #include <webkit/webkitwebsettings.h>
       
    35 
       
    36 G_BEGIN_DECLS
       
    37 
       
    38 #define WEBKIT_TYPE_WEB_VIEW            (webkit_web_view_get_type())
       
    39 #define WEBKIT_WEB_VIEW(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), WEBKIT_TYPE_WEB_VIEW, WebKitWebView))
       
    40 #define WEBKIT_WEB_VIEW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),  WEBKIT_TYPE_WEB_VIEW, WebKitWebViewClass))
       
    41 #define WEBKIT_IS_WEB_VIEW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), WEBKIT_TYPE_WEB_VIEW))
       
    42 #define WEBKIT_IS_WEB_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),  WEBKIT_TYPE_WEB_VIEW))
       
    43 #define WEBKIT_WEB_VIEW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),  WEBKIT_TYPE_WEB_VIEW, WebKitWebViewClass))
       
    44 
       
    45 typedef struct _WebKitWebViewPrivate WebKitWebViewPrivate;
       
    46 
       
    47 typedef enum {
       
    48     WEBKIT_NAVIGATION_RESPONSE_ACCEPT,
       
    49     WEBKIT_NAVIGATION_RESPONSE_IGNORE,
       
    50     WEBKIT_NAVIGATION_RESPONSE_DOWNLOAD
       
    51 } WebKitNavigationResponse;
       
    52 
       
    53 typedef enum {
       
    54     WEBKIT_CACHE_MODEL_DOCUMENT_VIEWER = 1,
       
    55     WEBKIT_CACHE_MODEL_WEB_BROWSER
       
    56 } WebKitCacheModel;
       
    57 
       
    58 typedef enum
       
    59 {
       
    60     WEBKIT_WEB_VIEW_TARGET_INFO_HTML,
       
    61     WEBKIT_WEB_VIEW_TARGET_INFO_TEXT,
       
    62     WEBKIT_WEB_VIEW_TARGET_INFO_IMAGE,
       
    63     WEBKIT_WEB_VIEW_TARGET_INFO_URI_LIST,
       
    64     WEBKIT_WEB_VIEW_TARGET_INFO_NETSCAPE_URL
       
    65 } WebKitWebViewTargetInfo;
       
    66 
       
    67 struct _WebKitWebView {
       
    68     GtkContainer parent_instance;
       
    69 
       
    70     /*< private >*/
       
    71     WebKitWebViewPrivate *priv;
       
    72 };
       
    73 
       
    74 struct _WebKitWebViewClass {
       
    75     GtkContainerClass parent_class;
       
    76 
       
    77     /*< public >*/
       
    78     /*
       
    79      * default handler/virtual methods
       
    80      */
       
    81     WebKitWebView            * (* create_web_view)        (WebKitWebView        *web_view,
       
    82                                                            WebKitWebFrame       *web_frame);
       
    83 
       
    84     gboolean                   (* web_view_ready)          (WebKitWebView* web_view);
       
    85 
       
    86     gboolean                   (* close_web_view)         (WebKitWebView* web_view);
       
    87 
       
    88     WebKitNavigationResponse   (* navigation_requested)   (WebKitWebView        *web_view,
       
    89                                                            WebKitWebFrame       *frame,
       
    90                                                            WebKitNetworkRequest *request);
       
    91     void                       (* window_object_cleared)  (WebKitWebView        *web_view,
       
    92                                                            WebKitWebFrame       *frame,
       
    93                                                            JSGlobalContextRef    context,
       
    94                                                            JSObjectRef           window_object);
       
    95     gchar                    * (* choose_file)            (WebKitWebView        *web_view,
       
    96                                                            WebKitWebFrame       *frame,
       
    97                                                            const gchar          *old_file);
       
    98     gboolean                   (* script_alert)           (WebKitWebView        *web_view,
       
    99                                                            WebKitWebFrame       *frame,
       
   100                                                            const gchar          *alert_message);
       
   101     gboolean                   (* script_confirm)         (WebKitWebView        *web_view,
       
   102                                                            WebKitWebFrame       *frame,
       
   103                                                            const gchar          *confirm_message,
       
   104                                                            gboolean             *did_confirm);
       
   105     gboolean                   (* script_prompt)          (WebKitWebView        *web_view,
       
   106                                                            WebKitWebFrame       *frame,
       
   107                                                            const gchar          *message,
       
   108                                                            const gchar          *default_value,
       
   109                                                            gchar*               *value);
       
   110     gboolean                   (* console_message)        (WebKitWebView        *web_view,
       
   111                                                            const gchar          *message,
       
   112                                                            guint                 line_number,
       
   113                                                            const gchar*          source_id);
       
   114     void                       (* select_all)             (WebKitWebView        *web_view);
       
   115     void                       (* cut_clipboard)          (WebKitWebView        *web_view);
       
   116     void                       (* copy_clipboard)         (WebKitWebView        *web_view);
       
   117     void                       (* paste_clipboard)        (WebKitWebView        *web_view);
       
   118     gboolean                   (* move_cursor)            (WebKitWebView        *web_view,
       
   119                                                            GtkMovementStep       step,
       
   120                                                            gint                  count);
       
   121 
       
   122     /*
       
   123      * internal
       
   124      */
       
   125     void                       (* set_scroll_adjustments) (WebKitWebView        *web_view,
       
   126                                                            GtkAdjustment        *hadjustment,
       
   127                                                            GtkAdjustment        *vadjustment);
       
   128 
       
   129     void                       (* undo)                   (WebKitWebView        *web_view);
       
   130     void                       (* redo)                   (WebKitWebView        *web_view);
       
   131 
       
   132     /* Padding for future expansion */
       
   133     void (*_webkit_reserved0) (void);
       
   134     void (*_webkit_reserved1) (void);
       
   135     void (*_webkit_reserved2) (void);
       
   136     void (*_webkit_reserved3) (void);
       
   137 };
       
   138 
       
   139 WEBKIT_API GType
       
   140 webkit_web_view_get_type (void);
       
   141 
       
   142 WEBKIT_API GtkWidget *
       
   143 webkit_web_view_new (void);
       
   144 
       
   145 WEBKIT_API G_CONST_RETURN gchar *
       
   146 webkit_web_view_get_title                       (WebKitWebView        *web_view);
       
   147 
       
   148 WEBKIT_API G_CONST_RETURN gchar *
       
   149 webkit_web_view_get_uri                         (WebKitWebView        *web_view);
       
   150 
       
   151 WEBKIT_API void
       
   152 webkit_web_view_set_maintains_back_forward_list (WebKitWebView        *web_view,
       
   153                                                  gboolean              flag);
       
   154 
       
   155 WEBKIT_API WebKitWebBackForwardList *
       
   156 webkit_web_view_get_back_forward_list           (WebKitWebView        *web_view);
       
   157 
       
   158 WEBKIT_API gboolean
       
   159 webkit_web_view_go_to_back_forward_item         (WebKitWebView        *web_view,
       
   160                                                  WebKitWebHistoryItem *item);
       
   161 
       
   162 WEBKIT_API gboolean
       
   163 webkit_web_view_can_go_back                     (WebKitWebView        *web_view);
       
   164 
       
   165 WEBKIT_API gboolean
       
   166 webkit_web_view_can_go_back_or_forward          (WebKitWebView        *web_view,
       
   167                                                  gint                  steps);
       
   168 
       
   169 WEBKIT_API gboolean
       
   170 webkit_web_view_can_go_forward                  (WebKitWebView        *web_view);
       
   171 
       
   172 WEBKIT_API void
       
   173 webkit_web_view_go_back                         (WebKitWebView        *web_view);
       
   174 
       
   175 WEBKIT_API void
       
   176 webkit_web_view_go_back_or_forward              (WebKitWebView        *web_view,
       
   177                                                  gint                  steps);
       
   178 
       
   179 WEBKIT_API void
       
   180 webkit_web_view_go_forward                      (WebKitWebView        *web_view);
       
   181 
       
   182 WEBKIT_API void
       
   183 webkit_web_view_stop_loading                    (WebKitWebView        *web_view);
       
   184 
       
   185 WEBKIT_API void
       
   186 webkit_web_view_open                            (WebKitWebView        *web_view,
       
   187                                                  const gchar          *uri);
       
   188 
       
   189 WEBKIT_API void
       
   190 webkit_web_view_reload                          (WebKitWebView        *web_view);
       
   191 
       
   192 WEBKIT_API void
       
   193 webkit_web_view_reload_bypass_cache             (WebKitWebView        *web_view);
       
   194 
       
   195 WEBKIT_API void
       
   196 webkit_web_view_load_uri                        (WebKitWebView        *web_view,
       
   197                                                  const gchar          *uri);
       
   198 
       
   199 WEBKIT_API void
       
   200 webkit_web_view_load_string                     (WebKitWebView        *web_view,
       
   201                                                  const gchar          *content,
       
   202                                                  const gchar          *mime_type,
       
   203                                                  const gchar          *encoding,
       
   204                                                  const gchar          *base_uri);
       
   205 
       
   206 WEBKIT_API void
       
   207 webkit_web_view_load_html_string                (WebKitWebView        *web_view,
       
   208                                                  const gchar          *content,
       
   209                                                  const gchar          *base_uri);
       
   210 
       
   211 WEBKIT_API void
       
   212 webkit_web_view_load_request                    (WebKitWebView        *web_view,
       
   213                                                  WebKitNetworkRequest *request);
       
   214 
       
   215 WEBKIT_API gboolean
       
   216 webkit_web_view_search_text                     (WebKitWebView        *web_view,
       
   217                                                  const gchar          *text,
       
   218                                                  gboolean              case_sensitive,
       
   219                                                  gboolean              forward,
       
   220                                                  gboolean              wrap);
       
   221 
       
   222 WEBKIT_API guint
       
   223 webkit_web_view_mark_text_matches               (WebKitWebView        *web_view,
       
   224                                                  const gchar          *string,
       
   225                                                  gboolean              case_sensitive,
       
   226                                                  guint                 limit);
       
   227 
       
   228 WEBKIT_API void
       
   229 webkit_web_view_set_highlight_text_matches      (WebKitWebView        *web_view,
       
   230                                                  gboolean              highlight);
       
   231 
       
   232 WEBKIT_API void
       
   233 webkit_web_view_unmark_text_matches             (WebKitWebView        *web_view);
       
   234 
       
   235 WEBKIT_API WebKitWebFrame *
       
   236 webkit_web_view_get_main_frame                  (WebKitWebView        *web_view);
       
   237 
       
   238 WEBKIT_API WebKitWebFrame *
       
   239 webkit_web_view_get_focused_frame               (WebKitWebView        *web_view);
       
   240 
       
   241 WEBKIT_API void
       
   242 webkit_web_view_execute_script                  (WebKitWebView        *web_view,
       
   243                                                  const gchar          *script);
       
   244 
       
   245 WEBKIT_API gboolean
       
   246 webkit_web_view_can_cut_clipboard               (WebKitWebView        *web_view);
       
   247 
       
   248 WEBKIT_API gboolean
       
   249 webkit_web_view_can_copy_clipboard              (WebKitWebView        *web_view);
       
   250 
       
   251 WEBKIT_API gboolean
       
   252 webkit_web_view_can_paste_clipboard             (WebKitWebView        *web_view);
       
   253 
       
   254 WEBKIT_API void
       
   255 webkit_web_view_cut_clipboard                   (WebKitWebView        *web_view);
       
   256 
       
   257 WEBKIT_API void
       
   258 webkit_web_view_copy_clipboard                  (WebKitWebView        *web_view);
       
   259 
       
   260 WEBKIT_API void
       
   261 webkit_web_view_paste_clipboard                 (WebKitWebView        *web_view);
       
   262 
       
   263 WEBKIT_API void
       
   264 webkit_web_view_delete_selection                (WebKitWebView        *web_view);
       
   265 
       
   266 WEBKIT_API gboolean
       
   267 webkit_web_view_has_selection                   (WebKitWebView        *web_view);
       
   268 
       
   269 WEBKIT_API void
       
   270 webkit_web_view_select_all                      (WebKitWebView        *web_view);
       
   271 
       
   272 WEBKIT_API gboolean
       
   273 webkit_web_view_get_editable                    (WebKitWebView        *web_view);
       
   274 
       
   275 WEBKIT_API void
       
   276 webkit_web_view_set_editable                    (WebKitWebView        *web_view,
       
   277                                                  gboolean              flag);
       
   278 
       
   279 WEBKIT_API GtkTargetList *
       
   280 webkit_web_view_get_copy_target_list            (WebKitWebView        *web_view);
       
   281 
       
   282 WEBKIT_API GtkTargetList *
       
   283 webkit_web_view_get_paste_target_list           (WebKitWebView        *web_view);
       
   284 
       
   285 WEBKIT_API void
       
   286 webkit_web_view_set_settings                    (WebKitWebView        *web_view,
       
   287                                                  WebKitWebSettings    *settings);
       
   288 
       
   289 WEBKIT_API WebKitWebSettings *
       
   290 webkit_web_view_get_settings                    (WebKitWebView        *web_view);
       
   291 
       
   292 WEBKIT_API WebKitWebInspector *
       
   293 webkit_web_view_get_inspector                   (WebKitWebView        *web_view);
       
   294 
       
   295 WEBKIT_API WebKitWebWindowFeatures*
       
   296 webkit_web_view_get_window_features             (WebKitWebView        *web_view);
       
   297 
       
   298 WEBKIT_API gboolean
       
   299 webkit_web_view_can_show_mime_type              (WebKitWebView        *web_view,
       
   300                                                  const gchar          *mime_type);
       
   301 
       
   302 WEBKIT_API gboolean
       
   303 webkit_web_view_get_transparent                 (WebKitWebView        *web_view);
       
   304 
       
   305 WEBKIT_API void
       
   306 webkit_web_view_set_transparent                 (WebKitWebView        *web_view,
       
   307                                                  gboolean              flag);
       
   308 
       
   309 WEBKIT_API gfloat
       
   310 webkit_web_view_get_zoom_level                  (WebKitWebView        *web_view);
       
   311 
       
   312 WEBKIT_API void
       
   313 webkit_web_view_set_zoom_level                  (WebKitWebView        *web_view,
       
   314                                                  gfloat                zoom_level);
       
   315 
       
   316 WEBKIT_API void
       
   317 webkit_web_view_zoom_in                         (WebKitWebView        *web_view);
       
   318 
       
   319 WEBKIT_API void
       
   320 webkit_web_view_zoom_out                        (WebKitWebView        *web_view);
       
   321 
       
   322 WEBKIT_API gboolean
       
   323 webkit_web_view_get_full_content_zoom           (WebKitWebView        *web_view);
       
   324 
       
   325 WEBKIT_API void
       
   326 webkit_web_view_set_full_content_zoom           (WebKitWebView        *web_view,
       
   327                                                  gboolean              full_content_zoom);
       
   328 
       
   329 WEBKIT_API SoupSession*
       
   330 webkit_get_default_session                      (void);
       
   331 
       
   332 WEBKIT_API const gchar*
       
   333 webkit_web_view_get_encoding                    (WebKitWebView        * webView);
       
   334 
       
   335 WEBKIT_API void
       
   336 webkit_web_view_set_custom_encoding             (WebKitWebView        * webView,
       
   337                                                  const gchar          * encoding);
       
   338 
       
   339 WEBKIT_API const char*
       
   340 webkit_web_view_get_custom_encoding             (WebKitWebView        * webView);
       
   341 
       
   342 WEBKIT_API void
       
   343 webkit_web_view_move_cursor                     (WebKitWebView        * webView,
       
   344                                                  GtkMovementStep        step,
       
   345                                                  gint                   count);
       
   346 
       
   347 WEBKIT_API WebKitLoadStatus
       
   348 webkit_web_view_get_load_status                 (WebKitWebView        *web_view);
       
   349 
       
   350 WEBKIT_API gdouble
       
   351 webkit_web_view_get_progress                    (WebKitWebView        *web_view);
       
   352 
       
   353 WEBKIT_API void
       
   354 webkit_web_view_undo                            (WebKitWebView        *webView);
       
   355 
       
   356 WEBKIT_API gboolean
       
   357 webkit_web_view_can_undo                        (WebKitWebView        *webView);
       
   358 
       
   359 WEBKIT_API void
       
   360 webkit_web_view_redo                            (WebKitWebView        *webView);
       
   361 
       
   362 WEBKIT_API gboolean
       
   363 webkit_web_view_can_redo                        (WebKitWebView        *webView);
       
   364 
       
   365 WEBKIT_API void
       
   366 webkit_web_view_set_view_source_mode            (WebKitWebView        *web_view,
       
   367                                                  gboolean             view_source_mode);
       
   368 
       
   369 WEBKIT_API gboolean
       
   370 webkit_web_view_get_view_source_mode            (WebKitWebView        *web_view);
       
   371 
       
   372 WEBKIT_API WebKitHitTestResult*
       
   373 webkit_web_view_get_hit_test_result             (WebKitWebView        *webView,
       
   374                                                  GdkEventButton       *event);
       
   375 
       
   376 WEBKIT_API G_CONST_RETURN gchar *
       
   377 webkit_web_view_get_icon_uri                    (WebKitWebView        *webView);
       
   378 
       
   379 WEBKIT_API void
       
   380 webkit_set_cache_model                          (WebKitCacheModel     cache_model);
       
   381 
       
   382 WEBKIT_API WebKitCacheModel
       
   383 webkit_get_cache_model                          (void);
       
   384 
       
   385 WEBKIT_API WebKitDOMDocument *
       
   386 webkit_web_view_get_dom_document                (WebKitWebView        *webView);
       
   387 
       
   388 G_END_DECLS
       
   389 
       
   390 #endif