  
    
    
    
    
    
    
    
  
  
    
      
        
          
libxml2-xinclude.html            
Prev          
        
        
          
general.html            
Up          
        
        
          
index.html            
Home          
        
        
          
libxml2-xmlIO.html            
Next          
        
        
libxml2 Reference Manual      
    
    
      
xlink    
    
xlink - unfinished XLink detection module
    
unfinished XLink detection module 
    
Author(s): Daniel Veillard 
    
      
Synopsis
      
typedef libxml2-xmlstring.html#xmlCharxmlChar  * #xlinkTitlexlinkTitle ;
typedef enum 
#xlinkShowxlinkShow ;
typedef 
libxml2-xmlstring.html#xmlCharxmlChar  * #xlinkHRefxlinkHRef ;
typedef enum 
#xlinkActuatexlinkActuate ;
typedef struct _xlinkHandler 
#xlinkHandlerxlinkHandler ;
typedef 
libxml2-xmlstring.html#xmlCharxmlChar  * #xlinkRolexlinkRole ;
typedef 
libxml2-xlink.html#xlinkHandlerxlinkHandler  * #xlinkHandlerPtrxlinkHandlerPtr ;
typedef enum 
#xlinkTypexlinkType ;
void	
#xlinkSetDefaultDetectxlinkSetDefaultDetect 		( libxml2-xlink.html#xlinkNodeDetectFuncxlinkNodeDetectFunc  func);
void	
#xlinkSetDefaultHandlerxlinkSetDefaultHandler 		( libxml2-xlink.html#xlinkHandlerPtrxlinkHandlerPtr  handler);
typedef void 
#xlinkExtendedLinkFunkxlinkExtendedLinkFunk 		(void * ctx, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  node, 					 int nbLocators, 					 const libxml2-xlink.html#xlinkHRefxlinkHRef  * hrefs, 					 const libxml2-xlink.html#xlinkRolexlinkRole  * roles, 					 int nbArcs, 					 const libxml2-xlink.html#xlinkRolexlinkRole  * from, 					 const libxml2-xlink.html#xlinkRolexlinkRole  * to, 					 libxml2-xlink.html#xlinkShowxlinkShow  * show, 					 libxml2-xlink.html#xlinkActuatexlinkActuate  * actuate, 					 int nbTitles, 					 const libxml2-xlink.html#xlinkTitlexlinkTitle  * titles, 					 const libxml2-xmlstring.html#xmlCharxmlChar  ** langs);
typedef void 
#xlinkExtendedLinkSetFunkxlinkExtendedLinkSetFunk 	(void * ctx, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  node, 					 int nbLocators, 					 const libxml2-xlink.html#xlinkHRefxlinkHRef  * hrefs, 					 const libxml2-xlink.html#xlinkRolexlinkRole  * roles, 					 int nbTitles, 					 const libxml2-xlink.html#xlinkTitlexlinkTitle  * titles, 					 const libxml2-xmlstring.html#xmlCharxmlChar  ** langs);
typedef void 
#xlinkSimpleLinkFunkxlinkSimpleLinkFunk 		(void * ctx, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  node, 					 const libxml2-xlink.html#xlinkHRefxlinkHRef  href, 					 const libxml2-xlink.html#xlinkRolexlinkRole  role, 					 const libxml2-xlink.html#xlinkTitlexlinkTitle  title);
typedef void 
#xlinkNodeDetectFuncxlinkNodeDetectFunc 		(void * ctx, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  node);
libxml2-xlink.html#xlinkHandlerPtrxlinkHandlerPtr 	#xlinkGetDefaultHandlerxlinkGetDefaultHandler 	(void);
libxml2-xlink.html#xlinkTypexlinkType 	#xlinkIsLinkxlinkIsLink 		( libxml2-tree.html#xmlDocPtrxmlDocPtr  doc, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  node);
libxml2-xlink.html#xlinkNodeDetectFuncxlinkNodeDetectFunc 	#xlinkGetDefaultDetectxlinkGetDefaultDetect 	(void);
    
    
      
Description
    
    
      
Details
      
        
Enum xlinkActuate
enum #xlinkActuatexlinkActuate  {
    
XLINK_ACTUATE_NONE  = 0
    
XLINK_ACTUATE_AUTO  = 1
    
XLINK_ACTUATE_ONREQUEST  = 2
};
        
        
Typedef xlinkHRef
libxml2-xmlstring.html#xmlCharxmlChar  * xlinkHRef;
        
        
Structure xlinkHandler
struct _xlinkHandler {
    
libxml2-xlink.html#xlinkSimpleLinkFunkxlinkSimpleLinkFunk 	simple
    
libxml2-xlink.html#xlinkExtendedLinkFunkxlinkExtendedLinkFunk 	extended
    
libxml2-xlink.html#xlinkExtendedLinkSetFunkxlinkExtendedLinkSetFunk 	set
} xlinkHandler;
        
        
Typedef xlinkHandlerPtr
libxml2-xlink.html#xlinkHandlerxlinkHandler  * xlinkHandlerPtr;
        
        
Typedef xlinkRole
libxml2-xmlstring.html#xmlCharxmlChar  * xlinkRole;
        
        
Enum xlinkShow
enum #xlinkShowxlinkShow  {
    
XLINK_SHOW_NONE  = 0
    
XLINK_SHOW_NEW  = 1
    
XLINK_SHOW_EMBED  = 2
    
XLINK_SHOW_REPLACE  = 3
};
        
        
Typedef xlinkTitle
libxml2-xmlstring.html#xmlCharxmlChar  * xlinkTitle;
        
        
Enum xlinkType
enum #xlinkTypexlinkType  {
    
XLINK_TYPE_NONE  = 0
    
XLINK_TYPE_SIMPLE  = 1
    
XLINK_TYPE_EXTENDED  = 2
    
XLINK_TYPE_EXTENDED_SET  = 3
};
        
        
Function type xlinkExtendedLinkFunk
void	xlinkExtendedLinkFunk		(void * ctx, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  node, 					 int nbLocators, 					 const libxml2-xlink.html#xlinkHRefxlinkHRef  * hrefs, 					 const libxml2-xlink.html#xlinkRolexlinkRole  * roles, 					 int nbArcs, 					 const libxml2-xlink.html#xlinkRolexlinkRole  * from, 					 const libxml2-xlink.html#xlinkRolexlinkRole  * to, 					 libxml2-xlink.html#xlinkShowxlinkShow  * show, 					 libxml2-xlink.html#xlinkActuatexlinkActuate  * actuate, 					 int nbTitles, 					 const libxml2-xlink.html#xlinkTitlexlinkTitle  * titles, 					 const libxml2-xmlstring.html#xmlCharxmlChar  ** 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, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  node, 					 int nbLocators, 					 const libxml2-xlink.html#xlinkHRefxlinkHRef  * hrefs, 					 const libxml2-xlink.html#xlinkRolexlinkRole  * roles, 					 int nbTitles, 					 const libxml2-xlink.html#xlinkTitlexlinkTitle  * titles, 					 const libxml2-xmlstring.html#xmlCharxmlChar  ** 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, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  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, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  node, 					 const libxml2-xlink.html#xlinkHRefxlinkHRef  href, 					 const libxml2-xlink.html#xlinkRolexlinkRole  role, 					 const libxml2-xlink.html#xlinkTitlexlinkTitle  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 ()
libxml2-xlink.html#xlinkNodeDetectFuncxlinkNodeDetectFunc 	xlinkGetDefaultDetect	(void)Get the default xlink detection routine
Returns: the current function or NULL;         
        
xlinkGetDefaultHandler ()
libxml2-xlink.html#xlinkHandlerPtrxlinkHandlerPtr 	xlinkGetDefaultHandler	(void)Get the default xlink handler.
Returns: the current libxml2-xlink.html#xlinkHandlerPtrxlinkHandlerPtr  value.         
        
xlinkIsLink ()
libxml2-xlink.html#xlinkTypexlinkType 	xlinkIsLink		( libxml2-tree.html#xmlDocPtrxmlDocPtr  doc, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  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 libxml2-xlink.html#xlinkTypexlinkType  of the node (XLINK_TYPE_NONE if there is no link detected.         
        
xlinkSetDefaultDetect ()
void	xlinkSetDefaultDetect		( libxml2-xlink.html#xlinkNodeDetectFuncxlinkNodeDetectFunc  func)Set the default xlink detection routine
func: pointer to the new detection routine.         
        
xlinkSetDefaultHandler ()
void	xlinkSetDefaultHandler		( libxml2-xlink.html#xlinkHandlerPtrxlinkHandlerPtr  handler)Set the default xlink handlers
handler: the new value for the xlink handler block         
      
    
  
