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">/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> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
27 |
</TD> |
</ul> |
28 |
</TR> |
|
29 |
</TABLE> |
</div> |
30 |
<BR> |
</div> |
31 |
|
|
32 |
<h2>File: Program_Root/tag_utils/frame_utils.inc</h2> |
|
33 |
<!-- ========== Info from phpDoc block ========= --> |
|
34 |
This file contains helper functions related |
|
35 |
to framesets and frames |
|
36 |
<BR> |
<a name="sec-functions"></a> |
37 |
$Id$ |
<div class="info-box"> |
38 |
|
<div class="info-box-title">Functions</div> |
39 |
<UL> |
<div class="nav-bar"> |
40 |
|
<a href="#sec-description">Description</a> | |
41 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
<span class="disabled">Functions</span> |
42 |
|
</div> |
43 |
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
<div class="info-box-body"> |
44 |
|
<a name="functionhtml_frame" id="functionhtml_frame"><!-- --></a> |
45 |
</UL> |
<div class="oddrow"> |
46 |
|
|
47 |
<br> |
<div> |
48 |
<!-- =========== Used Classes =========== --> |
<span class="method-title">html_frame</span> (line <span class="line-number">55</span>) |
49 |
<A NAME='classes_summary'><!-- --></A> |
</div> |
50 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
|
51 |
<TR CLASS='TableHeadingColor'> |
<!-- ========== Info from phpDoc block ========= --> |
52 |
<TD> |
<p class="short-description">This function is used to build a FRAMEtag object with some common attributes already set.</p> |
53 |
<span class="font12bold">Classes defined in this file</span> |
<p class="description"><p>NOT: this comes with the following attribtes defaulted to: marginwidth = "0" marginheight = "0" noresize frameborder = "0"</p></p> |
54 |
<A HREF="#top" CLASS="links">^TOP</A> |
<ul class="tags"> |
55 |
</TD> |
<li><span class="field">return:</span> object.</li> |
56 |
</TR> |
</ul> |
57 |
</TABLE> |
|
58 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<div class="method-signature"> |
59 |
<THEAD> |
<span class="method-result"><a href="../phpHtmlLib/FRAMEtag.html">FRAMEtag</a></span> |
60 |
<TR><TD STYLE="width:20%"><h4>CLASS NAME</h4></TD><TD STYLE="width: 80%"><h4>DESCRIPTION</h4></TD></TR> |
<span class="method-name"> |
61 |
</THEAD> |
html_frame |
62 |
<TBODY> |
</span> |
63 |
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$src</span>, [<span class="var-type">string</span> <span class="var-name">$scrolling</span> = <span class="var-default">"no"</span>]) |
64 |
</TBODY> |
</div> |
65 |
</TABLE> |
|
66 |
<br> |
<ul class="parameters"> |
67 |
<br> |
<li> |
68 |
<!-- =========== Includes SUMMARY =========== --> |
<span class="var-type">string</span> |
69 |
<A NAME='includes_summary'><!-- --></A> |
<span class="var-name">$name</span><span class="var-description">: - $name - the "name" attribute</span> </li> |
70 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
<li> |
71 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<span class="var-type">string</span> |
72 |
<TD> |
<span class="var-name">$src</span><span class="var-description">: - $src - the "src" atribute</span> </li> |
73 |
<span CLASS="font12bold">Include Statements Summary</span> |
<li> |
74 |
<A HREF="#top" CLASS="links">^TOP</A> |
<span class="var-type">string</span> |
75 |
</TD> |
<span class="var-name">$scrolling</span><span class="var-description">: - $scrolling - the "scrolling" attribute</span> </li> |
76 |
</TR> |
</ul> |
77 |
</TABLE> |
|
78 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
79 |
<THEAD> |
</div> |
80 |
<TR><TH>INCLUDE TYPE</TH><TH>INCLUDED FILENAME</TH><TH>DESCRIPTION</TH></TR> |
<a name="functionhtml_frameset" id="functionhtml_frameset"><!-- --></a> |
81 |
</THEAD> |
<div class="evenrow"> |
82 |
<TBODY> |
|
83 |
|
<div> |
84 |
</TBODY> |
<span class="method-title">html_frameset</span> (line <span class="line-number">28</span>) |
85 |
</TABLE> |
</div> |
86 |
<br> |
|
87 |
|
<!-- ========== Info from phpDoc block ========= --> |
88 |
<br> |
<p class="short-description">This function is used to build a FRAMESETtag object with the most common attributes.</p> |
89 |
<!-- =========== CONSTANT SUMMARY =========== --> |
<p class="description"><p>NOTE: It comes with the following attributes defaulted to: framespacing = "0" frameborder = "no"</p></p> |
90 |
<A NAME='global_summary'><!-- --></A> |
<ul class="tags"> |
91 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
<li><span class="field">return:</span> object</li> |
92 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
</ul> |
93 |
<TD> |
|
94 |
<FONT SIZE='+2'><B>Global Variable Summary</B></FONT> |
<div class="method-signature"> |
95 |
<A HREF="#top" CLASS="links">^TOP</A> |
<span class="method-result"><a href="../phpHtmlLib/FRAMESETtag.html">FRAMESETtag</a></span> |
96 |
</TD> |
<span class="method-name"> |
97 |
</TR> |
html_frameset |
98 |
</TABLE> |
</span> |
99 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
(<span class="var-type">string</span> <span class="var-name">$rows</span>, <span class="var-type">string</span> <span class="var-name">$cols</span>, [<span class="var-type">int</span> <span class="var-name">$border</span> = <span class="var-default">"0"</span>]) |
100 |
<THEAD> |
</div> |
101 |
<TR><TH>VARIABLE NAME</TH><TH>VARIABLE VALUE</TH><TH>DESCRIPTION</TH></TR> |
|
102 |
</THEAD> |
<ul class="parameters"> |
103 |
<TBODY> |
<li> |
104 |
|
<span class="var-type">string</span> |
105 |
</TBODY> |
<span class="var-name">$rows</span><span class="var-description">: - $rows - the rows attribute</span> </li> |
106 |
</TABLE> |
<li> |
107 |
<br> |
<span class="var-type">string</span> |
108 |
|
<span class="var-name">$cols</span><span class="var-description">: - $cols - the cols attribute</span> </li> |
109 |
|
<li> |
110 |
<br> |
<span class="var-type">int</span> |
111 |
<!-- =========== CONSTANT SUMMARY =========== --> |
<span class="var-name">$border</span><span class="var-description">: - $border - the border attribute</span> </li> |
112 |
<A NAME='constant_summary'><!-- --></A> |
</ul> |
113 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
|
114 |
<TR CLASS='TableHeadingColor'> |
|
115 |
<TD> |
</div> |
116 |
<span CLASS="font12bold">Constant Summary</span> |
</div> |
117 |
<A HREF="#top" CLASS="links">^TOP</A> |
</div> |
118 |
</TD> |
|
119 |
</TR> |
<p class="notes" id="credit"> |
120 |
</TABLE> |
Documentation generated on Thu, 1 Apr 2004 09:38:56 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
121 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
</p> |
122 |
<THEAD> |
</div></body> |
123 |
<TR><TH>CONSTANT NAME</TH><TH>CONSTANT VALUE</TH><TH>DESCRIPTION</TH></TR> |
</html> |
|
</THEAD> |
|
|
<TBODY> |
|
|
|
|
|
</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> |
|
|
|
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='_tag_utils_frame_utils_inc.html#html_frame'>FRAMEtag html_frame ( $name, $src, [$scrolling = "no"] )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function is used to build a |
|
|
FRAMEtag object with some common attributes |
|
|
already set. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='_tag_utils_frame_utils_inc.html#html_frameset'>FRAMESETtag html_frameset ( [$rows = NULL], [$cols = NULL], [$border = "0"] )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function is used to build a |
|
|
FRAMESETtag object with the most |
|
|
common attributes. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
</TABLE> |
|
|
|
|
|
<br> |
|
|
<!-- ============ Includes DETAIL =========== --> |
|
|
|
|
|
<A NAME='includes_detail'></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<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> |
|
|
<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 = "0" |
|
|
marginheight = "0" |
|
|
noresize |
|
|
frameborder = "0" |
|
|
<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 "name" 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 "src" 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 "scrolling" 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> |
|
|
<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 = "0" |
|
|
frameborder = "no" |
|
|
<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> |
|