Kino API Description
 
NodeNew
Creates and initializes a new node
Returns
Node *the created and initialized node 
Parameters
void   

ElementNew
Creates and initializes a new element
Returns
Element * 
Parameters
void   

DocumentNew
Creates and initializes a new document
Returns
Document * 
Parameters
void   

TextNew
Creates and initializes a new text element
Returns
Text * 
Parameters
void   

InsetNew
Creates and initializes a new inset element
Returns
Inset * 
Parameters
void   

NodeDelete
Removes a node from the DOM tree and frees it, including child nodes
Returns
void 
Parameters
Node *  the node to be freed 

NodeGetNodeType
Returns the type of the node (ELEMENT_NODE = 1, ATTRIBUTE_NODE = 2, TEXT_NODE = 3, CDATA_SECTION_NODE = 4, ENTITY_REFERENCE_NODE = 5, ENTITY_NODE = 6, PROCESSING_INSTRUCTION_NODE = 7, COMMENT_NODE = 8, DOCUMENT_NODE = 9, DOCUMENT_TYPE_NODE = 10, DOCUMENT_FRAGMENT_NODE = 11, NOTATION_NODE = 12, INSET_NODE = 9000, LINEBREAK_NODE = 9001)
Returns
int 
Parameters
Node *  the current node 

NodeGetParentNode
Returns the parent Node
Returns
Node * 
Parameters
Node *  the current node 

NodeGetOwnerDocument
Returns the containing document of the Node
Returns
Document * 
Parameters
Node *  the current node 

NodeGetPreviousSibling
Returns the previous sibling (within the child list of the parent node) of a node
Returns
Node * 
Parameters
Node *  the current node 

NodeGetNextSibling
Returns the previous sibling (within the child list of the parent node) of a node
Returns
Node * 
Parameters
Node *  the current node 

NodeHasChildNodes
returns 1 if a node has child nodes, 0 otherwise
Returns
int 
Parameters
Node *  the current node 

NodeGetFirstChild
Returns the first child node of a node
Returns
Node* 
Parameters
Node *  the current node 

NodeGetLastChild
Returns the last child node of a node
Returns
Node* 
Parameters
Node *  the current node 

NodeAppendChild
Appends a node at the end of the child list of a given node
Returns
void 
Parameters
Node *  the node containing the child list 
Node *  the node to be appended 

NodeInsertBefore
Inserts a node before a given node in the child list of a parent node
Returns
void 
Parameters
Node *  the node containing the child list 
Node *  the node before the new node is to be inserted or NULL if the new node is to be appended at the end of the child list 
Node *  the node to be inserted 

NodeReplaceChild
Replaces a child node and returns the replaced node
Returns
Node *the replaced node 
Parameters
Node *  the node containing the child list 
Node *  the node to be replaced 
Node *  the new node 

NodeRemoveChild
Removes a node from the child list and returns the removed node
Returns
Node *the removed node 
Parameters
Node *  the node containing the child list 
Node *  the node to be removed 

NodePrint
Prints an internal representation of a node and its children
Returns
void 
Parameters
Node *  the node to be printed 
int  the indentiation level 

NodeToText
Returns the XML source text for the given node and its children
Returns
char *the textual representation 
Parameters
Node *  the node to be inspected 

NodeParentLookup
Looks for a node with a given attribute value in the parent chain of a node
Returns
Node * 
Parameters
Node *  the current node 
char *  the attribute name 
char *  the attribute value to look for 

NodeChildLookup
Looks for a node with a given attribute value among the children of a node
Returns
Node * 
Parameters
Node *  the current node 
char *  the attribute name 
char *  the attribute value to look for 

NodeGetSuccessor
Returns the next node in a depth-first traversal
Returns
Node *the following node in a depth-first traversal 
Parameters
Node *  the current node 

TextGetData
Returns a reference to the value of a text element
Returns
char *a pointer to the text 
Parameters
Text *  the current element 

TextSetData
Sets the value of a text element, releases memory held by the old value
Returns
void 
Parameters
Text *  the current element 
char *  the new value 

DocumentGetElementsByTagName
Returns a list of sub-elements which have a given tag name or all sub-elements if the given name is "*"
Returns
NodeList *the list of sub-elements 
Parameters
Document *  the document where the search starts 
char *  the tag name to look for 

ElementGetTagName
Returns the tag name of an element
Returns
char * 
Parameters
Element *  the current element 

ElementSetTagName
Sets the tag name of an element, releases memory held by old tag name
Returns
void 
Parameters
Element *  the current element 
char *  the new tag name 

ElementGetAttribute
Returns the value of a given attribute
Returns
char * 
Parameters
Element *  the current element 
char *  the attribute name 

ElementSetAttribute
Sets the value of an attribute, releases memory held by old attribute value
Returns
void 
Parameters
Element *  the current element 
char *  the attribute name 
char *  the new attribute value 

ElementSetContents
Sets the textual contents of a Element. The contents is stored in a single Text element. Any previous contents is deleted
Returns
void 
Parameters
Element *  the current element 
char *  the new contents 

ElementGetContents
Returns the textual contents of a Element. Any non-textual context is ignored. The result is a new allocated string which has to be freed by the caller
Returns
char * 
Parameters
Element *  the current element 

ElementSetDefaultAttributes
Sets the default attribute values according to the DTD
Returns
void 
Parameters
Element *  the current element 

ElementSetInherited
Copies the inheritable CSS attributes from the parent element
Returns
void 
Parameters
Element *  the current element 

ElementGetElementsByTagName
Returns a list of sub-elements which have a given tag name or all sub-elements if the given name is "*"
Returns
NodeList *the list of sub-elements 
Parameters
Element *  the element where the search starts 
char *  the tag name to look for 

NodeListNew
Creates a new NodeList
Returns
NodeList *the created NodeList 
Parameters
void   

NodeListDelete
Deletes a NodeList (not its contents!)
Returns
void 
Parameters
NodeList *  the NodeList to be deleted 

NodeListAppendItem
Appends a Node at the end of a NodeList
Returns
intthe index of the appended Node 
Parameters
NodeList *  the NodeList where the Node is appended 
Node *  the Node to be appended 

NodeListGetLength
Returns the number of items in a NodeList
Returns
intthe number of items in the list 
Parameters
NodeList *  the NodeList 

NodeListGetItem
Returns the Node at the given position
Returns
Node *The Node or NULL if the position is out of range 
Parameters
NodeList *  the NodeList 
int  the position (starting at zero) 

NodeListRemoveItem
Removes all occurences of a node from the list
Returns
Node *the last of the removed node 
Parameters
NodeList *  the NodeList 
Node *  the Node to be removed 

ElementMatch
Matches a given Element hierarchy against a pattern hierarchy
Returns
NodeList *the list of nodes that matched the pattern nodes or NULL if the pattern did not match 
Parameters
Element *  the given hierarchy 
Element *  the pattern hierarchy 

ParserNew
Creates a new parser object
Returns
Parser *The newly allocated parser object 
Parameters

ParserDelete
Deletes a parser object
Returns
void 
Parameters
Parser *  The parser object to be deleted 

ParserSetStartElement
Sets the start element for a following parse process
Returns
void 
Parameters
Parser *   
Element *   

ParserSetDocument
Sets the start document for the parsing process
Returns
void 
Parameters
Parser *   
Document *   

ParserSetURI
Returns
void 
Parameters
Parser *   
char *   

ParserProcessData
Process a piece of data after the parser has been prepared with an initial document, URI and start element
Returns
Element *The original element where the parse process has bee started 
Parameters
Parser *  The parser to be used for parsing 
char *  the MIME type of the text to be parsed (possible values are currently text/xml, text/html, text/css and text/plain) 
char *  the text to be parsed 

AHDRuntimeNew
Create a new instance of an AHD runtime
Returns
AHDRuntime * 
Parameters
int  port number of the internal AHD server or 0 if no server is to be used 
char *  root directory of the internal AHD server or NULL if no server is to be used 

AHDRuntimeDelete
Deletes a runtime object
Returns
void 
Parameters
AHDRuntime *  The object to be deleted 

AHDRuntimeAddScriptHandler
Add a script handler to the runtime
Returns
void 
Parameters
AHDRuntime *  The AHD runtime 
HandlerProc  Pointer to the script handler 
void *  Callback data 

AHDRuntimeDocumentInit
Initialize a document to be used with a runtime
Returns
void 
Parameters
AHDRuntime *  The AHD runtime 
Document *  The document to be initialized 

AHDRuntimeLoad
Load a remote document referenced by a URI
Returns
Document *The loaded document 
Parameters
AHDRuntime *  The AHD runtime 
char *  The document's URI 

AHDRuntimeUnload
Removes a document from the runtime
Returns
void 
Parameters
AHDRuntime *  The AHD runtime 
Document *  The document to be unloaded 

AHDRuntimeSave
Saves a document under its original location (only for runtime-local documents)
Returns
void 
Parameters
AHDRuntime *  The AHD runtime 
Document *  The document to be saved 

AHDRuntimeStore
Stores a document in a remote runtime and activates it there
Returns
void 
Parameters
AHDRuntime *  The AHD runtime 
Document *  The document to be stored 
char *  the remote URL 
char *  the origin address for this document 

AHDRuntimeCall
Calls an AHD function within a document using parent delegation
Returns
char *The result of the called function 
Parameters
AHDRuntime *  The AHD runtime 
Node *  The current node where the call originates 
char *  The function name 
char *  The URL encoded parameters in name/value pairs 

AHDRuntimeBroadcastCall
Broadcast call of an AHD function within a document
Returns
void 
Parameters
AHDRuntime *  The AHD runtime 
Node *  The current node where the call originates 
char *  The function name 
char *  The URL encoded parameters in name/value pairs 

AHDRuntimeGet
Returns the value of an AHD variable using parent delegation
Returns
char *The value of the variable 
Parameters
AHDRuntime *  The AHD runtime 
Node *  The current node where the call originates 
char *  The variable name 

AHDRuntimePut
Sets the value of an AHD variable using parent delegation
Returns
void 
Parameters
AHDRuntime *  The AHD runtime 
Node *  The current node where the call originates 
char *  The variable name 
char *  The value of the variable 

AHDRuntimeMatch
Matches a given Element hierarchy against a pattern hierarchy, triggering onmatch events
Returns
NodeList *the list of nodes that matched the pattern nodes or NULL if the pattern did not match 
Parameters
AHDRuntime *  the runtime executing the onmatch events 
Element *  the given hierarchy 
Element *  the pattern hierarchy 

AHDRuntimeHere
Returns the hostname and port number of the given AHD runtime
Returns
char *the hostname and port number as "hostname:port" 
Parameters
AHDRuntime *  the runtime 

AHDRuntimeGetLoadedDocuments
Returns a list of the currently loaded documents in the runtime
Returns
NodeList *the list of loaded documents 
Parameters
AHDRuntime *  the runtime 

AHDRuntimeGetOrigin
Returns the origin URL of a given document
Returns
char *the origin URL 
Parameters
AHDRuntime *  the runtime 
Document *  the document