SFXXMLAttribute

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

#include <SFXXMLAttribute.hpp>

class SFXXMLAttribute : public SFXXMLNode;

SFMTYPEDEFCLASS(SFXXMLAttribute)

継承図

協調図

参照

メンバ

コンストラクタ/デストラクタ
SFXXMLAttribute( `SFXXMLDocumentPtr` owner , `SFXAnsiStringConstRef` name , `SFXAnsiStringConstRef` value ) SFXXMLAttribute クラスのコンストラクタです。
SFXXMLAttribute( `SFXXMLDocumentPtr` owner , `SFXAnsiStringConstRef` name , `SFXAnsiStringConstRef` namespaceURI , `SFXAnsiStringConstRef` value ) SFXXMLAttribute クラスのコンストラクタです。
SFXXMLAttribute( `SFXXMLAttributeConstRef` other , `Bool` deep = false ) SFXXMLAttribute クラスのコンストラクタです。
~SFXXMLAttribute( `Void` ) SFXXMLAttribute クラスのデストラクタです。

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

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

SFXXMLAttribute::SFXXMLAttribute

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

[ public, explicit ]
SFXXMLAttribute(
    SFXXMLDocumentPtr owner       // ルート
    SFXAnsiStringConstRef name    // 属性名
    SFXAnsiStringConstRef value   // 属性値
);

[ public, explicit ]
SFXXMLAttribute(
    SFXXMLDocumentPtr owner              // ルート
    SFXAnsiStringConstRef name           // 属性名
    SFXAnsiStringConstRef namespaceURI   // 属性の名前空間 URI
    SFXAnsiStringConstRef value          // 属性値
);

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

SFXXMLAttribute::~SFXXMLAttribute

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

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

SFXXMLAttribute::AppendChild

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

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

戻り値

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

解説

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

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

参照

SFXXMLNode::AppendChild | SFXXMLNode

SFXXMLAttribute::CloneNode

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

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

引数

clonenode

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

deep

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

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

戻り値

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

参照

SFXXMLNode::CloneNode | SFXXMLNode

SFXXMLAttribute::EqualNode

指定したノードと同等かどうかを判定します。

[ public, virtual, const ]
Bool EqualNode(
    SFXXMLNodeConstPtr arg   // 同等性を比較する対象のノード 
);

参照

SFXXMLNode::EqualNode | SFXXMLNode

SFXXMLAttribute::GetChildNodes

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

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

戻り値

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

解説

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

参照

SFXXMLNode::DOMNodeList | SFXXMLNode::GetChildNodes | SFXXMLNode

SFXXMLAttribute::GetFirstChild

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

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

戻り値

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

参照

SFXXMLNode::GetFirstChild | SFXXMLNode

SFXXMLAttribute::GetLastChild

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

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

戻り値

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

参照

SFXXMLNode::GetLastChild | SFXXMLNode

SFXXMLAttribute::GetLocalName

ローカル名を取得します。

[ public, const ]
ACharConstPtr GetLocalName(Void);

戻り値

Attribute ノードの名前(属性名)に設定されているローカル名を返します。

解説

Attribute ノードの名前(属性名)が修飾名である場合、名前は名前空間接頭辞とローカル名の対からなります。

	注意
	Attribute ノードの名前とは XML 文書の「属性名」のことです。

SFXXMLAttribute::GetName

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

[ public, const ]
ACharConstPtr GetName(Void);

解説

SFXXMLAttribute::GetNodeName 関数を呼び出すのと同等です。

	注意
	Attribute ノードの名前とは XML 文書の「属性名」のことです。

	注意
	名前空間が設定されている場合、修飾名(名前空間接頭辞とローカル名)が返されます。

使用例

// 修飾名と名前空間 URI 付きの Attribute ノードを作成する
SFXXMLAttributePtr atti = document.CreateAttributeNS("book:isbn","http://www.w3.org/book");
// Attribute ノードに属性値を設定する
atti->SetValue("4-7741-1616-5");
// Attribute ノードを設定する	
book->SetAttributeNode(atti);
    
TRACE("Attribute's name = %s", atti->GetName());           // 属性名(修飾名) = book:isbn
TRACE("Attribute's value = %s", atti->GetValue());         // 属性値         = 4-7741-1616-5
TRACE("Attribute's prefix = %s", atti->GetPrefix());       // 名前空間接頭辞 = book
TRACE("Attribute's uri = %s", atti->GetNamespaceURI());    // 名前空間 URI   = http://www.w3.org/book

参照

SFXXMLAttribute::GetNodeName | SFXXMLAttribute::GetPrefix

SFXXMLAttribute::GetNamespaceURI

名前空間 URI を取得します。

[ public, const ]
ACharConstPtr GetNamespaceURI(Void);

戻り値

Attribute ノードの名前(属性名)に設定されている名前空間 URIを返します。

設定されていない場合は null を返します。

SFXXMLAttribute::GetNodeName

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

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

解説

SFXXMLAttribute::GetName 関数を呼び出すのと同等です。

	注意
	Attribute ノードの名前とは XML 文書の「属性名」のことです。

	注意
	名前空間が設定されている場合、修飾名(名前空間接頭辞とローカル名)が返されます。

参照

SFXXMLAttribute::GetName | SFXXMLNode::GetNodeName | SFXXMLNode

SFXXMLAttribute::GetNodeType

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

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

戻り値

ATTRIBUTE_NODE を返します。

参照

SFXXMLNode::NodeType | SFXXMLNode::GetNodeType| SFXXMLNode

SFXXMLAttribute::GetNodeValue

ノードの値を取得します。

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

解説

SFXXMLAttribute::GetValue 関数を呼び出すのと同等です。

	注意
	Attribute ノードの値とは XML 文書の「属性値」のことです。

参照

SFXXMLAttribute::GetValue| SFXXMLNode::GetNodeValue | SFXXMLNode

SFXXMLAttribute::GetPrefix

名前空間接頭辞を取得します。

[ public, const ]
ACharConstPtr GetPrefix(Void);

戻り値

Attribute ノードの名前(属性名)に設定されている名前空間接頭辞を返します。設定されていないときは null を返します。

解説

Attribute ノードの名前(属性名)が修飾名である場合、名前は名前空間接頭辞とローカル名の対からなります。

	注意
	Attribute ノードの名前とは XML 文書の「属性名」のことです。

参照

SFXXMLAttribute::GetName

SFXXMLAttribute::GetValue

ノードの値を取得します。

[ public, const ]
ACharConstPtr GetValue(Void);

解説

SFXXMLAttribute::GetNodeValue 関数を呼び出すのと同等です。

	注意
	Attribute ノードの値とは XML 文書の「属性値」のことです。

参照

SFXXMLAttribute::GetNodeValue

SFXXMLAttribute::HasChildNodes

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

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

戻り値

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

参照

SFXXMLNode::HasChildNodes | SFXXMLNode

SFXXMLAttribute::InsertBefore

ノードを挿入します。

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

戻り値

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

参照

SFXXMLNode::InsertBefore | SFXXMLNode

SFXXMLAttribute::RemoveChild

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

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

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正であるとき : SFERR_INVALID_PARAM
失敗したとき : SFERR_FAILED

参照

SFXXMLNode::RemoveChild | SFXXMLNode

SFXXMLAttribute::ReplaceChild

子ノードを置換します。

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

戻り値

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

参照

SFXXMLNode::ReplaceChild | SFXXMLNode

SFXXMLAttribute::SetNodeValue

ノードの値を設定します。

[ public, virtual ]
Void SetNodeValue(
    ACharConstPtr value   //新たなノード内容 
);

解説

SFXXMLAttribute::SetValue 関数を呼び出すのと同等です。

	注意
	Attribute ノードの値とは XML 文書の「属性値」のことです。

参照

SFXXMLAttribute::SetValue | SFXXMLNode::SetNodeValue | SFXXMLNode

SFXXMLAttribute::SetValue

ノードの値を設定します。

[ public ]
Void SetValue(
    SFXAnsiStringConstRef value   // 属性値 
);

解説

SFXXMLAttribute::SetNodeValue 関数を呼び出すのと同等です。

	注意
	Attribute ノードの値とは XML 文書の「属性値」のことです。

参照

SFXXMLAttribute::SetNodeValue