1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<!-- This file generated using Python HTMLgen module. -->
<HEAD>
<META NAME="GENERATOR" CONTENT="HTMLgen 2.2.2">
<TITLE>Class FramesetDocument - A minimal document suitable for entering Framesets.</TITLE>
<LINK rel=stylesheet href="HTMLgen.css" type=text/css title="HTMLgen.css">
</HEAD>
<BODY BGCOLOR="#FFFFFF" BACKGROUND="../image/bg-dots.gif" TEXT="#000000" LINK="#EE0000" VLINK="#990000">
<A HREF="HTMLgen-Frameset.html"><IMG src="../image/back.gif" height="22" width="66" alt="Previous" border="0"></A>
<A HREF="HTMLgen-HR.html"><IMG src="../image/next.gif" height="22" width="66" alt="Next" border="0"></A>
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif">
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif">
<H3>Class FramesetDocument - A minimal document suitable for entering Framesets.</H3>
<HR>
<H2>SYNOPSIS</H2>
<PRE>import HTMLgen</PRE>
<PRE>class FramesetDocument(BasicDocument)
string __module__ = 'HTMLgen'
def __str__(self)
None alinkcolor = None
None alinkcolor = None
None alinkcolor = None
None alinkcolor = None
# Methods inherited by FramesetDocument from BasicDocument
def __init__(self, *args, **kw)
<A HREF="#def append(self, *items)">def append(self, *items)</A>
<A HREF="#def append_file(self, filename, marker_function = None)">def append_file(self, filename, marker_function = None)</A>
<A HREF="#def copy(self)">def copy(self)</A>
<A HREF="#def html_body_tag(self)">def html_body_tag(self)</A>
<A HREF="#def html_head(self)">def html_head(self)</A>
<A HREF="#def prepend(self, *items)">def prepend(self, *items)</A>
<A HREF="#def write(self, filename = None)">def write(self, filename = None)</A>
</PRE>
<H2>DESCRIPTION</H2>
<P>Arguments are for contents <STRONG>NOT</STRONG> a document resource file.</P>
<H3><A NAME="def append(self, *items)">def append(self, *items)</A></H3>
<P>Add content to the Document object.</P>
<P>Arg <EM>items</EM> can be plain text or objects; multiple arguments supported.
</P>
<H3><A NAME="def append_file(self, filename, marker_function = None)">def append_file(self, filename, marker_function = None)</A></H3>
<P>Add the contents of a file to the document.</P>
<DL>
<DT><B>filename</B><DD>the filename of the file to be read [string]
<DT><B>marker_function</B><DD>a callable object which the text read from
the file will be passed through before being added to the
document.
</DL>
<H3><A NAME="def copy(self)">def copy(self)</A></H3>
<P>Return a complete copy of the current Document object.
</P>
<H3><A NAME="def html_body_tag(self)">def html_body_tag(self)</A></H3>
<P>Return BODY tag with attributes.
</P>
<H3><A NAME="def html_head(self)">def html_head(self)</A></H3>
<P>Generate the HEAD, TITLE and BODY tags.
</P>
<H3><A NAME="def prepend(self, *items)">def prepend(self, *items)</A></H3>
<P>Add content to the beginning of the Document object.</P>
<P>Arg <EM>items</EM> can be plain text or objects; multiple arguments supported.
</P>
<H3><A NAME="def write(self, filename = None)">def write(self, filename = None)</A></H3>
<P>Emit the Document HTML to a file or standard output.</P>
<P>In Unix you can use environment variables in filenames.
Will print to stdout if no argument.
</P>
<H2>Keyword Parameters</H2>
<DL>
<DT><B> title</B><DD>string to be used as the document title.
<DT><B> base </B><DD>object of the Base class
<DT><B> meta </B><DD>object of the Meta class
<DT><B> cgi </B><DD>if non zero will issue a mime type of text/html
<DT><B> script</B><DD>a single or list of Script objects to be included in the <HEAD>
</DL>
<P>No <body> markup. Instead add Frameset(s) with the constructor or
append method.
</P>
<H2>SEE ALSO</H2>
<P><A HREF="HTMLgen_overview.html">HTMLgen</A></P>
<P><A HREF="HTMLgen-BasicDocument.html">BasicDocument</A></P>
<P><HR>
<A HREF="HTMLgen-Frameset.html"><IMG src="../image/back.gif" height="22" width="66" alt="Previous" border="0"></A>
<A HREF="HTMLgen-HR.html"><IMG src="../image/next.gif" height="22" width="66" alt="Next" border="0"></A>
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif">
<IMG src="../image/blank.gif" height="22" width="66" alt="blank.gif">
<BR><IMG src="../image/Buzz.gif" height="51" width="56" alt="Buzz.gif" align="bottom">
<FONT SIZE="-1"><P>Copyright © Robin Friedrich<BR>All Rights Reserved<BR>
Comments to author: <A HREF="mailto:friedrich@pythonpros.com">friedrich@pythonpros.com</A><br>
Generated: Tue Apr 20, 1999 <BR><hr>
</FONT>
</BODY> </HTML>
|