SFRBrewHtmlControl

HTML データの表示を行うレスポンダです。

#include <SFRBrewHtmlControl.hpp>

class SFRBrewHtmlControl : public SFRBrewControl;

typedef SFRBrewHtmlControl&          SFRBrewHtmlControlRef;
typedef SFRBrewHtmlControl*          SFRBrewHtmlControlPtr;
typedef SFRBrewHtmlControl**         SFRBrewHtmlControlHandle;
typedef const SFRBrewHtmlControl     ConstSFRBrewHtmlControl;
typedef const SFRBrewHtmlControl&    ConstSFRBrewHtmlControlRef;
typedef const SFRBrewHtmlControl*    ConstSFRBrewHtmlControlPtr;
typedef const SFRBrewHtmlControl**   ConstSFRBrewHtmlControlHandle;

協調図

解説

HTML データの表示を行うレスポンダです。このレスポンダを利用することにより、ウィンドウ上で HTML データの表示を行うことが可能になります。 HTML データの表示には、BREW 標準のコントロールである IHtmlViewer インターフェイスを使用しています。

注意

IHtmlViewer の問題で、SFRBrewHtmlControl は常に最前面で使用してください。

参照

SFRBrewControl

メンバ

コンストラクタ/デストラクタ
public	SFRBrewHtmlControl	SFRBrewHtmlControl クラスのコンストラクタです。
public	~SFRBrewHtmlControl	SFRBrewHtmlControl クラスのデストラクタです。

パブリック関数
public	FindElem	指定された要素名と発生順序の要素を検索します。
public	FocusDown (SFRResponder から継承)	座標上で自分より下に存在するレスポンダにフォーカスを移動します。
public	FocusLeft (SFRResponder から継承)	座標上で自分より左に存在するレスポンダにフォーカスを移動します。
public	FocusNext (SFRResponder から継承)	フォーカスを一つ次に進めます。
public	FocusPrevious (SFRResponder から継承)	フォーカスを一つ前に戻します。
public	FocusRight (SFRResponder から継承)	座標上で自分より右に存在するレスポンダにフォーカスを移動します。
public	FocusUp (SFRResponder から継承)	座標上で自分より上に存在するレスポンダにフォーカスを移動します。
public	GetAttrValue	要素の属性値を取得します。
public	GetAttribute (SFRResponder から継承)	アトリビュートを取得します。
public	GetBack (SFRResponder から継承)	子階層のレスポンダのうち検索条件に一致するレスポンダを後ろから検索します。
public	GetBaseBound (SFRResponder から継承)	ベース領域を親レスポンダのコンテント座標系で取得します。
public	GetBaseWorld (SFRResponder から継承)	ベース領域を取得します。
public	GetContentBound (SFRResponder から継承)	コンテント領域をベース領域の座標系で取得します。
public	GetContentWorld (SFRResponder から継承)	コンテント領域を取得します。
public	GetDirector (SFRResponder から継承)	親レスポンダを取得します。
public	GetElemText	要素のテキスト内容を取得します。
public	GetFocus (SFRResponder から継承)	子階層のレスポンダのうちフォーカスされているレスポンダを取得します。
public	GetFront (SFRResponder から継承)	子階層のレスポンダのうち検索条件に一致するレスポンダを前から検索します。
public	GetIndexBackward (SFRResponder から継承)	同階層のレスポンダのうち自分が背面から数えて何番目かを返します。
public	GetIndexForward (SFRResponder から継承)	同階層のレスポンダのうち自分が前面から数えて何番目かを返します。
public	GetLeft (SFRResponder から継承)	グループ化されているレスポンダのうち自分より前にあるレスポンダで検索条件に一致するレスポンダを検索します。
public static	GetMargin (SFRBrewControl から継承)	ベース領域とコンテント領域のマージンを計算して返します。
public	GetMoveInterval (SFRResponder から継承)	MoveUpHandler, MoveDownHandler, MoveLeftHandler, MoveRightHandler によりレスポンダが移動されるときの移動量を取得します。
public	GetMoveMargin (SFRResponder から継承)	Move 関数によりレスポンダが移動されるときに、仮想領域の端から何ピクセル内側まで移動可能かのマージンを取得します。またこの設定は、MoveUpHandler, MoveDownHandler, MoveLeftHandler, MoveRightHandler にも適応されています。
public	GetNext (SFRResponder から継承)	自分より後にあるレスポンダで検索条件に一致するレスポンダを検索します。
public	GetNthBackward (SFRResponder から継承)	子階層のレスポンダのうち検索条件に一致するレスポンダで後ろから数えてＮ番目にあるレスポンダを検索します。
public	GetNthForward (SFRResponder から継承)	子階層のレスポンダのうち検索条件に一致するレスポンダで前から数えてＮ番目にあるレスポンダを検索します。
public	GetOption	ビューワの状態を記述する値の一つを取得します。
public	GetPrevious (SFRResponder から継承)	自分より前にあるレスポンダで検索条件に一致するレスポンダを検索します。
public	GetProperties (SFRBrewControl から継承)	現在設定されているコントロール固有のプロパティを返します。
public	GetReference (SFRResponder から継承)	ユーザが自由に設定できるリファレンス値を取得します。
public	GetRight (SFRResponder から継承)	グループ化されているレスポンダのうち自分より後にあるレスポンダで検索条件に一致するレスポンダを検索します。
public	GetScrollInterval (SFRResponder から継承)	ScrollUpHandler, ScrollDownHandler, ScrollLeftHandler, ScrollRightHandler によりレスポンダの仮想領域がスクロールされるときのスクロール量を取得します。
public	GetStatusEnable (SFRResponder から継承)	応答可能/不可能フラグを取得します。
public	GetStatusFocus (SFRResponder から継承)	フォーカス/非フォーカスフラグを取得します。
public	GetStatusTarget (SFRResponder から継承)	ターゲット/非ターゲットフラグを取得します。
public	GetStatusVisible (SFRResponder から継承)	可視/不可視フラグを取得します。
public	GetTranslate (SFRResponder から継承)	コンテント座標系での仮想領域の原点座標を取得します。
public	GetTravelMargin (SFRResponder から継承)	フォーカスされたレスポンダを自動的にコンテント領域内に移動させるときに、コンテント領域の端から何ピクセル内側に移動させるかのマージンを取得します。
public	GetType (SFRResponder から継承)	タイプを取得します。
public	GetViewState	現在のビューワの状態を記述する文字列を返します。
public	GetVirtualBound (SFRResponder から継承)	仮想領域をコンテント領域の座標系で取得します。
public	GetVirtualWorld (SFRResponder から継承)	仮想領域を取得します。
public	Group (SFRResponder から継承)	他のレスポンダとグループ化します。
public	GroupMove (SFRResponder から継承)	グループ化されているレスポンダすべてを移動します。
public	GroupScroll (SFRResponder から継承)	グループ化されているレスポンダすべての仮想領域をスクロールします。
public	GroupSelect (SFRResponder から継承)	グループ化されているレスポンダすべてを最前面に移動させます。
public	GroupStatusEnable (SFRResponder から継承)	グループ化されているレスポンダすべてに対して、応答可能/不可能フラグを設定します。
public	GroupStatusVisible (SFRResponder から継承)	グループ化されているレスポンダすべてに対して、可視/不可視フラグを設定します。
public	InvalidateBase (SFRResponder から継承)	ベース領域内のアップデート領域を登録します。
public	InvalidateContent (SFRResponder から継承)	コンテント領域内のアップデート領域を登録します。
public	InvalidateVirtual (SFRResponder から継承)	仮想領域内のアップデート領域を登録します。
public	Invoke (SFRResponder から継承)	イベントを送信します。
public	IsBusy	ビューワが SFBAStream または、SFBSource からの HTML データのロード中である場合に TRUE を返します。
public	LoadSource	SFBSource の内容をドキュメントにロードし、そのデータを HTML として構文解析をします。
public	LoadStream	SFBAStream の内容をドキュメントにロードし、そのデータを HTML として構文解析します。
public	Move (SFRResponder から継承)	レスポンダを移動します。
public	ParseBuffer	ビューワに文字列の内容をロードします。
public	RegisterHandler (SFRHandler から継承)	ハンドラを登録します。
public	RegisterIntelligentHandler (SFRResponder から継承)	SelectHandler, ClearHandler, FocusUpHandler, FocusDownHandler, FocusLeftHandler, FocusRightHandler をそれぞれ AVK_SELECT, AVK_CLR, AVK_UP, AVK_DOWN, AVK_LEFT, AVK_RIGHT に登録します。
public	RegisterManipulateHandler (SFRResponder から継承)	SelectHandler, ClearHandler, FocusNextHandler, FocusPreviousHandler をそれぞれ AVK_SELECT, AVK_CLR, AVK_DOWN, AVK_UP に登録します。
public	RegisterMoveHandler (SFRResponder から継承)	MoveUpHandler, MoveDownHandler, MoveLeftHandler, MoveRightHandler をそれぞれ AVK_2, AVK_8, AVK_4, AVK_6 に登録します。
public	RegisterScrollHandler (SFRResponder から継承)	ScrollUpHandler, ScrollDownHandler, ScrollLeftHandler, ScrollRightHandler をそれぞれ AVK_2, AVK_8, AVK_4, AVK_6 に登録します。
public	RegisterTracer (SFRTracer から継承)	トレーサを登録します。
public	Scroll (SFRResponder から継承)	仮想領域をスクロールします。
public	Select (SFRResponder から継承)	レスポンダを最前面に移動させます。
public	SetBaseBound (SFRBrewControl から継承)	ベース領域を親の相対座標で設定します。
public	SetContentBound (SFRResponder から継承)	コンテント領域をベース領域の座標系で設定します。
public	SetData	ビューワに HTML データを設定します。
public	SetIWeb	SFRBrewHtmlControl::SetOption( HVOPT_PTR_IWEB ) の簡略関数です。ビューワがサブオブジェクトを取得するために使用する IWeb インタフェースを設定します。
public	SetIndent	SFRBrewHtmlControl::SetOption( HVOPT_N_INDENT ) の簡略関数です。基本字下げの値を設定します。
public	SetLinkColor	SFRBrewHtmlControl::SetOption( HVOPT_RGB_LINK ) の簡略関数です。デフォルトのリンクの色を設定します。
public	SetMoveInterval (SFRResponder から継承)	MoveUpHandler, MoveDownHandler, MoveLeftHandler, MoveRightHandler によりレスポンダが移動されるときの移動量を設定します。
public	SetMoveMargin (SFRResponder から継承)	Move 関数によりレスポンダが移動されるときに、仮想領域の端から何ピクセル内側まで移動可能かのマージンを設定します。またこの設定は、MoveUpHandler, MoveDownHandler, MoveLeftHandler, MoveRightHandler にも適応されます。
public	SetNotifyFn	通知コールバックの情報を設定します。
public	SetOption	ビューワの動作を制御するオプションの１つを設定します。通常、この関数は使用されず、各オプション専用の別の関数が定義されています。
public	SetProperties (SFRBrewControl から継承)	コントロール固有のプロパティを設定します。
public	SetReference (SFRResponder から継承)	ユーザが自由に設定できるリファレンス値を設定します。
public	SetSBWidth	SFRBrewHtmlControl::SetOption( HVOPT_N_SBWIDTH ) の簡略関数です。垂直スクロールバーの幅を設定します。
public	SetScrollInterval (SFRResponder から継承)	ScrollUpHandler, ScrollDownHandler, ScrollLeftHandler, ScrollRightHandler によりレスポンダの仮想領域がスクロールされるときのスクロール量を設定します。
public	SetStatusEnable (SFRResponder から継承)	応答可能/不可能フラグを設定します。
public	SetStatusFocus (SFRResponder から継承)	フォーカス/非フォーカスフラグを設定します。
public	SetStatusTarget (SFRResponder から継承)	ターゲット/非ターゲットフラグを設定します。
public	SetStatusVisible (SFRResponder から継承)	可視/不可視フラグを設定します。
public	SetTextColor	SFRBrewHtmlControl::SetOption( HVOPT_RGB_TEXT ) の簡略関数です。テキストの色を設定します。
public	SetTranslate (SFRResponder から継承)	コンテント座標系での仮想領域の原点座標を設定します。
public	SetTravelMargin (SFRResponder から継承)	フォーカスされたレスポンダを自動的にコンテント領域内に移動させるときに、コンテント領域の端から何ピクセル内側に移動させるかのマージンを設定します。
public	SetType	SFRBrewHtmlControl::SetOption( HVOPT_SZ_TYPE ) の簡略関数です。ビューワに MIME タイプおよび／または文字セットを設定します。
public	SetURL	ビューワにロードするドキュメントの URL アドレスを指定します。この関数は、HTML がドキュメントにロードされる前に呼び出す必要があります。
public	SetVSpace	SFRBrewHtmlControl::SetOption( HVOPT_N_VSPACE ) の簡略関数です。垂直段落間隔を設定します。
public	SetViewState	HTML コントロールの状態を SFRBrewHtmlControl::GetViewState から返される文字列で表現される状態に復元します。
public	SetVirtualBound (SFRResponder から継承)	仮想領域をコンテント領域の座標系で設定します。
public	Stop	ビューワがビジーな場合に、HTML データのロードを停止します。
public	Travel (SFRResponder から継承)	設定された長方形が可視領域に入るように、レスポンダの仮想領域をスクロールします。
public	Ungroup (SFRResponder から継承)	グループ化を解除します。
public	UnregisterHandler (SFRHandler から継承)	登録されているハンドラを削除します。
public	UnregisterTracer (SFRTracer から継承)	登録されているトレーサを削除します。

プロテクト関数
protected	BaseHandler (SFRBrewControl から継承)	ベース領域のアップデート時に呼び出されるハンドラです。
protected	ClearHandler (SFRResponder から継承)	クリアキーが押されたときのハンドラです。
protected	ContentHandler (SFRBrewControl から継承)	コンテント領域のアップデート時に呼び出されるハンドラです。
protected	Control (SFRBrewControl から継承)	このコントロールで利用中の SFBControl オブジェクトを取得します。
protected	FocusDownHandler (SFRResponder から継承)	下矢印キーが押されたときのハンドラです。座標上で自分より下に存在するレスポンダにフォーカスを移動します。
protected	FocusLeftHandler (SFRResponder から継承)	左矢印キーが押されたときのハンドラです。座標上で自分より左に存在するレスポンダにフォーカスを移動します。
protected	FocusNextHandler (SFRResponder から継承)	下矢印キーが押されたときのハンドラです。フォーカスを一つ後に移動します。
protected	FocusPreviousHandler (SFRResponder から継承)	上矢印キーが押されたときのハンドラです。フォーカスを一つ前に移動します。
protected	FocusRightHandler (SFRResponder から継承)	右矢印キーが押されたときのハンドラです。座標上で自分より右に存在するレスポンダにフォーカスを移動します。
protected	FocusUpHandler (SFRResponder から継承)	上矢印キーが押されたときのハンドラです。座標上で自分より上に存在するレスポンダにフォーカスを移動します。
protected	GetAppearanceTransparent (SFRResponder から継承)	APPEARANCE_TRANSPARENT フラグが設定されているかどうかを取得します。
protected	GetInheriteEnable (SFRResponder から継承)	現在の応答可能/不可能の状態を取得します。
protected	GetInheriteFocus (SFRResponder から継承)	現在のフォーカス/非フォーカスの状態を取得します。
protected	GetInheriteTarget (SFRResponder から継承)	現在のターゲット/非ターゲットの状態を取得します。
protected	GetInheriteVisible (SFRResponder から継承)	現在の可視/不可視の状態を取得します。
protected	GetPropertyClosable (SFRResponder から継承)	PROPERTY_CLOSABLE フラグが設定されているかどうかを取得します。
protected	GetPropertyDirect (SFRResponder から継承)	PROPERTY_DIRECT フラグが設定されているかどうかを取得します。
protected	GetPropertyMovable (SFRResponder から継承)	PROPERTY_MOVABLE フラグが設定されているかどうかを取得します。
protected	GetPropertyScrollable (SFRResponder から継承)	PROPERTY_SCROLLABLE フラグが設定されているかどうかを取得します。
protected	GetPropertySelect (SFRResponder から継承)	PROPERTY_SELECT フラグが設定されているかどうかを取得します。
protected	GetPropertyTravel (SFRResponder から継承)	PROPERTY_TRAVEL フラグが設定されているかどうかを取得します。
protected	MoveDownHandler (SFRResponder から継承)	数字の８キーが押されたときのハンドラです。
protected	MoveLeftHandler (SFRResponder から継承)	数字の４キーが押されたときのハンドラです。
protected	MoveRightHandler (SFRResponder から継承)	数字の６キーが押されたときのハンドラです。
protected	MoveUpHandler (SFRResponder から継承)	数字の２キーが押されたときのハンドラです。
protected	NativeHandler (SFRBrewControl から継承)	サスペンド・レジューム・描画イベント以外のイベントが発生した時に呼び出されるハンドラです。
protected	RenderSafe (SFRBrewControl から継承)	コントロールの描画処理をレスポンダへ委譲します。
protected	ResumeHandler (SFRBrewControl から継承)	レジュームイベントが発生した時に呼び出されるハンドラです。
protected	ScrollDownHandler (SFRResponder から継承)	数字の８キーが押されたときのハンドラです。
protected	ScrollLeftHandler (SFRResponder から継承)	数字の４キーが押されたときのハンドラです。
protected	ScrollRightHandler (SFRResponder から継承)	数字の６キーが押されたときのハンドラです。
protected	ScrollUpHandler (SFRResponder から継承)	数字の２キーが押されたときのハンドラです。
protected	SelectHandler (SFRResponder から継承)	セレクトキーが押されたときのハンドラです。
protected	SuspendHandler (SFRBrewControl から継承)	サスペンドイベントが発生した時に呼び出されるハンドラです。
protected	UnregisterIntelligentHandler (SFRResponder から継承)	AVK_SELECT, AVK_CLR, AVK_UP, AVK_DOWN, AVK_LEFT, AVK_RIGHT に登録されているハンドラを削除します。
protected	UnregisterManipulateHandler (SFRResponder から継承)	AVK_SELECT, AVK_CLR, AVK_DOWN, AVK_UP に登録されているハンドラを削除します。
protected	UnregisterMoveHandler (SFRResponder から継承)	AVK_2, AVK_8, AVK_4, AVK_6 に登録されているハンドラを削除します。
protected	UnregisterScrollHandler (SFRResponder から継承)	AVK_2, AVK_8, AVK_4, AVK_6 に登録されているハンドラを削除します。

型
	BehaviorEnum (SFRControl から継承)	コントロールのデフォルトのビヘイビアを表します。
	HandlerEnum (SFRHandler から継承)	ハンドラの呼び出されるタイミングを表します。
	TracerEnum (SFRTracer から継承)	トレース順序を表します。

SFRBrewHtmlControl::SFRBrewHtmlControl

SFRBrewHtmlControl クラスのコンストラクタです。

[ public ]
SFRBrewHtmlControl(
    SFRResponderPtr director                        // 親となるレスポンダのポインタ
    ConstSFURectRef rect                            // 親の座標上での位置
    BehaviorType behavior = BEHAVIOR_CONTROL        // ビヘイビア
    SFCType attribute = ATTRIBUTE_BREWHTMLCONTROL   // アトリビュート
);

SFRBrewHtmlControl::~SFRBrewHtmlControl

SFRBrewHtmlControl クラスのデストラクタです。

[ public, virtual ]
~SFRBrewHtmlControl(Void);

SFRBrewHtmlControl::FindElem

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

[ public, const ]
SInt32 FindElem(
    ConstSFUAnsiStringRef elem   // 要素名
    SInt32 index                 // 発生順序
);

引数

elem: 検索する要素の名前を指定します。
index: 発生順序を指定します。（0 = 最初の発生、1 = ２つ目の発生、・・・）

戻り値

ドキュメント内で要素が発見できた場合は、要素の位置に対応するインデックスを返します。 elem が見つからない場合は、IHTMLVIEWER_NOTFOUND を返し、 elem が、認識可能な要素名ではない場合は、IHTMLVIEWER_BADELEMENT を返します。

参照

SFRBrewHtmlControl::GetElemText

SFRBrewHtmlControl::GetAttrValue

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

[ public, const ]
SInt32 GetAttrValue(
    SInt32 elem_pos                   // 要素の位置
    ConstSFUAnsiStringRef attr_name   // 属性の名前
    SFUAnsiStringPtr result_str       // 結果を取得するバッファ
    SInt32 size = 256                 // バッファのサイズ
);

戻り値

result_ptr にコピーされた文字列の長さを返します。

処理に失敗した場合は、以下の様なエラーメッセージを返します。

エラーメッセージ	意味
IHTMLVIEWER_NOTFOUND	属性が見つからない場合
IHTMLVIEWER_BADELEMENT	elem_posが無効な場合
IHTMLVIEWER_BADATTR	attr_nameが認識可能な属性で無い場合
IHTMLVIEWER_NOVALUE	属性が指定されたが、値が割り当てられていない場合

SFRBrewHtmlControl::GetElemText

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

[ public, const ]
SFUAnsiString GetElemText(
    SInt32 elem_pos     // 要素の位置
    SInt32 size = 256   // バッファのサイズ
);

戻り値

テキストの内容を返します。

参照

SFRBrewHtmlControl::FindElem

SFRBrewHtmlControl::GetOption

ビューワの状態を記述する値の一つを取得します。

[ public, const ]
SFCError GetOption(
    SInt32 opt_id   // オプションのID
    HVOpt * opt     // ビューワの状態値を格納するバッファ
);

戻り値

成功時には、SUCCESS を返します。また、オプションがサポートされていない場合は、EUNSUPPORTED を返します。

解説

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

参照

SFRBrewHtmlControl::SetOption

SFRBrewHtmlControl::GetViewState

現在のビューワの状態を記述する文字列を返します。

[ public, const ]
SFUAnsiString GetViewState(Void);

解説

この文字列を SFRBrewHtmlControl::SetViewState に渡すことにより、ビューワの状態を復元できます。

参照

SFRBrewHtmlControl::SetViewState

SFRBrewHtmlControl::IsBusy

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

[ public, const ]
Bool IsBusy(Void);

参照

SFRBrewHtmlControl::LoadSource | SFRBrewHtmlControl::LoadStream

SFRBrewHtmlControl::LoadSource

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

[ public ]
Void LoadSource(
    const SFUBrewPtr< SFBSource > & source   // SFBSource オブジェクト
);

解説

SFBSource の内容をドキュメントにロードし、そのデータを HTML として構文解析します。すでに存在していた内容は、すべて消去されます。また、ロードは非同期にバックグラウンドで行われ、通常この関数の呼び出し中に完了しません。 SFBSource の終端に達するとドキュメントが表示されます。呼び出し元は、ビューワがロード中であるかどうかを SFRBrewHtmlControl::IsBusy を呼び出すことで確認できます。また、通知コールバックを設定して HVN_DONE 通知をチェックすることにより、ロードの完了を通知させることもできます。

参照

SFRBrewHtmlControl::IsBusy | SFRBrewHtmlControl::SetNotifyFn

SFRBrewHtmlControl::LoadStream

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

[ public ]
Void LoadStream(
    const SFUBrewPtr< SFBAStream > & a_stream   // SFBAStream オブジェクト
);

解説

SFBAStream の内容をドキュメントにロードし、そのデータを HTML として構文解析します。すでに存在していた内容は、すべて消去されます。また、ロードは非同期にバックグラウンドで行われ、通常この関数の呼び出し中に完了しません。 SFBSource の終端に達するとドキュメントが表示されます。呼び出し元は、ビューワがロード中であるかどうかを SFRBrewHtmlControl::IsBusy を呼び出すことで確認できます。また、通知コールバックを設定して HVN_DONE 通知をチェックすることにより、ロードの完了を通知させることもできます。

参照

SFRBrewHtmlControl::IsBusy | SFRBrewHtmlControl::SetNotifyFn

SFRBrewHtmlControl::ParseBuffer

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

[ public ]
Void ParseBuffer(
    ConstSFUAnsiStringRef str   // ビューワにロードする文字列
);

解説

ビューワにゼロ終結の文字列の内容をロードします。この機能は、SFRBrewHtmlControl::SetData と同じですが、長さが制限されたバッファ内の文字列の代わりに、ゼロ終結の文字列として HTML が供給される点が異なります。

参照

SFRBrewHtmlControl::SetData

SFRBrewHtmlControl::SetData

ビューワに HTML データを設定します。

[ public ]
Void SetData(
    ConstSFUAnsiStringRef str   // HTML データ
    SInt32  = -1                // HTML データのサイズ
);

解説

ビューワに HTML データを設定します。 HTML データの内容はすべて同期で構文解析され、ビューワに供給されます。すでに存在していた内容は、すべて消去されます。

参照

SFRBrewHtmlControl::ParseBuffer

SFRBrewHtmlControl::SetIndent

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

[ public ]
SFCError SetIndent(
    SInt32 indent   // 字下げ値
);

戻り値

成功した場合は、NO_ERRORを返します。

参照

SFRBrewHtmlControl::SetOption

SFRBrewHtmlControl::SetIWeb

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

[ public ]
SFCError SetIWeb(
    const SFUBrewPtr< SFBWeb > & web   // SFBWebオブジェクト
);

戻り値

成功した場合は、NO_ERRORを返します。

参照

SFRBrewHtmlControl::SetOption

SFRBrewHtmlControl::SetLinkColor

SFRBrewHtmlControl::SetOption( HVOPT_RGB_LINK ) の簡略関数です。デフォルトのリンクの色を設定します。

[ public ]
Void SetLinkColor(
    ConstSFUColorRef color   // リンクの色
);

戻り値

成功した場合は、NO_ERRORを返します。

参照

SFRBrewHtmlControl::SetOption

SFRBrewHtmlControl::SetNotifyFn

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

[ public ]
Void SetNotifyFn(
    PFNHVIEWNOTIFY notify_fn   // コールバック関数を指すポインタ
    VoidPtr arg                // コールバック関数の引数
);

解説

通知コールバックの情報を指定します。コールバックとして呼び出される関数のポインタと関数に引数で渡されるポインタを指定します。

参照

SFRBrewHtmlControl::LoadSource | SFRBrewHtmlControl::LoadStream

SFRBrewHtmlControl::SetOption

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

[ public ]
SFCError SetOption(
    SInt32 opt_id   // オプションの ID
    HVOpt opt       // オプションに設定する値
);

戻り値

オプションの設定に成功した場合は、NO_ERRORを返します。オプション ID がサポートされていない場合は、EUNSUPPORTED を返します。

参照

SFRBrewHtmlControl::SetSBWidth

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

[ public ]
SFCError SetSBWidth(
    SInt32 width   // 幅
);

戻り値

成功した場合は、NO_ERRORを返します。

参照

SFRBrewHtmlControl::SetOption

SFRBrewHtmlControl::SetTextColor

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

[ public ]
SFCError SetTextColor(
    ConstSFUColorRef color   // テキストの色
);

戻り値

成功した場合は、NO_ERRORを返します。

参照

SFRBrewHtmlControl::SetOption

SFRBrewHtmlControl::SetType

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

[ public ]
SFCError SetType(
    ConstSFUAnsiStringRef str   // MIME タイプ文字列
);

戻り値

成功した場合は、NO_ERRORを返します。

参照

SFRBrewHtmlControl::SetOption

SFRBrewHtmlControl::SetURL

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

[ public ]
SFCError SetURL(
    ConstSFUAnsiStringRef url   // URL アドレス
);

戻り値

成功した場合は、NO_ERRORを返します。

SFRBrewHtmlControl::SetViewState

HTML コントロールの状態を SFRBrewHtmlControl::GetViewState から返される文字列で表現される状態に復元します。

[ public ]
Void SetViewState(
    ConstSFUAnsiStringRef str   // SFRBrewHtmlControl::GetViewState の戻り値
);

参照

SFRBrewHtmlControl::GetViewState

SFRBrewHtmlControl::SetVSpace

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

[ public ]
SFCError SetVSpace(
    SInt32 space   // 段落間隔
);

戻り値

成功した場合は、NO_ERRORを返します。

参照

SFRBrewHtmlControl::SetOption

SFRBrewHtmlControl::Stop

ビューワがビジーな場合に、HTML データのロードを停止します。

[ public ]
Void Stop(Void);

解説

ビューワがビジーな場合に、 SFBAStream または SFBSource から HTML データをロードすることを停止します。この関数により、ドキュメントへのロードが停止した場合は、 HVN_DONE が通知コールバックに送信されます。

参照

SFRBrewHtmlControl::LoadSource | SFRBrewHtmlControl::LoadStream