継承図

協調図

解説

■ 仕様と使い方

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

SFZWebBrowserControl クラスは、 BREW API IHtmlViewer を使用して実装されています。 そのため、HTML レンダリングに関する機能は BREW API IHtmlViewer と同等です。

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

コントロール値の役割について

SFZWebBrowserControl クラスにおける SFYControl の現在値、最大値、最小値の役割は以下の通りです。

現在値は、現在表示されているページの履歴番号を表します。 SFZWebBrowserControl::GetCurrentHistoryIndex 関数の戻り値は、 現在値を参照しています。

最大値は、履歴リストのエントリ数（履歴のサイズ）を表します。 SFZWebBrowserControl::GetHistorySize 関数の戻り値は、 最大値を参照しています。

最小値は、常に 0 です（最小値は使用されません）。

	コントロール値の変更について
	上記にあるように、 現在値、最大値、最小値は SFZWebBrowserControl クラスの内部で制御されていますので、 SFYControl::SetCurrentValue / SFYControl::SetMaximumValue / SFYControl::SetMinimumValue 関数を使用して現在値、最大値、最小値を変更してはいけません。

	Tip
	HTTP リクエストヘッダー、タイムアウトなどの設定を行うには、 SFZWebBrowserControl::SetWeb 関数を使用します。 タイムアウトなどのエラー処理は、 SFZWebBrowserControl クラスを継承するクラスを作成し、 SFZWebBrowserControl::ResponseNotifyHandler または SFZWebBrowserControl::DoneNotifyHandler 関数をオーバーライドして処理を記述します。 タイマーでタイムアウトの処理を行う方法については、 こちらのサンプルアプリ（websample.zip）を参照してください。

	エラー値
	SFZWebBrowserControl::SFZWebBrowserControl コンストラクタでエラーが発生すると、 エラー値は内部（SFZWebBrowserControl インスタンス）に記録されます。 このエラー値は、 static_catch 関数を使用して取得します。 エラーが発生しなかった場合は、SFERR_NO_ERROR が返却されます。

	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=\"http://www.s-cradle.com/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);

            // HTML 文書をレンダリングする
            _browser->Load(buffer);

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

図 468. 実行結果

参照

SFYControl | SFBHTMLViewer | SFBWeb | BREW API IHtmlViewer | BREW API IWeb

メンバ

解説

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

内部実装

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

/*protected */SFZWebBrowserControl::SFZWebBrowserControl(Void) static_throws
{
    SFXRectangle                        rect;
    SFCError                            error(SFERR_NO_ERROR);

    if (static_try()) {
        SetType(CODE_TYPE);
        static_throw(MakeHandler());
        if (static_try()) {
            _webCode = 0;
            _optBodyMem = null;
            _history = null;
            _stateHistory = null;
            _fullscreen_edit = false;
            _fepin = false;
            SetMaximumValue(DEFAULT_HISTORY_SIZE);
            if ((_viewer = SFBHTMLViewer::NewInstance(&error)) != null) {
                if ((_stateHistory = ::new SFXAnsiString[GetHistorySize()]) != null) {
                    if ((_history = ::new HistoryEntry[GetHistorySize()]) != null) {
                        RenderSafe();
                        _viewer->SetRect(SFXRectangle::EmptyInstance());
                        _viewer->SetProperties(HVP_LOADALLIMAGES | HVP_INVALIDATION | _viewer->GetProperties());
                        _viewer->SetNotifyFn(NotifyHandler, this);
                    }
                    else {
                        static_throw(SFERR_NO_MEMORY);
                    }
                }
                else {
                    static_throw(SFERR_NO_MEMORY);
                }
            }
            else {
                static_throw(SFERR_FAILED);
            }
        }
    }
}// SFZWebBrowserControl::SFZWebBrowserControl //

/*private */Void SFZWebBrowserControl::RenderSafe(Void)
{
    SFXGraphics::GetInstance()->SetClip(SFXRectangle::EmptyInstance());
}// SFZWebBrowserControl::RenderSafe //

/*private */SFCError SFZWebBrowserControl::MakeHandler(Void)
{
    static SFXEventRange::AtomRecConst  range[] = {
        {   SFEVT_BEGIN,            SFEVT_END,              SFP16_BEGIN,            SFP16_END           },
        {   SFEVT_CTL_TAB,          SFEVT_CTL_TAB,          SFP16_BEGIN,            SFP16_END           },
        {   SFEVT_APP_RESUME,       SFEVT_APP_RESUME,       SFP16_BEGIN,            SFP16_END           },
        {   SFEVT_APP_SUSPEND,      SFEVT_APP_SUSPEND,      SFP16_BEGIN,            SFP16_END           },
        {   SFEVT_RESPONDER_STATE,  SFEVT_RESPONDER_STATE,  SFP16_STATE_FOCUS,      SFP16_STATE_FOCUS   },
    };
    SFYHandler::RuleRec                 rule[lengthof(range)];
    SFCError                            error(SFERR_NO_ERROR);

    rule[0].spp = XANDLER_FUNCTION(NativeHandler);
    rule[0].reference = this;
    rule[1].spp = XANDLER_FUNCTION(CtlTabHandler);
    rule[1].reference = this;
    rule[2].spp = XANDLER_FUNCTION(ResumeHandler);
    rule[2].reference = this;
    rule[3].spp = XANDLER_FUNCTION(SuspendHandler);
    rule[3].reference = this;
    rule[4].spp = XANDLER_FUNCTION(OnState);
    rule[4].reference = this;
    error = RegisterHandler(atomic_cast(range), rule, lengthof(range));
    return error;
}// SFZWebBrowserControl::MakeHandler //

/*protected */XANDLER_IMPLEMENT_BOOLEVENT(SFZWebBrowserControl, NativeHandler, invoker, event)
{
    Bool                                result(false);
    unused(invoker);

    if (!_fullscreen_edit) {
        RenderSafe();
    }
    if (_viewer != null && _viewer->IsActive()) {
        if (_viewer->HandleEvent(event)) {
            result = true;
        }
        else {
            #if defined TARGET_EXTENSION_KDDI
            #if TARGET_VERSION_GE(3, 1, 0)
            if (event.GetType() == SFEVT_CTL_TEXT_MODECHANGED) {
                switch (event.GetP16()) {
                    case TMJ_FEPIN://TMJ_FEPIN:
                        _fepin = true;
                        break;
                    case TMJ_FEPOUT://TMJ_FEPOUT:
                        _fepin = false;
                        break;
                    default:
                        break;
                }
            }
            #endif
            #endif
        }
    }
    return result;
}// XANDLER_IMPLEMENT_BOOLEVENT(SFZWebBrowserControl, NativeHandler, invoker, event) //

/*protected */XANDLER_IMPLEMENT_BOOLVOID(SFZWebBrowserControl, CtlTabHandler, invoker)
{
    unused(invoker);
    return false;
}// XANDLER_IMPLEMENT_BOOLVOID(SFZWebBrowserControl, CtlTabHandler, invoker)

/*protected */XANDLER_IMPLEMENT_VOIDSUSPEND(SFZWebBrowserControl, SuspendHandler, invoker, reason, info)
{
    unused(invoker); unused(reason); unused(info);
    RenderSafe();
    Stop();
    ClearWebRespAndOpts();
    _web.Release();
    _resumeProperty = _viewer->GetProperties();
    _viewer->Reset();
    return;
}// XANDLER_IMPLEMENT_VOIDSUSPEND //

/*private */Void SFZWebBrowserControl::ClearWebRespAndOpts(Void)
{
    _webResp.Release();
    _optMethod = SFXAnsiString::EmptyInstance();
    _optBody.Release();
    if (_optBodyMem != null) {
        MemoryFree(_optBodyMem);
    }
    _optBodyMem = null;
    _optSsl.Release();
}

/*protected */XANDLER_IMPLEMENT_VOIDRESUME(SFZWebBrowserControl, ResumeHandler, invoker, environment)
{
    SFCError                            error(SFERR_NO_ERROR);

    unused(invoker); unused(environment);
    RenderSafe();
    if ((_viewer = SFBHTMLViewer::NewInstance(&error)) != null) {
        RenderSafe();
        AdjustViewer(GetGlobalBound());
        _viewer->SetProperties(_resumeProperty);
        _viewer->SetNotifyFn(NotifyHandler, this);
    }
    _viewer->SetActive(GetStateVisible() && GetStateActive() && GetStateEnable());
    _viewer->SetViewState(_stateHistory[GetCurrentHistoryIndex()]);
    Reload();
    return;
}// XANDLER_IMPLEMENT_VOIDRESUME //

/*private */Void SFZWebBrowserControl::AdjustViewer(SFXRectangleConstRef rectangle) const
{
    SFXRectangle                        grect(rectangle);

    grect.Deflate(VIEWER_MARGIN, VIEWER_MARGIN);
    _viewer->SetRect(grect);
}// SFZWebBrowserControl::AdjustViewer //

/*private */XANDLER_IMPLEMENT_VOIDSTATE(SFZWebBrowserControl, OnState, invoker, reason, state)
{
    Bool                                focus(GetStateFocus(true));
    unused(invoker);
    unused(reason);
    unused(state);

    if (focus != _viewer->IsActive()) {
        _viewer->SetActive(focus);
    }
    return;
}// XANDLER_IMPLEMENT_VOIDSTATE(SFZWebBrowserControl, OnState, invoker, reason, state)

/*private static */Void SFZWebBrowserControl::NotifyHandler(VoidPtr p, HViewNotify* n)
{
    SFZWebBrowserControlPtr             self(reinterpret_cast<SFZWebBrowserControlPtr>(p));
    Notify*                             notify = static_cast<Notify*>(n);
    SFBShellSmp                         shell;
    SFXAnsiString                       state;
    SInt32                              elementNo;
    SFYResponderSmp                     root;

    switch (notify->GetType()) {
    case HVN_DONE:
        if (notify->u.nDone == SFERR_NO_ERROR) {
            if ((state = self->_stateHistory[self->GetCurrentHistoryIndex()]) != SFXAnsiString::EmptyInstance()) {
                self->_viewer->SetViewState(state);
            }
            elementNo = self->FindElement("title", 0);
            self->_history[self->GetCurrentHistoryIndex()].title = elementNo < 0 ? SFXAnsiString::EmptyInstance() : self->GetElementText(elementNo);
        }
        if (notify->u.nDone > SFERR_NO_ERROR) {
            self->_viewer->GetOption(HVOPT_N_ERROR, (HVOpt*)(&notify->u.nDone));
            notify->u.nDone = -notify->u.nDone;  // error code change to negative
        }
        else {
            notify->u.nDone = self->_webCode;
        }
        self->DoneNotifyHandler(*(static_cast<DoneNotify*>(notify)));
        break;
    case HVN_JUMP:
    case HVN_SUBMIT:
        self->JumpNotifyHandler(*(static_cast<JumpNotify*>(notify)));
        break;
    case HVN_FOCUS:
        self->FocusNotifyHandler(*(static_cast<FocusNotify*>(notify)));
        break;
    case HVN_FULLSCREEN_EDIT:   // htmlviewer edit field going into fullscreen mode
        self->_fullscreen_edit = true;
        self->Invalidate();
        break;
    case HVN_REDRAW_SCREEN:     // htmlviewer drew outside of bounding rectangle, applet must redraw it's screen
        self->_fullscreen_edit = false;
        if ((root = self->GetRoot()) != null) {
            root->Render(true);
        }
        break;
    case HVN_INVALIDATE:        // htmlviewer needs redraw
        if (self->_fepin == false && self->GetStateFocus(true)) {
            self->Invalidate();
        }
        else {
            self->_viewer->Redraw();
        }
        break;
    #if TARGET_VERSION_GE(3, 1, 0)
    case HVN_PAGEDONE:
        break;
    case HVN_CONTENTDONE:
        self->Render();
        break;
    #endif
    default:
        break;
    }
}// SFZWebBrowserControl::NotifyHandler //

参照

SFZWebBrowserControl::SetHistorySize | SFZWebBrowserControl::Reload | SFYControl::SetMaximumValue | SFZWebBrowserControl::HistoryEntry | SFZWebBrowserControl::DEFAULT | SFZWebBrowserControl::DoneNotify | SFZWebBrowserControl::ResponseNotify | SFZWebBrowserControl::FocusNotify | SFZWebBrowserControl::JumpNotify | SFBHTMLViewer | SFBWeb | SFBWebResp | BREW API IHtmlViewer | BREW API IWeb| BREW API IWebResp

解説

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

内部実装

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

/*protected virtual */SFZWebBrowserControl::~SFZWebBrowserControl(Void)
{
    if (_viewer != null) {
        RenderSafe();
        Stop();
        _viewer->Reset();
    }
    ClearWebRespAndOpts();
    if (_history != null) {
        ::delete [] _history;
    }
    if (_stateHistory != null) {
        ::delete [] _stateHistory;
    }
}// SFZWebBrowserControl::~SFZWebBrowserControl //

/*private */Void SFZWebBrowserControl::RenderSafe(Void)
{
    SFXGraphics::GetInstance()->SetClip(SFXRectangle::EmptyInstance());
}// SFZWebBrowserControl::RenderSafe //

参照

SFZWebBrowserControl::Stop

解説

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

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

内部実装

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

/*public */Void SFZWebBrowserControl::ClearHistory(Void)
{
    UInt32                              i;

    for (i = 0; i < GetHistorySize(); ++i) {
        _history[i].title = SFXAnsiString::EmptyInstance();
        _history[i].url = SFXAnsiString::EmptyInstance();
    }
    SetCurrentValue(0);
    return;
}// SFZWebBrowserControl::ClearHistory //

参照

SFZWebBrowserControl::GetCurrentHistoryIndex

引数

解説

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

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

タイムアウトなどのエラー処理を行う場合は、 この関数をオーバーロードして処理を記述する必要があります。

	注意
	SFZWebBrowserControl::ResponseNotifyHandler 関数と呼び出されるタイミングが異なります。

使用例

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

#include <SFZResponder/SFZControl/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(DoneNotifyConstRef notify) {
        if (notify.GetErrorCode() != SFERR_NO_ERROR) {
            // 通信エラーならエラーダイアログを表示する
            ErrorDialog(notify.GetErrorCode());
        }
        else if (WEB_SUCCEEDED(notify.GetDoneCode())) {
            // HTTP エラーなら警告ダイアログを表示する
            WarningDialog(notify.GetResposenCode());
        }
    }
};

内部実装

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

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

参照

SFZWebBrowserControl::DoneNotify | SFZWebBrowserControl::FocusNotifyHandler | SFZWebBrowserControl::JumpNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler

引数

戻り値

解説

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

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

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

内部実装

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

/*public */SInt32 SFZWebBrowserControl::FindElement(ACharConstPtr element, SInt32 no) const
{
    return _viewer->FindElem(element, no);
}// SFZWebBrowserControl::FindElement //

参照

SFZWebBrowserControl::GetElementText | BREW API IHTMLVIEWER_FindElem

引数

解説

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

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

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

内部実装

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

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

参照

SFZWebBrowserControl::FocusNotify | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::JumpNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler

戻り値

現在表示しているページの履歴内容（URL とタイトル）。

解説

この関数は、現在表示しているページの履歴内容（URL とタイトル）を取得します。

内部実装

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

/*public */SFZWebBrowserControl::HistoryEntry SFZWebBrowserControl::GetCurrentHistory(Void) const
{
    return GetHistory(GetCurrentHistoryIndex());
}// SFZWebBrowserControl::GetCurrentHistory //

参照

SFZWebBrowserControl::GetCurrentHistoryIndex | SFZWebBrowserControl::GetHistory | SFZWebBrowserControl::HistoryEntry

戻り値

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

解説

この関数は、現在の履歴番号を取得します。

	注意
	現在の履歴番号は、 SFZWebBrowserControl::Move 関数、 SFZWebBrowserControl::Previous 関数、 SFZWebBrowserControl::Next 関数で増減し、 SFZWebBrowserControl::ClearHistory 関数で 0 に初期化されます。

内部実装

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

/*public */inline UInt32 SFZWebBrowserControl::GetCurrentHistoryIndex(Void) const
{
    return static_cast<UInt32>(GetCurrentValue());
}// SFZWebBrowserControl::GetCurrentHistoryIndex //

参照

SFZWebBrowserControl::Move | SFZWebBrowserControl::Previous | SFZWebBrowserControl::Next | SFZWebBrowserControl::ClearHistory

引数

戻り値

指定された要素の内容。

解説

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

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

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

内部実装

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

/*public */SFXAnsiString SFZWebBrowserControl::GetElementText(SInt32 index) const
{
    SInt32                              len;
    SInt32                              size(128);
    SFXAnsiString                       result;

    for (result.SetThreshold((UInt16)size); (len = _viewer->GetElemText(index, &result)) == size; result.SetThreshold((UInt16)size)) {
        if (len != IHTMLVIEWER_BADELEMENT) {
            size *= 2;
        }
        else {
            result = SFXAnsiString::EmptyInstance();
            break;
        }
    }
    return result;
}// SFZWebBrowserControl::GetElemText //

参照

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

引数

戻り値

指定された履歴番号の履歴内容。

解説

この関数は、指定された履歴番号の履歴内容を取得します。

履歴情報がない、もしくは無効な履歴番号を指定された場合は、 戻り値の履歴内容である SFZWebBrowserControl::HistoryEntry 構造体の url 変数には空文字列 SFXAnsiString::EmptyInstance() が返却されます。

内部実装

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

/*public */SFZWebBrowserControl::HistoryEntry SFZWebBrowserControl::GetHistory(UInt32 index) const
{
    HistoryEntry dummy;

    if (index < GetHistorySize()) {
        return _history[index];
    }
    else {
        dummy.url = SFXAnsiString::EmptyInstance();
        return dummy;
    }
}// SFZWebBrowserControl::GetHistory //

参照

SFZWebBrowserControl::GetHistorySize | SFZWebBrowserControl::GetHistoryList | SFZWebBrowserControl::GetCurrentHistory | SFXAnsiString::EmptyInstance | SFZWebBrowserControl::HistoryEntry

戻り値

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

解説

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

	注意
	配列の先頭は一番新しい履歴となっており、 履歴番号と配列のインデックスは一致します。 履歴リストは SFZWebBrowserControl::HistoryEntry 構造体の配列です。 そのサイズは SFZWebBrowserControl::GetHistorySize 関数で取得できます。 履歴情報が設定されていない場合、 SFZWebBrowserControl::HistoryEntry 構造体の url 変数には空文字列 SFXAnsiString::EmptyInstance() が設定されています。

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

使用例

以下は、すべての履歴内容（タイトルと 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); 
    }
}

内部実装

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

/*public */inline SFZWebBrowserControl::HistoryEntryConstPtr SFZWebBrowserControl::GetHistoryList(Void) const
{
    return _history;
}// SFZWebBrowserControl::GetHistoryList //

参照

SFZWebBrowserControl::GetHistorySize | SFZWebBrowserControl::HistoryEntry

戻り値

履歴リストのエントリ数。

解説

この関数は、履歴リストのエントリ数を取得します。

	注意
	SFZWebBrowserControl::Move 関数や SFZWebBrowserControl::GetHistory 関数などで使用する履歴番号は、 履歴リストのエントリ数より小さな値でなければいけません。

	Tip
	履歴リストは SFZWebBrowserControl::GetHistoryList 関数を使用して取得できます。

内部実装

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

/*public */inline UInt32 SFZWebBrowserControl::GetHistorySize(Void) const
{
    return static_cast<UInt32>(GetMaximumValue());
}

参照

SFZWebBrowserControl::SetHistorySize | SFZWebBrowserControl::GetHistory | SFZWebBrowserControl::GetHistoryList | SFZWebBrowserControl::Move

戻り値

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

解説

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

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

内部実装

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

/*public */SInt32 SFZWebBrowserControl::GetIndent(Void) const
{
    HVOpt                               opt;
    SInt32                              pixel;

    if (_viewer->GetOption(HVOPT_N_INDENT, &opt) == SFERR_NO_ERROR) {
        pixel = SInt32(opt);
    }
    else {
        pixel = -1;
    }
    return pixel;
}// SFZWebBrowserControl::GetIndent //

参照

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

戻り値

リンク文字列の表示色。

解説

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

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

内部実装

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

/*public */SFXRGBColor SFZWebBrowserControl::GetLinkColor(Void) const
{
    HVOpt                               opt;
    SFXRGBColor                         color;

    if (_viewer->GetOption(HVOPT_RGB_LINK, &opt) == SFERR_NO_ERROR) {
        color = SFXRGBColor(RGBVAL(opt));
    }
    return color;
}// SFZWebBrowserControl::GetLinkColor //

参照

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

戻り値

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

解説

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

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

内部実装

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

/*public */SInt32 SFZWebBrowserControl::GetParagraphSpacing(Void) const
{
    HVOpt                               opt;
    SInt32                              pixel;

    if (_viewer->GetOption(HVOPT_N_VSPACE, &opt) == SFERR_NO_ERROR) {
        pixel = SInt32(opt);
    }
    else {
        pixel = -1;
    }
    return pixel;
}// SFZWebBrowserControl::GetParagraphSpacing //

参照

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

戻り値

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

解説

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

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

内部実装

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

/*public */SInt32 SFZWebBrowserControl::GetScrollbarWidth(Void) const
{
    HVOpt                               opt;
    SInt32                              pixel;

    if (_viewer->GetOption(HVOPT_N_SBWIDTH, &opt) == SFERR_NO_ERROR) {
        pixel = SInt32(opt);
    }
    else {
        pixel = -1;
    }
    return pixel;
}// SFZWebBrowserControl::GetScrollbarWidth //

参照

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

戻り値

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

解説

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

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

内部実装

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

/*public */SFXRGBColor SFZWebBrowserControl::GetTextColor(Void) const
{
    HVOpt                               opt;
    SFXRGBColor                         color;

    if (_viewer->GetOption(HVOPT_RGB_TEXT, &opt) == SFERR_NO_ERROR) {
        color = SFXRGBColor(RGBVAL(opt));
    }
    return color;
}// SFZWebBrowserControl::GetTextColor //

参照

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

戻り値

SFZWebBrowserControl::SetWeb 関数で設定された IWeb インターフェース。

解説

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

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

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

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

内部実装

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

/*public */inline SFBWebSmpConstRef SFZWebBrowserControl::GetWeb(Void) const
{
    return _web;
}// SFZWebBrowserControl::GetWeb //

参照

SFZWebBrowserControl::SetWeb | SFZWebBrowserControl::UnsetWeb | SFBWeb | BREW API IWeb

解説

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

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

デフォルトの実装は、内部で保持する BREW API IHtmlViewer インスタンスの領域をこのコントロールを上下左右 3 ピクセルずつ縮小した矩形領域に設定します。

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_GLOBAL) イベントの送信
	領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_GLOBAL, rectangle)] は SFYResponder::SetRealBound または SFYResponder::SetVirtualBound 関数の呼び出しによってグローバル領域が変化したときに発生します。 このとき、(SFEVT_RESPONDER_BOUND, SFP16_BOUND_GLOBAL) イベントは描画エンジンを起動した直後、描画エンジンによって送信されます。

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

	[非推奨（廃止予定　API）]
	この関数は、SophiaFramework UNIVERSE 6.0 で廃止される予定です。 描画ハンドラの処理などでグローバル領域が必要な場合は、 SFYResponder::GetGlobalBound 関数を呼び出して取得してください。

内部実装

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

#define     VIEWER_MARGIN           (3)

/*protected virtual */Void SFZWebBrowserControl::HandleBoundGlobal(SFXRectangleConstRef rectangle)
{
    AdjustViewer(rectangle);
}// SFZWebBrowserControl::HandleBoundGlobal //

/*private */Void SFZWebBrowserControl::AdjustViewer(SFXRectangleConstRef rectangle) const
{
    SFXRectangle                        grect(rectangle);

    grect.Deflate(VIEWER_MARGIN, VIEWER_MARGIN);
    _viewer->SetRect(grect);
}// SFZWebBrowserControl::AdjustViewer //

参照

SFBControl::SetRect | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | グローバル領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

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

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

レスポンダの描画手順

SFYResponder::Invalidate 関数を使用して再描画領域を登録します。 アプリ開始時とレジューム時に全画面再描画を行う SFYApplication::HandleRender 関数内、 イベントループの最後、 あるいは、コールバックなどのイベントループの外で、 自動的に、あるいは、明示的に 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, 0x99, 0xDD, 0x99}}},
        {{{0x00, 0xFF, 0xFF, 0xFF}}},
        {{{0x00, 0x66, 0x66, 0x66}}}
    };
    SFBDisplaySmp                       display;
    SFXRectangle                        rectangle(GetLocalBound());
    SFXRectangle                        grect(GetGlobalBound());

    graphics->DrawBevelRectangle(rectangle, frameRgb);
    rectangle.Deflate(1, 1);
    graphics->DrawRectangle(rectangle, theme[0]);
    rectangle.Deflate(1, 1);
    if (GetStateFocus()) {
        graphics->DrawRectangle(rectangle, theme[1]);
    }
    else {
        graphics->DrawRectangle(rectangle, theme[3]);
    }
    if (_fullscreen_edit) {
        display = SFXGraphics::GetInstance()->GetSFBDisplay();
        display->ResetClipRect();
    }
    _viewer->Redraw();
}// SFZWebBrowserControl::HandleRenderRequest //

参照

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

戻り値

解説

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

内部実装

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

/*public */Bool SFZWebBrowserControl::IsBusy(Void) const
{
    return _webCallback.IsQueued() || _viewer->IsBusy();
}// SFZWebBrowserControl::IsBusy //

戻り値

解説

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

参照

SFZWebBrowserControl::SetInlineEditEnable

戻り値

解説

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

参照

SFZWebBrowserControl::SetScrollbarEnable

引数

解説

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

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

デフォルトの実装は、リンク先 url を自動的に Open します。

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

使用例

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

#include <SFZResponder/SFZControl/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(JumpNotifyConstRef notify) {
        if (notify.GetUrl().StartWith("mailto:")) {
            // mailto:ならメーラーを呼ぶ
            Mailer(notify.GetUrl());
        }
        else {
            // それ以外なら標準ハンドラを呼ぶ
            SFZWebBrowserControl::JumpNotifyHandler(notify);
        }
    }
};

内部実装

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

/*protected virtual */Void SFZWebBrowserControl::JumpNotifyHandler(JumpNotifyConstRef notify)
{
    SFXAnsiString                       url;
    SFBWebUtilSmp                       webUtil;
    SFCError                            error(SFERR_NO_ERROR);

    if ((webUtil = SFBWebUtil::NewInstance(&error)) != null) {
        if (!_history[GetCurrentHistoryIndex()].url.IsEmpty()) {
            url = webUtil->MakeUrl(_history[GetCurrentHistoryIndex()].url, notify.GetUrl());
        }
        else {
            url = notify.GetUrl();
        }
        if (notify.GetType() == HVN_JUMP) {
            Navigate(url);
        }
        else {
            if (notify.GetMethod().Compare("POST") == 0) {
                Navigate(url, notify.GetMethod(), notify.GetData());
            }
            else {
                Navigate(url, notify.GetMethod());
            }
        }
    }
    return;
}// SFZWebBrowserControl::JumpNotifyHandler //

参照

SFZWebBrowserControl::JumpNotify | SFZWebBrowserControl::Navigate | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::FocusNotifyHandler | SFZWebBrowserControl::ResponseNotifyHandler

引数

戻り値

解説

この関数は、指定された文字列を HTML 文書とみなして、レンダリングを開始します。

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

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

内部実装

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

/*public */SFCError SFZWebBrowserControl::Load(SFBSourceSmpConstRef source)
{
    return Load(source, UNKNOWN_URL);
}// SFZWebBrowserControl::Load(SFBSourceSmpConstRef source) //

/*public */SFCError SFZWebBrowserControl::Load(SFBSourceSmpConstRef source, SFXAnsiStringConstRef url)
{
    SFCError                            error(SFERR_NO_ERROR);

    ReorderHistory();
    if (IsBusy()) {
        Stop();
    }
    if ((error = WebSetup(url)) == SFERR_NO_ERROR) {
        _history[GetCurrentHistoryIndex()].url = url;
        _viewer->SetURL(url);
        _viewer->SetIWeb(_web);
        _viewer->LoadSource(source);
    }
    return error;
}// SFZWebBrowserControl::Load(SFBSourceSmpConstRef source, SFXAnsiStringConstRef url) //

/*private */Void SFZWebBrowserControl::ReorderHistory(Void)
{
    UInt32                              i;
    UInt32                              j;

    _stateHistory[GetCurrentHistoryIndex()] = _viewer->GetViewState();
    if (GetCurrentHistoryIndex() == 0) {
        for (i = GetHistorySize() - 1; i >= 1; --i) {
            _history[i] = _history[i - 1];
            _stateHistory[i] = _stateHistory[i - 1];
        }
    }
    else {
        for (i = 1; i < GetHistorySize(); ++i) {
            j = GetCurrentHistoryIndex() + i - 1;
            if (j < GetHistorySize()) {
                _history[i] = _history[j];
                _stateHistory[i] = _stateHistory[j];
            }
            else {
                ClearHistory(i);
            }
        }
    }
    ClearHistory(0);
    SetCurrentValue(0);
}// SFZWebBrowserControl::ReorderHistory //

/*private */SFCError SFZWebBrowserControl::WebSetup(SFXAnsiStringConstRef url)
{
    SFBWebUtilSmp                       webUtil;
    UrlParts                            parts;
    WebOpt                              webopt[4];
    UIntN                               num;
    SFCError                            error;

    if ((webUtil = SFBWebUtil::NewInstance(&error)) != null) {
        ClearWebSubset();
        if (_web == null) {
            if ((_web = SFBWeb::NewInstance(&error)) == null) {
                error = SFERR_FAILED;
            }
        }
        if (error == SFERR_NO_ERROR) {
            if (webUtil->ParseUrl(url, &parts) == SFERR_NO_ERROR) {
                if (url.StartsWith("http://") || url.StartsWith("https://") || url.StartsWith("file://") || url.StartsWith("res:")) {
                    num = 0;
                    webopt[num].nId = WEBOPT_FLAGS;
                    webopt[num].pVal = null;
                    _web->GetOpt(WEBOPT_FLAGS, null, &webopt[num]);
                    webopt[num].pVal = (VoidPtr)(WEBREQUEST_NOWAITCONN | ((UInt32)webopt[num].pVal));
                    ++num;
                    if (url.StartsWith("https://")) {
                        if ((_optSsl = SFBSSLRootCerts::NewInstance(&error)) != null) {
                            webopt[num].nId = WEBOPT_DEFAULTS;
                            webopt[num].pVal = interface_cast(_optSsl.Get());
                            ++num;
                        }
                        else {
                            error = SFERR_INVALID_PARAM;
                        }
                    }
                    if (error == SFERR_NO_ERROR) {
                        if (!_authHeader.IsEmpty()) {
                            RemoveHeader(_authHeader);
                        }
                        if (UP_HASUSER(&parts)) {
                            _authBaseUrl = SFXAnsiString::EmptyInstance();
                            if (!_authHeader.IsEmpty()) {
                                _authHeader.Clear();
                            }
                            MakeAuthHeader(parts.cpcUser, parts.cpcHost - parts.cpcUser - 1); // -1 for '@'
                            if (_authHeader.IsEmpty()) {
                                error = SFERR_NO_MEMORY;
                            }
                        }
                        else if (!_authBaseUrl.IsEmpty() && (!url.StartsWith(_authBaseUrl))) {
                            if (!_authHeader.IsEmpty()) {
                                _authHeader.Clear();
                            }
                            _authBaseUrl = SFXAnsiString::EmptyInstance();
                        }
                        if (error == SFERR_NO_ERROR) {
                            if (!_authHeader.IsEmpty()) {
                                webopt[num].nId = WEBOPT_HEADER;
                                webopt[num].pVal = _authHeader.GetBuffer();
                                ++num;
                            }
                            webopt[num].nId = WEBOPT_END;
                            ASSERT(num < lengthof(webopt) - 1);
                            error = _web->AddOpt(webopt);
                        }
                    }
                }
                else {
                    error = SFERR_INVALID_PARAM;
                }
            }
            else {
                error = SFERR_INVALID_PARAM;
            }
        }
    }
    return error;
}// SFZWebBrowserControl::WebSetup //

参照

SFZWebBrowserControl::Navigate | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::GetCurrentHistoryIndex | SFZWebBrowserControl::IsBusy | SFZWebBrowserControl::Stop

引数

戻り値

解説

この関数は、指定された履歴番号のページへ移動し、ページの再取得と再レンダリングを行います。

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

内部実装

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

/*public */SFCError SFZWebBrowserControl::Move(UInt32 index)
{
    SFCError                            error(SFERR_NO_ERROR);

    if (index < GetHistorySize() && !_history[index].url.IsEmpty()) {
        _stateHistory[GetCurrentHistoryIndex()] = _viewer->GetViewState();
        SetCurrentValue(index);
        error = OpenImpl(_history[GetCurrentHistoryIndex()].url, NULL_STR, NULL_BUFFER);
    }
    else {
        error = SFERR_INVALID_PARAM;
    }
    return error;
}// SFZWebBrowserControl::Move //

/*private */SFCError SFZWebBrowserControl::OpenImpl(SFXAnsiStringConstRef url, SFXAnsiStringConstRef method, SFXBufferConstRef data)
{
    WebOpt                              webopt[4];
    UIntN                               num(0);
    SFBSourceUtilSmp                    su;
    SFCError                            error(SFERR_NO_ERROR);

    if (url.StartsWith("http://") || url.StartsWith("https://")) {
        if (IsBusy()) {
            Stop();
        }
        if ((error = WebSetup(url)) == SFERR_NO_ERROR) {

            // set additonal http option
            if (!method.IsEmpty()) {
                _optMethod = method;
                webopt[num].nId = WEBOPT_METHOD;
                webopt[num].pVal = _optMethod.GetBuffer();
                ++num;
            }
            if (data.GetSize() != 0) {
                if ((_optBodyMem = MemoryAllocate(data.GetSize())) != null) {
                    SFXHelper::memcpy(_optBodyMem, data.GetBuffer(), data.GetSize());
                    _optBody.Release();
                    if ((su = SFBSourceUtil::NewInstance(&error)) != null) {
                        su->PeekFromMemory(_optBodyMem, data.GetSize(), null, null, &_optBody);
                    }
                    // *** vice versa *** //
                    if (_optBody != null) {
                        webopt[num].nId = WEBOPT_BODY;
                        webopt[num].pVal = VoidPtr(&_optBody);
                        ++num;
                    }
                    else {
                        error = SFERR_FAILED;
                    }
                }
                else {
                    error = SFERR_NO_MEMORY;
                }
            }
            if (error == SFERR_NO_ERROR) {
                webopt[num].nId = WEBOPT_END;
                ASSERT(num < lengthof(webopt) - 1);
                _webCallback.Set(WebCallback, this);
                _history[GetCurrentHistoryIndex()].url = url;
                _web->GetResponseV(&_webResp, &_webCallback, _history[GetCurrentHistoryIndex()].url, webopt);
            }
        }
    }
    else {
        error = OpenFileImpl(url);
    }
    return error;
}// SFZWebBrowserControl::OpenImpl //

/*private */SFCError SFZWebBrowserControl::OpenFileImpl(SFXAnsiStringConstRef url)
{
    static ACharConst                   fileScheme[] = "file://localhost/";
    static ACharConst                   resScheme[] = "res:";
    SFXAnsiString                       path;
    SFBFileMgrSmp                       mgr;
    SFBAStreamSmp                       file;
    SFCError                            error(SFERR_NO_ERROR);

    if (url.StartsWith(fileScheme)) {
        path = url.Substring(STRLEN(fileScheme), url.GetLength());
    }
    else if (url.StartsWith(resScheme)) {
        path = url.Substring(STRLEN(resScheme), url.GetLength());
    }
    else {
        error = SFERR_INVALID_PARAM;
    }
    if (error == SFERR_NO_ERROR) {
        if ((mgr = SFBFileMgr::NewInstance(&error)) != null) {
            file = mgr->OpenFile(path, _OFM_READ);
            if (file != null) {
                if (IsBusy()) {
                    Stop();
                }
                if ((error = WebSetup(url)) == SFERR_NO_ERROR) {
                    _history[GetCurrentHistoryIndex()].url = url;
                    _viewer->SetURL(url);
                    _viewer->SetIWeb(_web);
                    _viewer->LoadStream(file);
                }
            }
            else {
                error = SFERR_INVALID_PARAM; // XXX or mgr->GetLastError();
            }
        }
    }
    return error;
}// SFZWebBrowserControl::OpenFileImpl //

/*private static*/Void SFZWebBrowserControl::WebCallback(VoidPtr p)
{
    SFZWebBrowserControlPtr             self(reinterpret_cast<SFZWebBrowserControlPtr>(p));
    WebRespInfo*                        info = self->_webResp->GetInfo();
    ResponseNotify                      response(self->_viewer.Get(), info->nCode);
    SFBSourceSmp                        source(interface_cast(info->pisMessage));

    if (!self->ResponseNotifyHandler(response)) {
        self->_webCode = info->nCode;
        if (self->_webCode >= 0) {
            self->_viewer->SetIWeb(self->_web);
            self->_viewer->SetURL(self->_history[self->GetCurrentHistoryIndex()].url);
            self->_viewer->LoadSource(source);
            self->ClearWebRespAndOpts();
        }
        else {
            DoneNotify notify(self->_viewer.Get(), info->nCode);
            NotifyHandler(self, &notify);
        }
    }
}// SFZWebBrowserControl::WebCallback //

/*private */Void SFZWebBrowserControl::ClearWebRespAndOpts(Void)
{
    _webResp.Release();
    _optMethod = SFXAnsiString::EmptyInstance();
    _optBody.Release();
    if (_optBodyMem != null) {
        MemoryFree(_optBodyMem);
    }
    _optBodyMem = null;
    _optSsl.Release();
}

参照

SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::Navigate | SFZWebBrowserControl::Previous | SFZWebBrowserControl::Next | SFZWebBrowserControl::Reload

引数

戻り値

解説

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

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

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

内部実装

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

/*public */SFCError SFZWebBrowserControl::Navigate(SFXAnsiStringConstRef url)
{
    return Navigate(url, NULL_STR, NULL_BUFFER);
}// SFZWebBrowserControl::Navigate(SFXAnsiStringConstRef url) //

/*public */SFCError SFZWebBrowserControl::Navigate(SFXAnsiStringConstRef url, SFXAnsiStringConstRef method)
{
    return Navigate(url, method, NULL_BUFFER);
}// SFZWebBrowserControl::Navigate(SFXAnsiStringConstRef url, SFXAnsiStringConstRef method) //

/*public */SFCError SFZWebBrowserControl::Navigate(SFXAnsiStringConstRef url, SFXAnsiStringConstRef method, SFXAnsiStringConstRef data)
{
    return Navigate(url, method, SFXBuffer(data));
}// SFZWebBrowserControl::Navigate(SFXAnsiStringConstRef url, SFXAnsiStringConstRef method, SFXAnsiStringConstRef data) //

/*public */SFCError SFZWebBrowserControl::Navigate(SFXAnsiStringConstRef url, SFXAnsiStringConstRef method, SFXBufferConstRef data)
{
    ReorderHistory();
    return OpenImpl(url, method, data);
}// SFZWebBrowserControl::Navigate(SFXAnsiStringConstRef url, SFXAnsiStringConstRef method, SFXBufferConstRef data) //

/*private */Void SFZWebBrowserControl::ReorderHistory(Void)
{
    UInt32                              i;
    UInt32                              j;

    _stateHistory[GetCurrentHistoryIndex()] = _viewer->GetViewState();
    if (GetCurrentHistoryIndex() == 0) {
        for (i = GetHistorySize() - 1; i >= 1; --i) {
            _history[i] = _history[i - 1];
            _stateHistory[i] = _stateHistory[i - 1];
        }
    }
    else {
        for (i = 1; i < GetHistorySize(); ++i) {
            j = GetCurrentHistoryIndex() + i - 1;
            if (j < GetHistorySize()) {
                _history[i] = _history[j];
                _stateHistory[i] = _stateHistory[j];
            }
            else {
                ClearHistory(i);
            }
        }
    }
    ClearHistory(0);
    SetCurrentValue(0);
}// SFZWebBrowserControl::ReorderHistory //

/*private */SFCError SFZWebBrowserControl::OpenImpl(SFXAnsiStringConstRef url, SFXAnsiStringConstRef method, SFXBufferConstRef data)
{
    WebOpt                              webopt[4];
    UIntN                               num(0);
    SFBSourceUtilSmp                    su;
    SFCError                            error(SFERR_NO_ERROR);

    if (url.StartsWith("http://") || url.StartsWith("https://")) {
        if (IsBusy()) {
            Stop();
        }
        if ((error = WebSetup(url)) == SFERR_NO_ERROR) {

            // set additonal http option
            if (!method.IsEmpty()) {
                _optMethod = method;
                webopt[num].nId = WEBOPT_METHOD;
                webopt[num].pVal = _optMethod.GetBuffer();
                ++num;
            }
            if (data.GetSize() != 0) {
                if ((_optBodyMem = MemoryAllocate(data.GetSize())) != null) {
                    SFXHelper::memcpy(_optBodyMem, data.GetBuffer(), data.GetSize());
                    _optBody.Release();
                    if ((su = SFBSourceUtil::NewInstance(&error)) != null) {
                        su->PeekFromMemory(_optBodyMem, data.GetSize(), null, null, &_optBody);
                    }
                    // *** vice versa *** //
                    if (_optBody != null) {
                        webopt[num].nId = WEBOPT_BODY;
                        webopt[num].pVal = VoidPtr(&_optBody);
                        ++num;
                    }
                    else {
                        error = SFERR_FAILED;
                    }
                }
                else {
                    error = SFERR_NO_MEMORY;
                }
            }
            if (error == SFERR_NO_ERROR) {
                webopt[num].nId = WEBOPT_END;
                ASSERT(num < lengthof(webopt) - 1);
                _webCallback.Set(WebCallback, this);
                _history[GetCurrentHistoryIndex()].url = url;
                _web->GetResponseV(&_webResp, &_webCallback, _history[GetCurrentHistoryIndex()].url, webopt);
            }
        }
    }
    else {
        error = OpenFileImpl(url);
    }
    return error;
}// SFZWebBrowserControl::OpenImpl //

/*private */SFCError SFZWebBrowserControl::OpenFileImpl(SFXAnsiStringConstRef url)
{
    static ACharConst                   fileScheme[] = "file://localhost/";
    static ACharConst                   resScheme[] = "res:";
    SFXAnsiString                       path;
    SFBFileMgrSmp                       mgr;
    SFBAStreamSmp                       file;
    SFCError                            error(SFERR_NO_ERROR);

    if (url.StartsWith(fileScheme)) {
        path = url.Substring(STRLEN(fileScheme), url.GetLength());
    }
    else if (url.StartsWith(resScheme)) {
        path = url.Substring(STRLEN(resScheme), url.GetLength());
    }
    else {
        error = SFERR_INVALID_PARAM;
    }
    if (error == SFERR_NO_ERROR) {
        if ((mgr = SFBFileMgr::NewInstance(&error)) != null) {
            file = mgr->OpenFile(path, _OFM_READ);
            if (file != null) {
                if (IsBusy()) {
                    Stop();
                }
                if ((error = WebSetup(url)) == SFERR_NO_ERROR) {
                    _history[GetCurrentHistoryIndex()].url = url;
                    _viewer->SetURL(url);
                    _viewer->SetIWeb(_web);
                    _viewer->LoadStream(file);
                }
            }
            else {
                error = SFERR_INVALID_PARAM; // XXX or mgr->GetLastError();
            }
        }
    }
    return error;
}// SFZWebBrowserControl::OpenFileImpl //

/*private static*/Void SFZWebBrowserControl::WebCallback(VoidPtr p)
{
    SFZWebBrowserControlPtr             self(reinterpret_cast<SFZWebBrowserControlPtr>(p));
    WebRespInfo*                        info = self->_webResp->GetInfo();
    ResponseNotify                      response(self->_viewer.Get(), info->nCode);
    SFBSourceSmp                        source(interface_cast(info->pisMessage));

    if (!self->ResponseNotifyHandler(response)) {
        self->_webCode = info->nCode;
        if (self->_webCode >= 0) {
            self->_viewer->SetIWeb(self->_web);
            self->_viewer->SetURL(self->_history[self->GetCurrentHistoryIndex()].url);
            self->_viewer->LoadSource(source);
            self->ClearWebRespAndOpts();
        }
        else {
            DoneNotify notify(self->_viewer.Get(), info->nCode);
            NotifyHandler(self, &notify);
        }
    }
}// SFZWebBrowserControl::WebCallback //

/*private */Void SFZWebBrowserControl::ClearWebRespAndOpts(Void)
{
    _webResp.Release();
    _optMethod = SFXAnsiString::EmptyInstance();
    _optBody.Release();
    if (_optBodyMem != null) {
        MemoryFree(_optBodyMem);
    }
    _optBodyMem = null;
    _optSsl.Release();
}

参照

SFZWebBrowserControl::Load | SFZWebBrowserControl::DoneNotifyHandler

引数

戻り値

解説

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

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

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

内部実装

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

/*public */SFCError SFZWebBrowserControl::Next(SInt32 n)
{
    SFCError                            error(SFERR_NO_ERROR);

    if (GetCurrentValue() - n >= 0 && GetCurrentValue() - n < GetMaximumValue()) {
        error = Move(static_cast<UInt32>(GetCurrentValue() - n));
    }
    else {
        error = SFERR_INVALID_PARAM;
    }
    return error;
}// SFZWebBrowserControl::Next //

参照

SFZWebBrowserControl::Previous | SFZWebBrowserControl::Navigate | SFZWebBrowserControl::Move | SFZWebBrowserControl::Reload | SFZWebBrowserControl::DoneNotifyHandler

引数

戻り値

解説

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

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

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

内部実装

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

/*public */SFCError SFZWebBrowserControl::Previous(SInt32 n)
{
    return Next(-n);
}// SFZWebBrowserControl::Previous //

参照

SFZWebBrowserControl::Next | SFZWebBrowserControl::Navigate | SFZWebBrowserControl::Move | SFZWebBrowserControl::Reload | SFZWebBrowserControl::DoneNotifyHandler

解説

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

	注意
	現在表示しているページが、 SFZWebBrowserControl::Load 関数か、 IAStream、ISource を引数にした SFZWebBrowserControl::Navigate 関数によるものである場合、 引数の url が適切に設定されていないと再描画に失敗します。

内部実装

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

/*public */Void SFZWebBrowserControl::Reload(Void)
{
    Move(GetCurrentHistoryIndex());
}// SFZWebBrowserControl::Reload //

参照

SFZWebBrowserControl::GetCurrentHistoryIndex | SFZWebBrowserControl::Move | SFZWebBrowserControl::Load | SFZWebBrowserControl::Navigate

引数

戻り値

解説

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

デフォルトの実装以外の処理（タイムアウトなどのエラー処理）を行いたい場合は、 この関数をオーバーライドします。

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

	注意
	SFZWebBrowserControl::DoneNotifyHandler とは 呼び出されるタイミングが違います。

使用例

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

#include <SFZResponder/SFZControl/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(ResponseNotifyConstRef notify) {
        if (notify.GetErrorCode() != SFERR_NO_ERROR) {
            // 通信エラーならエラーダイアログを表示し、HTML をレンダリングしない 
            ErrorDialog(notify.GetErrorCode());
            return true;
        }
        else if (WEB_SUCCEEDED(notify.GetDoneCode())) {
            // HTTP エラーなら警告ダイアログを表示する 
            WarningDialog(notify.GetResposenCode());
        }
        return false;  // 正常、警告ならば HTML をレンダリングする 
    }
};

内部実装

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

/*protected virtual */Bool SFZWebBrowserControl::ResponseNotifyHandler(ResponseNotifyConstRef notify)
{
    unused(notify);
    return false;
}// SFZWebBrowserControl::ResponseNotifyHandler //

参照

SFZWebBrowserControl::ResponseNotify | SFZWebBrowserControl::DoneNotifyHandler | SFZWebBrowserControl::FocusNotifyHandler | SFZWebBrowserControl::JumpNotifyHandler

引数

戻り値

解説

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

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

認証情報の設定を解除する時は、 SFZWebBrowserControl::UnsetAuthorizeData 関数を呼び出します。

また、 url 引数に指定した URL で始まらないページをアクセスした場合、 認証情報の設定は自動的に解除されます。

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

内部実装

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

/*public */SFCError SFZWebBrowserControl::SetAuthorizedData(SFXAnsiStringConstRef user, SFXAnsiStringConstRef passwd, SFXAnsiStringConstRef url)
{
    SFCError                            error(SFERR_NO_ERROR);

    RemoveHeader(_authHeader);
    _authHeader.Clear();
    if (!user.IsEmpty()) {
        _authBaseUrl = url;
        MakeAuthHeader((user + ":" + passwd).GetCString(), user.GetLength() + passwd.GetLength() + 1);
        if (_authHeader.IsEmpty()) {
            error = SFERR_NO_MEMORY;
        }
    }
    else {
        _authBaseUrl = SFXAnsiString::EmptyInstance();
        error = SFERR_NO_ERROR;
    }
    return error;
}// SFZWebBrowserControl::SetAuthorizedData //

/*private */Void SFZWebBrowserControl::RemoveHeader(SFXAnsiStringConstRef header)
{
    WebOpt                              webopt;
    SInt32                              n;

    for (n = 0; _web->GetOpt(WEBOPT_HEADER, n, &webopt) == SFERR_NO_ERROR; ++n) {
        if (header.Compare(static_cast<ACharConstPtr>(webopt.pVal)) == 0) {
            _web->RemoveOpt(WEBOPT_HEADER, n);
            break;
        }
    }
}// SFZWebBrowserControl::RemoveHeader //

/*private */Void SFZWebBrowserControl::MakeAuthHeader(SFXAnsiStringConstRef auth, UIntN len)
{
    SFXAnsiString                       base64;
    SFBWebUtilSmp                       webUtil;
    SFCError                            error;

    base64 = "";
    base64.SetThreshold(BASE64LEN(len) + 1);
    if ((webUtil = SFBWebUtil::NewInstance(&error)) != null) {
        webUtil->EncodeBase64(auth.GetCString(), len, base64.GetBuffer());
        base64.SetChar(BASE64LEN(len), '\0');
    }
    _authHeader = SFXAnsiString::Format("Authorization: Basic %s\r\n", base64.GetCString());
    return;
}// SFZWebBrowserControl::MakeAuthHeader //

参照

SFZWebBrowserControl::UnsetAuthorizeData

引数

戻り値

解説

この関数は、履歴リストのサイズを設定します。

デフォルト値: SFZWebBrowserControl::HISTORY_SIZE（30）

戻り値が SFERR_NO_ERROR でない場合、履歴リストのサイズは変更されません。

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

参照

SFZWebBrowserControl::GetCurrentHistoryIndex | SFZWebBrowserControl::GetHistory | SFZWebBrowserControl::GetHistoryList | SFZWebBrowserControl::Move | SFZWebBrowserControl::DEFAULT

引数

戻り値

解説

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

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

内部実装

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

/*public */SFCError SFZWebBrowserControl::SetIndent(SInt32 pixel)
{
    SFCError                            error(SFERR_NO_ERROR);

    RenderSafe();
    error = _viewer->SetOption(HVOPT_N_INDENT, (HVOpt)pixel);
    Invalidate();
    return error;
}// SFZWebBrowserControl::SetIndent //


/*private */Void SFZWebBrowserControl::RenderSafe(Void)
{
    SFXGraphics::GetInstance()->SetClip(SFXRectangle::EmptyInstance());
}// SFZWebBrowserControl::RenderSafe //

参照

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

引数

解説

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

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

内部実装

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

/*public */Void SFZWebBrowserControl::SetInlineEditEnable(Bool enable)
{
    UInt32                              property;

    property = _viewer->GetProperties();
    if (enable) {
        property |= HVP_INLINE_EDIT;
    }
    else {
        property &= ~HVP_INLINE_EDIT;
    }
    RenderSafe();
    _viewer->SetProperties(property);
    Invalidate();
    return;
}// SFZWebBrowserControl::SetInlineEditEnable //

/*private */Void SFZWebBrowserControl::RenderSafe(Void)
{
    SFXGraphics::GetInstance()->SetClip(SFXRectangle::EmptyInstance());
}// SFZWebBrowserControl::RenderSafe //

参照

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

引数

戻り値

解説

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

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

内部実装

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

/*public */SFCError SFZWebBrowserControl::SetLinkColor(SFXRGBColorConstRef color)
{
    SFCError                            error(SFERR_NO_ERROR);

    RenderSafe();
    error = _viewer->SetOption(HVOPT_RGB_LINK, HVOpt(color.AsRGBVAL()));
    Invalidate();
    return error;
}// SFZWebBrowserControl::SetLinkColor //

/*private */Void SFZWebBrowserControl::RenderSafe(Void)
{
    SFXGraphics::GetInstance()->SetClip(SFXRectangle::EmptyInstance());
}// SFZWebBrowserControl::RenderSafe //

参照

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

引数

戻り値

解説

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

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

内部実装

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

/*public */SFCError SFZWebBrowserControl::SetParagraphSpacing(SInt32 pixel)
{
    SFCError                            error(SFERR_NO_ERROR);

    RenderSafe();
    error = _viewer->SetOption(HVOPT_N_VSPACE, (HVOpt)pixel);
    Invalidate();
    return error;
}// SFZWebBrowserControl::SetParagraphSpacing //

/*private */Void SFZWebBrowserControl::RenderSafe(Void)
{
    SFXGraphics::GetInstance()->SetClip(SFXRectangle::EmptyInstance());
}// SFZWebBrowserControl::RenderSafe //

参照

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

引数

解説

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

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

内部実装

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

/*public */Void SFZWebBrowserControl::SetScrollbarEnable(Bool enable)
{
    UInt32                              property;

    property = _viewer->GetProperties();
    if (enable) {
        property |= HVP_SCROLLBAR;
    }
    else {
        property &= ~HVP_SCROLLBAR;
    }
    RenderSafe();
    _viewer->SetProperties(property);
    Invalidate();
    return;
}// SFZWebBrowserControl::SetScrollbarEnable //

/*private */Void SFZWebBrowserControl::RenderSafe(Void)
{
    SFXGraphics::GetInstance()->SetClip(SFXRectangle::EmptyInstance());
}// SFZWebBrowserControl::RenderSafe //

参照

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

引数

戻り値

解説

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

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

内部実装

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

/*public */SFCError SFZWebBrowserControl::SetScrollbarWidth(SInt32 pixel)
{
    SFCError                            error(SFERR_NO_ERROR);

    RenderSafe();
    error = _viewer->SetOption(HVOPT_N_SBWIDTH, (HVOpt)pixel);
    Invalidate();
    return error;
}// SFZWebBrowserControl::SetScrollbarWidth //

/*private */Void SFZWebBrowserControl::RenderSafe(Void)
{
    SFXGraphics::GetInstance()->SetClip(SFXRectangle::EmptyInstance());
}// SFZWebBrowserControl::RenderSafe //

参照

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

引数

戻り値

解説

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

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

内部実装

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

/*public */SFCError SFZWebBrowserControl::SetTextColor(SFXRGBColorConstRef color)
{
    SFCError                            error(SFERR_NO_ERROR);

    RenderSafe();
    error = _viewer->SetOption(HVOPT_RGB_TEXT, HVOpt(color.AsRGBVAL()));
    Invalidate();
    return error;
}// SFZWebBrowserControl::SetTextColor //

/*private */Void SFZWebBrowserControl::RenderSafe(Void)
{
    SFXGraphics::GetInstance()->SetClip(SFXRectangle::EmptyInstance());
}// SFZWebBrowserControl::RenderSafe //

参照

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

引数

解説

この関数は、 HTTP 通信でサーバーにアクセスするときに使用される BREW API IWeb インターフェースを設定します。

ネットワークアクセス中、あるいはレンダリング中の場合、それらの処理は中断されます。

この関数で設定した値は、 SFZWebBrowserControl::GetWeb 関数で取得できます。

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

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

使用例

以下は、HTTP リクエストヘッダーを設定するコードと、 タイムアウトを設定するコードです。

	注意
	端末がサスペンドすると設定が無効になるので、 レジュームハンドラ内で設定し直す必要があります。

// HTTP リクエストヘッダーを設定するコード
// ※header: 設定が有効な間は解放してはならない。例えば、header には "User-Agent: ibROWSE/0.1 (SophiaFramework; I; BREW 4.0)\r\n"　などを指定する。
SCError sample::SetHeader(SFXAnsiStringConstRef header, SFZWebBrowserControlRef browser) {
    SFBWebSmp web;
    SFCError error(SFERR_NO_ERROR);

    web = browser.GetWeb();
    if (web == null) {

        web = SFBWeb::NewInstance(&error);
    }
    if (error == SFERR_NO_ERROR) {

        WebOpt opts[2];
        opts[0].nId = WEB_HEADER;
        opts[0].pVal = const_cast<ACharPtr>(header.GetCString()); // 設定する文字列をヒープに確保する場合、設定が有効な間は解放してはならない
        opts[1].nId = WEBOPT_END;
        opts[1].pVal = null;  // "opts[1].pVal = null;" は省略可
        if ((error = web->AddOpt(opts)) == SFERR_NO_ERROR) {

            browser.SetWeb(web);            
        }
    }

    return error;
}

// タイムアウトを設定するコード
SCError sample::SetTimeOut(UInt32 time_out, SFZWebBrowserControlRef browser) {
    SFBWebSmp web;
    SFCError error(SFERR_NO_ERROR);

    web = browser.GetWeb();
    if (web == null) {

        web = SFBWeb::NewInstance(&error);
    }
    if (error == SFERR_NO_ERROR) {

        // SFBWeb にタイムアウトを設定する
        WebOpt opts[2];
        opts[0].nId = WEBOPT_CONNECTTIMEOUT;
        opts[0].pVal = reinterpret_cast<VoidPtr>(time_out); // 単位: ミリ秒
        opts[1].nId = WEBOPT_END;
        if ((error = web->AddOpt(opts)) == SFERR_NO_ERROR) {

            browser.SetWeb(web);            
        }
    }

    return error;
}

参照

SFZWebBrowserControl::UnsetWeb | SFZWebBrowserControl::GetWeb | SFBHTMLViewer | SFBWeb | SFBWebResp | SFBWebOpts | BREW API IHtmlViewer | BREW API IWeb | BREW API IWebResp | BREW API IWebOpts | BREW API WebOpt

解説

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

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

内部実装

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

/*public */Void SFZWebBrowserControl::Stop(Void)
{
    _webCallback.Cancel();
    _viewer->Stop();
    return;
}// SFZWebBrowserControl::Stop //

参照

SFZWebBrowserControl::~SFZWebBrowserControl

戻り値

解説

この関数は、 SFZWebBrowserControl::SetAuthorizeData 関数による HTTP ベーシック認証の設定を解除します。

	注意
	この関数を実行した後は、 HTTP リクエストには認証情報のヘッダーは付きません。

内部実装

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

/*public */SFCError SFZWebBrowserControl::UnsetAuthorizedData(Void)
{
    return SetAuthorizedData(NULL_STR, NULL_STR, NULL_STR);
}// SFZWebBrowserControl::UnsetAuthorizedData //

参照

SFZWebBrowserControl::SetAuthorizeData

解説

この関数は、 SFZWebBrowserControl::SetWeb 関数による BREW API IWeb インターフェースの設定を解除します。

この関数を実行すると、 通信に必要な BREW API IWeb インターフェースはコントロール内部で作成されます。

現在通信中、もしくはレンダリング中の場合は、それらの処理は中断されます。

内部実装

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

/*public */Void SFZWebBrowserControl::UnsetWeb(Void)
{
    Stop();
    ClearWebRespAndOpts();
    _web.Release();
}// SFZWebBrowserControl::UnsetWeb //


/*private */Void SFZWebBrowserControl::ClearWebRespAndOpts(Void)
{
    _webResp.Release();
    _optMethod = SFXAnsiString::EmptyInstance();
    _optBody.Release();
    if (_optBodyMem != null) {
        MemoryFree(_optBodyMem);
    }
    _optBodyMem = null;
    _optSsl.Release();
}

参照

SFZWebBrowserControl::SetWeb | SFZWebBrowserControl::GetWeb | SFZWebBrowserControl::Stop | SFBWeb | BREW API IWeb

参照

SFYResponder::GetType | SFYResponder::SetType

解説

履歴リストの大きさのデフォルト値を示す HISTORY_SIZE のみ定義されています。

参照

SFZWebBrowserControl::SetHistorySize

解説

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

SFZWebBrowserControl::DoneNotifyHandler 関数の引数として渡されるデータの型です。

DoneNotify クラスは以下のメンバ関数から構成されます。

参照

SFZWebBrowserControl::DoneNotifyHandler | BREW API HViewNotify | BREW API WEB_ERROR_SUCCEEDED | BREW API WEB_ERROR_MAP

解説

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

SFZWebBrowserControl::FocusNotifyHandler 関数の引数として渡されるデータの型です。

FocusNotify クラスは、以下のメンバ関数から構成されます。

参照

SFZWebBrowserControl::FocusNotifyHandler | SFZWebBrowserControl::FindElement | BREW API HViewNotify

解説

この型は、履歴内容（URL とタイトル）を表す構造体です。

参照

SFZWebBrowserControl::GetHistory | SFZWebBrowserControl::GetHistoryList

解説

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

SFZWebBrowserControl::JumpNotifyHandler 関数の引数として渡されるデータの型です。

JumpNotify クラスは、以下のメンバ関数から構成されます。

参照

SFZWebBrowserControl::JumpNotifyHandler | SFZWebBrowserControl::FindElement | BREW API HViewNotify |

解説

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

SFZWebBrowserControl::ResponseNotifyHandler 関数の引数として渡されるデータの型です。

ResponseNotify クラスは、以下のメンバ関数から構成されます。

参照

SFZWebBrowserControl::ResponseNotifyHandler | BREW API HViewNotify