WebKit/gtk/webkit/webkitwebview.h

   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 typedef enum
  68 {
  69     WEBKIT_WEB_VIEW_VIEW_MODE_WINDOWED,
  70     WEBKIT_WEB_VIEW_VIEW_MODE_FLOATING,
  71     WEBKIT_WEB_VIEW_VIEW_MODE_FULLSCREEN,
  72     WEBKIT_WEB_VIEW_VIEW_MODE_MAXIMIZED,
  73     WEBKIT_WEB_VIEW_VIEW_MODE_MINIMIZED
  74 } WebKitWebViewViewMode;
  75
  76 typedef enum
  77 {
  78     WEBKIT_SELECTION_AFFINITY_UPSTREAM,
  79     WEBKIT_SELECTION_AFFINITY_DOWNSTREAM,
  80 } WebKitSelectionAffinity;
  81
  82 typedef enum
  83 {
  84     WEBKIT_INSERT_ACTION_TYPED,
  85     WEBKIT_INSERT_ACTION_PASTED,
  86     WEBKIT_INSERT_ACTION_DROPPED,
  87 } WebKitInsertAction;
  88
  89 struct _WebKitWebView {
  90     GtkContainer parent_instance;
  91
  92     /*< private >*/
  93     WebKitWebViewPrivate *priv;
  94 };
  95
  96 struct _WebKitWebViewClass {
  97     GtkContainerClass parent_class;
  98
  99     /*< public >*/
 100     /*
 101      * default handler/virtual methods
 102      */
 103     WebKitWebView            * (* create_web_view)        (WebKitWebView        *web_view,
 104                                                            WebKitWebFrame       *web_frame);
 105
 106     gboolean                   (* web_view_ready)          (WebKitWebView* web_view);
 107
 108     gboolean                   (* close_web_view)         (WebKitWebView* web_view);
 109
 110     WebKitNavigationResponse   (* navigation_requested)   (WebKitWebView        *web_view,
 111                                                            WebKitWebFrame       *frame,
 112                                                            WebKitNetworkRequest *request);
 113     void                       (* window_object_cleared)  (WebKitWebView        *web_view,
 114                                                            WebKitWebFrame       *frame,
 115                                                            JSGlobalContextRef    context,
 116                                                            JSObjectRef           window_object);
 117     gchar                    * (* choose_file)            (WebKitWebView        *web_view,
 118                                                            WebKitWebFrame       *frame,
 119                                                            const gchar          *old_file);
 120     gboolean                   (* script_alert)           (WebKitWebView        *web_view,
 121                                                            WebKitWebFrame       *frame,
 122                                                            const gchar          *alert_message);
 123     gboolean                   (* script_confirm)         (WebKitWebView        *web_view,
 124                                                            WebKitWebFrame       *frame,
 125                                                            const gchar          *confirm_message,
 126                                                            gboolean             *did_confirm);
 127     gboolean                   (* script_prompt)          (WebKitWebView        *web_view,
 128                                                            WebKitWebFrame       *frame,
 129                                                            const gchar          *message,
 130                                                            const gchar          *default_value,
 131                                                            gchar*               *value);
 132     gboolean                   (* console_message)        (WebKitWebView        *web_view,
 133                                                            const gchar          *message,
 134                                                            guint                 line_number,
 135                                                            const gchar*          source_id);
 136     void                       (* select_all)             (WebKitWebView        *web_view);
 137     void                       (* cut_clipboard)          (WebKitWebView        *web_view);
 138     void                       (* copy_clipboard)         (WebKitWebView        *web_view);
 139     void                       (* paste_clipboard)        (WebKitWebView        *web_view);
 140     gboolean                   (* move_cursor)            (WebKitWebView        *web_view,
 141                                                            GtkMovementStep       step,
 142                                                            gint                  count);
 143
 144     /*
 145      * internal
 146      */
 147     void                       (* set_scroll_adjustments) (WebKitWebView        *web_view,
 148                                                            GtkAdjustment        *hadjustment,
 149                                                            GtkAdjustment        *vadjustment);
 150
 151     void                       (* undo)                   (WebKitWebView        *web_view);
 152     void                       (* redo)                   (WebKitWebView        *web_view);
 153     gboolean                   (* should_allow_editing_action) (WebKitWebView   *web_view);
 154
 155     /* Padding for future expansion */
 156     void (*_webkit_reserved0) (void);
 157     void (*_webkit_reserved1) (void);
 158     void (*_webkit_reserved2) (void);
 159 };
 160
 161 WEBKIT_API GType
 162 webkit_web_view_get_type (void);
 163
 164 WEBKIT_API GtkWidget *
 165 webkit_web_view_new (void);
 166
 167 WEBKIT_API G_CONST_RETURN gchar *
 168 webkit_web_view_get_title                       (WebKitWebView        *webView);
 169
 170 WEBKIT_API G_CONST_RETURN gchar *
 171 webkit_web_view_get_uri                         (WebKitWebView        *webView);
 172
 173 WEBKIT_API void
 174 webkit_web_view_set_maintains_back_forward_list (WebKitWebView        *webView,
 175                                                  gboolean              flag);
 176
 177 WEBKIT_API WebKitWebBackForwardList *
 178 webkit_web_view_get_back_forward_list           (WebKitWebView        *webView);
 179
 180 WEBKIT_API gboolean
 181 webkit_web_view_go_to_back_forward_item         (WebKitWebView        *webView,
 182                                                  WebKitWebHistoryItem *item);
 183
 184 WEBKIT_API gboolean
 185 webkit_web_view_can_go_back                     (WebKitWebView        *webView);
 186
 187 WEBKIT_API gboolean
 188 webkit_web_view_can_go_back_or_forward          (WebKitWebView        *webView,
 189                                                  gint                  steps);
 190
 191 WEBKIT_API gboolean
 192 webkit_web_view_can_go_forward                  (WebKitWebView        *webView);
 193
 194 WEBKIT_API void
 195 webkit_web_view_go_back                         (WebKitWebView        *webView);
 196
 197 WEBKIT_API void
 198 webkit_web_view_go_back_or_forward              (WebKitWebView        *webView,
 199                                                  gint                  steps);
 200
 201 WEBKIT_API void
 202 webkit_web_view_go_forward                      (WebKitWebView        *webView);
 203
 204 WEBKIT_API void
 205 webkit_web_view_stop_loading                    (WebKitWebView        *webView);
 206
 207 WEBKIT_API void
 208 webkit_web_view_open                            (WebKitWebView        *webView,
 209                                                  const gchar          *uri);
 210
 211 WEBKIT_API void
 212 webkit_web_view_reload                          (WebKitWebView        *webView);
 213
 214 WEBKIT_API void
 215 webkit_web_view_reload_bypass_cache             (WebKitWebView        *webView);
 216
 217 WEBKIT_API void
 218 webkit_web_view_load_uri                        (WebKitWebView        *webView,
 219                                                  const gchar          *uri);
 220
 221 WEBKIT_API void
 222 webkit_web_view_load_string                     (WebKitWebView        *webView,
 223                                                  const gchar          *content,
 224                                                  const gchar          *mime_type,
 225                                                  const gchar          *encoding,
 226                                                  const gchar          *base_uri);
 227
 228 WEBKIT_API void
 229 webkit_web_view_load_html_string                (WebKitWebView        *webView,
 230                                                  const gchar          *content,
 231                                                  const gchar          *base_uri);
 232
 233 WEBKIT_API void
 234 webkit_web_view_load_request                    (WebKitWebView        *webView,
 235                                                  WebKitNetworkRequest *request);
 236
 237 WEBKIT_API gboolean
 238 webkit_web_view_search_text                     (WebKitWebView        *webView,
 239                                                  const gchar          *text,
 240                                                  gboolean              case_sensitive,
 241                                                  gboolean              forward,
 242                                                  gboolean              wrap);
 243
 244 WEBKIT_API guint
 245 webkit_web_view_mark_text_matches               (WebKitWebView        *webView,
 246                                                  const gchar          *string,
 247                                                  gboolean              case_sensitive,
 248                                                  guint                 limit);
 249
 250 WEBKIT_API void
 251 webkit_web_view_set_highlight_text_matches      (WebKitWebView        *webView,
 252                                                  gboolean              highlight);
 253
 254 WEBKIT_API void
 255 webkit_web_view_unmark_text_matches             (WebKitWebView        *webView);
 256
 257 WEBKIT_API WebKitWebFrame *
 258 webkit_web_view_get_main_frame                  (WebKitWebView        *webView);
 259
 260 WEBKIT_API WebKitWebFrame *
 261 webkit_web_view_get_focused_frame               (WebKitWebView        *webView);
 262
 263 WEBKIT_API void
 264 webkit_web_view_execute_script                  (WebKitWebView        *webView,
 265                                                  const gchar          *script);
 266
 267 WEBKIT_API gboolean
 268 webkit_web_view_can_cut_clipboard               (WebKitWebView        *webView);
 269
 270 WEBKIT_API gboolean
 271 webkit_web_view_can_copy_clipboard              (WebKitWebView        *webView);
 272
 273 WEBKIT_API gboolean
 274 webkit_web_view_can_paste_clipboard             (WebKitWebView        *webView);
 275
 276 WEBKIT_API void
 277 webkit_web_view_cut_clipboard                   (WebKitWebView        *webView);
 278
 279 WEBKIT_API void
 280 webkit_web_view_copy_clipboard                  (WebKitWebView        *webView);
 281
 282 WEBKIT_API void
 283 webkit_web_view_paste_clipboard                 (WebKitWebView        *webView);
 284
 285 WEBKIT_API void
 286 webkit_web_view_delete_selection                (WebKitWebView        *webView);
 287
 288 WEBKIT_API gboolean
 289 webkit_web_view_has_selection                   (WebKitWebView        *webView);
 290
 291 WEBKIT_API void
 292 webkit_web_view_select_all                      (WebKitWebView        *webView);
 293
 294 WEBKIT_API gboolean
 295 webkit_web_view_get_editable                    (WebKitWebView        *webView);
 296
 297 WEBKIT_API void
 298 webkit_web_view_set_editable                    (WebKitWebView        *webView,
 299                                                  gboolean              flag);
 300
 301 WEBKIT_API GtkTargetList *
 302 webkit_web_view_get_copy_target_list            (WebKitWebView        *webView);
 303
 304 WEBKIT_API GtkTargetList *
 305 webkit_web_view_get_paste_target_list           (WebKitWebView        *webView);
 306
 307 WEBKIT_API void
 308 webkit_web_view_set_settings                    (WebKitWebView        *webView,
 309                                                  WebKitWebSettings    *settings);
 310
 311 WEBKIT_API WebKitWebSettings *
 312 webkit_web_view_get_settings                    (WebKitWebView        *webView);
 313
 314 WEBKIT_API WebKitWebInspector *
 315 webkit_web_view_get_inspector                   (WebKitWebView        *webView);
 316
 317 WEBKIT_API WebKitWebWindowFeatures*
 318 webkit_web_view_get_window_features             (WebKitWebView        *webView);
 319
 320 WEBKIT_API gboolean
 321 webkit_web_view_can_show_mime_type              (WebKitWebView        *webView,
 322                                                  const gchar          *mime_type);
 323
 324 WEBKIT_API gboolean
 325 webkit_web_view_get_transparent                 (WebKitWebView        *webView);
 326
 327 WEBKIT_API void
 328 webkit_web_view_set_transparent                 (WebKitWebView        *webView,
 329                                                  gboolean              flag);
 330
 331 WEBKIT_API gfloat
 332 webkit_web_view_get_zoom_level                  (WebKitWebView        *webView);
 333
 334 WEBKIT_API void
 335 webkit_web_view_set_zoom_level                  (WebKitWebView        *webView,
 336                                                  gfloat                zoom_level);
 337
 338 WEBKIT_API void
 339 webkit_web_view_zoom_in                         (WebKitWebView        *webView);
 340
 341 WEBKIT_API void
 342 webkit_web_view_zoom_out                        (WebKitWebView        *webView);
 343
 344 WEBKIT_API gboolean
 345 webkit_web_view_get_full_content_zoom           (WebKitWebView        *webView);
 346
 347 WEBKIT_API void
 348 webkit_web_view_set_full_content_zoom           (WebKitWebView        *webView,
 349                                                  gboolean              full_content_zoom);
 350
 351 WEBKIT_API SoupSession*
 352 webkit_get_default_session                      (void);
 353
 354 WEBKIT_API const gchar*
 355 webkit_web_view_get_encoding                    (WebKitWebView        * webView);
 356
 357 WEBKIT_API void
 358 webkit_web_view_set_custom_encoding             (WebKitWebView        * webView,
 359                                                  const gchar          * encoding);
 360
 361 WEBKIT_API const char*
 362 webkit_web_view_get_custom_encoding             (WebKitWebView        * webView);
 363
 364 WEBKIT_API void
 365 webkit_web_view_set_view_mode                   (WebKitWebView        *webView,
 366                                                  WebKitWebViewViewMode mode);
 367
 368 WEBKIT_API WebKitWebViewViewMode
 369 webkit_web_view_get_view_mode                   (WebKitWebView        *webView);
 370
 371 WEBKIT_API void
 372 webkit_web_view_move_cursor                     (WebKitWebView        * webView,
 373                                                  GtkMovementStep        step,
 374                                                  gint                   count);
 375
 376 WEBKIT_API WebKitLoadStatus
 377 webkit_web_view_get_load_status                 (WebKitWebView        *webView);
 378
 379 WEBKIT_API gdouble
 380 webkit_web_view_get_progress                    (WebKitWebView        *webView);
 381
 382 WEBKIT_API void
 383 webkit_web_view_undo                            (WebKitWebView        *webView);
 384
 385 WEBKIT_API gboolean
 386 webkit_web_view_can_undo                        (WebKitWebView        *webView);
 387
 388 WEBKIT_API void
 389 webkit_web_view_redo                            (WebKitWebView        *webView);
 390
 391 WEBKIT_API gboolean
 392 webkit_web_view_can_redo                        (WebKitWebView        *webView);
 393
 394 WEBKIT_API void
 395 webkit_web_view_set_view_source_mode            (WebKitWebView        *webView,
 396                                                  gboolean             view_source_mode);
 397
 398 WEBKIT_API gboolean
 399 webkit_web_view_get_view_source_mode            (WebKitWebView        *webView);
 400
 401 WEBKIT_API WebKitHitTestResult*
 402 webkit_web_view_get_hit_test_result             (WebKitWebView        *webView,
 403                                                  GdkEventButton       *event);
 404
 405 WEBKIT_API G_CONST_RETURN gchar *
 406 webkit_web_view_get_icon_uri                    (WebKitWebView        *webView);
 407
 408 WEBKIT_API void
 409 webkit_set_cache_model                          (WebKitCacheModel     cache_model);
 410
 411 WEBKIT_API WebKitCacheModel
 412 webkit_get_cache_model                          (void);
 413
 414 WEBKIT_API WebKitDOMDocument *
 415 webkit_web_view_get_dom_document                (WebKitWebView        *webView);
 416
 417 G_END_DECLS
 418
 419 #endif