home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _8eaa1a9d87fcd90600a434fd3f2a4ba2 < prev    next >
Encoding:
Text File  |  2000-03-23  |  4.2 KB  |  121 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>XML::Element - Base element class for XML elements</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> XML::Element - Base element class for XML elements</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#methods">METHODS</A></LI>
  26.     <LI><A HREF="#limitations">LIMITATIONS</A></LI>
  27.     <LI><A HREF="#authors">AUTHORS</A></LI>
  28.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  29. </UL>
  30. <!-- INDEX END -->
  31.  
  32. <HR>
  33. <P>
  34. <H1><A NAME="name">NAME</A></H1>
  35. <P>XML::Element - Base element class for XML elements</P>
  36. <P>
  37. <HR>
  38. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  39. <UL>
  40. <LI>Linux</LI>
  41. <LI>Solaris</LI>
  42. <LI>Windows</LI>
  43. </UL>
  44. <HR>
  45. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  46. <PRE>
  47.  use XML::Element;
  48.  @ISA = qw( XML::Element );</PRE>
  49. <P>
  50. <HR>
  51. <H1><A NAME="description">DESCRIPTION</A></H1>
  52. <P>Base element class for XML elements.  To be derived from to create your own
  53. elements for use with the XML::Parser module.  Supports output of empty
  54. elements using <.... />.</P>
  55. <P>It is recommended that you use a
  56. version of the XML::Parser module which includes support for Styles; by
  57. deriving your own elements from XML::Element and using the 'Objects' style it
  58. becomes <STRONG>much</STRONG> easier to create your own parser.</P>
  59. <P>
  60. <HR>
  61. <H1><A NAME="methods">METHODS</A></H1>
  62. <DL>
  63. <DT><STRONG><A NAME="item_add_text">add_text ($text)</A></STRONG><BR>
  64. <DD>
  65. Adds character data to the end of the element.  The element created is placed
  66. within the same package space as the element it was created under (e.g. adding
  67. text to a XML::Foobar::Stuff element would put the character data into an
  68. XML::Foobar::Characters element).  If successful, this method returns a
  69. reference to the newly created element.
  70. <P></P>
  71. <DT><STRONG><A NAME="item_as_text">as_text</A></STRONG><BR>
  72. <DD>
  73. Returns a string value containing the entire XML document from this element on
  74. down.
  75. <P></P>
  76. <DT><STRONG><A NAME="item_content">content</A></STRONG><BR>
  77. <DD>
  78. Returns a string value containing the entire content of this XML element.  Note
  79. that this is quite similar to the <A HREF="#item_as_text"><CODE>as_text()</CODE></A> method except that it does not
  80. include any information about this element in particular.
  81. <P></P>
  82. <DT><STRONG><A NAME="item_output">output</A></STRONG><BR>
  83. <DD>
  84. Recursively outputs the structure of the XML document from this element on
  85. down.
  86. <P></P>
  87. <DT><STRONG><A NAME="item_add_child">add_child ($elemref)</A></STRONG><BR>
  88. <DD>
  89. Adds the child element to the list of children for this element.  Note that the
  90. element given must be a reference to an object derived from <CODE>XML::Element</CODE>.
  91. <P></P>
  92. <DT><STRONG><A NAME="item_remove_child">remove_child ($elemref)</A></STRONG><BR>
  93. <DD>
  94. Removes the given child element from the list of children for this element.
  95. This method returns non-zero if it is able to locate and remove the child
  96. element, returning zero if it is unable to do so.
  97. <P></P></DL>
  98. <P>
  99. <HR>
  100. <H1><A NAME="limitations">LIMITATIONS</A></H1>
  101. <P>The <CODE>XML::Element</CODE> module has no provisions for outputting processor
  102. directives or external entities.  It only outputs child elements and any
  103. character data which the elements may contain.</P>
  104. <P>
  105. <HR>
  106. <H1><A NAME="authors">AUTHORS</A></H1>
  107. <P>Graham TerMarsch <<A HREF="mailto:gtermars@activestate.com">gtermars@activestate.com</A>></P>
  108. <P>
  109. <HR>
  110. <H1><A NAME="see also">SEE ALSO</A></H1>
  111. <P><A HREF="../../../site/lib/XML/Parser.html">the XML::Parser manpage</A></P>
  112. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  113. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  114. <STRONG><P CLASS=block> XML::Element - Base element class for XML elements</P></STRONG>
  115. </TD></TR>
  116. </TABLE>
  117.  
  118. </BODY>
  119.  
  120. </HTML>
  121.