継承図

協調図

解説

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

SFRBrowserControl クラスは BREW API の IHtmlViewer を使って実装されているので、HTML レンダリングに関する制限は IHtmlViewer と概ね同等です。

参照

SFRResponder | SFRApplication | SFRWindow | SFRDialog | SFRControl | SFBHTMLViewer | SFBWeb | 簡易 ウェブ ブラウザー

メンバ

戻り値

解説

データメンバの初期化を行い、ページのレンダリングに使う IHtmlViewer インスタンスを生成します。

通信に使う IWeb インターフェースはここでは生成されません。

解説

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

戻り値

SFERR_NO_ERROR を返します。

解説

現在の履歴番号は 0 に戻ります。

参照

SFRBrowserControl::GetCurrentHistoryIndex

引数

解説

標準の実装では、何も処理しません。

何か処理するには、SFRBrowserControl::DoneNotifyHandler 関数をオーバーロードする必要があります。

SFRBrowserControl::ResponseNotifyHandler とは呼び出されるタイミングが異なります。

使用例

オーバーロードして利用する例です。

#include <SFRResponder/SFRControl/SFRBrowserControl.hpp>

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

protected:
    virtual Void DoneNotifyHandler(DoneNotifyConstRef 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

引数

戻り値

見つかった要素の位置を返します。 見つからなければ負の値を返します。

解説

現在表示しているページから、指定した要素を検索します。 戻り値(要素の位置)は、SFRBrowserControl::GetElementText 関数や SFRBrowserControl::GetElementAttribute 関数で使います。

参照

SFRBrowserControl::GetElementText | SFRBrowserControl::GetElementAttribute

引数

解説

標準の関数では、何も処理しません。

何か処理するには、SFRBrowserControl::FocusNotifyHandler 関数をオーバーロードする必要があります。

参照

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

戻り値

現在表示しているページの履歴内容を返します。

参照

SFRBrowserControl::GetCurrentHistoryIndex | SFRBrowserControl::GetHistory

戻り値

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

解説

SFRBrowserControl::Move 関数、 SFRBrowserControl::Previous 関数、 SFRBrowserControl::Next 関数で増減し、 SFRBrowserControl::ClearHistory 関数で 0 に初期化されます。

参照

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

引数

戻り値

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

解説

現在表示しているページから、指定の要素の属性を取得します。 指定の属性が見付からなければ空文字列を返します。

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

参照

SFRBrowserControl::FindElement | SFRBrowserControl::GetElementText

引数

戻り値

要素の内容を返します。要素の中身がない場合は空文字列を返します。

解説

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

参照

SFRBrowserControl::FindElement | SFRBrowserControl::GetElementAttribute

引数

戻り値

履歴内容を返します。 履歴情報がない、もしくは無効な履歴番号を指定した場合は、 履歴構造体 SFRBrowserControl::HistoryEntry の url 変数の値は空文字列に設定されます。

参照

SFRBrowserControl::GetHistoryList | SFRBrowserControl::GetCurrentHistory

戻り値

履歴リストへのポインターです。

履歴リストは SFRBrowserControl::HistoryEntry 構造体の配列です。そのサイズは SFRBrowserControl::GetHistorySize 関数で取得できます。

解説

配列の先頭は一番新しい履歴となっており、履歴番号と配列のインデックスは一致します。

履歴情報が設定されていない部分は、履歴構造体 SFRBrowserControl::HistoryEntry の url 変数は空文字列に設定されます。

	使用上の注意
	履歴リストの内容は書き換えてはいけません。

使用例

デバッグ用に全履歴のタイトルと URL を表示します。

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

参照

SFRBrowserControl::GetHistorySize

戻り値

履歴リストのエントリ数を返します。

解説

SFRBrowserControl::Move 関数や SFRBrowserControl::GetHistory 関数など 　　　で使用する履歴番号は、履歴リストのエントリ数より小さな値である必要があります。

※ 履歴リストは SFRBrowserControl::GetHistoryList 関数を使って取得できます。

参照

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

戻り値

インデントの幅を返します。( 単位 : ピクセル )

参照

SFRBrowserControl::SetIndent

戻り値

リンク文字列の表示色を返します。

参照

SFRBrowserControl::SetLinkColor | SFRBrowserControl::GetTextColor

戻り値

段落間の行間の長さを返します。( 単位 : ピクセル )

参照

SFRBrowserControl::SetParagraphSpacing

戻り値

設定されているスクロールバーの幅を返します。( 単位 : ピクセル )

参照

SFRBrowserControl::SetScrollbarWidth

戻り値

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

参照

SFRBrowserControl::SetTextColor | SFRBrowserControl::GetLinkColor

戻り値

SFRBrowserControl::SetWeb 関数で設定された IWeb インターフェースを返します。 IWeb インターフェースが設定されていない場合は、null を返します。

解説

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

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

参照

SFBWeb | SFRBrowserControl::UnsetWeb | SFRBrowserControl::SetWeb

戻り値

戻り値

参照

SFRBrowserControl::SetInlineEditEnable

戻り値

参照

SFRBrowserControl::SetScrollbarEnable

引数

解説

リンク先の url を自動的に Open します。

リンクが http:// 、https:// 、file:// 、res: 以外のスキームのときは何もしません。

標準以外の処理を行うときは、SFRBrowserControl::JumpNotifyHandler 関数をオーバーライドする必要があります。

使用例

SFRBrowserControl::JumpNotifyHandler 関数をオーバーライドして使うサンプルコードです。

#include <SFRResponder/SFRControl/SFRBrowserControl.hpp>

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

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

参照

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

引数

戻り値

解説

インライン画像は取得できしだい表示されます。

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

参照

SFRBrowserControl::Open | SFRBrowserControl::DoneNotifyHandler