継承図

協調図

解説

■ 仕様と使い方

SFZWebBrowserControl クラスは、以下の機能を備える簡易ウェブブラウザコントロールです。

SFZWebBrowserControl クラスは、 内部に SFYWebBrowserWidget インスタンスを保持します。 その SFYWebBrowserWidget クラスの HTML レンダリングに関する機能は BREW API IHtmlViewer を使用して実装されています。

簡易ウェブブラウザコントロールの枠線の色や表示に関するデザインを変更したい場合は、 SFZWebBrowserControl::HandleRenderRequest 関数をオーバーライドします。

	HTTP/HTTPS 接続のタイムアウト
	接続時のタイムアウトを行うには、SFZWebBrowserControl::SetTimeoutCallback 関数でコールバックを登録し、SFZWebBrowserControl::SetTimeoutMillisecond 関数でタイムアウトの時間を設定します。

	致命的なエラー
	通知コールバック中やレジューム時などで処理を継続できない致命的なエラーが発生したとき、SFZWebBrowserControl::HandleError 関数が起動されます。 このとき、この関数をオーバーライドして、SFZWebBrowserControl インスタンスを終了する等の処理を記述する必要があります。

	mif ファイルの特権設定
	SFZWebBrowserControl クラスを利用するには、 mif ファイルの特権レベル設定で「Web アクセス」の項目をオンにする必要があります。 独自のルート証明書ファイルを読み込む場合は、さらに「ファイル」の項目もオンにします。

■ サンプルコード

以下は、 簡易ブラウザ（SFZWebBrowserControl クラス）を利用してウィンドウ内に HTML 文書を表示するコードです。

SFMTYPEDEFRESPONDER(MyWindow)
class MyWindow : public SFZWindow{
    SFMSEALRESPONDER(MyWindow)
    SFMRESPONDERINSTANTIATEFOUR(MyWindow, SFZWindow, SFYContainer, SFYWidget, SFYResponder)
public:
    // MyWindow のタイプ
    enum CodeEnum {
        CODE_TYPE = four_char_code('M', 'W', 'N', 'D')
    };
    SFMTYPEDEFTYPE(CodeEnum)
public:
    static MyWindowSmp NewInstance(SFCErrorPtr exception = null);
    // MyWindow 内のレスポンダ（簡易ウェブブラウザ）を作成する関数
    SFCError Make(Void); 

protected:
    explicit MyWindow(Void) static_throws;
    virtual ~MyWindow(Void);

    // 簡易ウェブブラウザ
    SFZWebBrowserControlSmp _browser;

};

// コンストラクタ
MyWindow::MyWindow(Void) static_throws
{
    if (static_try()) {
        // レスポンダのタイプを設定する
        SetType(CODE_TYPE);
   }
}

// デストラクタ
MyWindow::~MyWindow(Void)
{
}

// MyWindow 内のレスポンダ（簡易ウェブブラウザ）を作成する関数
SFCError MyWindow::Make(Void)
{
    SFCError error;

    // 簡易ブラウザに表示する HTML 文書
    SFXAnsiString buffer(
         "BrowserControl<br /><br />"
         "<a href=\"/example/tabbrowser/\">ソフィアクレイドル</a><br /><br />"
    );

    // 簡易ウェブブラウザの作成
    if ((_browser = SFZWebBrowserControl::NewInstance(&error)) != null) {

        // 親レスポンダを MyWindow に設定する
        if ((error = _browser->SetParent(GetThis())) == SFERR_NO_ERROR) {

            // 実領域を MyWindow のローカル領域に設定する
            // ※ 以下の文を実行する前に、MyWindow のローカル領域を設定していないと、
            //    実領域は空の矩形領域となり何も表示されない
            _browser->SetRealBound(GetLocalBound());

            // 状態を「可視＋活性＋操作可能＋フォーカス」にまとめて設定する
            _browser->SetState(true, true, true, true);

            // ブラウザコントロールを開く
            // * SophiaFramework 5.3.0 からこの処理が必要になります。
            _browser->Open();

            // HTML 文書を読み込む
            _browser->Load(buffer);

            // 簡易ウェブブラウザを最前面に移動する
            // ※ MyWindow の子レスポンダは簡易ウェブブラウザだけなので省略可
            _browser->ToFront();
        }
    }
    return error;
}

図 469. 実行結果

参照

SFYControl | SFBHTMLViewer | SFZWebBrowserControl::SetRequestHeader | SFZWebBrowserControl::SetTimeoutCallback | SFZWebBrowserControl::SetTimeoutMillisecond | SFZWebBrowserControl::HandleError | BREW API IHtmlViewer | BREW API IWeb

メンバ

解説

このコンストラクタは、SFZWebBrowserControl インスタンスの初期化処理を行います。 詳細は、内部実装のコードを参照してください。

内部実装

このコンストラクタの内部実装は以下の通りです。

/*protected */SFZWebBrowserControl::SFZWebBrowserControl(Void) static_throws
{
    static SFXEventRange::AtomRecConst          range[] = {
        { SFEVT_RESPONDER_BROWSER_NOTIFY, SFEVT_RESPONDER_BROWSER_NOTIFY, SFP16_BEGIN, SFP16_END }
    };
    SFYHandler::RuleRec                         rule[lengthof(range)];
    SFCError                                    error;

    if (static_try()) {
        SetType(CODE_TYPE);
        if ((_widget = SFYWebBrowserWidget::NewInstance(&error)) != null) {
            static_throw(_widget->SetParent(GetThis()));
            if (static_try()) {
                rule[0].spp = XANDLER_FUNCTION(OnNotify);
                rule[0].reference = this;
                static_throw(_widget->RegisterHandler(atomic_cast(range), rule, lengthof(range)));
                if (static_try()) {
                    _widget->SetState(true, true, true, true);
                }
            }
        }
        else {
            static_throw(error);
        }
    }
}// SFZWebBrowserControl::SFZWebBrowserControl //

/*private */XANDLER_IMPLEMENT_VOIDBROWSERNOTIFY(SFZWebBrowserControl, OnNotify, invoker, reason, notify)
{
    switch (reason) {
        case SFYWebBrowserWidget::NOTIFY_RESPONSE:
            ResponseNotifyHandler(*notify);
            break;
        case SFYWebBrowserWidget::NOTIFY_DONE:
            DoneNotifyHandler(*notify);
            break;
        case SFYWebBrowserWidget::NOTIFY_JUMP_SUBMIT:
            JumpNotifyHandler(*notify);
            break;
        case SFYWebBrowserWidget::NOTIFY_FOCUS:
            FocusNotifyHandler(*notify);
            break;
        case SFYWebBrowserWidget::NOTIFY_PAGE_DONE:
            break;
        case SFYWebBrowserWidget::NOTIFY_CONTENT_DONE:
            break;
        case SFYWebBrowserWidget::NOTIFY_FATAL_ERROR:
            HandleError(notify->u.nDone);
            break;
    }
    return;
}// XANDLER_IMPLEMENT_VOIDBROWSERNOTIFY(OnNotify) //

参照

SFYWebBrowserWidget | SFYWebBrowserWidget::NotifyEnum | SFZWebBrowserControl::ResponseNotifyHandler | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::JumpNotifyHandler | SFZWebBrowserControl::FocusNotifyHandler | SFZWebBrowserControl::HandleError

解説

何も行いません。

参照

SFYWebBrowserWidget::~SFYWebBrowserWidget

戻り値

解説

この関数は内部で保持する IHTMLViewer オブジェクトの領域を調整します。

通常は、実領域または仮想領域が変更されたときに自動的に呼び出されるため呼び出す必要がありません。

その他の要因で自身のレスポンダのグローバル領域が変更される場合は、明示的な呼び出しが必要です。

解説

この関数は、Web サーバーへの接続をキャンセルします。その際、接続タイムアウトのタイマーもキャンセルされます。

この関数は、HTTP/HTTPS 接続が SFXHTTPConnection::STATE_CONNECT の状態のときに有効です。

この関数は、SFZWebBrowserControl::Close 関数の内部からも呼び出されます。

参照

SFZWebBrowserControl::Close

解説

この関数は、履歴リストを空にします。

参照

SFYWebBrowserWidget::ClearHistory

解説

この関数は、HTTP/HTTPS 接続を閉じます。

HTTP/HTTPS 接続の状態は、SFXHTTPConnection::STATE_CLOSE になります。

参照

SFYWebBrowserWidget::Close

引数

解説

この関数は、レンダリングが終了したときに呼び出されるハンドラです。

デフォルトの実装は、何も行いません。

使用例

以下は、オーバーライドしてエラー処理を行うコードです。

#include <SFZResponder/SFZControl/SFZBrowserControl/SFZWebBrowserControl.hpp>

SFMTYPEDEFRESPONDER(MyBrowserControl)
class MyBrowserControl : public SFZWebBrowserControl {
    SFBSEALRESPONDER(MyBrowserControl)
    SFMRESPONDERINSTANTIATEFOUR(MyBrowserControl, SFZWebBrowserControl, SFYControl, SFYWidget, SFYResponder)
public:
    static MyBrowserControlSmp NewInstance(SFCErrorPtr exception = null);
protected:
    explicit MyBrowserControl(Void) static_throws;
    virtual ~MyBrowserControl(Void);
    virtual Void DoneNotifyHandler(NotifyRef notify) {
        if (notify.u.nDone != SFERR_NO_ERROR) {
            // エラー処理を行う
        }
    }
};

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZWebBrowserControl::DoneNotifyHandler(NotifyRef notify)
{
    unused(notify);
    return;
}// SFZWebBrowserControl::DoneNotifyHandler //

参照

SFZWebBrowserControl::Notify | SFZWebBrowserControl::FocusNotifyHandler | SFZWebBrowserControl::JumpNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler

引数

戻り値

解説

この関数は、現在表示中のページから、指定された要素を検索します。

	注意
	この関数は、内部で SFBHTMLViewer::FindElem 関数（ BREW API IHTMLVIEWER_FindElem）を呼び出します。

	Tip
	戻り値（要素の位置）は、SFZWebBrowserControl::GetElementText 関数で使用します。

参照

SFZWebBrowserControl::GetElementText | BREW API IHTMLVIEWER_FindElem

引数

解説

この関数は、カーソルが移動したときに呼び出されるハンドラです。

デフォルトの実装以外の処理を行いたい場合は、 この関数をオーバーライドします。

デフォルトの実装は、何も行いません。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZWebBrowserControl::FocusNotifyHandler(NotifyRef notify)
{
    unused(notify);
    return;
}// SFZWebBrowserControl::FocusNotifyHandler //

参照

SFZWebBrowserControl::Notify | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::JumpNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler

戻り値

Basic 認証の基準 URL

解説

Basic 認証の基準 URL を取得します。

SFZWebBrowserControl::SetAuthorizeData 関数で設定された値が取得されます。

参照

SFZWebBrowserControl::SetAuthorizeData

戻り値

HTTP レスポンスヘッダーの Content-Encoding フィールドの値

解説

この関数は、HTTP/HTTPS 接続の HTTP レスポンスヘッダーの Content-Encoding フィールドの値を取得します。 HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、 空文字列(SFXAnsiString::EmptyInstance())を返します。

戻り値

HTTP レスポンスヘッダーの Content-Length フィールドの値

解説

この関数は、HTTP/HTTPS 接続の HTTP レスポンスヘッダーの Content-Length フィールドの値を取得します。

HTTP レスポンスヘッダーに Content-Length フィールドが存在しない場合、または HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、 -1 を返します。

戻り値

HTTP レスポンスヘッダーの Content-Type フィールド

解説

この関数は、HTTP/HTTPS 接続の HTTP レスポンスヘッダーの Content-Type フィールドを取得します。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、 空文字列(SFXAnsiString::EmptyInstance) を返します。

戻り値

現在表示しているページのタイトル。

解説

この関数は、現在表示しているページのタイトルを取得します。

参照

SFZWebBrowserControl::GetCurrentURL

戻り値

現在表示しているページの URL。

解説

この関数は、現在表示しているページの URL を取得します。

参照

SFZWebBrowserControl::GetCurrentTitle

戻り値

HTTP レスポンスヘッダーの Date フィールドの値(SFXDate)

解説

この関数は、HTTP/HTTPS 接続の HTTP レスポンスヘッダーの Date フィールドの値(SFXDate)を取得します。

HTTP レスポンスヘッダーに Date フィールドが存在しない場合、 または HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、SFXDate(0) を返します。

参照

SFXDate

引数

戻り値

指定された要素の内容。

解説

この関数は、現在表示しているページから指定された要素の内容を取得します。

要素の中身がない場合は空文字列 SFXAnsiString::EmptyInstance() を返します。

	注意
	この関数は、内部で SFBHTMLViewer::GetElemText 関数（ BREW API IHTMLVIEWER_GetElemText）を呼び出します。

参照

SFZWebBrowserControl::FindElement | SFXAnsiString::EmptyInstance | SFBHTMLViewer::GetElemText | BREW API IHTMLVIEWER_GetElemText

戻り値

HTTP レスポンスヘッダーの Expires フィールドの値 (SFXDate)

解説

この関数は、HTTP/HTTPS 接続の HTTP レスポンスヘッダーの Expires フィールドの値(SFXDate)を取得します。 HTTP レスポンスヘッダーに Expires フィールドが存在しない場合、 または HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、 SFXDate(0) を返します。

参照

SFYWebBrowserWidget::GetExpires

戻り値

インデントの幅。[単位: ピクセル]

解説

この関数は、HTML 表示のインデントの幅を取得します。[単位: ピクセル]

	注意
	この関数は、内部で引数のオプション ID に "HVOPT_N_INDENT" を指定して BREW API IHTMLVIEWER_GetOption 関数を呼び出します。

参照

SFZWebBrowserControl::SetIndent | SFBHTMLViewer::GetOption | BREW API IHTMLVIEWER_GetOption

戻り値

HTTP レスポンスヘッダーの Last-Modified フィールドの値 (SFXDate)

解説

この関数は、HTTP/HTTPS 接続の HTTP レスポンスヘッダーの Last-Modified フィールドの値 (SFXDate) を取得します。

HTTP レスポンスヘッダーに Last-Modified フィールドが存在しない場合、または HTTP 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、SFXDate(0) を返します。

参照

SFYWebBrowserWidget::GetLastModified

戻り値

リンク文字列の表示色。

解説

この関数は、HTML 表示のリンクの文字の表示色を取得します。

	注意
	この関数は、内部で引数のオプション ID に "HVOPT_RGB_LINK" を指定して BREW API IHTMLVIEWER_GetOption 関数を呼び出します。

参照

SFZWebBrowserControl::SetLinkColor | SFZWebBrowserControl::GetTextColor | SFBHTMLViewer::GetOption | BREW API IHTMLVIEWER_GetOption

戻り値

HTTP リクエストメソッド

解説

この関数は、SFZWebBrowserControl::SetMethod 関数で設定した、HTTP/HTTPS 接続の HTTP リクエストメソッドを取得します。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、空文字列(SFXAnsiString::EmptyInstance())を返します。

参照

SFYWebBrowserWidget::GetMethod | SFZWebBrowserControl::SetMethod

戻り値

段落間の行間の長さ。[単位: ピクセル]

解説

この関数は、HTML 表示の段落間の行間の長さを取得します。[単位: ピクセル]

	注意
	この関数は、内部で引数のオプション ID に "HVOPT_N_VSPACE" を指定して BREW API IHTMLVIEWER_GetOption 関数を呼び出します。

参照

SFZWebBrowserControl::SetParagraphSpacing | SFBHTMLViewer::GetOption | BREW API IHTMLVIEWER_GetOption

戻り値

Basic 認証のパスワード

解説

Basic 認証のパスワードを取得します。

SFZWebBrowserControl::SetAuthorizeData 関数で設定された値が取得されます。

参照

SFZWebBrowserControl::SetAuthorizeData

戻り値

HTTP/HTTPS 接続のプロキシサーバー(SFXSocketAddress)

解説

この関数は、SFXHTTPConnection::SetProxyServer 関数で設定した、HTTP/HTTPS 接続のプロキシサーバー(SFXSocketAddress)を取得します。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、またはプロキシサーバーが設定されていない場合、SFXSocketAddress::EmptyInstance() を返します。

参照

SFXSocketAddress | SFXHTTPConnection::SetProxyServer

戻り値

HTTP リクエストボディを管理する SFBSource インスタンス

解説

この関数は、SFXHTTPConnection::SetRequestContent 関数を使用して設定した、HTTP/HTTPS 接続の HTTP リクエストボディを管理する SFBSource インスタンスを取得します。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、または何も設定されていない場合、SFBSourceSmp::EmptyInstance() の参照を返します。

参照

SFXHTTPConnection::SetRequestContent | SFBSource

戻り値

HTTP リクエストフラグ

解説

この関数は、SFZWebBrowserControl::SetRequestFlag 関数で設定した、 HTTP リクエストフラグを取得します。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、 0 を返します。

参照

SFZWebBrowserControl::SetRequestFlag | SFZWebBrowserControl::Open | BREW API IWEB_GetResponse

戻り値

HTTP リクエストヘッダー

解説

この関数は、HTTP リクエストヘッダーを取得します。 フィールド名を指定して個別に取得することも可能です。 引数に何も指定しない場合は、全ての HTTP リクエストヘッダーを取得します。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、、 空文字列(SFXAnsiString::EmptyInstance())、または 空のプロパティ(SFXProperty::EmptyInstance()) を返します。

参照

SFZWebBrowserControl::SetRequestHeader | SFXProperty | SFXAnsiString

戻り値

HTTP レスポンスボディを管理する SFBSource インスタンス

解説

この関数は、HTTP/HTTPS 接続の HTTP レスポンスボディを管理する SFBSource インスタンスを取得します。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、 SFBSourceSmp::EmptyInstance() を返します。

	Tip
	HTTP/HTTP 接続確立後、この関数を使用して HTTP レスポンスボディを取得することが可能です。

	注意
	SFZWebBrowserControl::GetStreamReader 関数は、 SFZWebBrowserControl::GetResponseContent 関数の戻り値である SFBSource インスタンスからストリームを取得しています。

	HTTP レスポンスボディの読み込み
	SFZWebBrowserControl::GetResponseContent 関数を使用して HTTP レスポンスボディを読み込む場合は、 SFZWebBrowserControl::GetStreamReader 関数を使えません。 逆に、SFZWebBrowserControl::GetStreamReader 関数を使用して HTTP レスポンスボディを読み込む場合は、 SFZWebBrowserControl::GetResponseContent 関数を使えません。

参照

SFZWebBrowserControl::GetStreamReader | SFBSource | SFZWebBrowserControl::Navigate

戻り値

HTTP レスポンスフラグ

解説

この関数は、HTTP/HTTPS 接続の HTTP レスポンスフラグを取得します。

HTTP レスポンスフラグは、以下のフラグの論理和として表現されます。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、 0 を返します。

参照

SFZWebBrowserControl::SetRequestFlag | SFZWebBrowserControl::Navigate | SFBWebResp | BREW API IWEBRESP_GetOpt

戻り値

HTTP レスポンスヘッダー

解説

この関数は、HTTP レスポンスヘッダーを取得します。 フィールド名を指定して個別に取得することも可能です。 引数に何も指定しない場合は、全ての HTTP レスポンスヘッダーを取得します。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、 空文字列(SFXAnsiString::EmptyInstance())、 空のプロパティ(SFXProperty::EmptyInstance())を返します。

参照

SFZWebBrowserControl::Navigate | SFXProperty | SFXAnsiString

戻り値

HTTP ステータスコード

解説

この関数は、HTTP ステータスコードを取得します。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、 -1 を返します。

HTTP/HTTPS 接続が確立されている場合、 この関数の戻り値は、BREW API の WebRespInfo 内のフィールド nCode と同じです。

nCode は、プロトコルエラーコードまたは「負の」 WEB_ERROR エラーコードを表します。 正の値はサーバーから返された値であり、負のエラーコードはシステムエラーを表します。 戻り値を WEB_ERROR_MAP() に渡すことによって、BREW の WEB_ERROR エラーコードを取得できます。 また、WEB_ERROR_SUCCEEDED() に渡すことによって操作が成功したかどうか判定できます。

	注意
	WEB_ERROR エラーコードの詳細については、 AEEError.h を参照してください。

参照

SFZWebBrowserControl::Navigate | BREW API WebRespInfo | BREW API WEB_ERROR_MAP | BREW API WEB_ERROR_SUCCEEDED

戻り値

内部で使用される SFBWeb インスタンス

解説

この関数は、このコントロールが内部で保持する　 BREW API IWeb インターフェースを取得します。

BREW API IWeb インターフェースが設定されていない場合は、null を返します。

	WebOpt 指定時の注意
	他の用途で利用するまでは、IWeb インターフェースに設定した WebOpt データを保持する必要があります。 詳しくは、BREW API リファレンス、IWeb インターフェースの「 WEBOPT の寿命に関する注意事項 」を参照してください。

	サスペンド時の振る舞い
	サスペンドしたとき、WebOpt の情報はリセットされ IWeb インターフェースを内部で作成する設定(デフォルト状態)に戻ります。 サスペンド前の IWeb インターフェースを使うには、レジューム時に WebOpt データを再設定する必要があります。

参照

SFBWeb | BREW API IWeb

戻り値

この HTTP/HTTPS 接続が内部で管理する SFBWebResp インスタンス

解説

この関数は、HTTP/HTTPS 接続が内部で管理する SFBWebResp インスタンスを取得します。

参照

SFBWebResp | BREW API IWebResp

戻り値

スクロールバーの幅。[単位: ピクセル]

解説

この関数は、HTML 表示のスクロールバーの幅を取得します。[単位: ピクセル]

	注意
	この関数は、内部で引数のオプション ID に "HVOPT_N_SBWIDTH" を指定して BREW API IHTMLVIEWER_GetOption 関数を呼び出します。

参照

SFZWebBrowserControl::SetScrollbarWidth | SFBHTMLViewer::GetOption | BREW API IHTMLVIEWER_GetOption

戻り値

解説

この関数は、HTTP/HTTPS 接続の HTTP レスポンスボディを読み込むためのデータ受信用ストリームを取得します。

size 引数を指定する場合、ストリームバッファは指定したサイズで固定です。 指定しない場合は、ストリームバッファは可変長になり、 内部的に SFXElasticStreamReader クラスが利用されます。

	Tip
	データ受信用ストリームは、受信するデータの種類に応じて SFXBinaryStreamReader、 SFXAnsiStringStreamReader、または SFXWideStringStreamReader クラスを使い分けます。

	注意
	SFZWebBrowserControl::GetStreamReader 関数を使用して取得するストリームは、 SFZWebBrowserControl::GetResponseContent 関数の戻り値である SFBSource インスタンスから取得しています。

	HTTP レスポンスボディの読み込み
	SFZWebBrowserControl::GetResponseContent 関数を使用して HTTP レスポンスボディを読み込む場合は、 SFZWebBrowserControl::GetStreamReader 関数を使えません。 逆に、SFZWebBrowserControl::GetStreamReader 関数を使用して HTTP レスポンスボディを読み込む場合は、 SFZWebBrowserControl::GetResponseContent 関数を使えません。

	注意
	この関数は、HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN のときにのみ有効です。

参照

SFZWebBrowserControl::GetResponseContent | SFZWebBrowserControl::GetStreamWriter | SFZWebBrowserControl::Navigate | SFXBinaryStreamReader | SFXAnsiStringStreamReader | SFXWideStringStreamReader | ストリームバッファ

戻り値

解説

この関数は、この HTTP 接続の HTTP リクエストボディにデータを書き込むためのデータ送信用ストリームを取得します。

size 引数を指定する場合、ストリームバッファは指定したサイズで固定です。 指定しない場合は、ストリームバッファは可変長になり、 内部的に SFXElasticStreamWriter クラスが利用されます。

	Tip
	データ送信用ストリームは、送信するデータの種類に応じて SFXBinaryStreamWriter、 SFXAnsiStringStreamWriter、または SFXWideStringStreamWriter クラスを使い分けます。

	Tip
	SFZWebBrowserControl::GetStreamWriter 関数を使用してデータを送信する場合、 一旦ヒープ上に HTTP リクエストボディが作成されるため、 送信可能なデータサイズは携帯電話に搭載されているメモリ容量に依存することになります。 SFZWebBrowserControl::SetRequestContent 関数を使用してファイルストレージ(SFXFile)を設定すると、 ファイルから直接ネットーワークへデータが送信可能となり、大きなサイズのデータを送信できます。

	HTTP リクエストボディの作成
	SFZWebBrowserControl::SetRequestContent 関数を使用して HTTP リクエストボディを作成する場合は、 SFZWebBrowserControl::GetStreamWriter 関数を使えません。 逆に、SFZWebBrowserControl::GetStreamWriter 関数を使用して HTTP リクエストボディを作成する場合は、 SFZWebBrowserControl::SetRequestContent 関数を使えません。

	注意
	この関数は、HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN のときにのみ有効です。

参照

SFZWebBrowserControl::GetStreamReader | SFZWebBrowserControl::SetRequestContent | SFZWebBrowserControl::Open | SFXBinaryStreamWriter | SFXAnsiStringStreamWriter | SFXWideStringStreamWriter | ストリームバッファ

戻り値

HTML 表示のテキストの表示色。

解説

この関数は、HTML 表示のテキストの表示色を取得します。

	注意
	この関数は、内部で引数のオプション ID に "HVOPT_RGB_TEXT" を指定して BREW API IHTMLVIEWER_GetOption 関数を呼び出します。

参照

SFZWebBrowserControl::SetTextColor | SFZWebBrowserControl::GetLinkColor | SFBHTMLViewer::GetOption | BREW API IHTMLVIEWER_GetOption

戻り値

接続タイムアウト時間 [単位: ミリ秒]

解説

この関数は、 接続タイムアウト時間を取得します。 [単位: ミリ秒]

参照

SFZWebBrowserControl::SetTimeoutMillisecond | SFZWebBrowserControl::SetTimeoutCallback

戻り値

SSL 認証モード

解説

この関数は、HTTPS 通信の SSL 認証モードを取得します。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、 0 を返します。

以下の 4 種類の SSL 認証モードの何れかが返却されます。

参照

SFZWebBrowserControl::SetTrustMode | SFZWebBrowserControl::Open | BREW API ISSL_NegotiateV

戻り値

ユーザー名

解説

Basic 認証のユーザー名を取得します。

SFZWebBrowserControl::SetAuthorizeData 関数で設定された値が取得されます。

参照

SFZWebBrowserControl::SetAuthorizeData

戻り値

ユーザーエージェント

解説

この関数は、HTTP/HTTPS 接続のユーザーエージェントを取得します。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でない場合、 空文字列(SFXAnsiString::EmptyInstance()) を返します。

参照

SFZWebBrowserControl::SetUserAgent | SFZWebBrowserControl::Open | SFXAnsiString

戻り値

Web クラス ID

解説

HTTP/HTTPS 接続を開く際の Web クラス ID を取得します。

デフォルト値は、AEECLSID_WEB です。

参照

SFZWebBrowserControl::SetWebClassId

戻り値

ウェブブラウザウィジェット

解説

内部で保持する SFYWebBrowserWidget ウィジェットを取得します。

参照

SFYWebBrowserWidget

解説

この関数は、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] を受信したときに呼び出されます。

仮想領域の変更時に追加の処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、内部で保持する SFYWebBrowserWidget インスタンスの実領域を自身のローカル領域から SFXMargin(2, 2) マージンサイズだけ縮小して設定します。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベント]
	SFYResponder::SetRealBound / SFYResponder::SetVirtualBound 関数は、 この関数内の処理により仮想領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundVirtual 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には変更後の仮想領域が設定されています。

	仮想領域の変更処理
	SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 仮想領域の変更処理は、最初に SFYWidget::HandleBoundVirtual 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZWebBrowserControl::HandleBoundVirtual(Void)
{
    SFXRectangle                                rx;

    rx.Set(GetLocalBound());
    rx.Deflate(2, 2);
    _widget->SetRealBound(rx);
    return;
}// SFZWebBrowserControl::HandleBoundVirtual //

参照

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 仮想領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

SFZWebBrowserControl クラスが致命的なエラーを発生したときに、呼び出されます。

デフォルトの実装は何もしません。

解説

この関数は、 描画イベント [SFXEvent(SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST, graphics)] を受信したときに呼び出されます。

デフォルトの実装は、このレスポンダを描画します。 詳細は、内部実装コードを参照してください。

枠線の色を変更するなど独自の描画処理を行いたい場合は、この関数をオーバーライドします。

レスポンダの描画手順

SFYResponder::Invalidate 関数を使用して再描画領域を登録します。 イベントループの最後、 アプリ開始/レジュームまたは優先的イベントハンドラ終了のタイミング、 あるいは、コールバックなどのイベントループの外で、 自動的に、あるいは、明示的に SFYResponder::Render 関数を呼び出します。 描画エンジンが起動されます。 再描画が必要なレスポンダだけが描画イベントを受信します。 SFYWidget クラスを継承するレスポンダが描画イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した描画ハンドラの処理により、 SFYWidget::HandleRenderRequest 仮想関数が呼び出されます。 その後、描画ハンドラが登録した順に呼び出されます。 実際にレスポンダが描画されます。 Tip 描画ハンドラの宣言と登録の手間を省けるので、 通常は SFYWidget::HandleRenderRequest 仮想関数だけを利用してレスポンダを描画します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZWebBrowserControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    static SFXBevelColor::AtomRecConst          frameRgb = {
        {{{0x00, 0xAA, 0xAA, 0xAA}}}, {{{0x00, 0xFF, 0xFF, 0xFF}}}, {{{0x00, 0xFF, 0xFF, 0xFF}}}
    };
    static SFXRGBColor::AtomRecConst            theme[] = {
        {{{0x00, 0x00, 0x00, 0x00}}},
        {{{0x00, 0xDD, 0x99, 0x99}}},
        {{{0x00, 0xFF, 0xFF, 0xFF}}}
    };
    SFBDisplaySmp                               display;
    SFXRectangle                                rx;

    rx.Set(GetLocalBound());
    graphics->DrawBevelRectangle(rx, frameRgb);
    rx.Deflate(1, 1);
    graphics->DrawRectangle(rx, theme[0]);
    rx.Deflate(1, 1);
    if (GetStateFocus(true)) {
        graphics->DrawRectangle(rx, theme[1]);
    }
    else {
        graphics->DrawRectangle(rx, theme[2]);
    }
    return;
}// SFZWebBrowserControl::HandleRenderRequest //

参照

SFYResponder::Invalidate | SFYResponder::Render | 描画イベント[SFEVT_RESPONDER_RENDER] | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理 | イベントループ | レスポンダツリー

戻り値

解説

この関数は、通信中またはレンダリング中であるかどうかを判定をします。

参照

SFYWebBrowserWidget::IsBusy

戻り値

解説

この関数は、文字をインラインで入力する設定であるかどうかを判定します。

参照

SFZWebBrowserControl::SetInlineEditEnable

戻り値

解説

この関数は、スクロールバーがあるかどうかを判定をします。

参照

SFZWebBrowserControl::SetScrollbarEnable

引数

解説

この関数は、リンクが押されたときに呼び出されるハンドラです。

デフォルトの実装以外の処理を行いたい場合は、 この関数をオーバーライドします。

デフォルトの実装では、リンク先のページを開きます。

使用例

以下のコードでは、 リンクが mailto: ならメーラーを呼ぶようにこの関数をオーバーライドしています。

#include <SFZResponder/SFZControl/SFZBrowserControl/SFZWebBrowserControl.hpp>

SFMTYPEDEFRESPONDER(MyBrowserControl)
class MyBrowserControl : public SFZWebBrowserControl {
    SFBSEALRESPONDER(MyBrowserControl)
    SFMRESPONDERINSTANTIATEFOUR(MyBrowserControl, SFZWebBrowserControl, SFYControl, SFYWidget, SFYResponder)
public:
    static MyBrowserControlSmp NewInstance(SFCErrorPtr exception = null);
protected:
    explicit MyBrowserControl(Void) static_throws;
    virtual ~MyBrowserControl(Void);
    virtual Void JumpNotifyHandler(NotifyRef notify) {
        if (notify.ex.absoluteURL.StartWith("mailto:")) {
            // mailto:ならメーラーを呼ぶ
            Mailer(notify.ex.absoluteURL);
        }
        else {
            // それ以外なら標準ハンドラを呼ぶ
            SFZWebBrowserControl::JumpNotifyHandler(notify);
        }
    }
};

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZWebBrowserControl::JumpNotifyHandler(NotifyRef notify)
{
    Navigate(notify.ex.absoluteURL);
    return;
}// SFZWebBrowserControl::JumpNotifyHandler //

参照

SFZWebBrowserControl::Notify | SFZWebBrowserControl::Navigate | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::FocusNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler

引数

戻り値

解説

この関数は、指定された HTML 文書を読み込み、レンダリングを開始します。

	注意
	インライン画像は取得できしだい表示されます。 HTTP 接続を要するインライン画像を読み込む可能性があるので、HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN でなければなりません。

参照

SFZWebBrowserControl::Navigate | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler | SFZWebBrowserControl::IsBusy | SFZWebBrowserControl::Stop

引数

戻り値

解説

ASN.1/DER 形式の証明書のファイルまたはバッファを読み込みます。

HTTP/HTTPS 接続を開く前に実行する必要があります。

使用例

ルート証明書を読み込む

SFZWebBrowserControlSmp browser;
SFCError error;

if ((browser = SFZWebBrowserControl::NewInstance(&error)) != null) {
    // 接続を開く前にルート証明書を読み込む
    if ((error = browser->LoadCertificate(WEBOPT_X509_ROOT_CERT, SFXPath("scradle.der"))) == SFERR_NO_ERROR) {
        if ((error = browser->Open()) == SFERR_NO_ERROR) {
            if ((error = browser->SetMethod("GET")) == SFERR_NO_ERROR) {
                error = browser->Navigate("https://www.s-cradle.com/example/tabbrowser/");
            }
        }
    }
}

参照

SFBX509Chain::AddCert

引数

戻り値

解説

この関数は、指定された URL のページを取得して、レンダリングを開始します。

この関数を呼び出す前に、SFZWebBrowserControl::Open 関数で接続を開いて、SFZWebBrowserControl::SetMethod 関数で HTTP メソッドを設定する必要があります。

また、HTTP メッセージのリクエストコンテンツを利用するときは、SFZWebBrowserControl::SetRequestContent 関数で事前に設定します。

	注意
	HTML データとインライン画像の読み込みは任意のタイミングで行われ、 取得できしだい表示に反映されます。

	通信に関するエラー
	通信に関するエラーは戻り値では取得できません。 レンダリングの終了や、通信に関するエラーを取得する場合は、 SFZWebBrowserControl クラスを継承して、 SFZWebBrowserControl::DoneNotifyHandler 関数、または SFZWebBrowserControl::ResponseNotifyHandler 関数をオーバライドするクラスを作成する必要があります。

使用例

SFZWebBrowserControlSmp browser;
SFCError error;

if ((browser = SFZWebBrowserControl::NewInstance(&error)) != null) {
    if ((error = browser->Open()) == SFERR_NO_ERROR) {
        if ((error = browser->SetMethod("GET")) == SFERR_NO_ERRROR) {
            error = browser->Navigate("/example/tabbrowser/");
        }
    }
}

参照

SFZWebBrowserControl::Load | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler

引数

戻り値

解説

この関数は、SFZWebBrowserControl クラスの新しいインスタンスを作成します。

インスタンスの作成に成功した場合は null 以外のポインタを返します。 失敗した場合は、null ポインタを返します。

exception 引数を指定した場合、 この引数にはエラー値が返ります。

使用例

以下は、ウェブブラウザコントロールのインスタンスを生成するためのコードです。

// ウェブブラウザウィジェットのインスタンスを生成する
SFZWebBrowserControlSmp _browser;
SFCError error;

if ((_browser = SFZWebBrowserControl::NewInstance(&error)) != null) {
    // ...
}

引数

戻り値

解説

この関数は、指定された値だけ履歴を進み、ページを再取得しレンダリングします。

	注意
	引数に負の値を指定すると、絶対値の数だけ履歴を戻ります。 指定された数が履歴リストから外れる場合はエラーとなり、 戻り値として SFERR_INVALID_PARAM を返します。

	通信に関するエラー
	通信に関するエラーは戻り値では取得できません。 レンダリングの終了や、通信に関するエラーを取得する場合は、 SFZWebBrowserControl クラスを継承して、 SFZWebBrowserControl::DoneNotifyHandler 関数、または SFZWebBrowserControl::ResponseNotifyHandler 関数をオーバライドするクラスを作成する必要があります。

参照

SFZWebBrowserControl::Previous | SFZWebBrowserControl::Navigate | SFZWebBrowserControl::Reload | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler

戻り値

解説

この関数は、HTTP/HTTPS 接続を開きます。

HTTP/HTTPS 接続の状態は、SFXHTTPConnection::STATE_OPEN になります。

HTTP/HTTPS 接続の状態が既に SFXHTTPConnection::STATE_OPEN だった場合は何も処理を行いません。エラー値は SFERR_NO_ERROR が返ります。

SFZWebBrowserControl::Navigate 関数や、SFZWebBrowserControl::Load 関数で実際にページを開く前にこの関数を呼び出す必要があります。

参照

SFZWebBrowserControl::Navigate | SFZWebBrowserControl::Load

引数

戻り値

解説

この関数は、指定された値だけ履歴を戻り、ページを再取得しレンダリングします。

	注意
	引数に負の値を指定すると、絶対値の数だけ履歴を進みます。 指定された数が履歴リストから外れる場合はエラーとなり、 戻り値として SFERR_INVALID_PARAM を返します。

	通信に関するエラー
	通信に関するエラーは戻り値では取得できません。 レンダリングの終了や、通信に関するエラーを取得する場合は、 SFZWebBrowserControl クラスを継承して、 SFZWebBrowserControl::DoneNotifyHandler 関数、または SFZWebBrowserControl::ResponseNotifyHandler 関数をオーバライドするクラスを作成する必要があります。

参照

SFZWebBrowserControl::Next | SFZWebBrowserControl::Navigate | SFZWebBrowserControl::Reload | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler

解説

この関数は、現在表示しているページを再取得して再描画します。

	注意
	現在表示しているページが、 SFZWebBrowserControl::Load 関数か、 POST メソッド使用した SFZWebBrowserControl::Navigate 関数によるものである場合、 再描画に失敗します。

参照

SFZWebBrowserControl::Load | SFZWebBrowserControl::Navigate

引数

解説

この関数は、サーバーへの接続が完了し、レンダリングが始まる前に呼び出されるハンドラです。

デフォルトの実装以外の処理を行いたい場合は、 この関数をオーバーライドします。

デフォルトの実装は、何も行いません。

使用例

以下は、オーバーライドしてエラー処理を行うコードです。

#include <SFZResponder/SFZControl/SFZBrowserControl/SFZWebBrowserControl.hpp>

SFMTYPEDEFRESPONDER(MyBrowserControl)
class MyBrowserControl : public SFZWebBrowserControl {
    SFBSEALRESPONDER(MyBrowserControl)
    SFMRESPONDERINSTANTIATEFOUR(MyBrowserControl, SFZWebBrowserControl, SFYControl, SFYWidget, SFYResponder)
public:
    static MyBrowserControlSmp NewInstance(SFCErrorPtr exception = null);
protected:
    explicit MyBrowserControl(Void) static_throws;
    virtual ~MyBrowserControl(Void);
    virtual Void ResponseNotifyHandler(NotifyConstRef notify) {
        if (!WEB_ERROR_SUCCEEDED(notify.u.nDone)) {
            // HTTP エラーなら警告ダイアログを表示する 
            WarningDialog(notify.u.nDone);
        }
        return;
    }
};

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZWebBrowserControl::ResponseNotifyHandler(NotifyConstRef notify)
{
    unused(notify);
    return;
}// SFZWebBrowserControl::ResponseNotifyHandler //

参照

SFZWebBrowserControl::Notify | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::FocusNotifyHandler | SFZWebBrowserControl::JumpNotifyHandler

引数

戻り値

解説

この関数は、HTTP ベーシック認証の情報を設定します。

この関数を実行した後、 url 引数に指定した URL で始まるページへのアクセスは、 指定された認証情報を持つヘッダーをつけて行われます。

HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN のときのみ呼び出しが成功します。

認証情報の設定を解除する時は、空文字列を指定してこの関数を呼び出します。

また、 url 引数に指定した URL で始まらないページをアクセスした場合、 認証情報は使用されません。

	注意
	戻り値が SFERR_NO_ERROR 以外の場合は、ベーシック認証は行われません。

参照

SFZWebBrowserControl::Open

引数

戻り値

解説

この関数は、HTML 表示のインデントの幅を設定します。[単位: ピクセル]

	注意
	この関数は、内部で引数のオプション ID に "HVOPT_N_INDENT" を指定して BREW API IHTMLVIEWER_SetOption 関数を呼び出します。

参照

SFZWebBrowserControl::GetIndent | SFBHTMLViewer::SetOption | BREW API IHTMLVIEWER_SetOption

引数

解説

この関数は、HTML 表示の文字入力をインラインにするか、フルスクリーンにするかを設定します。

	注意
	この関数は、内部で BREW API IHTMLVIEWER_SetProperties 関数を呼び出します。

参照

SFZWebBrowserControl::IsInlineEditEnable | SFBControl::SetProperties | BREW API IHTMLVIEWER_SetProperties

引数

戻り値

解説

この関数は、HTML 表示のリンク文字列の表示色を設定します。

	注意
	この関数は、内部で引数のオプション ID に "HVOPT_RGB_LINK" を指定して BREW API IHTMLVIEWER_SetOption 関数を呼び出します。

参照

SFZWebBrowserControl::GetLinkColor | SFZWebBrowserControl::SetTextColor | SFBHTMLViewer::SetOption | BREW API IHTMLVIEWER_SetOption

戻り値

解説

この関数は、HTTP/HTTPS 接続の HTTP リクエストメソッドを設定します。

引数には、"GET"、"POST"、"HEAD" など BREW の IWeb インターフェースが対応している HTTP リクエストメソッドを指定できます。

デフォルト値: "GET"

設定された値は、 SFZWebBrowserControl::Close 関数が呼び出されるまで有効です。

	注意
	この関数は、HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN のときにのみ有効です。

参照

SFZWebBrowserControl::GetMethod | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close | SFXAnsiString | BREW API IWeb

引数

戻り値

解説

この関数は、HTML 表示の段落間の行間の長さを設定します。[単位: ピクセル]

	注意
	この関数は、内部で引数のオプション ID に "HVOPT_N_VSPACE" を指定して BREW API IHTMLVIEWER_SetOption 関数を呼び出します。

参照

SFZWebBrowserControl::GetParagraphSpacing | SFBHTMLViewer::SetOption | BREW API IHTMLVIEWER_SetOption

戻り値

解説

この関数は、HTTP/HTTPS 接続のプロキシサーバー(SFXSocketAddress)を設定します。

設定された値は、 SFZWebBrowserControl::Close 関数が呼び出されるまで有効です。

	注意
	この関数は、HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN のときにのみ有効です。

参照

SFZWebBrowserControl::GetProxyServer | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close | SFXSocketAddress

戻り値

解説

この関数は、 HTTP/HTTPS 接続の HTTP リクエストボディにストレージまたはソースを設定します。

引数にファイルストレージまたはメモリストレージだけを指定したとき、 そのストレージ全体の長さが自動的に設定されます。

length 引数を指定する場合、 ストレージまたはソースの現在の読み書きポインタの位置から指定した長さ分のデータが HTTP リクエストボディに設定されます。

	Tip
	SFZWebBrowserControl::SetRequestContent 関数を使用してファイルストレージ(SFXFile)を設定すると、 ファイルから直接ネットーワークへデータが送信可能となり、 大きなサイズのデータを送信できます。 SFZWebBrowserControl::GetStreamWriter 関数を使用してデータを送信する場合、 一旦ヒープ上に HTTP リクエストボディが作成されるため、 送信可能なデータサイズは携帯電話に搭載されているメモリ容量に依存することになります。

	HTTP リクエストボディの作成
	SFZWebBrowserControl::SetRequestContent 関数を使用して HTTP リクエストボディを作成する場合は、 SFZWebBrowserControl::GetStreamWriter 関数を使えません。 逆に、SFZWebBrowserControl::GetStreamWriter 関数を使用して HTTP リクエストボディを作成する場合は、 SFZWebBrowserControl::SetRequestContent 関数を使えません。

設定された値は、 SFZWebBrowserControl::Close 関数が呼び出されるまで有効です。

	注意
	この関数は、HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN のときにのみ有効です。

	注意
	SFZWebBrowserControl::SetRequestContent 関数は、 SophiaFramework UNIVERSE 5.1.11 以降有効です。

参照

SFZWebBrowserControl::GetRequestContent | SFZWebBrowserControl::GetStreamWriter | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close | SFBSource | SFXStorage

戻り値

解説

この関数は、HTTP/HTTPS 接続の HTTP リクエストフラグを設定します。

	注意
	HTTP リクエストフラグは、内部的に IWEB_GetResponse 関数に渡されます。

具体的には、以下のフラグの論理和として設定します。

設定された値は、 SFZWebBrowserControl::Close 関数が呼び出されるまで有効です。

	注意
	この関数は、HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN のときにのみ有効です。

参照

SFZWebBrowserControl::GetRequestFlag | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close | BREW API IWEB_GetResponse

戻り値

解説

この関数は、HTTP/HTTPS 接続の HTTP リクエストヘッダーを設定します。

同一の key で複数回呼ばれた場合は、すべて記憶してリクエスト時に送信されます。

設定された値は、 SFZWebBrowserControl::Close 関数を呼び出すまで有効です。

	注意
	この関数は、HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN のときにのみ有効です。

参照

SFZWebBrowserControl::GetRequestHeader | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close

引数

解説

この関数は、スクロールバーの有無を設定します。

	注意
	この設定で表示されるスクロールバーは、 SophiaFramework UNIVERSE で実装されているものではなく、 BREW API IHtmlViewer インターフェースのスクロールバーです。

参照

SFZWebBrowserControl::IsScrollbarEnable | SFBControl::SetProperties | BREW API IHTMLVIEWER_SetProperties

引数

戻り値

解説

この関数は、HTML 表示のスクロールバーの幅を設定します。[単位: ピクセル]

	注意
	この関数は、内部で引数のオプション ID に "HVOPT_N_SBWIDTH" を指定して BREW API IHTMLVIEWER_SetOption 関数を呼び出します。

参照

SFZWebBrowserControl::GetScrollbarWidth | SFBHTMLViewer::SetOption | BREW API IHTMLVIEWER_SetOption

引数

戻り値

解説

この関数は、HTML 表示のテキストの表示色を設定します。

	注意
	この関数は、内部で引数のオプション ID に "HVOPT_RGB_TEXT" を指定して BREW API IHTMLVIEWER_SetOption 関数を呼び出します。

参照

SFZWebBrowserControl::GetTextColor | SFZWebBrowserControl::SetLinkColor | SFBHTMLViewer::SetOption | BREW API IHTMLVIEWER_SetOption

解説

この関数は、 通信開始から接続タイムアウト時間を過ぎても応答がない場合に呼び出されるコールバック関数を設定します。

コールバック関数を設定しなかった場合は、 SFXHTTPConnection::OnTimeoutDefault 関数が登録されていることになります。

SFXHTTPConnection::OnTimeoutDefault 関数は、以下の内部実装コードにあるように、 SFXHTTPConnection::Cancel 関数を呼び出して通信をキャンセルします。

/*private */XALLBACK_IMPLEMENT_SFXTIMER(SFXHTTPConnection, OnTimeoutDefault)
{
    Cancel();
    return;
}// XALLBACK_IMPLEMENT_SFXTIMER(SFXHTTPConnection, OnTimeoutDefault)

	注意
	接続タイムアウト時間は、 SFZWebBrowserControl::SetTimeoutMillisecond 関数を利用して設定します。

参照

SFZWebBrowserControl::SetTimeoutMillisecond | SFXHTTPConnection::Cancel

解説

この関数は、 接続タイムアウト時間を設定します 。[単位: ミリ秒]

デフォルト値: 0（タイムアウト処理を行いません）

通信開始からタイムアウト時間を過ぎても応答がない場合、 SFZWebBrowserControl::SetTimeoutCallback 関数で設定する接続タイムアウトコールバックが呼び出されます。

	注意
	接続タイムアウト時間が 0 のとき、タイムアウト処理を行いません。

参照

SFZWebBrowserControl::GetTimeoutMillisecond | SFZWebBrowserControl::SetTimeoutCallback

引数

戻り値

解説

この関数は、HTTPS 通信の SSL 認証モードを設定します（HTTPS 通信の場合に有効です）。

デフォルト値: SSL_TRUST_MODE_FAIL

設定可能な SSL 認証モードは、 以下の 4 種類です（参照: BREW API ISSL_NegotiateV）。

設定された値は、 SFZWebBrowserControl::Close 関数が呼び出されるまで有効です。

実機において、この値を変更した直後の SFZWebBrowserControl::Navigate 関数の呼び出しでは SSL_RESULT_SERV_VERS エラーが発生することがあります。

エラーを避けるには、一度 SFZWebBrowserControl::Close 関数を呼び出してからSSL 認証モードを設定し、 SFZWebBrowserControl::Navigate 関数を呼び出します。

	注意
	詳細情報: BREW API ISSL_NegotiateV

	注意
	この関数は、HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN のときにのみ有効です。

参照

SFZWebBrowserControl::GetTrustMode | SFZWebBrowserControl::Navigate | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close | BREW API ISSL_NegotiateV

戻り値

解説

この関数は、HTTP/HTTPS 接続のユーザーエージェントを設定します。

設定された値は、 SFZWebBrowserControl::Close 関数が呼び出されるまで有効です。

	注意
	この関数は、HTTP/HTTPS 接続の状態が SFXHTTPConnection::STATE_OPEN のときにのみ有効です。

参照

SFZWebBrowserControl::GetUserAgent | SFZWebBrowserControl::Open | SFZWebBrowserControl::Close | SFXAnsiString

解説

HTTP/HTTPS 接続を開く際の Web クラス ID を設定します。

設定内容は、次回 SFZWebBrowserControl::Open 関数を呼び出す際に有効になります。

デフォルト値は、AEECLSID_WEB です。

参照

SFZWebBrowserControl::GetWebClassId | SFZWebBrowserControl::Open

解説

この関数は、レンダリングを行っている場合、その処理を中断します。

	注意
	レンダリング中以外ならば何も行いません。 表示済みの部分に対しては、影響を与えません。

参照

SFZWebBrowserControl::~SFZWebBrowserControl

参照

SFYResponder::GetType | SFYResponder::SetType

解説

この型は、 BREW API HViewNotify から派生しています。

通知コールバック関数 (SFZWebBrowserControl::ResponseNotifyHandler, SFZWebBrowserControl::DoneNotifyHandler, SFZWebBrowserControl::JumpNotifyHandler, SFZWebBrowserControl::FocusNotifyHandler) の引数として渡されるデータの型です。

Notify 構造体は、HViewNotify 構造体に Extension 構造体が追加された形になります。

ex.absoluteURL は SFZWebBrowserControl::JumpNotifyHandler 関数で通知されるときのみ使用され、ジャンプ先の絶対 URL を表します。

SFZWebBrowserControl::ResponseNotifyHandler 関数による通知では、u.nDone に HTTP 通信の結果コードが格納されます。

その他の通知コールバック関数におけるメンバ変数の役割は、IHTMLViewer の BREW API HViewNotify の仕様に準じます。

参照

SFZWebBrowserControl::ResponseNotifyHandler | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::JumpNotifyHandler | SFZWebBrowserControl::FocusNotifyHandler | BREW API HViewNotify | BREW API WEB_ERROR_SUCCEEDED | BREW API WEB_ERROR_MAP