SFXXMLComment

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

#include <SFXXMLComment.hpp>

class SFXXMLComment : public SFXXMLText;

SFMTYPEDEFCLASS(SFXXMLComment)

継承図

協調図

解説

Comment ノード（SFXXMLComment）は、 XML 文書のコメントの内容を保持します。

	注意
	内容の一部に文字列「--」(二重ハイフン) が含まれるコメントは不正です。

	注意
	`SFXXMLComment` は `SFXXMLText` を継承します。

参照

SFXXMLNode | SFXXMLText | SFXXMLDocument

メンバ

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

パブリック関数
`SFCError`	CloneNode( `SFXXMLNodeHandle` clonenode , `Bool` deep ) ノードのコピーを作成します。
`ACharConstPtr`	GetNodeName( `Void` ) ノードの名前（nodeName 属性値）を取得します。
`NodeType`	GetNodeType( `Void` ) ノードタイプ（nodeType 属性値）を取得します。
`SFXXMLNodePtr`	GetParentNode( `Void` ) 親ノードを取得します。
`SFXXMLCommentPtr`	SplitText( `SInt32` offset ) 2 つのノードに分割します。
`SFCError`	AppendChild( `SFXXMLNodeConstPtr` newchild ) (SFXXMLNode から継承) 【無効】子ノードの最後にノードを追加します。
`Void`	AppendData( `ACharConstPtr` data ) (SFXXMLText から継承) テキストをノードの値（nodeValue 属性値）の末尾に追加します。
`Void`	DeleteData( `SInt32` offset , `SInt32` count ) (SFXXMLText から継承) ノードの値（nodeValue 属性値）を一部削除します。
`Bool`	EqualNode( `SFXXMLNodeConstPtr` arg ) (SFXXMLNode から継承) 指定されたノードと同等かどうかを判定します。
`DOMNodeListPtr`	GetChildNodes( `Void` ) (SFXXMLNode から継承) 【無効】すべての子ノードを取得します。
`ACharConstPtr`	GetData( `Void` ) (SFXXMLText から継承) ノードの値（nodeValue 属性値）を取得します。
`SFXXMLNodePtr`	GetFirstChild( `Void` ) (SFXXMLNode から継承) 【無効】最初の子ノードを取得します。
`SFXXMLNodePtr`	GetLastChild( `Void` ) (SFXXMLNode から継承) 【無効】最後の子ノードを取得します。
`SInt32`	GetLength( `Void` ) (SFXXMLText から継承) テキストの長さ（文字数）を取得します。
`SFXXMLNodePtr`	GetNextSibling( `Void` ) (SFXXMLText から継承) 次の兄弟ノードを取得します。
`ACharConstPtr`	GetNodeValue( `Void` ) (SFXXMLText から継承) ノードの値（nodeValue 属性値）を取得します。
`SFXXMLNodePtr`	GetPreviousSibling( `Void` ) (SFXXMLText から継承) 前の兄弟ノードを取得します。
`SFXAnsiString`	GetText( `Void` ) (SFXXMLNode から継承) ノードテキストを取得します。
`Bool`	HasChildNodes( `Void` ) (SFXXMLNode から継承) 【無効】子ノードを持つかどうかを判定します。
`SFCError`	InsertBefore( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` refchild ) (SFXXMLNode から継承) 【無効】ノードを挿入します。
`Void`	InsertData( `SInt32` offset , `ACharConstPtr` data ) (SFXXMLText から継承) テキストを挿入します。
`Bool`	IsSameNode( `SFXXMLNodeConstPtr` other ) (SFXXMLNode から継承) 指定されたノードと同一であるか判定します。
`SFCError`	RemoveChild( `SFXXMLNodeConstPtr` oldchild ) (SFXXMLNode から継承) 【無効】子孫ノードも含めて子ノードを削除します。
`SFCError`	ReplaceChild( `SFXXMLNodeConstPtr` newchild , `SFXXMLNodeConstPtr` oldchild ) (SFXXMLNode から継承) 【無効】子ノードを置換します。
`Void`	ReplaceData( `SInt32` offset , `SInt32` count , `ACharConstPtr` data ) (SFXXMLText から継承) テキストを置換します。
`Void`	SetData( `ACharConstPtr` data ) (SFXXMLText から継承) ノードの値（nodeValue 属性値）を設定します。
`Void`	SetNodeValue( `ACharConstPtr` value ) (SFXXMLText から継承) ノードの値（nodeValue 属性値）を設定します。
`SFCError`	SetText( `SFXAnsiStringConstRef` text ) (SFXXMLNode から継承) ノードテキストを設定します。
`SFXAnsiString`	SubstringData( `SInt32` offset , `SInt32` count ) (SFXXMLText から継承) 部分文字列を取得します。

型
DOMNamedNodeMap (SFXXMLNode から継承) 複数の DOM ノードを名前またはローカル名と名前空間 URI で管理するためのクラスです。
DOMNodeList (SFXXMLNode から継承) 複数の DOM ノードをリスト形式で管理するためのクラスです。
NodeType (SFXXMLNode から継承) ノードタイプを表す定数です。

SFXXMLComment::SFXXMLComment

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

[ public, explicit ]
SFXXMLComment(
    SFXXMLDocumentPtr owner      // ドキュメントツリーのルート
    SFXAnsiStringConstRef name   // コメントの内容
);

[ public, explicit ]
SFXXMLComment(
    SFXXMLCommentConstRef other   // Comment ノード
    Bool deep = false             // 子ノードを再帰的にコピーするかどうか
);

解説

このコンストラクタは、指定された値をこのノードに設定します。

引数には、このノードを所有するドキュメントツリーのルート（SFXXMLDocument）とコメントの内容、または別の Comment ノードのいずれかを指定することが可能です。

	注意
	name 引数に指定されるコメントの内容は、 `SFXXMLText::GetNodeValue` 関数で取得できる、このノードの nodeValue 属性として設定されます。

参照

SFXXMLText::GetNodeValue | SFXXMLDocument

SFXXMLComment::~SFXXMLComment

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

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

解説

このデストラクタは、何も行いません。

SFXXMLComment::CloneNode

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

[ public, virtual ]
SFCError CloneNode(
    SFXXMLNodeHandle clonenode   // コピー先のノード(Handle 型)
    Bool deep                    // 子ノードを再帰的にコピーするかどうか【無効】
);

引数

clonenode: コピー先ノードを指定します。
deep: この引数は無効です。

戻り値

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

解説

この関数は、このノードのコピーを作成し、clonenode 引数に返します。

	注意
	Comment ノードは子ノードを持たないので、 deep 引数は無効です。true を指定しても、false を指定しても結果は同じです。

参照

SFXXMLComment::SFXXMLComment | SFXXMLNode::CloneNode | SFXXMLNode

SFXXMLComment::GetNodeName

ノードの名前（nodeName 属性値）を取得します。

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

戻り値

"#comment"

解説

この関数は、このノードの名前（nodeName 属性値）を取得します。

Comment ノードの場合、nodeName 属性値は "#comment" です。

参照

SFXXMLNode::GetNodeName | SFXXMLNode

SFXXMLComment::GetNodeType

ノードタイプ（nodeType 属性値）を取得します。

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

戻り値

SFXXMLNode::COMMENT_NODE

解説

この関数は、このノードのタイプ（nodeType 属性値）を取得します。

Comment ノードの場合、nodeType 属性値は SFXXMLNode::COMMENT_NODE です。

参照

SFXXMLNode::NodeType | SFXXMLNode::GetNodeType | SFXXMLNode

SFXXMLComment::GetParentNode

親ノードを取得します。

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

戻り値

親ノード

解説

この関数は、このノードの親ノードを取得します。

	注意
	親ノードが存在しない場合は null を返します。

参照

SFXXMLNode::GetParentNode | SFXXMLNode

SFXXMLComment::SplitText

2 つのノードに分割します。

[ public ]
SFXXMLCommentPtr SplitText(
    SInt32 offset   // 分割する位置
);

戻り値

新たに作成された Comment ノード（作成されなかった場合は null）

解説

この関数は、この Comment ノードを 2 つに分割し、新たに作成された Comment ノードを返します。

具体的な処理内容は以下の通りです。、

この Comment ノードの nodeValue 属性値であるコメントの内容（文字列）の offset 引数に指定された位置以降の文字列を削除します。
この Comment ノードと同じ親ノードを持つ Comment ノードを新たに作成し、その nodeValue 属性値を削除した文字列に設定します。
そして、新しく作成した Comment ノードを返します。
※ offset 引数に指定された位置がこの Comment ノードの nodeValue 属性値であるコメントの内容（文字列）の末尾を超える場合は、この Comment ノードは分割されず、この関数は null を返します。

	注意
offset 引数に指定される位置が分割前の Comment ノードのコメントの内容（文字列）の末尾である場合、この関数が返す Comment ノードのコメントは空の文字列です。 offset 引数に指定される値が 0 である場合、分割後、この Comment ノードのコメントの内容（文字列）は空の文字列になります。この関数が返す Comment ノードのコメントは分割前にこの Comment ノードに設定されていたコメントの内容（文字列）になります。

注意

offset 引数に指定される位置が分割前の Comment ノードのコメントの内容（文字列）の末尾である場合、この関数が返す Comment ノードのコメントは空の文字列です。

offset 引数に指定される値が 0 である場合、分割後、この Comment ノードのコメントの内容（文字列）は空の文字列になります。この関数が返す Comment ノードのコメントは分割前にこの Comment ノードに設定されていたコメントの内容（文字列）になります。

参照

SFXXMLText::SplitText | SFXXMLText