Emacsは、必要なサポートライブラリを用いてビルドされ、グラフィカルターミナル上で動作している場合、GTK+
WebKitウィジェットなどのネイティブウィジェットをEmacsバッファに表示できます。Emacsが埋め込みウィジェットの表示をサポートしているか確認するには、xwidget-internal機能が利用可能であるかを確認してください(機能を参照)。
埋め込みウィジェットをバッファに表示するには、まず xwidget オブジェクトを作成し、そのオブジェクトを display テキストまたはオーバーレイプロパティの表示指定子として使用する必要があります(display
プロパティを参照)。
組み込みウィジェットは、内部で発生した変更をLispコードに通知するイベントを送信できます。(Xwidgetイベントを参照)。
これにより xwidget オブジェクトが生成され、返されます。buffer が省略された場合、または
nil が指定された場合は、現在のバッファがデフォルトとなります。buffer で存在しないバッファを指定した場合は、そのバッファが作成されます。type は xwidget コンポーネントのタイプを識別するもので、以下のいずれかになります:
webkitWebKitコンポーネント。
引数 width と height はウィジェットのサイズをピクセル単位で指定し、文字列である title はそのタイトルを指定します。related は WebKit ウィジェット内部で使用され、新しく作成されたウィジェットが設定やサブプロセスを共有すべき別の WebKit ウィジェットを指定します。
返されるxwidgetは、そのバッファとともに破棄されます(バッファの破棄を参照)。また、kill-xwidgetを使用して破棄することも可能です。一度破棄されると、それへのすべての参照がなくなるまで、xwidgetはLispオブジェクトとして存在し続け、displayプロパティとして機能することがありますが、アクティブなxwidgetに対して実行可能な操作のほとんどは利用できなくなります。
この関数は、object が xwidget であれば t を、そうでなければ nil を返します。
この関数は、object が終了されていない xwidget である場合は t を、それ以外の場合は nil を返します。
この関数は、xwidgetをバッファから削除し、保持しているウィンドウシステムリソースを解放することで、これを終了させます。
この関数は、xwidget のプロパティリストを返します。
この関数は、xwidget のプロパティリストを、plist で指定された新しいプロパティリストに置き換えます。
この関数はxwidgetのバッファを返します。xwidgetがキルされている場合は、nilを返します。
この関数は、xwidget のバッファを buffer に設定します。
This function returns a list of xwidget objects associated with the buffer, which can be specified as a buffer object or a
name of an existing buffer, a string. The value is nil if buffer contains no
xwidgets.
この関数は、指定された xwidget 内の指定された uri を参照します。uri は、ファイル名または URL を指定する文字列です。
この関数は、xwidget で指定されたブラウザウィジェットに、指定された JavaScript
script を実行させます。
この関数は、xwidget のタイトルを文字列として返します。
この関数は、指定された xwidget を widthxheight ピクセルのサイズにリサイズします。
この関数は、xwidget の希望サイズを (width height)
形式のリストとして返します。寸法はピクセル単位です。
この関数は、xwidget の属性を [type title width height]
形式のベクトルとして返します。属性は通常、xwidget の作成時に make-xwidget
によって決定されます。
この関数を使用すると、終了時や、xwidget が関連付けられているバッファをキルする前に、Emacs
がユーザーに確認を求めるように設定できます。flag が nil 以外の場合は Emacs はユーザーに確認を求めますが、それ以外の場合は求めません。
この関数は、xwidget の query-on-exit フラグの現在の設定(t または nil)を返します。
event から xwidget へ入力イベントを送信します。実行される具体的な動作はプラットフォームによって異なります。入力イベントを参照してください。
オプションで、イベントが発生したフレームを frame 経由で渡すことができます。X11 では、frame が nil であり、かつ選択されたフレームが
X-Windows フレームでない場合、キーイベント内の修飾キーは考慮されません。
GTKでは、キーボードおよびファンクションキーのイベントのみがサポートされています。マウス、モーション、クリックイベントはLispコードを介さずにxwidgetにディスパッチされるため、この関数を呼び出す必要はないはずです。
WebKitウィジェット xwidget で、文字列 query をクエリとしてインクリメンタル検索を開始します。case-insensitive は検索が大文字小文字を区別しないかどうかを、backwards はドキュメントの先頭に向かって逆方向に検索を行うかどうかを、wrap-around はドキュメントの末尾で検索を終了するかどうかをそれぞれ指定します。
検索クエリが既に存在する状態でこの関数を呼び出した場合、ここで指定したクエリが既存のクエリを上書きします。
検索クエリを停止するには、xwidget-webkit-finish-search を使用します。
次の検索結果をxwidgetに表示します。この関数は、xwidgetからxwidget-webkit-searchの間で検索クエリがまだ開始されていない場合、エラーを通知します。
xwidget-webkit-searchが呼び出された際にwrap-aroundがnilではなかった場合、ドキュメントの末尾に達すると、検索は先頭から再開されます。
直前の検索結果をxwidgetに表示します。xwidgetからxwidget-webkit-searchの間で検索クエリが既に開始されていない場合、この関数はエラーを返します。
xwidget-webkit-searchが呼び出された際にwrap-aroundがnilではなかった場合、文書の先頭に到達した時点で、検索は文書の末尾から再開されます。
xwidget-webkit-search で開始された検索操作を xwidget で完了させます。現在進行中のクエリがない場合、この関数はエラーを通知します。
文字列 text を、WebKit xwidget であるはずの xwidget に読み込みます。text 内の HTML マークアップは、テキストのレンダリング時に xwidget によって処理されます。
オプション引数 base-uri(文字列を指定)は、text 内の相対リンクの解決に使用する、text で参照されるウェブリソースの絶対パスを指定します。
WebKitウィジェットであるxwidgetに、ナビゲーション履歴のrel-pos番目の要素を読み込ませてください。
rel-pos が 0 の場合、代わりに現在のページが再読み込みされます。
xwidget のナビゲーション履歴を、前後それぞれ最大 limit 件まで返します。指定しない場合、limit のデフォルト値は 50 です。
戻り値は (back here forward)
形式のリストであり、here は現在のナビゲーション項目、back は現在のナビゲーション項目より前に WebKit が記録した項目のリスト、forward は現在のナビゲーション項目より後に記録された項目のリストとなります。back、here、forward はいずれも nil となり得ます。
hereがnilである場合は、まだ項目が記録されていないことを意味し、backまたはforwardがnilである場合は、それぞれ現在の項目の前後に記録された履歴がないことを意味します。
ナビゲーション項目自体は、(idx title uri)
形式のリストとなっています。これらのリストにおいて、idx は xwidget-webkit-goto-history に渡すことができるインデックス、title は項目の人間が読みやすいタイトル、uri
は項目のURIです。通常、ユーザーが特定の履歴項目にアクセスするために uri
を手動で読み込む必要はありません。代わりに、idx をインデックスとして xwidget-webkit-goto-history に渡す必要があります。
WebKitウィジェット xwidget が表示するページが完全に読み込まれるまでに、あとどれくらいのデータの転送が残っているかの推定値を返します。
返される値は、0.0から1.0の範囲の浮動小数点数です。
WebKitウィジェット xwidget に file でクッキーを保存させる。
file は絶対ファイル名である必要があります。この新しい設定は、make-xwidget の related 引数として
xwidget を指定して作成されたすべての xwidget
、およびそれらに関連するウィジェットにも適用されます。
この関数が xwidget または関連ウィジェットで少なくとも1回呼び出されない場合、xwidget はクッキーをディスクに一切保存しません。
ページ読み込み処理の一環として、WebKitウィジェット xwidget で進行中のデータ転送をすべて終了します。ページが読み込まれていない場合、この関数は何も行いません。