前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFBHTMLViewer
IHtmlViewer インターフェースのラッパークラスです。
#include <SFBHTMLViewer.h.hpp>
class SFBHTMLViewer : public SFBControl;
SFMTYPEDEFWRAPPER(SFBHTMLViewer)

継承図

SFBHTMLViewer クラスの継承図

バージョン

BREW 2.0 BREW 2.1 BREW 3.1 BREW 4.0

参照

BREW API IHtmlViewer

メンバ

パブリック関数
SInt32 FindElem( ACharConstPtr element , SInt32 index )
指定した要素名と発生順序の要素を検索します。
SInt32 FindElem( SFXAnsiStringConstRef element , SInt32 index )
指定した要素名と発生順序の要素を検索します。
SInt32 GetAttrValue( SInt32 pos , ACharConstPtr attribute , ACharPtr buf , SInt32 bufSize )
要素の属性の値を取得します。
SInt32 GetAttrValue( SInt32 pos , SFXAnsiStringConstRef attribute , ACharPtr buf , SInt32 bufSize )
要素の属性の値を取得します。
SInt32 GetAttrValue( SInt32 pos , ACharConstPtr attribute , SFXAnsiStringPtr string )
要素の属性の値を取得します。
SInt32 GetAttrValue( SInt32 pos , SFXAnsiStringConstRef attribute , SFXAnsiStringPtr string )
要素の属性の値を取得します。
SInt32 GetElemText( SInt32 pos , ACharPtr buf , SInt32 bufSize )
要素のテキスト内容を取得します。
SInt32 GetElemText( SInt32 pos , SFXAnsiStringPtr string )
要素のテキスト内容を取得します。
SFCError GetOption( SInt32 id , HVOpt* state )
ビューワの状態を記述する値の 1 つを取得します。 この関数は、SFBHTMLViewer::SetOption で設定された値は取得しません。
SInt32 GetViewState( ACharPtr buf , SInt32 bufSize )
現在のビューワ状態を記述する文字列を取得します。 この文字列を SFBHTMLViewer::SetViewState に渡すことで、 ビューワ状態を復元できます。
SInt32 GetViewState( SFXAnsiStringPtr string )
現在のビューワ状態を記述する文字列を取得します。 この文字列を SFBHTMLViewer::SetViewState に渡すことで、 ビューワ状態を復元できます。
SFXAnsiString GetViewState( Void )
現在のビューワ状態を記述する文字列を取得します。 この文字列を SFBHTMLViewer::SetViewState に渡すことで、 ビューワ状態を復元できます。
Bool IsBusy( Void )
ビューワが SFBAStream または SFBSource から HTML ファイルをロード中であるかを判定します。
Void LoadSource( SFBSourceSmpConstRef source )
SFBSource の内容をドキュメントにロードし、 そのデータを HTML として構文解析します。
SFCError LoadSource( SFXStorageConstRef storage )
SFBSource の内容をドキュメントにロードし、 そのデータを HTML として構文解析します。
Void LoadStream( SFBAStreamSmpConstRef stream )
SFBAStream の内容をドキュメントにロードし、 そのデータを HTML として構文解析します。
SFCError LoadStream( SFXStorageConstRef storage )
SFBAStream の内容をドキュメントにロードし、 そのデータを HTML として構文解析します。
static
SFBHTMLViewerSmp
NewInstance( SFCErrorPtr exception = null )
SFBHTMLViewer インスタンスを生成します。
static
SFBHTMLViewerSmp
NewInstance( AEECLSID id , SFCErrorPtr exception = null )
SFBHTMLViewer インスタンスを生成します。
Void ParseBuffer( ACharConstPtr string )
ビューワに文字列の内容をロードします。
Void ParseBuffer( SFXAnsiStringConstRef string )
ビューワに文字列の内容をロードします。
Void SetData( ACharConstPtr buf , SInt32 bufSize = -1 )
ビューワにHTMLのバッファを提供します。 バッファの内容はすべて同期で構文解析され、ビューワに供給されます。
Void SetData( SFXAnsiStringConstRef string )
ビューワにHTMLのバッファを提供します。 バッファの内容はすべて同期で構文解析され、ビューワに供給されます。
SFCError SetIWeb( SFBWebSmpConstRef web )
SFBHTMLViewer::SetOption ( HVOPT_PTR_IWEB ) の簡略関数です。 ビューワがサブオブジェクトを取得するために使用する SFBWeb インターフェースを設定します。
SFCError SetIndent( SInt32 indent )
SFBHTMLViewer::SetOption ( HVOPT_N_INDENT ) の簡略関数です。 基本字下げの値を設定します。
Void SetLinkColor( RGBVAL color )
SFBHTMLViewer::SetOption ( HVOPT_RGB_LINK ) の簡略関数です。 デフォルトのテキスト色を設定します。
Void SetLinkColor( SFXRGBColorConstRef color )
SFBHTMLViewer::SetOption ( HVOPT_RGB_LINK ) の簡略関数です。 デフォルトのテキスト色を設定します。
Void SetNotifyFn( PFNHVIEWNOTIFY notify , VoidPtr data = null )
通知コールバックの情報を指定します。
SFCError SetOption( SInt32 id , HVOpt state )
ビューワの動作を制御するオプションの 1 つを設定します。 通常はこの関数は使用しません。 各オプション専用の別の関数が定義されています。
SFCError SetSBWidth( SInt32 width )
SFBHTMLViewer::SetOption ( HVOPT_N_SBWIDTH ) の簡略関数です。 垂直スクロールバーの幅を設定します。
SFCError SetTextColor( RGBVAL color )
SFBHTMLViewer::SetOption ( HVOPT_RGB_TEXT ) の簡略関数です。 既定のテキスト色を設定します。
SFCError SetTextColor( SFXRGBColorConstRef color )
SFBHTMLViewer::SetOption ( HVOPT_RGB_TEXT ) の簡略関数です。 既定のテキスト色を設定します。
SFCError SetType( ACharConstPtr type )
SFBHTMLViewer::SetOption ( HVOPT_SZ_TYPE ) の簡略関数です。 ビューワにMIMEタイプおよび / または文字セットを設定します。
SFCError SetType( SFXAnsiStringConstRef type )
SFBHTMLViewer::SetOption ( HVOPT_SZ_TYPE ) の簡略関数です。 ビューワにMIMEタイプおよび / または文字セットを設定します。
SFCError SetURL( ACharConstPtr url )
ビューワにロードするドキュメントの URL アドレスを指定します。 この関数は、HTML がドキュメントにロードされる前に呼び出す必要があります。
SFCError SetURL( SFXAnsiStringConstRef url )
ビューワにロードするドキュメントの URL アドレスを指定します。 この関数は、HTML がドキュメントにロードされる前に呼び出す必要があります。
SFCError SetVSpace( SInt32 vSpace )
SFBHTMLViewer::SetOption ( HVOPT_N_VSPACE ) の簡略関数です。 垂直段落間隔を設定します。
Void SetViewState( ACharConstPtr state )
HTML ビューワの状態( スクロール位置など )を、 SFBHTMLViewer::GetViewState から返される文字列で表現される状態に復元します。
Void SetViewState( SFXAnsiStringConstRef state )
HTML ビューワの状態( スクロール位置など )を、 SFBHTMLViewer::GetViewState から返される文字列で表現される状態に復元します。
Void Stop( Void )
ビューワがビジーな場合に、 ビューワが SFBAStream または SFBSource から HTML をロードするのを停止させます。 このコールによりドキュメントのロードが停止した場合は、 HVN_DONE 通知が起動されます。
UInt32 GetProperties( Void ) (SFBControl から継承)
コントロール固有のプロパティまたはフラグを取得します。
Void GetRect( SFXRectanglePtr rect ) (SFBControl から継承)
コントロールの矩形を取得します。
SFXRectangle GetRect( Void ) (SFBControl から継承)
コントロールの矩形を取得します。
Bool HandleEvent( AEEEvent event , UInt16 wParam , UInt32 dwParam ) (SFBControl から継承)
コントロールのイベント処理機能を提供します。 この関数はすべてのコントロールで実装する必要があります。
Bool HandleEvent( SFXEventConstRef event ) (SFBControl から継承)
コントロールのイベント処理機能を提供します。 この関数はすべてのコントロールで実装する必要があります。
Bool IsActive( Void ) (SFBControl から継承)
コントロールがアクティブであるかを判定します。
Bool Redraw( Void ) (SFBControl から継承)
コントロールの内容を再描画します。
Void Reset( Void ) (SFBControl から継承)
コントロールの内容をリセットし、アクティブ状態をすぐに解除します。
Void SetActive( Bool active = true ) (SFBControl から継承)
コントロールのアクティブ状態を設定します。
Void SetProperties( UInt32 properties ) (SFBControl から継承)
コントロール固有のプロパティまたはフラグを設定します。
Void SetRect( SFXRectangleConstRef rect ) (SFBControl から継承)
コントロールの矩形を設定します。
プロテクト関数
static
SFBBaseSmp
FactoryByCreate( AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを生成します。
static
SFBBaseSmp
FactoryByQuery( SFBQuerySmpConstRef query , AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。

SFBHTMLViewer::FindElem
指定した要素名と発生順序の要素を検索します。
[ public ]
SInt32 FindElem(
    ACharConstPtr element   // 検索する要素の名前
                            // ゼロ終結の ASCII 文字列 ( 大文字小文字の区別なし ) を指定する 
    SInt32 index            // 発生順序 ( 0 : 最初の発生、1 : 2 つ目の発生、以下同様 )
);
[ public ]
SInt32 FindElem(
    SFXAnsiStringConstRef element   // 検索する要素の名前
                                    // ゼロ終結の ASCII 文字列 ( 大文字小文字の区別なし )を指定する
    SInt32 index                    // 発生順序 ( 0 : 最初の発生、1 : 2 つ目の発生、以下同様 )
);

参照

BREW API IHTMLVIEWER_FindElem


SFBHTMLViewer::GetAttrValue
要素の属性の値を取得します。
[ public ]
SInt32 GetAttrValue(
    SInt32 pos                // 要素の位置
    ACharConstPtr attribute   // 属性の名前
    ACharPtr buf              // 結果を取得するバッファ
    SInt32 bufSize            // バッファのサイズ
);
[ public ]
SInt32 GetAttrValue(
    SInt32 pos                        // 要素の位置
    SFXAnsiStringConstRef attribute   // 属性の名前
    ACharPtr buf                      // 結果を取得するバッファ
    SInt32 bufSize                    // バッファのサイズ
);
[ public ]
SInt32 GetAttrValue(
    SInt32 pos                // 要素の位置
    ACharConstPtr attribute   // 属性の名前
    SFXAnsiStringPtr string   // 結果を取得する文字列
);
[ public ]
SInt32 GetAttrValue(
    SInt32 pos                        // 要素の位置
    SFXAnsiStringConstRef attribute   // 属性の名前
    SFXAnsiStringPtr string           // 結果を取得する文字列
);

参照

BREW API IHTMLVIEWER_GetAttrValue


SFBHTMLViewer::GetElemText
要素のテキスト内容を取得します。
[ public ]
SInt32 GetElemText(
    SInt32 pos       // ドキュメント内での要素の位置
                     // SFBHTMLViewer::FindElem() から取得する
    ACharPtr buf     // 結果 ( ゼロ終結文字列 ) を格納するバッファの先頭を指すポインタ
    SInt32 bufSize   // バッファのサイズ ( バイト数 )
);
[ public ]
SInt32 GetElemText(
    SInt32 pos                // ドキュメント内での要素の位置
                              // SFBHTMLViewer::FindElem() から取得する 
    SFXAnsiStringPtr string   // 結果 ( ゼロ終結文字列 ) を格納するバッファの先頭を指すポインタ
);

参照

BREW API IHTMLVIEWER_GetElemText | SFBHTMLViewer::FindElem | SFBHTMLViewer::GetAttrValue


SFBHTMLViewer::GetOption
ビューワの状態を記述する値の 1 つを取得します。 この関数は、SFBHTMLViewer::SetOption で設定された値は取得しません。
[ public ]
SFCError GetOption(
    SInt32 id      // 取得する値の ID
    HVOpt* state   // 結果を格納する変数またはメモリー位置のアドレス
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • ID がサポートされていないとき: SFERR_UNSUPPORTED

参照

BREW API IHTMLVIEWER_GetOption | SFBHTMLViewer::SetOption


SFBHTMLViewer::GetViewState
現在のビューワ状態を記述する文字列を取得します。 この文字列を SFBHTMLViewer::SetViewState に渡すことで、 ビューワ状態を復元できます。
[ public ]
SInt32 GetViewState(
    ACharPtr buf     // 結果 ( ゼロ終結文字列 ) を格納するバッファの先頭を指すポインタ
    SInt32 bufSize   // バッファのサイズ ( バイト数 )
);
[ public ]
SInt32 GetViewState(
    SFXAnsiStringPtr string   // 結果( ゼロ終結文字列 )を格納するバッファの先頭を指すポインタ
);
[ public ]
SFXAnsiString GetViewState(Void);

参照

BREW API IHTMLVIEWER_GetViewState | SFBHTMLViewer::SetViewState


SFBHTMLViewer::IsBusy
ビューワが SFBAStream または SFBSource から HTML ファイルをロード中であるかを判定します。
[ public ]
Bool IsBusy(Void);

戻り値

  • ロード中のとき: true
  • それ以外のとき: false

参照

BREW API IHTMLVIEWER_IsBusy | SFBAStream | SFBSource


SFBHTMLViewer::LoadSource
SFBSource の内容をドキュメントにロードし、 そのデータを HTML として構文解析します。
[ public ]
Void LoadSource(
    SFBSourceSmpConstRef source   // SFBSource インターフェース
);
[ public ]
SFCError LoadSource(
    SFXStorageConstRef storage   // SFXStorage インターフェース
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • storage が閉じているとき: SFERR_INVALID_STATE
  • 引数が null のとき: SFERR_INVALID_PARAM
  • 失敗したとき: SFERR_FAILED

参照

BREW API IHTMLVIEWER_LoadSource | SFBSource


SFBHTMLViewer::LoadStream
SFBAStream の内容をドキュメントにロードし、 そのデータを HTML として構文解析します。
[ public ]
Void LoadStream(
    SFBAStreamSmpConstRef stream   // SFBAStream インターフェース
);
[ public ]
SFCError LoadStream(
    SFXStorageConstRef storage   // SFXStorage インターフェース
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • storage が閉じているとき: SFERR_INVALID_STATE
  • 引数が null のとき: SFERR_INVALID_PARAM

参照

BREW API IHTMLVIEWER_LoadStream | SFBAStream


SFBHTMLViewer::NewInstance
SFBHTMLViewer インスタンスを生成します。
[ public, static ]
SFBHTMLViewerSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);
[ public, static ]
SFBHTMLViewerSmp NewInstance(
    AEECLSID id                    // クラスID
    SFCErrorPtr exception = null   // エラー値
);

SFBHTMLViewer::ParseBuffer
ビューワに文字列の内容をロードします。
[ public ]
Void ParseBuffer(
    ACharConstPtr string   // HTML を含むゼロ終結文字列へのポインタ
);
[ public ]
Void ParseBuffer(
    SFXAnsiStringConstRef string   // HTML を含むゼロ終結文字列へのポインタ
);

参照

BREW API IHTMLVIEWER_ParseBuffer


SFBHTMLViewer::SetData
ビューワにHTMLのバッファを提供します。 バッファの内容はすべて同期で構文解析され、ビューワに供給されます。
[ public ]
Void SetData(
    ACharConstPtr buf     // バッファ( ゼロ終結であるとは限らない )の先頭へのポインタ
    SInt32 bufSize = -1   // バッファのサイズまたは -1
                          // -1 は、buf がゼロ終結文字列を指していおり、
                          // その文字列全部をビューワにロードする必要があることを示す 
);
[ public ]
Void SetData(
    SFXAnsiStringConstRef string   // バッファへのポインタ
);

参照

BREW API IHTMLVIEWER_SetData | SFBHTMLViewer::ParseBuffer


SFBHTMLViewer::SetIWeb
SFBHTMLViewer::SetOption ( HVOPT_PTR_IWEB ) の簡略関数です。 ビューワがサブオブジェクトを取得するために使用する SFBWeb インターフェースを設定します。
[ public ]
SFCError SetIWeb(
    SFBWebSmpConstRef web   // SFBWeb インターフェース
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IHTMLVIEWER_SetIWeb | SFBWeb | SFBHTMLViewer::SetOption


SFBHTMLViewer::SetIndent
SFBHTMLViewer::SetOption ( HVOPT_N_INDENT ) の簡略関数です。 基本字下げの値を設定します。
[ public ]
SFCError SetIndent(
    SInt32 indent   // デフォルトの字下げ( ピクセル数 )
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IHTMLVIEWER_SetIndent | SFBHTMLViewer::SetOption


SFBHTMLViewer::SetLinkColor
SFBHTMLViewer::SetOption ( HVOPT_RGB_LINK ) の簡略関数です。 デフォルトのテキスト色を設定します。
[ public ]
Void SetLinkColor(
    RGBVAL color   // リンクの色
);
[ public ]
Void SetLinkColor(
    SFXRGBColorConstRef color   // リンクの色
);

参照

BREW API IHTMLVIEWER_SetLinkColor | SFBHTMLViewer::SetOption


SFBHTMLViewer::SetNotifyFn
通知コールバックの情報を指定します。
[ public ]
Void SetNotifyFn(
    PFNHVIEWNOTIFY notify   // 通知と共にコールする関数へのポインタ
                            // または通知をキャンセルする場合は null
    VoidPtr data = null     // コールされた場合に pfnNotify に渡す 32 ビットの値
);

参照

BREW API IHTMLVIEWER_SetNotifyFn | PFNHVIEWNOTIFY


SFBHTMLViewer::SetOption
ビューワの動作を制御するオプションの 1 つを設定します。 通常はこの関数は使用しません。 各オプション専用の別の関数が定義されています。
[ public ]
SFCError SetOption(
    SInt32 id     // 設定するオプションの ID
    HVOpt state   // オプションに設定する値
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • ID がサポートされていないとき: SFERR_UNSUPPORTED

参照

BREW API IHTMLVIEWER_SetOption | SFBHTMLViewer::SetType | SFBHTMLViewer::SetURL | SFBHTMLViewer::SetIndent | SFBHTMLViewer::SetVSpace | SFBHTMLViewer::SetSBWidth | SFBHTMLViewer::SetTextColor | SFBHTMLViewer::SetLinkColor | SFBHTMLViewer::GetOption


SFBHTMLViewer::SetSBWidth
SFBHTMLViewer::SetOption ( HVOPT_N_SBWIDTH ) の簡略関数です。 垂直スクロールバーの幅を設定します。
[ public ]
SFCError SetSBWidth(
    SInt32 width   // 基本段落間隔
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IHTMLVIEWER_SetSBWidth


SFBHTMLViewer::SetTextColor
SFBHTMLViewer::SetOption ( HVOPT_RGB_TEXT ) の簡略関数です。 既定のテキスト色を設定します。
[ public ]
SFCError SetTextColor(
    RGBVAL color   // テキストの色
);
[ public ]
SFCError SetTextColor(
    SFXRGBColorConstRef color   // テキストの色
);

戻り値

SFERR_NO_ERROR を返します。

参照

BREW API IHTMLVIEWER_SetTextColor | SFBHTMLViewer::SetOption


SFBHTMLViewer::SetType
SFBHTMLViewer::SetOption ( HVOPT_SZ_TYPE ) の簡略関数です。 ビューワにMIMEタイプおよび / または文字セットを設定します。
[ public ]
SFCError SetType(
    ACharConstPtr type   // 次の書式の MIME タイプ文字列へのポインタ
                         // "text/html; charset=iso-8859-1" または "charset=iso-8859-1"
                         // 注意 : MIME タイプ文字列は、
                         //        RFC2046 に記述される Content-type フィールドの意味に従う
);
[ public ]
SFCError SetType(
    SFXAnsiStringConstRef type   // 次の書式の MIME タイプ文字列へのポインタ
                                 // "text/html; charset=iso-8859-1" または "charset=iso-8859-1"
                                 // 注意 : MIME タイプ文字列は、
                                 //        RFC2046 に記述される Content-type フィールドの意味に従う
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IHTMLVIEWER_SetType | SFBHTMLViewer::SetOption


SFBHTMLViewer::SetURL
ビューワにロードするドキュメントの URL アドレスを指定します。 この関数は、HTML がドキュメントにロードされる前に呼び出す必要があります。
[ public ]
SFCError SetURL(
    ACharConstPtr url   // ベース URL 文字列
);
[ public ]
SFCError SetURL(
    SFXAnsiStringConstRef url   // ベース URL 文字列
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IHTMLVIEWER_SetURL | SFBHTMLViewer::SetOption


SFBHTMLViewer::SetVSpace
SFBHTMLViewer::SetOption ( HVOPT_N_VSPACE ) の簡略関数です。 垂直段落間隔を設定します。
[ public ]
SFCError SetVSpace(
    SInt32 vSpace   // 基本段落間隔( ピクセル数 )
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IHTMLVIEWER_SetVSpace | SFBHTMLViewer::GetViewState


SFBHTMLViewer::SetViewState
HTML ビューワの状態( スクロール位置など )を、 SFBHTMLViewer::GetViewState から返される文字列で表現される状態に復元します。
[ public ]
Void SetViewState(
    ACharConstPtr state   // SFBHTMLViewer::GetViewState() から返される文字列
                          // 前のビュー状態を表現する
);
[ public ]
Void SetViewState(
    SFXAnsiStringConstRef state   // SFBHTMLViewer::GetViewState() から返される文字列
                                  // 前のビュー状態を表現する
);

参照

BREW API IHTMLVIEWER_SetViewState | SFBHTMLViewer::GetViewState


SFBHTMLViewer::Stop
ビューワがビジーな場合に、 ビューワが SFBAStream または SFBSource から HTML をロードするのを停止させます。 このコールによりドキュメントのロードが停止した場合は、 HVN_DONE 通知が起動されます。
[ public ]
Void Stop(Void);

参照

BREW API IHTMLVIEWER_Stop | SFBAStream | SFBSource