webEngineFrame QML Value Type

webEngineFrame は、ページフレームに関する情報と制御を提供します。詳細...

Import Statement: import QtWebEngine
Since: Qt 6.8
In C++: QWebEngineFrame

プロパティ

メソッド

詳細説明

ウェブエンジンフレームは、<frame><iframe> HTML 要素によって作成されるような、ウェブページ内の単一のフレームを表します。アクティブなWebEngineView には、1つ以上のフレームがツリー構造で配置されています。このツリーのルートである最上位のフレームには、ビューのmainFrame プロパティからアクセスできます。

フレームの寿命は、最大でもそれを生成したWebEngineView オブジェクトと同じ長さです。しかし、フレームは、ナビゲーションやスクリプトの実行などによって、自発的かつ動的に作成・削除されることがあります。

プロパティの説明

htmlName : string [read-only]

フレームのname HTML 属性の値、または何もない場合は空文字列を返します。

フレームが見つからない場合は、空の文字列を返します。

nameも参照してください


isMainFrame : bool [read-only]

このオブジェクトがページのメインフレームを表している場合はtrue を、そうでない場合はfalse を返します。


isValid : bool [read-only]

このオブジェクトが既存のフレームを表している場合はtrue を返し、そうでない場合はfalse を返します。

一度無効となったフレームが再び有効になることはありません。


name : string [read-only]

フレーム名を返します。つまり、JavaScriptでwindow.name

フレームが見つからない場合は、空の文字列を返します。

htmlNameも参照してください


size : size [read-only]

ビューポート内のフレームのサイズを返します。

フレームが見つからない場合は、寸法 (-1, -1) のデフォルトサイズを返します。


url : url [read-only]

このフレームに現在読み込まれているコンテンツのURLを返します。

フレームが見つからなかった場合、空のURLを返す。


メソッドの説明

void runJavaScript(string script, uint worldId, variant callback)

void runJavaScript(string script, variant callback)

ページの DOM が構築されているかどうかをチェックせずに、script に含まれる JavaScript コードをこのフレーム上で実行します。

ページ上で実行される他のスクリプトとの競合を避けるため、スクリプトが実行されるワールドはworldId で指定されます。ワールドIDの値は、QWebEngineScript::ScriptWorldId で指定されたものと同じで、0256 の間にある。world IDを省略すると、スクリプトはMainWorld で実行される。

callback パラメータはオプションである。コールバック関数を指定すると、スクリプトの実行終了後に呼び出されます。

frame.runJavaScript("document.title", function(result) { console.log(result); });

結果値としてJavaScriptから返せるのは、プレーンなデータだけです。サポートされるデータ型には、すべてのJSONデータ型のほか、たとえばDateArrayBuffer があります。サポートされていないデータ型には、FunctionPromise などがある。

スクリプトは、ロードされたサイトの一部である他のスクリプトと同じ世界で実行されます。

警告 Web コンテンツのレンダリングがブロックされる可能性があるため、長 いルーチンをコールバック関数で実行しないでください。

スクリプトの注入の詳細については、スクリプトの注入を参照してください。スクリプトを注入する別の方法については、WebEngineView::userScripts を参照してください。


void printToPdf(string filePath)

フレームの現在のコンテンツをPDFドキュメントに印刷し、filePath の下に保存します。生成されるドキュメントのページサイズは A4 で、向きは縦になります。

こ の メ ソ ッ ド は、 Web ページ を PDF へ印刷す る ための非同期 リ ク エ ス ト を発行 し 、 ただちに返 り ます。リクエストの結果を知るには、シグナルWebEngineView::pdfPrintingFinished() に接続してください。

WebEngineView::pdfPrintingFinished()も参照してください


void printToPdf(variant callback)

フレームの現在の内容を PDF ドキュメントに印刷し、バイト配列で返します。できあがったドキュメントは A4 のページサイズで縦向きになります。

callback は文字列パ ラ メ タ を と る 必要があ り ます。この文字列は、印刷に成功した場合はドキュメントのデータを含み、そうでない場合は空の文字列を含みます。


本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。