Skip to content

Latest commit

History

History
287 lines (181 loc) · 6.25 KB

File metadata and controls

287 lines (181 loc) · 6.25 KB

API categories | API index

Frame (object)

Remember to free all frame references for the browser to shut down cleanly. Otherwise data such as cookies or other storage might not be flushed to disk when closing app, and other issues might occur as well. If you store a reference to Frame somewhere in your code then to free it just assign a None value to the variable.

To compare frame objects always use GetIdentifier() method. Do not compare two Frame objects variables directly. There are some edge cases when after the OnBeforeClose event frame objects are no more globally referenced thus a new instance is created that wraps upstream CefFrame object. Frame objects that were globally unreferenced do not have properties of the original Frame object.

Table of contents:

Methods

Copy

Returnvoid

Execute copy in this frame.

Cut

Returnvoid

Execute cut in this frame.

Delete

Returnvoid

Execute delete in this frame.

ExecuteFunction

ParameterType
funcNamestring
..*args
Returnvoid

Call a javascript function asynchronously. This can also call object's methods, just pass "object.method" as funcName. Any valid javascript syntax is allowed as funcName, you could even pass an anonymous function here. For a list of allowed types of arguments see JavascriptBindings.IsValueAllowed() - except function, method and instance. Passing a python function here is not allowed, it is only possible using the JavascriptCallback object.

ExecuteJavascript

ParameterType
jsCodestring
scriptUrl=""string
startLine=1int
Returnvoid

Execute a string of JavaScript code in this frame. The sciptUrl 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 startLine parameter is the base line number to use for error reporting. This function executes asynchronously so there is no way to get the returned value. Calling javascript <> native code synchronously is not possible.

GetBrowser

ReturnBrowser

Returns the browser that this frame belongs to.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame.

GetIdentifier

Returnint

Frame identifiers are unique per render process, they are not globally unique.

Returns < 0 if the underlying frame does not yet exist.

GetBrowserIdentifier

Returnint

Returns the globally unique identifier for the browser hosting this frame.

GetName

Returnstring

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 empty name value.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame. This method should only be called on the UI thread.

GetSource

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's HTML source as a string sent to the specified visitor.

GetText

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's display text as a string sent to the specified visitor.

GetUrl

Returnstring

Returns the url currently loaded in this frame.

IsFocused

Returnbool

Returns true if this is the focused frame. This method should only be called on the UI thread.

IsMain

Returnbool

Returns true if this is the main (top-level) frame.

IsValid

Returnbool

True if this object is currently attached to a valid frame.

LoadString

ParameterType
valuestring
urlstring
Returnvoid

NOTE: LoadString is problematic due to the multi-process model and the need to create a render process (which does not happen with LoadString). It is best to use instead LoadUrl with a data uri, e.g. LoadUrl("data:text/html,some+html+code+here"). Take also a look at a custom resource handler.

Load the contents of |value| 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. LoadString() can be called only after the Renderer process has been created.

LoadUrl

ParameterType
urlstring
Returnvoid

Load the specified |url|.

Paste

Returnvoid

Execute paste in this frame.

Redo

Returnvoid

Execute redo in this frame.

SelectAll

Returnvoid

Execute select all in this frame.

Undo

Returnvoid

Execute undo in this frame.

ViewSource

Returnvoid

Save this frame's HTML source to a temporary file and open it in the default text viewing application.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
cefpython/api/Frame.md at master · Toroto006/cefpython · GitHub
Skip to content

Latest commit

History

History
287 lines (181 loc) · 6.25 KB

File metadata and controls

287 lines (181 loc) · 6.25 KB

API categories | API index

Frame (object)

Remember to free all frame references for the browser to shut down cleanly. Otherwise data such as cookies or other storage might not be flushed to disk when closing app, and other issues might occur as well. If you store a reference to Frame somewhere in your code then to free it just assign a None value to the variable.

To compare frame objects always use GetIdentifier() method. Do not compare two Frame objects variables directly. There are some edge cases when after the OnBeforeClose event frame objects are no more globally referenced thus a new instance is created that wraps upstream CefFrame object. Frame objects that were globally unreferenced do not have properties of the original Frame object.

Table of contents:

Methods

Copy

Returnvoid

Execute copy in this frame.

Cut

Returnvoid

Execute cut in this frame.

Delete

Returnvoid

Execute delete in this frame.

ExecuteFunction

ParameterType
funcNamestring
..*args
Returnvoid

Call a javascript function asynchronously. This can also call object's methods, just pass "object.method" as funcName. Any valid javascript syntax is allowed as funcName, you could even pass an anonymous function here. For a list of allowed types of arguments see JavascriptBindings.IsValueAllowed() - except function, method and instance. Passing a python function here is not allowed, it is only possible using the JavascriptCallback object.

ExecuteJavascript

ParameterType
jsCodestring
scriptUrl=""string
startLine=1int
Returnvoid

Execute a string of JavaScript code in this frame. The sciptUrl 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 startLine parameter is the base line number to use for error reporting. This function executes asynchronously so there is no way to get the returned value. Calling javascript <> native code synchronously is not possible.

GetBrowser

ReturnBrowser

Returns the browser that this frame belongs to.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame.

GetIdentifier

Returnint

Frame identifiers are unique per render process, they are not globally unique.

Returns < 0 if the underlying frame does not yet exist.

GetBrowserIdentifier

Returnint

Returns the globally unique identifier for the browser hosting this frame.

GetName

Returnstring

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 empty name value.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame. This method should only be called on the UI thread.

GetSource

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's HTML source as a string sent to the specified visitor.

GetText

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's display text as a string sent to the specified visitor.

GetUrl

Returnstring

Returns the url currently loaded in this frame.

IsFocused

Returnbool

Returns true if this is the focused frame. This method should only be called on the UI thread.

IsMain

Returnbool

Returns true if this is the main (top-level) frame.

IsValid

Returnbool

True if this object is currently attached to a valid frame.

LoadString

ParameterType
valuestring
urlstring
Returnvoid

NOTE: LoadString is problematic due to the multi-process model and the need to create a render process (which does not happen with LoadString). It is best to use instead LoadUrl with a data uri, e.g. LoadUrl("data:text/html,some+html+code+here"). Take also a look at a custom resource handler.

Load the contents of |value| 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. LoadString() can be called only after the Renderer process has been created.

LoadUrl

ParameterType
urlstring
Returnvoid

Load the specified |url|.

Paste

Returnvoid

Execute paste in this frame.

Redo

Returnvoid

Execute redo in this frame.

SelectAll

Returnvoid

Execute select all in this frame.

Undo

Returnvoid

Execute undo in this frame.

ViewSource

Returnvoid

Save this frame's HTML source to a temporary file and open it in the default text viewing application.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' cefpython/api/Frame.md at master · Toroto006/cefpython · GitHub
Skip to content

Latest commit

History

History
287 lines (181 loc) · 6.25 KB

File metadata and controls

287 lines (181 loc) · 6.25 KB

API categories | API index

Frame (object)

Remember to free all frame references for the browser to shut down cleanly. Otherwise data such as cookies or other storage might not be flushed to disk when closing app, and other issues might occur as well. If you store a reference to Frame somewhere in your code then to free it just assign a None value to the variable.

To compare frame objects always use GetIdentifier() method. Do not compare two Frame objects variables directly. There are some edge cases when after the OnBeforeClose event frame objects are no more globally referenced thus a new instance is created that wraps upstream CefFrame object. Frame objects that were globally unreferenced do not have properties of the original Frame object.

Table of contents:

Methods

Copy

Returnvoid

Execute copy in this frame.

Cut

Returnvoid

Execute cut in this frame.

Delete

Returnvoid

Execute delete in this frame.

ExecuteFunction

ParameterType
funcNamestring
..*args
Returnvoid

Call a javascript function asynchronously. This can also call object's methods, just pass "object.method" as funcName. Any valid javascript syntax is allowed as funcName, you could even pass an anonymous function here. For a list of allowed types of arguments see JavascriptBindings.IsValueAllowed() - except function, method and instance. Passing a python function here is not allowed, it is only possible using the JavascriptCallback object.

ExecuteJavascript

ParameterType
jsCodestring
scriptUrl=""string
startLine=1int
Returnvoid

Execute a string of JavaScript code in this frame. The sciptUrl 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 startLine parameter is the base line number to use for error reporting. This function executes asynchronously so there is no way to get the returned value. Calling javascript <> native code synchronously is not possible.

GetBrowser

ReturnBrowser

Returns the browser that this frame belongs to.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame.

GetIdentifier

Returnint

Frame identifiers are unique per render process, they are not globally unique.

Returns < 0 if the underlying frame does not yet exist.

GetBrowserIdentifier

Returnint

Returns the globally unique identifier for the browser hosting this frame.

GetName

Returnstring

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 empty name value.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame. This method should only be called on the UI thread.

GetSource

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's HTML source as a string sent to the specified visitor.

GetText

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's display text as a string sent to the specified visitor.

GetUrl

Returnstring

Returns the url currently loaded in this frame.

IsFocused

Returnbool

Returns true if this is the focused frame. This method should only be called on the UI thread.

IsMain

Returnbool

Returns true if this is the main (top-level) frame.

IsValid

Returnbool

True if this object is currently attached to a valid frame.

LoadString

ParameterType
valuestring
urlstring
Returnvoid

NOTE: LoadString is problematic due to the multi-process model and the need to create a render process (which does not happen with LoadString). It is best to use instead LoadUrl with a data uri, e.g. LoadUrl("data:text/html,some+html+code+here"). Take also a look at a custom resource handler.

Load the contents of |value| 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. LoadString() can be called only after the Renderer process has been created.

LoadUrl

ParameterType
urlstring
Returnvoid

Load the specified |url|.

Paste

Returnvoid

Execute paste in this frame.

Redo

Returnvoid

Execute redo in this frame.

SelectAll

Returnvoid

Execute select all in this frame.

Undo

Returnvoid

Execute undo in this frame.

ViewSource

Returnvoid

Save this frame's HTML source to a temporary file and open it in the default text viewing application.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' cefpython/api/Frame.md at master · Toroto006/cefpython · GitHub
Skip to content

Latest commit

History

History
287 lines (181 loc) · 6.25 KB

File metadata and controls

287 lines (181 loc) · 6.25 KB

API categories | API index

Frame (object)

Remember to free all frame references for the browser to shut down cleanly. Otherwise data such as cookies or other storage might not be flushed to disk when closing app, and other issues might occur as well. If you store a reference to Frame somewhere in your code then to free it just assign a None value to the variable.

To compare frame objects always use GetIdentifier() method. Do not compare two Frame objects variables directly. There are some edge cases when after the OnBeforeClose event frame objects are no more globally referenced thus a new instance is created that wraps upstream CefFrame object. Frame objects that were globally unreferenced do not have properties of the original Frame object.

Table of contents:

Methods

Copy

Returnvoid

Execute copy in this frame.

Cut

Returnvoid

Execute cut in this frame.

Delete

Returnvoid

Execute delete in this frame.

ExecuteFunction

ParameterType
funcNamestring
..*args
Returnvoid

Call a javascript function asynchronously. This can also call object's methods, just pass "object.method" as funcName. Any valid javascript syntax is allowed as funcName, you could even pass an anonymous function here. For a list of allowed types of arguments see JavascriptBindings.IsValueAllowed() - except function, method and instance. Passing a python function here is not allowed, it is only possible using the JavascriptCallback object.

ExecuteJavascript

ParameterType
jsCodestring
scriptUrl=""string
startLine=1int
Returnvoid

Execute a string of JavaScript code in this frame. The sciptUrl 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 startLine parameter is the base line number to use for error reporting. This function executes asynchronously so there is no way to get the returned value. Calling javascript <> native code synchronously is not possible.

GetBrowser

ReturnBrowser

Returns the browser that this frame belongs to.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame.

GetIdentifier

Returnint

Frame identifiers are unique per render process, they are not globally unique.

Returns < 0 if the underlying frame does not yet exist.

GetBrowserIdentifier

Returnint

Returns the globally unique identifier for the browser hosting this frame.

GetName

Returnstring

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 empty name value.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame. This method should only be called on the UI thread.

GetSource

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's HTML source as a string sent to the specified visitor.

GetText

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's display text as a string sent to the specified visitor.

GetUrl

Returnstring

Returns the url currently loaded in this frame.

IsFocused

Returnbool

Returns true if this is the focused frame. This method should only be called on the UI thread.

IsMain

Returnbool

Returns true if this is the main (top-level) frame.

IsValid

Returnbool

True if this object is currently attached to a valid frame.

LoadString

ParameterType
valuestring
urlstring
Returnvoid

NOTE: LoadString is problematic due to the multi-process model and the need to create a render process (which does not happen with LoadString). It is best to use instead LoadUrl with a data uri, e.g. LoadUrl("data:text/html,some+html+code+here"). Take also a look at a custom resource handler.

Load the contents of |value| 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. LoadString() can be called only after the Renderer process has been created.

LoadUrl

ParameterType
urlstring
Returnvoid

Load the specified |url|.

Paste

Returnvoid

Execute paste in this frame.

Redo

Returnvoid

Execute redo in this frame.

SelectAll

Returnvoid

Execute select all in this frame.

Undo

Returnvoid

Execute undo in this frame.

ViewSource

Returnvoid

Save this frame's HTML source to a temporary file and open it in the default text viewing application.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' cefpython/api/Frame.md at master · Toroto006/cefpython · GitHub
Skip to content

Latest commit

History

History
287 lines (181 loc) · 6.25 KB

File metadata and controls

287 lines (181 loc) · 6.25 KB

API categories | API index

Frame (object)

Remember to free all frame references for the browser to shut down cleanly. Otherwise data such as cookies or other storage might not be flushed to disk when closing app, and other issues might occur as well. If you store a reference to Frame somewhere in your code then to free it just assign a None value to the variable.

To compare frame objects always use GetIdentifier() method. Do not compare two Frame objects variables directly. There are some edge cases when after the OnBeforeClose event frame objects are no more globally referenced thus a new instance is created that wraps upstream CefFrame object. Frame objects that were globally unreferenced do not have properties of the original Frame object.

Table of contents:

Methods

Copy

Returnvoid

Execute copy in this frame.

Cut

Returnvoid

Execute cut in this frame.

Delete

Returnvoid

Execute delete in this frame.

ExecuteFunction

ParameterType
funcNamestring
..*args
Returnvoid

Call a javascript function asynchronously. This can also call object's methods, just pass "object.method" as funcName. Any valid javascript syntax is allowed as funcName, you could even pass an anonymous function here. For a list of allowed types of arguments see JavascriptBindings.IsValueAllowed() - except function, method and instance. Passing a python function here is not allowed, it is only possible using the JavascriptCallback object.

ExecuteJavascript

ParameterType
jsCodestring
scriptUrl=""string
startLine=1int
Returnvoid

Execute a string of JavaScript code in this frame. The sciptUrl 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 startLine parameter is the base line number to use for error reporting. This function executes asynchronously so there is no way to get the returned value. Calling javascript <> native code synchronously is not possible.

GetBrowser

ReturnBrowser

Returns the browser that this frame belongs to.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame.

GetIdentifier

Returnint

Frame identifiers are unique per render process, they are not globally unique.

Returns < 0 if the underlying frame does not yet exist.

GetBrowserIdentifier

Returnint

Returns the globally unique identifier for the browser hosting this frame.

GetName

Returnstring

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 empty name value.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame. This method should only be called on the UI thread.

GetSource

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's HTML source as a string sent to the specified visitor.

GetText

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's display text as a string sent to the specified visitor.

GetUrl

Returnstring

Returns the url currently loaded in this frame.

IsFocused

Returnbool

Returns true if this is the focused frame. This method should only be called on the UI thread.

IsMain

Returnbool

Returns true if this is the main (top-level) frame.

IsValid

Returnbool

True if this object is currently attached to a valid frame.

LoadString

ParameterType
valuestring
urlstring
Returnvoid

NOTE: LoadString is problematic due to the multi-process model and the need to create a render process (which does not happen with LoadString). It is best to use instead LoadUrl with a data uri, e.g. LoadUrl("data:text/html,some+html+code+here"). Take also a look at a custom resource handler.

Load the contents of |value| 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. LoadString() can be called only after the Renderer process has been created.

LoadUrl

ParameterType
urlstring
Returnvoid

Load the specified |url|.

Paste

Returnvoid

Execute paste in this frame.

Redo

Returnvoid

Execute redo in this frame.

SelectAll

Returnvoid

Execute select all in this frame.

Undo

Returnvoid

Execute undo in this frame.

ViewSource

Returnvoid

Save this frame's HTML source to a temporary file and open it in the default text viewing application.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' cefpython/api/Frame.md at master · Toroto006/cefpython · GitHub
Skip to content

Latest commit

History

History
287 lines (181 loc) · 6.25 KB

File metadata and controls

287 lines (181 loc) · 6.25 KB

API categories | API index

Frame (object)

Remember to free all frame references for the browser to shut down cleanly. Otherwise data such as cookies or other storage might not be flushed to disk when closing app, and other issues might occur as well. If you store a reference to Frame somewhere in your code then to free it just assign a None value to the variable.

To compare frame objects always use GetIdentifier() method. Do not compare two Frame objects variables directly. There are some edge cases when after the OnBeforeClose event frame objects are no more globally referenced thus a new instance is created that wraps upstream CefFrame object. Frame objects that were globally unreferenced do not have properties of the original Frame object.

Table of contents:

Methods

Copy

Returnvoid

Execute copy in this frame.

Cut

Returnvoid

Execute cut in this frame.

Delete

Returnvoid

Execute delete in this frame.

ExecuteFunction

ParameterType
funcNamestring
..*args
Returnvoid

Call a javascript function asynchronously. This can also call object's methods, just pass "object.method" as funcName. Any valid javascript syntax is allowed as funcName, you could even pass an anonymous function here. For a list of allowed types of arguments see JavascriptBindings.IsValueAllowed() - except function, method and instance. Passing a python function here is not allowed, it is only possible using the JavascriptCallback object.

ExecuteJavascript

ParameterType
jsCodestring
scriptUrl=""string
startLine=1int
Returnvoid

Execute a string of JavaScript code in this frame. The sciptUrl 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 startLine parameter is the base line number to use for error reporting. This function executes asynchronously so there is no way to get the returned value. Calling javascript <> native code synchronously is not possible.

GetBrowser

ReturnBrowser

Returns the browser that this frame belongs to.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame.

GetIdentifier

Returnint

Frame identifiers are unique per render process, they are not globally unique.

Returns < 0 if the underlying frame does not yet exist.

GetBrowserIdentifier

Returnint

Returns the globally unique identifier for the browser hosting this frame.

GetName

Returnstring

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 empty name value.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame. This method should only be called on the UI thread.

GetSource

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's HTML source as a string sent to the specified visitor.

GetText

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's display text as a string sent to the specified visitor.

GetUrl

Returnstring

Returns the url currently loaded in this frame.

IsFocused

Returnbool

Returns true if this is the focused frame. This method should only be called on the UI thread.

IsMain

Returnbool

Returns true if this is the main (top-level) frame.

IsValid

Returnbool

True if this object is currently attached to a valid frame.

LoadString

ParameterType
valuestring
urlstring
Returnvoid

NOTE: LoadString is problematic due to the multi-process model and the need to create a render process (which does not happen with LoadString). It is best to use instead LoadUrl with a data uri, e.g. LoadUrl("data:text/html,some+html+code+here"). Take also a look at a custom resource handler.

Load the contents of |value| 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. LoadString() can be called only after the Renderer process has been created.

LoadUrl

ParameterType
urlstring
Returnvoid

Load the specified |url|.

Paste

Returnvoid

Execute paste in this frame.

Redo

Returnvoid

Execute redo in this frame.

SelectAll

Returnvoid

Execute select all in this frame.

Undo

Returnvoid

Execute undo in this frame.

ViewSource

Returnvoid

Save this frame's HTML source to a temporary file and open it in the default text viewing application.

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); cefpython/api/Frame.md at master · Toroto006/cefpython · GitHub
Skip to content

Latest commit

History

History
287 lines (181 loc) · 6.25 KB

File metadata and controls

287 lines (181 loc) · 6.25 KB

API categories | API index

Frame (object)

Remember to free all frame references for the browser to shut down cleanly. Otherwise data such as cookies or other storage might not be flushed to disk when closing app, and other issues might occur as well. If you store a reference to Frame somewhere in your code then to free it just assign a None value to the variable.

To compare frame objects always use GetIdentifier() method. Do not compare two Frame objects variables directly. There are some edge cases when after the OnBeforeClose event frame objects are no more globally referenced thus a new instance is created that wraps upstream CefFrame object. Frame objects that were globally unreferenced do not have properties of the original Frame object.

Table of contents:

Methods

Copy

Returnvoid

Execute copy in this frame.

Cut

Returnvoid

Execute cut in this frame.

Delete

Returnvoid

Execute delete in this frame.

ExecuteFunction

ParameterType
funcNamestring
..*args
Returnvoid

Call a javascript function asynchronously. This can also call object's methods, just pass "object.method" as funcName. Any valid javascript syntax is allowed as funcName, you could even pass an anonymous function here. For a list of allowed types of arguments see JavascriptBindings.IsValueAllowed() - except function, method and instance. Passing a python function here is not allowed, it is only possible using the JavascriptCallback object.

ExecuteJavascript

ParameterType
jsCodestring
scriptUrl=""string
startLine=1int
Returnvoid

Execute a string of JavaScript code in this frame. The sciptUrl 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 startLine parameter is the base line number to use for error reporting. This function executes asynchronously so there is no way to get the returned value. Calling javascript <> native code synchronously is not possible.

GetBrowser

ReturnBrowser

Returns the browser that this frame belongs to.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame.

GetIdentifier

Returnint

Frame identifiers are unique per render process, they are not globally unique.

Returns < 0 if the underlying frame does not yet exist.

GetBrowserIdentifier

Returnint

Returns the globally unique identifier for the browser hosting this frame.

GetName

Returnstring

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 empty name value.

GetParent

ReturnFrame

Returns the parent of this frame or None if this is the main (top-level) frame. This method should only be called on the UI thread.

GetSource

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's HTML source as a string sent to the specified visitor.

GetText

ParameterType
visitorStringVisitor
Returnvoid

Retrieve this frame's display text as a string sent to the specified visitor.

GetUrl

Returnstring

Returns the url currently loaded in this frame.

IsFocused

Returnbool

Returns true if this is the focused frame. This method should only be called on the UI thread.

IsMain

Returnbool

Returns true if this is the main (top-level) frame.

IsValid

Returnbool

True if this object is currently attached to a valid frame.

LoadString

ParameterType
valuestring
urlstring
Returnvoid

NOTE: LoadString is problematic due to the multi-process model and the need to create a render process (which does not happen with LoadString). It is best to use instead LoadUrl with a data uri, e.g. LoadUrl("data:text/html,some+html+code+here"). Take also a look at a custom resource handler.

Load the contents of |value| 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. LoadString() can be called only after the Renderer process has been created.

LoadUrl

ParameterType
urlstring
Returnvoid

Load the specified |url|.

Paste

Returnvoid

Execute paste in this frame.

Redo

Returnvoid

Execute redo in this frame.

SelectAll

Returnvoid

Execute select all in this frame.

Undo

Returnvoid

Execute undo in this frame.

ViewSource

Returnvoid

Save this frame's HTML source to a temporary file and open it in the default text viewing application.