SFBHtmlViewer

IHtmlViewer インターフェイスのラッパークラスです。

#include <SFBHtmlViewer.hpp>

class SFBHtmlViewer : public SFBControl;

typedef SFBHtmlViewer&          SFBHtmlViewerRef;
typedef SFBHtmlViewer*          SFBHtmlViewerPtr;
typedef SFBHtmlViewer**         SFBHtmlViewerHandle;
typedef const SFBHtmlViewer     ConstSFBHtmlViewer;
typedef const SFBHtmlViewer&    ConstSFBHtmlViewerRef;
typedef const SFBHtmlViewer*    ConstSFBHtmlViewerPtr;
typedef const SFBHtmlViewer**   ConstSFBHtmlViewerHandle;

継承図

参照

BREW API IHtmlViewer

バグ情報

画像の表示について
ドキュメントエラー	BREW API リファレンス 2.0.1.5

BREW SDK 2.0.1.1 より、ドキュメントには記載されておりませんが、 HVP_LOADALLIMAGE というプロパティが定義されました。これにより <image> タグ内で、width/height の指定を行わなくても画像を正しく表示するようになります。この指定を行わない場合、必ず width/height を指定する必要があります。

IHTMLVIEWER_GetError (1/2)
ドキュメントエラー	BREW API リファレンス 2.0.1.5

対象となる HVERROR が存在しないため、この API は現在意味を持ちません。

IHTML_VIEWER_GetError (2/2)
ドキュメントエラー	BREW API リファレンス 2.0.1.5

BREW API リファレンスでは、この関数は以下のように定義されていますが、

int IHTMLVIEWER_GetError(IHtmlViewer * pIHTMLViewer);

正しくは以下の通りです。

int IHTMLVIEWER_GetError(IHtmlViewer * pIHTMLViewer, HVOpt * ppVal);

ppVal にエラーが格納され、戻り値としては、成功時には SUCCESS が、失敗時には EUNSUPPORTED が返ります。ただし、IHTMLViewer_GetError (1/2) の項で述べましたように現在この関数は動作しません。

メンバ

パブリック関数
public	AddRef (SFBBase から継承)	インターフェイスの参照カウントをインクリメントします。
public	FindElem	指定された要素名と発生順序の要素を検索します。
public	GetAttrValue	要素の属性の値を取得します。
public	GetElemText	要素のテキスト内容を取得します。
public	GetOption	ビューワの状態を記述する値の１つを取得します。この関数は、SFBHtmlViewer::SetOption で設定された値は取得しません。
public	GetProperties (SFBControl から継承)	コントロール固有のプロパティまたはフラグを返します。
public	GetRect (SFBControl から継承)	コントロールの矩形を取得します。
public	GetViewState	現在のビューワ状態を記述する文字列を返します。この文字列を SFBHtmlViewer::SetViewState に渡すことで、ビューワ状態を復元できます。
public	HandleEvent (SFBControl から継承)	コントロールのイベント処理機能を提供します。この関数はすべてのコントロールで実装する必要があります。
public static	Instance	IHtmlViewer インターフェイスのインスタンスを取得します。
public	IsActive (SFBControl から継承)	コントロールのアクティブ状態を返します。
public	IsBusy	ビューワが SFBAStream または SFBSource からの HTML のロード中であるときに、 TRUE を返します。
public	LoadSource	SFBSource の内容をドキュメントにロードし、そのデータを HTML として構文解析します。
public	LoadStream	SFBAStream の内容をドキュメントにロードし、そのデータを HTML として構文解析します。
public	ParseBuffer	ビューワに文字列の内容をロードします。
public	Redraw (SFBControl から継承)	コントロールの内容を再描画します。
public	Release (SFBBase から継承)	インターフェイスの参照カウントをデクリメントします。
public	Reset (SFBControl から継承)	コントロールの内容をリセットし、アクティブ状態をすぐに解除します。
public	SetActive (SFBControl から継承)	コントロールのアクティブ状態を設定/解除します。
public	SetData	ビューワにHTMLのバッファを提供します。バッファの内容はすべて同期で構文解析され、ビューワに供給されます。
public	SetIWeb	SFBHtmlViewer::SetOption (HVOPT_PTR_IWEB) の簡略関数です。ビューワがサブオブジェクトを取得するために使用する IWeb インタフェースを設定します。
public	SetIndent	SFBHtmlViewer::SetOption (HVOPT_N_INDENT) の簡略関数です。基本字下げの値を設定します。
public	SetLinkColor	SFBHtmlViewer::SetOption (HVOPT_RGB_LINK) の簡略関数です。デフォルトのテキスト色を設定します。
public	SetNotifyFn	通知コールバックの情報を指定します。
public	SetOption	ビューワの動作を制御するオプションの１つを設定します。通常はこの関数は使用しません。各オプション専用の別の関数が定義されています。
public	SetProperties (SFBControl から継承)	コントロール固有のプロパティまたはフラグを設定します。
public	SetRect (SFBControl から継承)	コントロールの矩形を設定します。
public	SetSBWidth	SFBHtmlViewer::SetOption (HVOPT_N_SBWIDTH) の簡略関数です。垂直スクロールバーの幅を設定します。
public	SetTextColor	SFBHtmlViewer::SetOption (HVOPT_RGB_TEXT) の簡略関数です。既定のテキスト色を設定します。
public	SetType	SFBHtmlViewer::SetOption (HVOPT_SZ_TYPE) の簡略関数です。ビューワにMIMEタイプおよび／または文字セットを設定します。
public	SetURL	ビューワにロードするドキュメントの URL アドレスを指定します。この関数は、HTML がドキュメントにロードされる前に呼び出す必要があります。
public	SetVSpace	SFBHtmlViewer::SetOption (HVOPT_N_VSPACE) の簡略関数です。垂直段落間隔を設定します。
public	SetViewState	HTML ビューワの状態（スクロール位置など）を、 SFBHtmlViewer::GetViewState から返される文字列で表現される状態に復元します。
public	Stop	ビューワがビジーな場合に、ビューワが IAStream または ISourceから HTML をロードするのを停止させます。このコールによりドキュメントのロードが停止した場合は、 HVN_DONE 通知が起動されます。

SFBHtmlViewer::FindElem

指定された要素名と発生順序の要素を検索します。

[ public ]
SInt32 FindElem(
    ConstACharPtr pszElem   
    SIntN nIndex            
);

[ public ]
SInt32 FindElem(
    ConstSFUAnsiStringRef strElem   
    SIntN nIndex                    
);

参照

BREW API IHTMLVIEWER_FindElem

SFBHtmlViewer::GetAttrValue

要素の属性の値を取得します。

[ public ]
SInt32 GetAttrValue(
    SInt32 nElemPos         // 要素の位置
    ConstACharPtr pszAttr   // 属性の名前
    ACharPtr pchBuf         // 結果を取得するバッファ
    SInt32 cbBuf            // バッファのサイズ
);

[ public ]
SInt32 GetAttrValue(
    SInt32 nElemPos                 // 要素の位置
    ConstSFUAnsiStringRef pszAttr   // 属性の名前
    ACharPtr pchBuf                 // 結果を取得するバッファ
    SInt32 cbBuf                    // バッファのサイズ
);

[ public ]
SInt32 GetAttrValue(
    SInt32 nElemPos           // 要素の位置
    ConstACharPtr pszAddr     // 属性の名前
    SFUAnsiStringPtr strBuf   // 結果を取得する文字列
    SInt32 cbBuf = 256        // バッファのサイズ
);

[ public ]
SInt32 GetAttrValue(
    SInt32 nElemPos                 // 要素の位置
    ConstSFUAnsiStringRef pszAddr   // 属性の名前
    SFUAnsiStringPtr strBuf         // 結果を取得する文字列
    SInt32 cbBuf = 256              // バッファのサイズ
);

参照

BREW API IHTMLVIEWER_GetAttrValue

SFBHtmlViewer::GetElemText

要素のテキスト内容を取得します。

[ public ]
SInt32 GetElemText(
    SInt32 nElemPos   
    ACharPtr pchBuf   
    SInt32 cbBuf      
);

[ public ]
SInt32 GetElemText(
    SInt32 nElemPos            
    SFUAnsiStringPtr pstrBuf   
    SInt32 cbBuf = 256         
);

[ public ]
SFUAnsiString GetElemText(
    SInt32 nElemPos      
    SInt32 cbBuf = 256   
);

参照

BREW API IHTMLVIEWER_GetElemText | SFBHtmlViewer::FindElem | SFBHtmlViewer::GetAttrValue

SFBHtmlViewer::GetOption

ビューワの状態を記述する値の１つを取得します。この関数は、SFBHtmlViewer::SetOption で設定された値は取得しません。

[ public ]
SFCError GetOption(
    SInt32 nID      
    HVOpt * ppVal   
);

参照

BREW API IHTMLVIEWER_GetOption | SFBHtmlViewer::SetOption | SFBHtmlViewer::GetError

SFBHtmlViewer::GetViewState

現在のビューワ状態を記述する文字列を返します。この文字列を SFBHtmlViewer::SetViewState に渡すことで、ビューワ状態を復元できます。

[ public ]
SIntN GetViewState(
    ACharPtr pszBuffer   
    SIntN cbBuffer       
);

参照

BREW API IHTMLVIEWER_GetViewState | SFBHtmlViewer::SetViewState

SFBHtmlViewer::Instance

IHtmlViewer インターフェイスのインスタンスを取得します。

[ public, static ]
SFUBrewPtr<SFBHtmlViewer> Instance(Void);

SFBHtmlViewer::IsBusy

ビューワが SFBAStream または SFBSource からの HTML のロード中であるときに、 TRUE を返します。

[ public ]
Bool IsBusy(Void);

参照

BREW API IHTMLVIEWER_IsBusy

SFBHtmlViewer::LoadSource

SFBSource の内容をドキュメントにロードし、そのデータを HTML として構文解析します。

[ public ]
Void LoadSource(
    const SFUBrewPtr<SFBSource>& source   
);

参照

BREW API IHTMLVIEWER_LoadSource

SFBHtmlViewer::LoadStream

SFBAStream の内容をドキュメントにロードし、そのデータを HTML として構文解析します。

[ public ]
Void LoadStream(
    const SFUBrewPtr<SFBAStream>& source   
);

参照

BREW API IHTMLVIEWER_LoadStream

SFBHtmlViewer::ParseBuffer

ビューワに文字列の内容をロードします。

[ public ]
Void ParseBuffer(
    ConstACharPtr pcText   
);

[ public ]
Void ParseBuffer(
    ConstSFUAnsiStringRef strText   
);

参照

BREW API IHTMLVIEWER_ParseBuffer

SFBHtmlViewer::SetData

ビューワにHTMLのバッファを提供します。バッファの内容はすべて同期で構文解析され、ビューワに供給されます。

[ public ]
Void SetData(
    ConstACharPtr pcText   
    SIntN nLen = -1        
);

[ public ]
Void SetData(
    ConstSFUAnsiStringRef pcText   
    SIntN nLen = -1                
);

参照

BREW API IHTMLVIEWER_SetData | SFBHtmlViewer::ParseBuffer

SFBHtmlViewer::SetIndent

SFBHtmlViewer::SetOption (HVOPT_N_INDENT) の簡略関数です。基本字下げの値を設定します。

[ public ]
SFCError SetIndent(
    SIntN nIndent   
);

参照

BREW API IHTMLVIEWER_SetIndent | SFBHtmlViewer::SetOption

SFBHtmlViewer::SetIWeb

SFBHtmlViewer::SetOption (HVOPT_PTR_IWEB) の簡略関数です。ビューワがサブオブジェクトを取得するために使用する IWeb インタフェースを設定します。

[ public ]
SFCError SetIWeb(
    SFUBrewPtr<SFBWeb>::Ptr pWeb   
);

参照

BREW API IHTMLVIEWER_SetIWeb

SFBHtmlViewer::SetLinkColor

SFBHtmlViewer::SetOption (HVOPT_RGB_LINK) の簡略関数です。デフォルトのテキスト色を設定します。

[ public ]
Void SetLinkColor(
    ConstSFUColorRef rgbLink   
);

参照

BREW API IHTMLVIEWER_SetLinkColor | SFBHtmlViewer::SetOption

SFBHtmlViewer::SetNotifyFn

通知コールバックの情報を指定します。

[ public ]
Void SetNotifyFn(
    PFNHVIEWNOTIFY pfnNotify   
    VoidPtr pvUser             
);

参照

BREW API IHTMLVIEWER_SetNotifyFn | PFNHVIEWNOTIFY

SFBHtmlViewer::SetOption

ビューワの動作を制御するオプションの１つを設定します。通常はこの関数は使用しません。各オプション専用の別の関数が定義されています。

[ public ]
SFCError SetOption(
    SInt32 nID   
    HVOpt pVal   
);

参照

SFBHtmlViewer::SetSBWidth

SFBHtmlViewer::SetOption (HVOPT_N_SBWIDTH) の簡略関数です。垂直スクロールバーの幅を設定します。

[ public ]
SFCError SetSBWidth(
    SIntN nSBWidth   
);

参照

BREW API IHTMLVIEWER_SetSBWidth

SFBHtmlViewer::SetTextColor

SFBHtmlViewer::SetOption (HVOPT_RGB_TEXT) の簡略関数です。既定のテキスト色を設定します。

[ public ]
SFCError SetTextColor(
    ConstSFUColorPtr rgb   
);

参照

BREW API IHTMLVIEWER_SetTextColor

SFBHtmlViewer::SetType

SFBHtmlViewer::SetOption (HVOPT_SZ_TYPE) の簡略関数です。ビューワにMIMEタイプおよび／または文字セットを設定します。

[ public ]
SFCError SetType(
    ConstACharPtr pszType   
);

[ public ]
SFCError SetType(
    ConstSFUAnsiStringRef strType   
);

参照

BREW API IHTMLVIEWER_SetType | SFBHtmlViewer::SetOption

SFBHtmlViewer::SetURL

ビューワにロードするドキュメントの URL アドレスを指定します。この関数は、HTML がドキュメントにロードされる前に呼び出す必要があります。

[ public ]
SFCError SetURL(
    ConstACharPtr pszURL   
);

[ public ]
SFCError SetURL(
    ConstSFUAnsiStringRef strURL   
);

参照

BREW API IHTMLVIEWER_SetURL | SFBHtmlViewer::SetOption

SFBHtmlViewer::SetViewState

HTML ビューワの状態（スクロール位置など）を、 SFBHtmlViewer::GetViewState から返される文字列で表現される状態に復元します。

[ public ]
Void SetViewState(
    PCSTR pcszState   
);

参照

BREW API IHTMLVIEWER_SetViewState | SFBHtmlViewer::GetViewState

SFBHtmlViewer::SetVSpace

SFBHtmlViewer::SetOption (HVOPT_N_VSPACE) の簡略関数です。垂直段落間隔を設定します。

[ public ]
SFCError SetVSpace(
    SIntN nVSpace   
);

参照

BREW API IHTMLVIEWER_SetVSpace | SFBHtmlViewer::GetViewState

SFBHtmlViewer::Stop

ビューワがビジーな場合に、ビューワが IAStream または ISourceから HTML をロードするのを停止させます。このコールによりドキュメントのロードが停止した場合は、 HVN_DONE 通知が起動されます。

[ public ]
Void Stop(Void);

参照

BREW API IHTMLVIEWER_Stop