webEngineFrame QML Value Type

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

プロパティ

• children : list<webEngineFrame> (since QtWebEngine 6.10)
• htmlName : string
• isMainFrame : bool
• isValid : bool
• name : string
• size : size
• url : url

方法

• void printToPdf(string filePath)
• void printToPdf(variant callback)
• void runJavaScript(string script, variant callback)
• void runJavaScript(string script, uint worldId, variant callback)

詳細説明

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

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

プロパティ・ドキュメント

children : list<webEngineFrame> [read-only, since QtWebEngine 6.10]

フレームの子のリストを任意の順序で返します。

フレームが見つからなかった場合は、空のリストを返します。

このプロパティは QtWebEngine 6.10 で導入されました。

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]

ビューポート内のフレームのサイズ。スケールファクターが100%以外のデバイスでは、これは画面上のサイズとは一致せず、代わりにスケーリングが適用される前のサイズとなる。そのような場合、サイズは小数値を含むことがあります。

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

url : url [read-only]

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

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

メソッドの説明

void printToPdf(string filePath)

フレームの現在の内容を PDF ドキュメントに印刷し、filePath に保存します。出来上がったドキュメントはA4ページサイズで縦向きになります。

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

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

void printToPdf(variant callback)

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

callback は文字列パラメータを取らなければなりません。こ の文字列は、 印刷に成功 し た と き は文書のデー タ を内容 と し 、 そ う でなければ空文字列を内容 と し ます。

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

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

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

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

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

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

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