uFText.h File Reference

Define uFText component and it's operation. More...

#include <CoconutXML/CoconutXML.h>

Go to the source code of this file.

Classes
struct	uFText
	Plain text component. More...
Functions
struct uFText *	uFAllocateText (struct CNString *text, struct CNResource *resource)
	Allocate uFText component.
static void	uFRetainText (struct uFText *dst)
	Retain the uFText component.
static void	uFReleaseText (struct uFText *dst)
	Release the uFText component.
static struct CNXMLObject *	uFCastTextToXMLObject (struct uFText *src)
	Cast uFText to XML object.
CNBoolean	uFIsTextXMLNode (xmlNodePtr src)
	Check the XML node can be encoded into uFText component.
static xmlNodePtr	uFEncodeText (const struct uFText *src)
	Encode uFText into XML node.
static struct CNString *	uFContextInText (const struct uFText *src)
	Get context of the uFText component.

---

Detailed Description

Define uFText component and it's operation.

Copyright

Copyright (C) 2012 Steel Wheels Project

---

Function Documentation

struct uFText* uFAllocateText	(	struct CNString *	text,
		struct CNResource *	resource
	)		[read]

Allocate uFText component.

Return values:

text	Allocated uFText component
NULL	Failed to allocate the component

Parameters:

text	Context for this component
resource	Resource to allocate the new component

static void uFRetainText

(

struct uFText *

dst

)

[inline, static]

Retain the uFText component.

Parameters:

dst	Destination component

References uFText::superClass.

static void uFReleaseText

(

struct uFText *

dst

)

[inline, static]

Release the uFText component.

Parameters:

dst	Destination component

References uFText::superClass.

static struct CNXMLObject* uFCastTextToXMLObject

(

struct uFText *

src

)

[static, read]

Cast uFText to XML object.

Returns:

XML Object

Parameters:

src	Source text

References uFText::superClass.

CNBoolean uFIsTextXMLNode

(

xmlNodePtr

src

)

Check the XML node can be encoded into uFText component.

Return values:

TRUE	Can be encoded
FALSE	Can NOT be encoded

Parameters:

src	Source XML node

static xmlNodePtr uFEncodeText

(

const struct uFText *

src

)

[inline, static]

Encode uFText into XML node.

Return values:

node	Encoded XML node
NULL	Failed to encode

Parameters:

src	Source uFText component

References uFText::superClass.

static struct CNString* uFContextInText

(

const struct uFText *

src

)

[static, read]

Get context of the uFText component.

Returns:

Context string

Parameters:

src	Source component

References uFText::text.