xlink.h File Reference

#include <libxml/xmlversion.h>
#include <libxml/tree.h>

Go to the source code of this file.

Classes
struct	_xlinkHandler
Typedefs
typedef xmlChar *	xlinkHRef
typedef xmlChar *	xlinkRole
typedef xmlChar *	xlinkTitle
typedef void(*	xlinkNodeDetectFunc )(void *ctx, xmlNodePtr node)
typedef void(*	xlinkSimpleLinkFunk )(void *ctx, xmlNodePtr node, const xlinkHRef href, const xlinkRole role, const xlinkTitle title)
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 _xlinkHandler	xlinkHandler
typedef xlinkHandler *	xlinkHandlerPtr
Enumerations
enum	xlinkType { XLINK_TYPE_NONE = 0, XLINK_TYPE_SIMPLE, XLINK_TYPE_EXTENDED, XLINK_TYPE_EXTENDED_SET }
enum	xlinkShow { XLINK_SHOW_NONE = 0, XLINK_SHOW_NEW, XLINK_SHOW_EMBED, XLINK_SHOW_REPLACE }
enum	xlinkActuate { XLINK_ACTUATE_NONE = 0, XLINK_ACTUATE_AUTO, XLINK_ACTUATE_ONREQUEST }
Functions
XMLPUBFUN xlinkNodeDetectFunc XMLCALL	xlinkGetDefaultDetect (void)
XMLPUBFUN void XMLCALL	xlinkSetDefaultDetect (xlinkNodeDetectFunc func)
XMLPUBFUN xlinkHandlerPtr XMLCALL	xlinkGetDefaultHandler (void)
XMLPUBFUN void XMLCALL	xlinkSetDefaultHandler (xlinkHandlerPtr handler)
XMLPUBFUN xlinkType XMLCALL	xlinkIsLink (xmlDocPtr doc, xmlNodePtr node)

---

Typedef Documentation

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)

xlinkExtendedLinkFunk: : user data pointer : the node carrying the link : the number of locators detected on the link : pointer to the array of locator hrefs : pointer to the array of locator roles : the number of arcs detected on the link : pointer to the array of source roles found on the arcs : pointer to the array of target roles found on the arcs : array of values for the show attributes found on the arcs : array of values for the actuate attributes found on the arcs : the number of titles detected on the link : array of titles detected on the link : array of xml:lang values for the titles This is the prototype for a extended link detection callback.

typedef void(* xlinkExtendedLinkSetFunk)(void *ctx, xmlNodePtr node, int nbLocators, const xlinkHRef *hrefs, const xlinkRole *roles, int nbTitles, const xlinkTitle *titles, const xmlChar **langs)

xlinkExtendedLinkSetFunk: : user data pointer : the node carrying the link : the number of locators detected on the link : pointer to the array of locator hrefs : pointer to the array of locator roles : the number of titles detected on the link : array of titles detected on the link : array of xml:lang values for the titles This is the prototype for a extended link set detection callback.

typedef struct _xlinkHandler xlinkHandler

This is the structure containing a set of Links detection callbacks. There is no default xlink callbacks, if one want to get link recognition activated, those call backs must be provided before parsing.

typedef xlinkHandler* xlinkHandlerPtr

typedef xmlChar* xlinkHRef

Various defines for the various Link properties. NOTE: the link detection layer will try to resolve QName expansion of namespaces. If "foo" is the prefix for "http://foo.com/" then the link detection layer will expand role="foo:myrole" to "http://foo.com/:myrole". NOTE: the link detection layer will expand URI-Refences found on href attributes by using the base mechanism if found.

typedef void(* xlinkNodeDetectFunc)(void *ctx, xmlNodePtr node)

xlinkNodeDetectFunc: : user data pointer : the node to check This is the prototype for the link detection routine. It calls the default link detection callbacks upon link detection.

typedef xmlChar* xlinkRole

typedef void(* xlinkSimpleLinkFunk)(void *ctx, xmlNodePtr node, const xlinkHRef href, const xlinkRole role, const xlinkTitle title)

xlinkSimpleLinkFunk: : user data pointer : the node carrying the link : the target of the link : the role string : the link title This is the prototype for a simple link detection callback.

typedef xmlChar* xlinkTitle

---

Enumeration Type Documentation

enum xlinkActuate

Enumeration values: XLINK_ACTUATE_NONE  XLINK_ACTUATE_AUTO  XLINK_ACTUATE_ONREQUEST

enum xlinkShow

Enumeration values: XLINK_SHOW_NONE  XLINK_SHOW_NEW  XLINK_SHOW_EMBED  XLINK_SHOW_REPLACE

enum xlinkType

Enumeration values: XLINK_TYPE_NONE  XLINK_TYPE_SIMPLE  XLINK_TYPE_EXTENDED  XLINK_TYPE_EXTENDED_SET

---

Function Documentation

XMLPUBFUN xlinkNodeDetectFunc XMLCALL xlinkGetDefaultDetect (  void   )

XMLPUBFUN xlinkHandlerPtr XMLCALL xlinkGetDefaultHandler (  void   )

XMLPUBFUN xlinkType XMLCALL xlinkIsLink (  xmlDocPtr  doc, xmlNodePtr  node )

XMLPUBFUN void XMLCALL xlinkSetDefaultDetect (  xlinkNodeDetectFunc  func  )

XMLPUBFUN void XMLCALL xlinkSetDefaultHandler (  xlinkHandlerPtr  handler  )

---