/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/_tag_utils_frame_utils_inc.html
ViewVC logotype

Diff of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/_tag_utils_frame_utils_inc.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1.1.1 by jonen, Thu Jan 30 03:29:31 2003 UTC revision 1.3 by jonen, Sat Sep 20 00:24:12 2003 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>  <?xml version="1.0" encoding="iso-8859-1"?>
2  <!--NewPage-->  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3  <HTML>    <html xmlns="http://www.w3.org/1999/xhtml">
4  <HEAD>                  <head>
5          <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:31 -0800' -->                          <!-- template designed by Marco Von Ballmoos -->
6          <TITLE>Docs for page frame_utils.inc</TITLE>                          <title>Docs for page frame_utils.inc</title>
7  <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>                          <link rel="stylesheet" href="../media/stylesheet.css" />
8  </HEAD>                          <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9  <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">                  </head>
10                        <body>
11                            <div class="page-body">                
12  <!-- Links -->  <h2 class="file-name">Program_Root/tag_utils/frame_utils.inc</h2>
13  <a NAME="top"></A>  
14  <table WIDTH="100%" class="links">  <a name="sec-description"></a>
15   <TR>  <div class="info-box">
16     <TD class="font10">          <div class="info-box-title">Description</div>
17        Links:          <div class="nav-bar">
18        <A HREF="#classes_summary" class="links" title="Classes created in this file">Classes</A>                                          <span class="disabled">Description</span> |
19        <A HREF="#includes_summary" class="links" title="Include Statements Summary">Includes</A>                                                                                                                          <a href="#sec-functions">Functions</a>
20        <A HREF="#globals_summary" class="links" title="Global Variable Summary">Globals</A>                          </div>
21        <A HREF="#constant_summary" class="links" title="Constant Summary">Constants</A>          <div class="info-box-body">    
22        <A HREF="#functions_summary" class="links" title="Function Summary">Functions</A>                  <!-- ========== Info from phpDoc block ========= -->
23        <A HREF="#includes_detail" class="links" title="Include Statements Detail">Includes Detail</A>  <p class="short-description">This file contains helper functions related  to framesets and frames</p>
24        <A HREF="#global_detail" class="links" title="Global Variable Detail">Globals Detail</A>  <p class="description"><p>$Id$</p></p>
25        <A HREF="#constant_detail" class="links" title="Constant Detail">Constants Detail</A>          <ul class="tags">
26        <A HREF="#function_detail" class="links" title="Function Detail">Functions Detail</A>                                  <li><span class="field">author:</span> <p>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</p></li>
27     </TD>                          </ul>
28   </TR>                  
29  </TABLE>                          </div>
30  <BR>  </div>
31                    
 <h2>File: Program_Root/tag_utils/frame_utils.inc</h2>  
 <!-- ========== Info from phpDoc block ========= -->  
 This file contains helper functions related  
 to framesets and frames  
 <BR>  
 $Id$  
32    
 <UL>  
33                    
         <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>  
34                    
         <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>  
35                    
36  </UL>          <a name="sec-functions"></a>    
37            <div class="info-box">
38  <br>                  <div class="info-box-title">Functions</div>
39  <!-- =========== Used Classes =========== -->                  <div class="nav-bar">
40  <A NAME='classes_summary'><!-- --></A>                          <a href="#sec-description">Description</a> |
41  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom">                                                                                                                          <span class="disabled">Functions</span>
42          <TR CLASS='TableHeadingColor'>                  </div>
43                  <TD>                  <div class="info-box-body">    
44                          <span class="font12bold">Classes defined in this file</span>                          <a name="functionhtml_frame" id="functionhtml_frame"><!-- --></a>
45              <A HREF="#top" CLASS="links">^TOP</A>  <div class="evenrow">
46                  </TD>          
47          </TR>          <div>
48  </TABLE>                  <span class="method-title">html_frame</span> (line <span class="line-number">62</span>)
49  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">          </div>
50          <THEAD>  
51                  <TR><TD STYLE="width:20%"><h4>CLASS NAME</h4></TD><TD STYLE="width: 80%"><h4>DESCRIPTION</h4></TD></TR>          <!-- ========== Info from phpDoc block ========= -->
52          </THEAD>  <p class="short-description">This function is used to build a  FRAMEtag object with some common attributes  already set.</p>
53          <TBODY>  <p class="description"><p>NOT: this comes with the following attribtes       defaulted to:       marginwidth = &quot;0&quot;       marginheight = &quot;0&quot;       noresize       frameborder = &quot;0&quot;</p></p>
54                            <ul class="tags">
55          </TBODY>                                  <li><span class="field">return:</span> <p>object.</p></li>
56  </TABLE>                          </ul>
57  <br>          
58  <br>          <div class="method-signature">
59  <!-- =========== Includes SUMMARY =========== -->                  <span class="method-result"><a href="../phpHtmlLib/FRAMEtag.html">FRAMEtag</a></span>
60  <A NAME='includes_summary'><!-- --></A>                  <span class="method-name">
61  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom">                          html_frame
62          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>                  </span>
63                  <TD>                                          (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$src</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$scrolling</span> = <span class="var-default">"no"</span>])
64                          <span CLASS="font12bold">Include Statements Summary</span>                          </div>
65              <A HREF="#top" CLASS="links">^TOP</A>  
66                  </TD>                          <ul class="parameters">
67          </TR>                                          <li>
68  </TABLE>                                  <span class="var-type">string</span>
69  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">                                  <span class="var-name">$name</span><span class="var-description">: <p>- $name - the &quot;name&quot; attribute</p></span>                       </li>
70          <THEAD>                                          <li>
71                  <TR><TH>INCLUDE TYPE</TH><TH>INCLUDED FILENAME</TH><TH>DESCRIPTION</TH></TR>                                  <span class="var-type">string</span>
72          </THEAD>                                  <span class="var-name">$src</span><span class="var-description">: <p>- $src  - the &quot;src&quot; atribute</p></span>                  </li>
73          <TBODY>                                          <li>
74                                                    <span class="var-type">string</span>
75          </TBODY>                                  <span class="var-name">$scrolling</span><span class="var-description">: <p>- $scrolling - the &quot;scrolling&quot; attribute</p></span>                        </li>
76  </TABLE>                                  </ul>
 <br>  
   
 <br>  
 <!-- =========== CONSTANT SUMMARY =========== -->  
 <A NAME='global_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <FONT SIZE='+2'><B>Global Variable Summary</B></FONT>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <THEAD>  
                 <TR><TH>VARIABLE NAME</TH><TH>VARIABLE VALUE</TH><TH>DESCRIPTION</TH></TR>  
         </THEAD>  
         <TBODY>  
                   
         </TBODY>  
 </TABLE>  
 <br>  
   
   
 <br>  
 <!-- =========== CONSTANT SUMMARY =========== -->  
 <A NAME='constant_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom">  
         <TR CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Constant Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <THEAD>  
                 <TR><TH>CONSTANT NAME</TH><TH>CONSTANT VALUE</TH><TH>DESCRIPTION</TH></TR>  
         </THEAD>  
         <TBODY>  
77                                    
         </TBODY>  
 </TABLE>  
 <br>  
   
 <br>  
 <!-- =========== Function SUMMARY =========== -->  
 <A NAME='Function_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Function Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
78                    
79          <!-- =========== Summary =========== -->  </div>
80          <TR BGCOLOR='white' CLASS='TableRowColor'>  <a name="functionhtml_frameset" id="functionhtml_frameset"><!-- --></a>
81                  <TD>  <div class="oddrow">
82                          <CODE><B><A HREF='_tag_utils_frame_utils_inc.html#html_frame'>FRAMEtag html_frame ( $name, $src, [$scrolling = "no"] )</A></B></CODE>          
83                          <BR>          <div>
84                          <blockquote> This function is used to build a                  <span class="method-title">html_frameset</span> (line <span class="line-number">29</span>)
85  FRAMEtag object with some common attributes          </div>
86  already set. </blockquote>  
87                  </TD>          <!-- ========== Info from phpDoc block ========= -->
88          </TR>  <p class="short-description">This function is used to build a  FRAMESETtag object with the most  common attributes.</p>
89            <p class="description"><p>NOTE: It comes with the following attributes        defaulted to:        framespacing = &quot;0&quot;        frameborder = &quot;no&quot;</p></p>
90          <!-- =========== Summary =========== -->          <ul class="tags">
91          <TR BGCOLOR='white' CLASS='TableRowColor'>                                  <li><span class="field">return:</span> <p>object</p></li>
92                  <TD>                          </ul>
93                          <CODE><B><A HREF='_tag_utils_frame_utils_inc.html#html_frameset'>FRAMESETtag html_frameset ( [$rows = NULL], [$cols = NULL], [$border = "0"] )</A></B></CODE>          
94                          <BR>          <div class="method-signature">
95                          <blockquote> This function is used to build a                  <span class="method-result"><a href="../phpHtmlLib/FRAMESETtag.html">FRAMESETtag</a></span>
96  FRAMESETtag object with the most                  <span class="method-name">
97  common attributes. </blockquote>                          html_frameset
98                  </TD>                  </span>
99          </TR>                                          ([<span class="var-type">string</span>&nbsp;<span class="var-name">$rows</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$cols</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$border</span> = <span class="var-default">"0"</span>])
100                            </div>
101    
102                            <ul class="parameters">
103                                            <li>
104                                    <span class="var-type">string</span>
105                                    <span class="var-name">$rows</span><span class="var-description">: <p>- $rows - the rows attribute</p></span>                   </li>
106                                            <li>
107                                    <span class="var-type">string</span>
108                                    <span class="var-name">$cols</span><span class="var-description">: <p>- $cols - the cols attribute</p></span>                   </li>
109                                            <li>
110                                    <span class="var-type">int</span>
111                                    <span class="var-name">$border</span><span class="var-description">: <p>- $border - the border attribute</p></span>                     </li>
112                                    </ul>
113                    
114                    
115  </TABLE>  </div>
116                    </div>
117  <br>          </div>
118  <!-- ============ Includes DETAIL =========== -->          
119            <p class="notes" id="credit">
120  <A NAME='includes_detail'></A>                  Documention generated on Thu, 31 Jul 2003 18:32:48 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
121  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">          </p>
122          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>          </div></body>
123                  <TD>  </html>
                         <span CLASS="font12bold">Include Statements Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
   
   
   
 <br>  
 <!-- ============ GLOBALS DETAIL =========== -->  
   
 <A NAME='global_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Global Variable Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
   
   
   
 <br>  
 <!-- ============ CONSTANT DETAIL =========== -->  
   
 <A NAME='constant_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Constant Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
   
   
   
 <br>  
 <!-- ============ FUNCTION DETAIL =========== -->  
   
 <A NAME='function_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Function Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='html_frame'><!-- --></A>  
 <SPAN CLASS="font12bold">html_frame</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/FRAMEtag.html">FRAMEtag</a></SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">html_frame ( $name, $src, [$scrolling = "no"] )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 This function is used to build a  
 FRAMEtag object with some common attributes  
 already set.  
 <BR>  
 NOT: this comes with the following attribtes  
      defaulted to:  
      marginwidth = &quot;0&quot;  
      marginheight = &quot;0&quot;  
      noresize  
      frameborder = &quot;0&quot;  
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$name</SPAN></SPAN> -  - the &quot;name&quot; attribute</DD>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$src</SPAN></SPAN> -   - the &quot;src&quot; atribute</DD>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$scrolling</SPAN></SPAN> -  - the &quot;scrolling&quot; attribute</DD>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='html_frameset'><!-- --></A>  
 <SPAN CLASS="font12bold">html_frameset</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/FRAMESETtag.html">FRAMESETtag</a></SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">html_frameset ( [$rows = NULL], [$cols = NULL], [$border = "0"] )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 This function is used to build a  
 FRAMESETtag object with the most  
 common attributes.  
 <BR>  
 NOTE: It comes with the following attributes  
       defaulted to:  
       framespacing = &quot;0&quot;  
       frameborder = &quot;no&quot;  
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$rows</SPAN></SPAN> -  - the rows attribute</DD>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$cols</SPAN></SPAN> -  - the cols attribute</DD>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$border</SPAN></SPAN> -  - the border attribute</DD>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
   
 <br>  
 </HTML>  
Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.3
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed