SFXXMLEntityReference

[XML] Entity Reference ノードを表すクラスです。

#include <SFXXMLEntityReference.hpp>

class SFXXMLEntityReference : public SFXXMLNode;

SFMTYPEDEFCLASS(SFXXMLEntityReference)

継承図

協調図

解説

EntityReference ノード (SFXXMLEntityReference) は、XML 文書のエンティティ参照を保持します。

参照

メンバ

コンストラクタ/デストラクタ
SFXXMLEntityReference( `SFXXMLDocumentPtr` owner , `SFXAnsiStringConstRef` name , `Bool` clonechild = true ) SFXXMLEntityReference( `SFXXMLEntityReferenceConstRef` other , `Bool` deep = false ) SFXXMLEntityReference クラスのコンストラクタです。
~SFXXMLEntityReference( `Void` ) SFXXMLEntityReference クラスのデストラクタです。

パブリック関数
`SFCError`	AppendChild( `SFXXMLNodeConstPtr` newchild ) 子ノードの最後にノードを追加します。
`SFCError`	CloneNode( `SFXXMLNodeHandle` clonenode , `Bool` deep ) ノードのコピーを作成します。
`DOMNodeListPtr`	GetChildNodes( `Void` ) すべての子ノードを取得します。
`SFXXMLNodePtr`	GetFirstChild( `Void` ) 最初の子ノードを取得します。
`SFXXMLNodePtr`	GetLastChild( `Void` ) 最後の子ノードを取得します。
`SFXXMLNodePtr`	GetNextSibling( `Void` ) 次の兄弟ノードを取得します。
`ACharConstPtr`	GetNodeName( `Void` ) ノードの名前を取得します。
`NodeType`	GetNodeType( `Void` ) ノードタイプを取得します。
`SFXXMLNodePtr`	GetParentNode( `Void` ) 親ノードを取得します。
`SFXXMLNodePtr`	GetPreviousSibling( `Void` ) 前の兄弟ノードを取得します。
`Bool`	HasChildNodes( `Void` ) 子ノードを持つかどうかを判定します。
`SFCError`	InsertBefore( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` refchild ) ノードを挿入します。
`SFCError`	RemoveChild( `SFXXMLNodeConstPtr` oldchild ) 子孫ノードも含めて子ノードを削除します。
`SFCError`	ReplaceChild( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` oldchild ) 子ノードを置換します。
`Bool`	EqualNode( `SFXXMLNodeConstPtr` arg ) (SFXXMLNode から継承) 指定したノードと同等かどうかを判定します。
`ACharConstPtr`	GetNodeValue( `Void` ) (SFXXMLNode から継承) ノードの値を取得します。
`SFXAnsiString`	GetText( `Void` ) (SFXXMLNode から継承) ノードテキストを取得します。
`Bool`	IsSameNode( `SFXXMLNodeConstPtr` other ) (SFXXMLNode から継承) 指定したノードと同一であるかを判定します。
`Void`	SetNodeValue( `ACharConstPtr` value ) (SFXXMLNode から継承) ノードに値を設定します。
`SFCError`	SetText( `SFXAnsiStringConstRef` text ) (SFXXMLNode から継承) ノードテキストを設定します。

型
DOMNamedNodeMap (SFXXMLNode から継承) 複数の DOM ノードを名前で管理するためのクラスです。
DOMNodeList (SFXXMLNode から継承) 複数の DOM ノードをリスト形式で管理するためのクラスです。
NodeType (SFXXMLNode から継承) ノードタイプの数値です。

SFXXMLEntityReference::SFXXMLEntityReference

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

[ public, explicit ]
SFXXMLEntityReference(
    SFXXMLDocumentPtr owner      // ルート
    SFXAnsiStringConstRef name   // ノードの名前
    Bool clonechild = true       // 子ノードをコピーするかどうか 
);

[ public, explicit ]
SFXXMLEntityReference(
    SFXXMLEntityReferenceConstRef other   // SFXXMLEntityReference ノードのインスタンス
    Bool deep = false                     // 子ノードを再帰的にコピーするかどうか
);

SFXXMLEntityReference::~SFXXMLEntityReference

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

[ public, virtual ]
virtual ~SFXXMLEntityReference(Void);

SFXXMLEntityReference::AppendChild

子ノードの最後にノードを追加します。

[ public, virtual ]
SFCError AppendChild(
    SFXXMLNodeConstPtr newchild   // 追加するノード
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正であるとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY

解説

newchild ノードをコピーせずにそのまま追加します。

newchild ノードが別の DOM ツリー内に存在する場合、その DOM ツリー内からは削除されます。

参照

SFXXMLNode::AppendChild | SFXXMLNode

SFXXMLEntityReference::CloneNode

ノードのコピーを作成します。

[ public, virtual ]
SFCError CloneNode(
    SFXXMLNodeHandle clonenode   // コピー先のノード(Handle 型)
    Bool deep                    // 子ノードが再帰的にコピーされるかどうか
);

引数

clonenode

コピー先ノードを指定します。

deep

true の場合、子ノードを再帰的にコピーします。

false の場合、ノード自身だけをコピーします。

戻り値

成功したとき : SFERR_NO_ERROR
失敗したとき : SFERR_FAILED

参照

SFXXMLNode::CloneNode | SFXXMLNode

SFXXMLEntityReference::GetChildNodes

すべての子ノードを取得します。

[ public, virtual, const ]
DOMNodeListPtr GetChildNodes(Void);

戻り値

指定したノードのすべての子ノードを SFXXMLNode::DOMNodeList へのポインターとして返します。子ノードがないときは null を返します。

解説

	注意
	`SFXXMLNode::DOMNodeList` の各要素は、SFXXMLNode 型へのポインターです。

参照

SFXXMLNode::DOMNodeList | SFXXMLNode::GetChildNodes | SFXXMLNode

SFXXMLEntityReference::GetFirstChild

最初の子ノードを取得します。

[ public, virtual, const ]
SFXXMLNodePtr GetFirstChild(Void);

戻り値

最初の子ノードを返します。子ノードがないときは null を返します。

参照

SFXXMLNode::GetFirstChild | SFXXMLNode

SFXXMLEntityReference::GetLastChild

最後の子ノードを取得します。

[ public, virtual, const ]
SFXXMLNodePtr GetLastChild(Void);

戻り値

最後の子ノードを返します。子ノードがないときは null を返します。

参照

SFXXMLNode::GetLastChild | SFXXMLNode

SFXXMLEntityReference::GetNextSibling

次の兄弟ノードを取得します。

[ public, virtual, const ]
SFXXMLNodePtr GetNextSibling(Void);

戻り値

指定したノードの次の兄弟ノードを返します。次の兄弟ノードがないときは null を返します。

参照

SFXXMLEntityReference::GetPreviousSibling | SFXXMLNode::GetNextSibling| SFXXMLNode::GetPreviousSibling | SFXXMLNode

SFXXMLEntityReference::GetNodeName

ノードの名前を取得します。

[ public, virtual, const ]
ACharConstPtr GetNodeName(Void);

解説

EntityReference ノードの名前(参照されるエンティティ名)を返します。

参照

SFXXMLNode::GetNodeName | SFXXMLNode

SFXXMLEntityReference::GetNodeType

ノードタイプを取得します。

[ public, virtual, const ]
NodeType GetNodeType(Void);

戻り値

ENTITY_REFERENCE_NODE を返します。

参照

SFXXMLNode::NodeType | SFXXMLNode::GetNodeType | SFXXMLNode

SFXXMLEntityReference::GetParentNode

親ノードを取得します。

[ public, virtual, const ]
SFXXMLNodePtr GetParentNode(Void);

戻り値

親ノードを返します。親ノードがない場合は、null を返します。

参照

SFXXMLNode::GetParentNode | SFXXMLNode

SFXXMLEntityReference::GetPreviousSibling

前の兄弟ノードを取得します。

[ public, virtual, const ]
SFXXMLNodePtr GetPreviousSibling(Void);

戻り値

指定したノードの前の兄弟ノードを返します。前の兄弟ノードがないときは null を返します。

参照

SFXXMLEntityReference::GetNextSibling | SFXXMLNode::GetPreviousSibling | SFXXMLNode::GetNextSibling | SFXXMLNode

SFXXMLEntityReference::HasChildNodes

子ノードを持つかどうかを判定します。

[ public, virtual, const ]
Bool HasChildNodes(Void);

戻り値

子ノードを持つとき : true
子ノードを持たないとき : false

参照

SFXXMLNode::HasChildNodes | SFXXMLNode

SFXXMLEntityReference::InsertBefore

ノードを挿入します。

[ public, virtual ]
SFCError InsertBefore(
    SFXXMLNodeConstPtr newchild   // 挿入するノード
    SFXXMLNodeConstPtr refchild   // 参照ノード、このノードの直前に挿入される
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正であるとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
失敗したとき : SFERR_FAILED

参照

SFXXMLNode::InsertBefore | SFXXMLNode

SFXXMLEntityReference::RemoveChild

子孫ノードも含めて子ノードを削除します。

[ public, virtual ]
SFCError RemoveChild(
    SFXXMLNodeConstPtr oldchild   // 削除する子ノード
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正であるとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
失敗したとき : SFERR_FAILED

参照

SFXXMLNode::RemoveChild | SFXXMLNode

SFXXMLEntityReference::ReplaceChild

子ノードを置換します。

[ public, virtual ]
SFCError ReplaceChild(
    SFXXMLNodeConstPtr newchild   // 置換後ノード
    SFXXMLNodeConstPtr oldchild   // 置換前ノード
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正であるとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
失敗したとき : SFERR_FAILED

参照

SFXXMLNode::ReplaceChild | SFXXMLNode