継承図

協調図

解説

簡易ウェブブラウザーを実現するコントロールクラスです。 このコントロールは、

を備えており、このコントロールを張り付けるだけで簡単なウェブブラウザを作成出来ます。

BREW API の IHtmlViewer を基に実装されています。 HTML のレンダリングに関する制限は IHtmlViewer とほぼ同じとなります。

参照

SFBHtmlViewer | SFBWeb | SFRBrewHtmlControl

メンバ

引数

解説

コンストラクタです。データメンバの初期化を行い、ページのレンダリングに使用する IHtmlViewer インスタンスを生成します。 通信に使用する IWeb インターフェースはここでは生成されません。 初期化に失敗した場合は、エラー値 SFERR_FAILED が Exception に設定されます。 初期化に成功した場合は、エラー値 SFERR_NO_ERROR が Exception に設定されます。

解説

デストラクタです。 通信、HTML のレンダリングを中断し、内部で確保した全てのリソースを解放します。

戻り値

エラー情報です。エラーなしなら SFERR_NO_ERROR が返ります。

解説

履歴リストを空にします。現在の履歴番号も 0 に戻ります。

参照

SFRBrowserControl::GetCurrentHistoryIndex

引数

解説

レンダリングが全て終了したときに呼び出されるハンドラです。 標準の実装では、何もしません。 標準以外の処理を行いたいときは、この関数をオーバーロードしてください。

SFRBrowserControl::ResponseNotifyHandlerとは 呼び出されるタイミングが異なることに注意してください。

使用例

オーバーロードの例です。

#include <SFRResponder/SFRControl/SFRBrowserControl.hpp>

class MyBrowserControl : public SFRBrowserControl {
public:
    MyBrowserControl(SFRResponderPtr director, ConstSFURectRef rect)
        : SFRBrowserControl(director, rect) {
    }

protected:
    virtual Void DoneNotifyHandler(ConstDoneNotifyRef notify) {
        if (notify.GetErrorCode() != SFERR_NO_ERROR) {
	    // 通信エラーならエラーダイアログを表示する。
            ErrorDialog(notify.GetErrorCode());
        }
        else if (WEB_SUCCEEDED(notify.GetDoneCode())) {
            // HTTP エラーなら警告ダイアログを表示する。
            WarningDialog(notify.GetResposenCode());
        }
    }
};

参照

SFRBrowserControl::DoneNotify | SFRBrowserControl::FocusNotifyHandler | SFRBrowserControl::JumpNotifyHandler | SFRBrowserControl::ResponseNotifyHandler

引数

戻り値

見つかった要素の位置です。 見つからなければ負の値となります。

解説

現在表示しているページから、特定の要素を検索し、その位置を取得します。 取得した位置は、 GetElementText GetElementAttribute で使用します。

参照

SFRBrowserControl::GetElementText | SFRBrowserControl::GetElementAttribute

引数

解説

ブラウザのカーソルが移動した際に呼び出されるハンドラです。 標準の関数では、何もしません。 標準以外の処理を行いたいときは、この関数をオーバーロードしてください。

参照

SFRBrowserControl::FocusNotify | SFRBrowserControl::DoneNotifyHandler | SFRBrowserControl::JumpNotifyHandler | SFRBrowserControl::ResponseNotifyHandler

戻り値

履歴内容です。

解説

現在表示しているページの履歴内容を取得します。 この関数は、 GetHistory(GetCurrentHistoryIndex()) と同じです。

参照

SFRBrowserControl::GetCurrentHistoryIndex | SFRBrowserControl::GetHistory

戻り値

現在表示しているページの履歴番号です。

解説

現在表示しているページの履歴番号を取得します。 この値は、 Move, Previous, Next で増減し、 ClearHistory で 0 に初期化されます。

参照

SFRBrowserControl::Move | SFRBrowserControl::Previous | SFRBrowserControl::Next | SFRBrowserControl::ClearHistory

引数

戻り値

属性の内容が返ります。指定の属性が見付からなければ空文字列になります。

解説

現在表示しているページから、指定の要素の属性を取得します。 要素に属性が無い場合は、空文字列が戻ります。

	値がない属性の取扱い
	<HR NOSHADE> のように、値が設定されていない属性がある要素で、 本関数を使用して NOSHADE 属性の内容を取得すると、 戻り値は属性名と同じ "NOSHADE" 文字列となります。

参照

SFRBrowserControl::FindElement | SFRBrowserControl::GetElementText

引数

戻り値

要素の内容が戻ります。要素の中身がない場合は空文字列です。

解説

現在表示しているページから、指定の要素の内容を取得します。

参照

SFRBrowserControl::FindElement | SFRBrowserControl::GetElementAttribute

引数

戻り値

履歴内容です。 履歴情報がない、 もしくは無効な履歴番号を指定した場合は、 戻り値の url メンバが空文字列となります。

解説

指定された履歴番号の履歴内容を取得します。 指定した履歴内容がなかったり、 履歴リストの大きさより大きな履歴番号を指定した場合は、 履歴情報の url メンバが空文字列の履歴情報が返ります。

参照

SFRBrowserControl::GetHistoryList | SFRBrowserControl::GetCurrentHistory

戻り値

履歴リストへのポインタです。 履歴リストは HistoryEntry 構造体の配列で、 大きさは GetHistorySize で取得できる大きさとなります。

解説

履歴リストを取得します。 取得できる値は HistoryEntry 構造体の配列で、大きさは GetHistorySize で取得できる大きさです。 配列の先頭が一番新しい履歴となっており、 履歴番号と配列のインデックスは一致することが保証されます。 まだ履歴情報が設定さていない部分は、 履歴構造体の url メンバが空文字列になります。

	使用上の注意
	この関数で取得した配列を書き換えてはいけません。

使用例

下記のコードは、 デバッグ用に全履歴のタイトルと URL を表示する関数です。

void PrintHistoryList(ConstSFBrowserControlRef browser)
{
    int i;
    SFBrowserControl::ConstHistoryEntryPtr historyList = browser.GetHistoryList();
    for (i=0; i<browser.GetHistorySize(); i++) {
        DBGPRINTF("title '%s' url %s",
                  (ConstACharPtr)historyList[i].title, (ConstACharPtr)historyList[i].url); 
    }
}

参照

SFRBrowserControl::GetHistorySize

戻り値

現在の履歴リストのエントリ数が返ります。

解説

現在の履歴リストのエントリ数を取得します。 Move, GetHistory 等で使用する履歴番号は、この関数で取得できるエントリ数未満でなくてはなりません。 また、 GetHistoryList で取得できる履歴リストは、ここで取得した大きさの配列となります。

参照

SFRBrowserControl::GetHistory | SFRBrowserControl::GetHistoryList | SFRBrowserControl::Move | SFRBrowserControl::SetHistorySize

戻り値

設定されているインデントの幅が返ります。単位はピクセルです。

解説

HTML 表示のインデントの幅を取得します。 取得した数値の単位は単位はピクセルです。

参照

SFRBrowserControl::SetIndent

戻り値

リンクの文字の表示色が返ります。

解説

HTML 表示のリンクの文字の表示色を取得します。

参照

SFRBrowserControl::SetLinkColor | SFRBrowserControl::GetTextColor

戻り値

設定されている段落間の行間の長さが返ります。単位はピクセルです。

解説

HTML 表示の段落間の行間の長さを取得します。 取得した値の単位はピクセルです。

参照

SFRBrowserControl::SetParagraphSpacing

戻り値

設定されているスクロールバーの幅が返ります。単位はピクセルです。

解説

HTML 表示のスクロールバーの幅を取得します。 取得した数値の単位は単位はピクセルです。

参照

SFRBrowserControl::SetScrollbarWidth

戻り値

地の文の表示色が返ります。

解説

HTML 表示の本文の表示色を取得します。

参照

SFRBrowserControl::SetTextColor, SFRBrowserControl::GetLinkColor

戻り値

通信に使用する IWeb インターフェースです。 SetWeb で使用する IWeb インターフェースを設定しておらず、 内部でまだ IWeb インターフェースを生成していない場合は、 NULL が返ります。

解説

通信に使用する IWeb インターフェースを取得します。

	WebOpt 指定時の注意
	取得した IWeb インターフェースに対して、 任意の WebOpt を設定することができますが、 ユーザが設定した WebOpt のデータは、 他の IWeb インターフェイスを使うように設定するまで、 ユーザが保持しなくてはなくてはなりません。 詳しくは、BREW API リファレンス、 IWeb インターフェースの「WEBOPT の寿命に関する注意事項」を参照してください。

	サスペンド時の挙動
	サスペンドが起こったときは、 デフォルト状態の IWeb インターフェースを内部で作成する設定に戻ります。 この際に、指定していた WebOpt の情報もリセットされます。 続けてユーザオリジナルの IWeb インターフェイスを使用したいときは、 レジューム ハンドラで設定しなおしてください。

参照

SFBWeb | SFRBrowserControl::UnsetWeb | SFRBrowserControl::SetWeb

戻り値

現在ネットワークアクセス中、もしくはレンダリング中ならば TRUE。

解説

現在、ネットワークアクセスかレンダリング中かどうかを取得します。

戻り値

設定がインライン入力ならば TRUE、 全画面入力なら FALSE が返ります。

解説

HTML 表示で、文字をインラインで入力する設定か、全画面で入力する設定かを調べます。 インライン入力ならば TRUE、全画面入力なら FALSE となります。

参照

SFRBrowserControl::SetInlineEditEnable

戻り値

スクロールバーありなら TRUE、 なしなら FALSE が返ります。

解説

HTML 表示のスクロールバーの設定を調べます。 スクロールバーありなら TRUE、 なしなら FALSE となります。

参照

SFRBrowserControl::SetScrollbarEnable

引数

解説

コントロール内の HTML のリンクが押された際に呼び出されるハンドラです。 この関数では、リンク先の url を自動的に Open します。 リンクが http://、https://、file://、res: 以外のスキームのときは何もしません。 標準以外の処理を行いたいときは、この関数をオーバーライドしてください。

使用例

下記のコードは、オーバーライドの例です。

#include <SFRResponder/SFRControl/SFRBrowserControl.hpp>

class MyBrowserControl : public SFRBrowserControl {
public:
    MyBrowserControl(SFRResponderPtr director, ConstSFURectRef rect)
        : SFRBrowserControl(director, rect) {
    }

protected:
    virtual Void JumpNotifyHandler(ConstJumpNotifyRef notify) {
        if (notify.GetUrl().StartWith("mailto:)) {
	    // mailto:ならメーラを呼び出す
            Mailer(notify.GetUrl());
        }
        else {
            // それ以外なら標準ハンドラを呼ぶ
            SFRBrowserControl::JumpNotifyHandler(notify);
        }
    }
};

参照

SFRBrowserControl::JumpNotify | SFRBrowserControl::Open | SFRBrowserControl::DoneNotifyHandler | SFRBrowserControl::FocusNotifyHandler | SFRBrowserControl::ResponseNotifyHandler

引数

戻り値

エラー情報です。 エラーがないなら SFERR_NO_ERROR、 処理中にメモリが足りなくなったときは SFERR_NO_MEMORY、 指定した url が正しくないときは SFERR_INVALID_PARAM が返ります。

解説

文字列データを HTML とみなして、レンダリングを開始します。 インライン画像の読み込みは任意のタイミングで行われ、取得できしだい表示に反映されます。

	通信に関するエラー
	通信に関するエラーは返値では取得できません。 レンダリングの終了や、通信に関するエラーを取得したい場合は、 本クラスを継承して、 DoneNotifyHandler をオーバロードするクラスを作成してください。

参照

SFRBrowserControl::Open | SFRBrowserControl::DoneNotifyHandler

引数

戻り値

エラー情報です。 エラーがないなら SFERR_NO_ERROR、 履歴番号が大きすぎるときは SFERR_INVALID_PARAM、 メモリ不足ならば SFERR_NO_MEMOERY が返ります。

解説

任意の履歴番号のページに飛んで、ページの再取得と再レンダリングを行います。 指定した履歴番号が履歴リストのサイズより大きかったり、 指定した履歴番号の履歴がまだない場合はエラーとなり、 返値として SFERR_INVALID_PARAM が返ります。

	通信に関するエラー
	通信に関するエラーは返値では取得できません。 レンダリングの終了や、通信に関するエラーを取得したい場合は、 本クラスを継承して、 DoneNotifyHandler をオーバロードするクラスを作成してください。

参照

SFRBrowserControl::DoneNotifyHandler | SFRBrowserControl::Open | SFRBrowserControl::Previous | SFRBrowserControl::Next | SFRBrowserControl::Reload

引数

戻り値

エラー情報です。 エラーがないなら SFERR_NO_ERROR、 指定した数が大きすぎるか小さすぎる時は SFERR_INVALID_PARAM、 メモリ不足ならば SFERR_NO_MEMOERY が返ります。

解説

指定の数だけ履歴を進み、ページの再取得と再レンダリングを行います。 引数に負の値を指定すると、絶対値の数だけ履歴を前に戻ります。 指定した数が履歴リストから外れる場合はエラーとなり、 返値として SFERR_INVALID_PARAM が返ります。

	通信に関するエラー
	通信に関するエラーは返値では取得できません。 レンダリングの終了や、通信に関するエラーを取得したい場合は、 本クラスを継承して、 DoneNotifyHandler をオーバロードするクラスを作成してください。

参照

SFRBrowserControl::DoneNotifyHandler | SFRBrowserControl::Open | SFRBrowserControl::Move | SFRBrowserControl::Previous | SFRBrowserControl::Reload

引数

戻り値

エラー情報です。 エラーがないなら SFERR_NO_ERROR、 処理中にメモリが足りなくなったときは SFERR_NO_MEMORY、 指定した url が正しくないときは SFERR_INVALID_PARAM が返ります。

解説

ある URL のページを取得して、レンダリングを開始します。 HTML データとインライン画像の読み込みは任意のタイミングで行われ、 取得できしだい表示に反映されます。

	通信に関するエラー
	通信に関するエラーは返値では取得できません。 レンダリングの終了や、 通信に関するエラーを取得したい場合は、 本クラスを継承して、 DoneNotifyHandler をオーバロードするクラスを作成してください。

参照

SFRBrowserControl::Load | SFRBrowserControl::DoneNotifyHandler

引数

戻り値

エラー情報です。 エラーがないなら SFERR_NO_ERROR、 指定した数が大きすぎるか小さすぎる時は SFERR_INVALID_PARAM、 メモリ不足ならば SFERR_NO_MEMOERY が返ります。

解説

指定の数だけ履歴を戻り、ページの再取得と再レンダリングを行います。 引数に負の値を指定すると、絶対値の数だけ履歴を前に進みます。 指定した数が履歴リストから外れる場合はエラーとなり、 返値として SFERR_INVALID_PARAM が返ります。

	通信に関するエラー
	通信に関するエラーは返値では取得できません。 レンダリングの終了や、通信に関するエラーを取得したい場合は、 本クラスを継承して、 DoneNotifyHandler をオーバロードするクラスを作成してください。

参照

SFRBrowserControl::DoneNotifyHandler | SFRBrowserControl::Open | SFRBrowserControl::Move | SFRBrowserControl::Next | SFRBrowserControl::Reload

解説

現在表示しているページを再取得して再描画します。 もし、現在表示しているページが、 SFRBrowserControl::Load か、IAStream、ISource を引数にした SFRBrowserControl::Open によるものだった場合、 引数の url が適切に設定されていないと再描画に失敗します。

参照

SFRBrowserControl::Load | SFRBrowserControl::Open

引数

戻り値

ハンドラから戻った後、続けて HTML のレンダリングに入りたいときは false を、HTML のレンダリングをせずに処理を終えたい時は true を戻します。

解説

サーバへの接続が完了した時に呼び出されるハンドラです。 このハンドラは、レンダリングが始まる前に呼び出されます。 標準の実装では、何もせずに false を戻します。 標準以外の処理を行いたいときは、この関数をオーバーロードしてください。

SFRBrowserControl::DoneNotifyHandlerとは 呼び出されるタイミングが異なることに注意してください。

使用例

オーバーロードの例です。

#include <SFRResponder/SFRControl/SFRBrowserControl.hpp>

class MyBrowserControl : public SFRBrowserContorl {
public:
    MyBrowserControl(SFRResponderPtr director, ConstSFURectRef rect)
        : SFRBrowserControl(director, rect) {
    }

protected:
    virtual Void ResponseNotifyHandler(ConstResponseNotifyRef notify) {
        if (notify.GetErrorCode() != SFERR_NO_ERROR) {
	    // 通信エラーならエラーダイアログを表示し、レンダリングしない。
            ErrorDialog(notify.GetErrorCode());
            return true;
        }
        else if (WEB_SUCCEEDED(notify.GetDoneCode())) {
            // HTTP エラーなら警告ダイアログを表示する。
            WarningDialog(notify.GetResposenCode());
        }
        return false; // 正常、警告ならば HTML のレンダリングをする
    }
};

参照

SFRBrowserControl::ResponseNotify | SFRBrowserControl::DoneNotifyHandler | SFRBrowserControl::FocusNotifyHandler | SFRBrowserControl::JumpNotifyHandler

引数

戻り値

エラー情報です。 エラーがないならば SFERR_NO_ERRORが、 内部でメモリが足りなくなった場合は SFERR_NO_MEMORY が返ります。 SFERR_NO_ERROR 以外が返った場合は、ベーシック認証は行いません。

解説

HTTP ベーシック認証の情報を設定します。 設定を行った後、url で始まるページのアクセスにはすべて指定した認証情報を持つヘッダをつけて行います。 url で始まらないページをアクセスした場合、この認証情報は解除されます。 認証を解除したい時は、 UnsetAuthorizeData を使用してください。

参照

SFRBrowserControl::UnsetAuthorizeData

引数

戻り値

エラー情報です。 エラーがないなら SFERR_NO_ERROR、 メモリが足りない場合は SFERR_NO_MEMORY、 引数として 0 をあたえたり、 現在表示中の履歴よりも小さい値をあたえた場合は SFERR_INVALID_PARAM が返ります。 SFERR_NO_ERROR 以外が返った場合は、履歴リストの大きさは変更されません。

解説

履歴リストの大きさを設定します。 現在より小さい値を設定した場合、履歴の大きさが指定したサイズに収まるまで古い履歴情報が捨てられます。 GetCurrentHistoryIndex で取得できる、 現在表示しているページの履歴番号よりも小さな値を設定することはできません。

参照

SFRBrowserControl::GetCurrentHistoryIndex | SFRBrowserControl::GetHistory | SFRBrowserControl::GetHistoryList | SFRBrowserControl::Move | SFRBrowserControl::SetHistorySize

引数

戻り値

エラー情報が返ります。エラーがないなら SFERR_NO_ERROR が返ります。

解説

HTML 表示のインデントの幅を設定します。設定する単位はピクセルです

参照

SFRBrowserControl::GetIndent

引数

戻り値

エラー情報が返ります。エラーがないなら SFERR_NO_ERROR が返ります。

解説

HTML 表示で、文字入力をインラインでするか、全画面でするかの設定をします。

参照

SFRBrowserControl::IsInlineEditEnable

引数

戻り値

エラー情報が返ります。エラーがないなら SFERR_NO_ERROR が返ります。

解説

HTML 表示のリンクの文字の表示色を設定します。

参照

SFRBrowserControl::GetLinkColor | SFRBrowserControl::SetTextColor

引数

戻り値

エラー情報が返ります。エラーがないなら SFERR_NO_ERROR が返ります。

解説

HTML 表示の段落間の行間を設定します。 設定する単位はピクセルです。

参照

SFRBrowserControl::GetParagraphSpacing

引数

戻り値

エラー情報が返ります。エラー無しなら SFERR_NO_ERROR が返ります。

解説

HTML 表示のスクロールバーの有無を設定します。 この設定で表示されるスクロールバーは、 SophiaFramework で実装されているものではなく、 BREW が用意しているスクロールバーになります。

参照

SFRBrowserControl::IsScrollbarEnable

引数

戻り値

エラー情報が返ります。エラー無しなら SFERR_NO_ERROR が返ります。

解説

HTML 表示のスクロールバーの幅を設定します。 設定する単位はピクセルです

参照

SFRBrowserControl::GetScrollbarWidth

引数

戻り値

エラー情報が返ります。エラーなしなら SFERR_NO_ERROR が返ります。

解説

HTML 表示の本文の表示色を設定します。

参照

SFRBrowserControl::GetTextColor | SFRBrowserControl::SetLinkColor

引数

解説

通信に使用する IWeb インターフェースを設定します。 以降、本関数で設定した IWeb インターフェースを使用して、HTTP アクセスを行うようになります。 現在通信中、レンダリング中だった場合は、それらの処理を中断します。

	WebOpt 指定時の注意
	設定する IWeb インターフェースには任意の WebOpt を設定することができますが、WebOpt のデータは他の IWeb インターフェイスを使うように設定するまで、ユーザが保持しなくてはなくてはなりません。 詳しくは、BREW API リファレンス、IWeb インターフェースの「WEBOPT の寿命に関する注意事項」を参照してください。

	サスペンド時の挙動
	また、サスペンドが起こったときは、デフォルト状態の、IWeb インターフェースを内部で作成する設定に戻ります。 続けてユーザオリジナルの IWeb インターフェイスを使用したいときは、レジューム ハンドラで設定しなおしてください。

この関数で指定した値は、 GetWeb で取り出せます。

使用例

ユーザエージェント名を設定します。 端末がサスペンドすると設定が無効になるので、 レジュームハンドラー内で再設定する必要があります。

SCError SetUserAgent(SFRBrowserControlRef browser) {
    SFUBrewPtr<SFBWeb> web;
    web = browser.GetWeb();
    if (web == NULL) {
        web = SFBWeb::Instance();
    }
    
    WebOpt opts[2];
    opts[0].nId = WEB_HEADER;
    // 設定する文字列をヒープに確保する場合、設定が有効な間は開放してはならない。
    opts[0].pVal = "User-Agent: ibROWSE/0.1 (SophiaFramework; I; BREW 2.1)\r\n";
    opts[1].nId = WEBOPT_END;
    opts[1].pVal = NULL;

    int s = web->AddOpt(opts);
    if (s != SFERR_NO_ERROR) {
        return s;
    }
    browser.SetWeb(web);
    return SFERR_NO_ERROR;
}

参照

SFBWeb | SFRBrowserControl::UnsetWeb | SFRBrowserControl::GetWeb

解説

現在行っているネットワークアクセス、レンダリング動作を中断します。 ネットワークアクセス中、レンダリング中以外ならば何も行いません。 表示済みの部分に対しては、なんら影響を与えません。

戻り値

エラー情報です。エラーがないなら SFERR_NO_ERROR が返ります。

解説

SetAuthorizeData で設定した HTTP ベーシック認証の設定を取り消します。 以降、認証情報を持つヘッダは使用しません。

参照

SFRBrowserControl::SetAuthorizeData

解説

通信に使用する IWeb インターフェイスを、コントロール内部で作成するように指示します。 現在通信中、レンダリング中だった場合は、それらの処理を中断します。

参照

SFBWeb SFRBrowserControl::SetWeb | SFRBrowserControl::GetWeb

解説

各パラメータの初期値を納めた列挙型です。 現在は、履歴リストの大きさのデフォルト値を示す HISTORY_SIZE のみ定義されています。

参照

SFRBrowserControl::GetHistorySize | SFRBrowserControl::SetHistorySize

解説

レンダリング終了時の情報を保持するクラスです。 BREW API の HVNotify から派生しています。 このクラスは、主に SFRBrowserControl::DoneNotifyHandler の引数として使われます。

以下のメンバ関数を持ちます。

参照

SFRBrowserControl::DoneNotifyHandler