|
|
|
|
libxml2 Reference Manual |
|---|
xlink
xlink - unfinished XLink detection module
unfinished XLink detection module
Author(s): Daniel Veillard
Synopsis
typedef xmlChar * xlinkTitle; typedef enum xlinkShow; typedef xmlChar * xlinkHRef; typedef enum xlinkActuate; typedef struct _xlinkHandler xlinkHandler; typedef xmlChar * xlinkRole; typedef xlinkHandler * xlinkHandlerPtr; typedef enum xlinkType; void xlinkSetDefaultDetect (xlinkNodeDetectFunc func); void xlinkSetDefaultHandler (xlinkHandlerPtr handler); typedef void xlinkExtendedLinkFunk (void * ctx,
xmlNodePtr node,
int nbLocators,
const xlinkHRef * hrefs,
const xlinkRole * roles,
int nbArcs,
const xlinkRole * from,
const xlinkRole * to,
xlinkShow * show,
xlinkActuate * actuate,
int nbTitles,
const xlinkTitle * titles,
const xmlChar ** langs); typedef void xlinkExtendedLinkSetFunk (void * ctx,
xmlNodePtr node,
int nbLocators,
const xlinkHRef * hrefs,
const xlinkRole * roles,
int nbTitles,
const xlinkTitle * titles,
const xmlChar ** langs); typedef void xlinkSimpleLinkFunk (void * ctx,
xmlNodePtr node,
const xlinkHRef href,
const xlinkRole role,
const xlinkTitle title); typedef void xlinkNodeDetectFunc (void * ctx,
xmlNodePtr node); xlinkHandlerPtr xlinkGetDefaultHandler (void); xlinkType xlinkIsLink (xmlDocPtr doc,
xmlNodePtr node); xlinkNodeDetectFunc xlinkGetDefaultDetect (void);
Description
Details
Enum xlinkActuate
enum xlinkActuate { XLINK_ACTUATE_NONE = 0 XLINK_ACTUATE_AUTO = 1 XLINK_ACTUATE_ONREQUEST = 2 };
Structure xlinkHandler
struct _xlinkHandler {
xlinkSimpleLinkFunk simple
xlinkExtendedLinkFunk extended
xlinkExtendedLinkSetFunk set
} xlinkHandler;
Typedef xlinkHandlerPtr
xlinkHandler * xlinkHandlerPtr;
Enum xlinkShow
enum xlinkShow { XLINK_SHOW_NONE = 0 XLINK_SHOW_NEW = 1 XLINK_SHOW_EMBED = 2 XLINK_SHOW_REPLACE = 3 };
Enum xlinkType
enum xlinkType { XLINK_TYPE_NONE = 0 XLINK_TYPE_SIMPLE = 1 XLINK_TYPE_EXTENDED = 2 XLINK_TYPE_EXTENDED_SET = 3 };
Function type xlinkExtendedLinkFunk
void xlinkExtendedLinkFunk (void * ctx,
xmlNodePtr node,
int nbLocators,
const xlinkHRef * hrefs,
const xlinkRole * roles,
int nbArcs,
const xlinkRole * from,
const xlinkRole * to,
xlinkShow * show,
xlinkActuate * actuate,
int nbTitles,
const xlinkTitle * titles,
const 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 |
Function type xlinkExtendedLinkSetFunk
void xlinkExtendedLinkSetFunk (void * ctx,
xmlNodePtr node,
int nbLocators,
const xlinkHRef * hrefs,
const xlinkRole * roles,
int nbTitles,
const xlinkTitle * titles,
const 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 |
Function type xlinkNodeDetectFunc
void xlinkNodeDetectFunc (void * ctx,
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 |
Function type xlinkSimpleLinkFunk
void xlinkSimpleLinkFunk (void * ctx,
xmlNodePtr node,
const xlinkHRef href,
const xlinkRole role,
const 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 |
xlinkGetDefaultDetect ()
xlinkNodeDetectFunc xlinkGetDefaultDetect (void)
Get the default xlink detection routine
| Returns: | the current function or NULL; |
xlinkGetDefaultHandler ()
xlinkHandlerPtr xlinkGetDefaultHandler (void)
Get the default xlink handler.
| Returns: | the current xlinkHandlerPtr value. |
xlinkIsLink ()
xlinkType xlinkIsLink (xmlDocPtr doc,
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. |
xlinkSetDefaultDetect ()
void xlinkSetDefaultDetect (xlinkNodeDetectFunc func)
Set the default xlink detection routine
| func: | pointer to the new detection routine. |
xlinkSetDefaultHandler ()
void xlinkSetDefaultHandler (xlinkHandlerPtr handler)
Set the default xlink handlers
| handler: | the new value for the xlink handler block |