deps/src/libxml2-2.9.1/doc/devhelp/libxml2-xlink.html
| | | | | libxml2 Reference Manual |
xlink - unfinished XLink detection module
unfinished XLink detection module
Author(s): Daniel Veillard
typedef[xmlChar](libxml2-xmlstring.html#xmlChar)*[xlinkTitle](#xlinkTitle);
typedef enum[xlinkShow](#xlinkShow);
typedef[xmlChar](libxml2-xmlstring.html#xmlChar)*[xlinkHRef](#xlinkHRef);
typedef enum[xlinkActuate](#xlinkActuate);
typedef struct _xlinkHandler[xlinkHandler](#xlinkHandler);
typedef[xmlChar](libxml2-xmlstring.html#xmlChar)*[xlinkRole](#xlinkRole);
typedef[xlinkHandler](libxml2-xlink.html#xlinkHandler)*[xlinkHandlerPtr](#xlinkHandlerPtr);
typedef enum[xlinkType](#xlinkType);
void[xlinkSetDefaultDetect](#xlinkSetDefaultDetect)([xlinkNodeDetectFunc](libxml2-xlink.html#xlinkNodeDetectFunc)func);
void[xlinkSetDefaultHandler](#xlinkSetDefaultHandler)([xlinkHandlerPtr](libxml2-xlink.html#xlinkHandlerPtr)handler);
typedef void[xlinkExtendedLinkFunk](#xlinkExtendedLinkFunk)(void * ctx,
[xmlNodePtr](libxml2-tree.html#xmlNodePtr)node,
int nbLocators,
const[xlinkHRef](libxml2-xlink.html#xlinkHRef)* hrefs,
const[xlinkRole](libxml2-xlink.html#xlinkRole)* roles,
int nbArcs,
const[xlinkRole](libxml2-xlink.html#xlinkRole)* from,
const[xlinkRole](libxml2-xlink.html#xlinkRole)* to,
[xlinkShow](libxml2-xlink.html#xlinkShow)* show,
[xlinkActuate](libxml2-xlink.html#xlinkActuate)* actuate,
int nbTitles,
const[xlinkTitle](libxml2-xlink.html#xlinkTitle)* titles,
const[xmlChar](libxml2-xmlstring.html#xmlChar)** langs);
typedef void[xlinkExtendedLinkSetFunk](#xlinkExtendedLinkSetFunk)(void * ctx,
[xmlNodePtr](libxml2-tree.html#xmlNodePtr)node,
int nbLocators,
const[xlinkHRef](libxml2-xlink.html#xlinkHRef)* hrefs,
const[xlinkRole](libxml2-xlink.html#xlinkRole)* roles,
int nbTitles,
const[xlinkTitle](libxml2-xlink.html#xlinkTitle)* titles,
const[xmlChar](libxml2-xmlstring.html#xmlChar)** langs);
typedef void[xlinkSimpleLinkFunk](#xlinkSimpleLinkFunk)(void * ctx,
[xmlNodePtr](libxml2-tree.html#xmlNodePtr)node,
const[xlinkHRef](libxml2-xlink.html#xlinkHRef)href,
const[xlinkRole](libxml2-xlink.html#xlinkRole)role,
const[xlinkTitle](libxml2-xlink.html#xlinkTitle)title);
typedef void[xlinkNodeDetectFunc](#xlinkNodeDetectFunc)(void * ctx,
[xmlNodePtr](libxml2-tree.html#xmlNodePtr)node);[xlinkHandlerPtr](libxml2-xlink.html#xlinkHandlerPtr)[xlinkGetDefaultHandler](#xlinkGetDefaultHandler)(void);[xlinkType](libxml2-xlink.html#xlinkType)[xlinkIsLink](#xlinkIsLink)([xmlDocPtr](libxml2-tree.html#xmlDocPtr)doc,
[xmlNodePtr](libxml2-tree.html#xmlNodePtr)node);[xlinkNodeDetectFunc](libxml2-xlink.html#xlinkNodeDetectFunc)[xlinkGetDefaultDetect](#xlinkGetDefaultDetect)(void);
enum[xlinkActuate](#xlinkActuate){XLINK\_ACTUATE\_NONE= 0XLINK\_ACTUATE\_AUTO= 1XLINK\_ACTUATE\_ONREQUEST= 2
};
[xmlChar](libxml2-xmlstring.html#xmlChar)* xlinkHRef;
struct _xlinkHandler {[xlinkSimpleLinkFunk](libxml2-xlink.html#xlinkSimpleLinkFunk)simple[xlinkExtendedLinkFunk](libxml2-xlink.html#xlinkExtendedLinkFunk)extended[xlinkExtendedLinkSetFunk](libxml2-xlink.html#xlinkExtendedLinkSetFunk)set
} xlinkHandler;
[xlinkHandler](libxml2-xlink.html#xlinkHandler)* xlinkHandlerPtr;
[xmlChar](libxml2-xmlstring.html#xmlChar)* xlinkRole;
enum[xlinkShow](#xlinkShow){XLINK\_SHOW\_NONE= 0XLINK\_SHOW\_NEW= 1XLINK\_SHOW\_EMBED= 2XLINK\_SHOW\_REPLACE= 3
};
[xmlChar](libxml2-xmlstring.html#xmlChar)* xlinkTitle;
enum[xlinkType](#xlinkType){XLINK\_TYPE\_NONE= 0XLINK\_TYPE\_SIMPLE= 1XLINK\_TYPE\_EXTENDED= 2XLINK\_TYPE\_EXTENDED\_SET= 3
};
void xlinkExtendedLinkFunk (void * ctx,
[xmlNodePtr](libxml2-tree.html#xmlNodePtr)node,
int nbLocators,
const[xlinkHRef](libxml2-xlink.html#xlinkHRef)* hrefs,
const[xlinkRole](libxml2-xlink.html#xlinkRole)* roles,
int nbArcs,
const[xlinkRole](libxml2-xlink.html#xlinkRole)* from,
const[xlinkRole](libxml2-xlink.html#xlinkRole)* to,
[xlinkShow](libxml2-xlink.html#xlinkShow)* show,
[xlinkActuate](libxml2-xlink.html#xlinkActuate)* actuate,
int nbTitles,
const[xlinkTitle](libxml2-xlink.html#xlinkTitle)* titles,
const[xmlChar](libxml2-xmlstring.html#xmlChar)** langs)
This is the prototype for a extended link detection callback.
| ctx: | user data pointer | | node: | the node carrying the link | | nbLocators: | the number of locators detected on the link | | hrefs: | pointer to the array of locator hrefs | | roles: | pointer to the array of locator roles | | nbArcs: | the number of arcs detected on the link | | from: | pointer to the array of source roles found on the arcs | | to: | pointer to the array of target roles found on the arcs | | show: | array of values for the show attributes found on the arcs | | actuate: | array of values for the actuate attributes found on the arcs | | nbTitles: | the number of titles detected on the link | | titles: | | | langs: | array of xml:lang values for the titles |
void xlinkExtendedLinkSetFunk (void * ctx,
[xmlNodePtr](libxml2-tree.html#xmlNodePtr)node,
int nbLocators,
const[xlinkHRef](libxml2-xlink.html#xlinkHRef)* hrefs,
const[xlinkRole](libxml2-xlink.html#xlinkRole)* roles,
int nbTitles,
const[xlinkTitle](libxml2-xlink.html#xlinkTitle)* titles,
const[xmlChar](libxml2-xmlstring.html#xmlChar)** langs)
This is the prototype for a extended link set detection callback.
| ctx: | user data pointer | | node: | the node carrying the link | | nbLocators: | the number of locators detected on the link | | hrefs: | pointer to the array of locator hrefs | | roles: | pointer to the array of locator roles | | nbTitles: | the number of titles detected on the link | | titles: | | | langs: | array of xml:lang values for the titles |
void xlinkNodeDetectFunc (void * ctx,
[xmlNodePtr](libxml2-tree.html#xmlNodePtr)node)
This is the prototype for the link detection routine. It calls the default link detection callbacks upon link detection.
| ctx: | user data pointer | | node: | the node to check |
void xlinkSimpleLinkFunk (void * ctx,
[xmlNodePtr](libxml2-tree.html#xmlNodePtr)node,
const[xlinkHRef](libxml2-xlink.html#xlinkHRef)href,
const[xlinkRole](libxml2-xlink.html#xlinkRole)role,
const[xlinkTitle](libxml2-xlink.html#xlinkTitle)title)
This is the prototype for a simple link detection callback.
| ctx: | user data pointer | | node: | the node carrying the link | | href: | the target of the link | | role: | the role string | | title: | the link title |
[xlinkNodeDetectFunc](libxml2-xlink.html#xlinkNodeDetectFunc)xlinkGetDefaultDetect (void)
Get the default xlink detection routine
| Returns: | the current function or NULL; |
[xlinkHandlerPtr](libxml2-xlink.html#xlinkHandlerPtr)xlinkGetDefaultHandler (void)
Get the default xlink handler.
| Returns: | the current xlinkHandlerPtr value. |
[xlinkType](libxml2-xlink.html#xlinkType)xlinkIsLink ([xmlDocPtr](libxml2-tree.html#xmlDocPtr)doc,
[xmlNodePtr](libxml2-tree.html#xmlNodePtr)node)
Check whether the given node carries the attributes needed to be a link element (or is one of the linking elements issued from the (X)HTML DtDs). This routine don't try to do full checking of the link validity but tries to detect and return the appropriate link type.
| doc: | the document containing the node | | node: | the node pointer itself | | Returns: | the xlinkType of the node (XLINK_TYPE_NONE if there is no link detected. |
void xlinkSetDefaultDetect ([xlinkNodeDetectFunc](libxml2-xlink.html#xlinkNodeDetectFunc)func)
Set the default xlink detection routine
| func: | pointer to the new detection routine. |
void xlinkSetDefaultHandler ([xlinkHandlerPtr](libxml2-xlink.html#xlinkHandlerPtr)handler)
Set the default xlink handlers
| handler: | the new value for the xlink handler block |