2017-01-11 01:25:18 +01:00
|
|
|
// Copyright (c) 2017 Marshall A. Greenblatt. All rights reserved.
|
2012-04-03 03:34:16 +02:00
|
|
|
//
|
|
|
|
// 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 Google Inc. nor the name Chromium Embedded
|
|
|
|
// Framework 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.
|
|
|
|
//
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
//
|
|
|
|
// This file was generated by the CEF translator tool and should not edited
|
|
|
|
// by hand. See the translator.README.txt file in the tools directory for
|
|
|
|
// more information.
|
|
|
|
//
|
|
|
|
|
|
|
|
#ifndef CEF_INCLUDE_CAPI_CEF_FRAME_CAPI_H_
|
|
|
|
#define CEF_INCLUDE_CAPI_CEF_FRAME_CAPI_H_
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include "include/capi/cef_base_capi.h"
|
2014-01-06 20:59:48 +01:00
|
|
|
#include "include/capi/cef_dom_capi.h"
|
|
|
|
#include "include/capi/cef_request_capi.h"
|
|
|
|
#include "include/capi/cef_stream_capi.h"
|
|
|
|
#include "include/capi/cef_string_visitor_capi.h"
|
2012-04-03 03:34:16 +02:00
|
|
|
|
2014-02-10 18:20:38 +01:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2014-01-06 20:59:48 +01:00
|
|
|
struct _cef_browser_t;
|
|
|
|
struct _cef_v8context_t;
|
2012-04-03 03:34:16 +02:00
|
|
|
|
|
|
|
///
|
|
|
|
// Structure used to represent a frame in the browser window. When used in the
|
|
|
|
// browser process the functions of this structure may be called on any thread
|
|
|
|
// unless otherwise indicated in the comments. When used in the render process
|
|
|
|
// the functions of this structure may only be called on the main thread.
|
|
|
|
///
|
|
|
|
typedef struct _cef_frame_t {
|
|
|
|
///
|
|
|
|
// Base structure.
|
|
|
|
///
|
|
|
|
cef_base_t base;
|
|
|
|
|
|
|
|
///
|
|
|
|
// True if this object is currently attached to a valid frame.
|
|
|
|
///
|
|
|
|
int (CEF_CALLBACK *is_valid)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Execute undo in this frame.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *undo)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Execute redo in this frame.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *redo)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Execute cut in this frame.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *cut)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Execute copy in this frame.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *copy)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Execute paste in this frame.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *paste)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Execute delete in this frame.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *del)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Execute select all in this frame.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *select_all)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Save this frame's HTML source to a temporary file and open it in the
|
|
|
|
// default text viewing application. This function can only be called from the
|
|
|
|
// browser process.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *view_source)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Retrieve this frame's HTML source as a string sent to the specified
|
|
|
|
// visitor.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *get_source)(struct _cef_frame_t* self,
|
|
|
|
struct _cef_string_visitor_t* visitor);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Retrieve this frame's display text as a string sent to the specified
|
|
|
|
// visitor.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *get_text)(struct _cef_frame_t* self,
|
|
|
|
struct _cef_string_visitor_t* visitor);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Load the request represented by the |request| object.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *load_request)(struct _cef_frame_t* self,
|
|
|
|
struct _cef_request_t* request);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Load the specified |url|.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *load_url)(struct _cef_frame_t* self,
|
|
|
|
const cef_string_t* url);
|
|
|
|
|
|
|
|
///
|
2013-04-05 19:19:26 +02:00
|
|
|
// Load the contents of |string_val| with the specified dummy |url|. |url|
|
|
|
|
// should have a standard scheme (for example, http scheme) or behaviors like
|
|
|
|
// link clicks and web security restrictions may not behave as expected.
|
2012-04-03 03:34:16 +02:00
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *load_string)(struct _cef_frame_t* self,
|
|
|
|
const cef_string_t* string_val, const cef_string_t* url);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Execute a string of JavaScript code in this frame. The |script_url|
|
|
|
|
// parameter is the URL where the script in question can be found, if any. The
|
|
|
|
// renderer may request this URL to show the developer the source of the
|
|
|
|
// error. The |start_line| parameter is the base line number to use for error
|
|
|
|
// reporting.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *execute_java_script)(struct _cef_frame_t* self,
|
2012-04-24 20:01:48 +02:00
|
|
|
const cef_string_t* code, const cef_string_t* script_url,
|
|
|
|
int start_line);
|
2012-04-03 03:34:16 +02:00
|
|
|
|
|
|
|
///
|
|
|
|
// Returns true (1) if this is the main (top-level) frame.
|
|
|
|
///
|
|
|
|
int (CEF_CALLBACK *is_main)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Returns true (1) if this is the focused frame.
|
|
|
|
///
|
|
|
|
int (CEF_CALLBACK *is_focused)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Returns the name for this frame. If the frame has an assigned name (for
|
|
|
|
// example, set via the iframe "name" attribute) then that value will be
|
|
|
|
// returned. Otherwise a unique name will be constructed based on the frame
|
|
|
|
// parent hierarchy. The main (top-level) frame will always have an NULL name
|
|
|
|
// value.
|
|
|
|
///
|
|
|
|
// The resulting string must be freed by calling cef_string_userfree_free().
|
|
|
|
cef_string_userfree_t (CEF_CALLBACK *get_name)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
2015-10-09 17:23:12 +02:00
|
|
|
// Returns the globally unique identifier for this frame or < 0 if the
|
|
|
|
// underlying frame does not yet exist.
|
2012-04-03 03:34:16 +02:00
|
|
|
///
|
|
|
|
int64 (CEF_CALLBACK *get_identifier)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Returns the parent of this frame or NULL if this is the main (top-level)
|
|
|
|
// frame.
|
|
|
|
///
|
|
|
|
struct _cef_frame_t* (CEF_CALLBACK *get_parent)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Returns the URL currently loaded in this frame.
|
|
|
|
///
|
|
|
|
// The resulting string must be freed by calling cef_string_userfree_free().
|
|
|
|
cef_string_userfree_t (CEF_CALLBACK *get_url)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Returns the browser that this frame belongs to.
|
|
|
|
///
|
|
|
|
struct _cef_browser_t* (CEF_CALLBACK *get_browser)(struct _cef_frame_t* self);
|
|
|
|
|
|
|
|
///
|
|
|
|
// Get the V8 context associated with the frame. This function can only be
|
|
|
|
// called from the render process.
|
|
|
|
///
|
|
|
|
struct _cef_v8context_t* (CEF_CALLBACK *get_v8context)(
|
|
|
|
struct _cef_frame_t* self);
|
2012-04-27 23:19:06 +02:00
|
|
|
|
|
|
|
///
|
|
|
|
// Visit the DOM document. This function can only be called from the render
|
|
|
|
// process.
|
|
|
|
///
|
|
|
|
void (CEF_CALLBACK *visit_dom)(struct _cef_frame_t* self,
|
|
|
|
struct _cef_domvisitor_t* visitor);
|
2012-04-03 03:34:16 +02:00
|
|
|
} cef_frame_t;
|
|
|
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif // CEF_INCLUDE_CAPI_CEF_FRAME_CAPI_H_
|