1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.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: 'Thu, 20 Feb 2003 16:23:49 -0800' --> |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<TITLE>Docs For Class TextCSSNav</TITLE> |
<title>Docs For Class TextCSSNav</title> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='../media/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 |
<!-- Links --> |
<body> |
11 |
<a NAME="top"></A> |
<div class="page-body"> |
12 |
<table WIDTH="100%" class="links"> |
<h2 class="class-name">Class TextCSSNav</h2> |
13 |
<TR> |
|
14 |
<TD class="font10"> |
<a name="sec-description"></a> |
15 |
Links: |
<div class="info-box"> |
16 |
<A HREF="#children_summary" class="links" title="Classes extended from TextCSSNav">Child Classes</A> |
<div class="info-box-title">Description</div> |
17 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
<div class="nav-bar"> |
18 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
<span class="disabled">Description</span> | |
19 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
20 |
<A HREF="#method_summary" class="links" title="Method Summary">Methods</A> |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
21 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
|
22 |
<A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A> |
</div> |
23 |
</TD> |
<div class="info-box-body"> |
24 |
</TR> |
<!-- ========== Info from phpDoc block ========= --> |
25 |
</TABLE> |
<p class="short-description">This class builds a simple text navigational widget.</p> |
26 |
<BR> |
<ul class="tags"> |
27 |
<!-- Start of Class Data --> |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
28 |
<H2> |
</ul> |
29 |
Class TextCSSNav |
<p class="notes"> |
30 |
</H2> (line <span class="linenumber">24</span>) |
Located in <a class="field" href="_widgets_TextCSSNav_inc.html">Program_Root/widgets/TextCSSNav.inc</a> (line <span class="field">24</span>) |
31 |
<pre> |
</p> |
32 |
<a href="../phpHtmlLib/Container.html">Container</a> |
|
33 |
|
|
34 |
|
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
35 |
| |
| |
36 |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
37 |
| |
| |
38 |
--TextCSSNav</pre> |
--TextCSSNav</pre> |
39 |
<p> |
|
40 |
<b><i>Located in File: Program_Root/widgets/TextCSSNav.inc</i></b><br> |
</div> |
41 |
</p> |
</div> |
42 |
<hr> |
|
43 |
This class builds a simple text navigational widget. |
|
44 |
<br /> |
<a name="sec-var-summary"></a> |
45 |
|
<div class="info-box"> |
46 |
<UL> |
<div class="info-box-title">Variable Summary</span></div> |
47 |
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></CODE></LI> |
<div class="nav-bar"> |
48 |
</UL> |
<a href="#sec-description">Description</a> | |
49 |
<hr> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
50 |
<!-- =========== VAR SUMMARY =========== --> |
| |
51 |
<A NAME='var_summary'><!-- --></A> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
52 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
53 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
</div> |
54 |
<TD> |
<div class="info-box-body"> |
55 |
<span CLASS="font12bold">Class Variable Summary</span> |
<div class="var-summary"> |
56 |
<A HREF="#top" CLASS="links">^TOP</A> |
<div class="var-title"> |
57 |
</TD> |
<span class="var-type">mixed</span> |
58 |
</TR> |
<a href="#$_highlight_selected" title="details" class="var-name">$_highlight_selected</a> |
59 |
|
</div> |
60 |
<!-- =========== Summary =========== --> |
<div class="var-title"> |
61 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-type">mixed</span> |
62 |
<TD> |
<a href="#$_query_prefix" title="details" class="var-name">$_query_prefix</a> |
63 |
<CODE><B><A HREF="../phpHtmlLib/TextCSSNav.html#var$_highlight_selected">$_highlight_selected</A></B></CODE> |
</div> |
64 |
<BR> |
<div class="var-title"> |
65 |
<blockquote> Flag to tell us that we can highlight (css) the selected link. </blockquote> |
<span class="var-type">mixed</span> |
66 |
<blockquote> Default Value: <CODE>-> FALSE<-</CODE> </blockquote> |
<a href="#$_selected" title="details" class="var-name">$_selected</a> |
67 |
</TD> |
</div> |
68 |
</TR> |
</div> |
69 |
<!-- =========== Summary =========== --> |
</div> |
70 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
71 |
<TD> |
|
72 |
<CODE><B><A HREF="../phpHtmlLib/TextCSSNav.html#var$_query_prefix">$_query_prefix</A></B></CODE> |
<a name="sec-method-summary"></a> |
73 |
<BR> |
<div class="info-box"> |
74 |
<blockquote> the prefix for the query string var </blockquote> |
<div class="info-box-title">Method Summary</span></div> |
75 |
<blockquote> Default Value: <CODE>-> ""<-</CODE> </blockquote> |
<div class="nav-bar"> |
76 |
</TD> |
<a href="#sec-description">Description</a> | |
77 |
</TR> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
78 |
<!-- =========== Summary =========== --> |
|
79 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| |
80 |
<TD> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
81 |
<CODE><B><A HREF="../phpHtmlLib/TextCSSNav.html#var$_selected">$_selected</A></B></CODE> |
</div> |
82 |
<BR> |
<div class="info-box-body"> |
83 |
<blockquote> Holds which one is auto selected </blockquote> |
<div class="method-summary"> |
84 |
<blockquote> Default Value: <CODE>-> 0<-</CODE> </blockquote> |
|
85 |
</TD> |
<div class="method-definition"> |
86 |
</TR> |
<span class="method-result">void</span> |
87 |
</TABLE> |
<a href="#TextCSSNav" title="details" class="method-name">TextCSSNav</a> |
88 |
<hr> |
([<span class="var-type">mixed</span> <span class="var-name">$highlight_selected</span> = <span class="var-default">FALSE</span>], <span class="var-type">int</span> <span class="var-name">$width</span>) |
89 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
</div> |
90 |
<A NAME='var_inherited_summary'><!-- --></A> |
|
91 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<div class="method-definition"> |
92 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<span class="method-result">void</span> |
93 |
<TD> |
<a href="#add" title="details" class="method-name">add</a> |
94 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">string</span> <span class="var-name">$text</span>, [<span class="var-type">string</span> <span class="var-name">$title</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$target</span> = <span class="var-default">""</span>], [<span class="var-type">mixed</span> <span class="var-name">$selected</span> = <span class="var-default">FALSE</span>]) |
95 |
<A HREF="#top" CLASS="links">^TOP</A> |
</div> |
96 |
</TD> |
|
97 |
</TR> |
<div class="method-definition"> |
98 |
|
<span class="method-result">void</span> |
99 |
<!-- =========== Summary =========== --> |
<a href="#add_blank" title="details" class="method-name">add_blank</a> |
100 |
<TR BGCOLOR='white'> |
([<span class="var-type">int</span> <span class="var-name">$num</span> = <span class="var-default">1</span>]) |
101 |
<TD> |
</div> |
102 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
|
103 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
<div class="method-definition"> |
104 |
<tr CLASS="tableheadingcolor"> |
<span class="method-result">void</span> |
105 |
<th>Variable</th> |
<a href="#add_text" title="details" class="method-name">add_text</a> |
106 |
<th>Default Value</th> |
(<span class="var-type">string</span> <span class="var-name">$text</span>) |
107 |
<th>Description</th> |
</div> |
108 |
</tr> |
|
109 |
<tr> |
<div class="method-definition"> |
110 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></td> |
<span class="method-result">void</span> |
111 |
<td CLASS="font10" STYLE="white-space: nowrap">->''<-</td> |
<a href="#push" title="details" class="method-name">push</a> |
112 |
<td CLASS="font10">The title of the table.</td> |
(<span class="var-type">mixed</span> <span class="var-name">$url</span>, <span class="var-type">mixed</span> <span class="var-name">$text</span>, [<span class="var-type">mixed</span> <span class="var-name">$title</span> = <span class="var-default">""</span>], [<span class="var-type">mixed</span> <span class="var-name">$target</span> = <span class="var-default">""</span>]) |
113 |
</tr> |
</div> |
114 |
<tr> |
|
115 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></td> |
<div class="method-definition"> |
116 |
<td CLASS="font10" STYLE="white-space: nowrap">->"100%"<-</td> |
<span class="method-result">void</span> |
117 |
<td CLASS="font10">the width of the widget</td> |
<a href="#push_blank" title="details" class="method-name">push_blank</a> |
118 |
</tr> |
([<span class="var-type">mixed</span> <span class="var-name">$num</span> = <span class="var-default">1</span>]) |
119 |
</table> |
</div> |
120 |
<BR> |
|
121 |
</TD> |
<div class="method-definition"> |
122 |
</TR> |
<span class="method-result">void</span> |
123 |
<!-- =========== Summary =========== --> |
<a href="#push_text" title="details" class="method-name">push_text</a> |
124 |
<TR BGCOLOR='white'> |
(<span class="var-type">mixed</span> <span class="var-name">$text</span>) |
125 |
<TD> |
</div> |
126 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
|
127 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
<div class="method-definition"> |
128 |
<tr CLASS="tableheadingcolor"> |
<span class="method-result">string</span> |
129 |
<th>Variable</th> |
<a href="#render" title="details" class="method-name">render</a> |
130 |
<th>Default Value</th> |
([<span class="var-type">int</span> <span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span> <span class="var-name">$output_debug</span>) |
131 |
<th>Description</th> |
</div> |
132 |
</tr> |
|
133 |
<tr> |
<div class="method-definition"> |
134 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td> |
<span class="method-result">void</span> |
135 |
<td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td> |
<a href="#set_prefix" title="details" class="method-name">set_prefix</a> |
136 |
<td CLASS="font10">The flags that tell us</td> |
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
137 |
</tr> |
</div> |
138 |
</table> |
|
139 |
<BR> |
<div class="method-definition"> |
140 |
</TD> |
<span class="method-result">Container</span> |
141 |
</TR> |
<a href="#_build_links" title="details" class="method-name">_build_links</a> |
142 |
</TABLE> |
() |
143 |
|
</div> |
144 |
<hr> |
</div> |
145 |
<!-- =========== METHOD SUMMARY =========== --> |
</div> |
146 |
<A NAME='method_summary'><!-- --></A> |
</div> |
147 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
|
148 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<a name="sec-vars"></a> |
149 |
<TD> |
<div class="info-box"> |
150 |
<span class="font12bold">Method Summary</span> |
<div class="info-box-title">Variables</div> |
151 |
<A HREF="#top" CLASS="links">^TOP</A> |
<div class="nav-bar"> |
152 |
</TD> |
<a href="#sec-description">Description</a> | |
153 |
</TR> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
154 |
|
|
155 |
<!-- =========== Summary =========== --> |
|
156 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| |
157 |
<TD> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
158 |
<CODE><B><A HREF='../phpHtmlLib/TextCSSNav.html#methodTextCSSNav'>void constructor TextCSSNav ( [$highlight_selected = FALSE] )</A></B></CODE> |
|
159 |
<BR> |
</div> |
160 |
<blockquote> Constructor for this class It just sets the width for the widget. </blockquote> |
<div class="info-box-body"> |
161 |
</TD> |
<a name="var$_highlight_selected" id="$_highlight_selected"><!-- --></A> |
162 |
</TR> |
<div class="oddrow"> |
163 |
<!-- =========== Summary =========== --> |
|
164 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<div class="var-header"> |
165 |
<TD> |
<span class="var-title"> |
166 |
<CODE><B><A HREF='../phpHtmlLib/TextCSSNav.html#methodadd'>void add ( $url, $text, [$title = ""], [$target = ""], [$selected = FALSE] )</A></B></CODE> |
<span class="var-type">mixed</span> |
167 |
<BR> |
<span class="var-name">$_highlight_selected</span> |
168 |
<blockquote> this function adds a clickable link. </blockquote> |
= <span class="var-default"> FALSE</span> (line <span class="line-number">33</span>) |
169 |
</TD> |
</span> |
170 |
</TR> |
</div> |
171 |
<!-- =========== Summary =========== --> |
|
172 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<!-- ========== Info from phpDoc block ========= --> |
173 |
<TD> |
<p class="short-description">Flag to tell us that we can highlight (css) the selected link.</p> |
174 |
<CODE><B><A HREF='../phpHtmlLib/TextCSSNav.html#methodadd_blank'>void add_blank ( [$num = 1] )</A></B></CODE> |
<p class="description"><p>This is off by default</p></p> |
175 |
<BR> |
|
176 |
<blockquote> This lets you add a blank entry between 2 links </blockquote> |
|
177 |
</TD> |
|
178 |
</TR> |
|
179 |
<!-- =========== Summary =========== --> |
|
180 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
181 |
<TD> |
<a name="var$_query_prefix" id="$_query_prefix"><!-- --></A> |
182 |
<CODE><B><A HREF='../phpHtmlLib/TextCSSNav.html#methodadd_text'>void add_text ( $text )</A></B></CODE> |
<div class="evenrow"> |
183 |
<BR> |
|
184 |
<blockquote> this adds a text item in the nav </blockquote> |
<div class="var-header"> |
185 |
</TD> |
<span class="var-title"> |
186 |
</TR> |
<span class="var-type">mixed</span> |
187 |
<!-- =========== Summary =========== --> |
<span class="var-name">$_query_prefix</span> |
188 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
= <span class="var-default"> ""</span> (line <span class="line-number">47</span>) |
189 |
<TD> |
</span> |
|
<CODE><B><A HREF='../phpHtmlLib/TextCSSNav.html#methodpush'>void push ( $url, $text, [$title = ""], [$target = ""] )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> depricated version of add() </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/TextCSSNav.html#methodpush_blank'>void push_blank ( [$num = 1] )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> depricated version of add_blank() </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/TextCSSNav.html#methodpush_text'>void push_text ( $text )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> depricated version of add_text() </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/TextCSSNav.html#methodrender'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> function that will render the widget. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/TextCSSNav.html#methodset_prefix'>void set_prefix ( $prefix )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This method is used to set the prefix for </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../phpHtmlLib/TextCSSNav.html#method_build_links'>Container _build_links ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function is used to build the links to click on </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
|
|
<A NAME='functions_inherited'><!-- --></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span CLASS="font12bold">Inherited Method Summary</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Function</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></td> |
|
|
<td CLASS="font10">This gets the alignment value for the outer table</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></td> |
|
|
<td CLASS="font10">This function provides the mechanism to build and return the css needed by this widget</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></td> |
|
|
<td CLASS="font10">Function for returning the raw javascript that is required for this widget.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></td> |
|
|
<td CLASS="font10">Function for accessing the title of this widget</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></td> |
|
|
<td CLASS="font10">Function for getting the current widget width setting.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></td> |
|
|
<td CLASS="font10">This function sets the align attribute for the outer table.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></td> |
|
|
<td CLASS="font10">Set the title for the widget.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></td> |
|
|
<td CLASS="font10">Set the width for the widget.</td> |
|
|
</table> |
|
|
<br> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Function</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td> |
|
|
<td CLASS="font10">The constructor.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td> |
|
|
<td CLASS="font10">add content onto content stack</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td> |
|
|
<td CLASS="font10">Add content onto content stack so you can change the item later.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td> |
|
|
<td CLASS="font10">counts the number of content objects</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td> |
|
|
<td CLASS="font10">This flag gets the current value of the indent flag</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td> |
|
|
<td CLASS="font10">Same as add().</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td> |
|
|
<td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td> |
|
|
<td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td> |
|
|
<td CLASS="font10">destroy existing content and start with new content.</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td> |
|
|
<td CLASS="font10">This function turns on the collapse flag</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td> |
|
|
<td CLASS="font10">function to set the indent flag</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td> |
|
|
<td CLASS="font10">This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.</td> |
|
|
</table> |
|
|
<br> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
<hr> |
|
|
<!-- ============ VARIABLE DETAIL =========== --> |
|
|
|
|
|
<A NAME='variable_detail'></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span CLASS="font12bold">Variable Detail</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
|
|
|
<A NAME='var$_highlight_selected'><!-- --></A><H3>$_highlight_selected</H3> (line <span class="linenumber">33</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>Flag to tell us that we can highlight (css) the selected link. |
|
|
<br /> |
|
|
<p>This is off by default</p> |
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<A NAME='var$_query_prefix'><!-- --></A><H3>$_query_prefix</H3> (line <span class="linenumber">47</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>the prefix for the query string var |
|
|
<br /> |
|
|
<p>so we can have multiple widgets on the same page and have them operate independantly</p> |
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<A NAME='var$_selected'><!-- --></A><H3>$_selected</H3> (line <span class="linenumber">39</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>Holds which one is auto selected |
|
|
<br /> |
|
|
|
|
|
<UL> |
|
|
</UL> |
|
|
<HR> |
|
|
<hr> |
|
|
<!-- ============ METHOD DETAIL =========== --> |
|
|
|
|
|
<A NAME='method_detail'></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span class="font12bold">Method Detail</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodTextCSSNav'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">Constructor TextCSSNav</SPAN> (line <span class="linenumber">57</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">TextCSSNav( |
|
|
[mixed |
|
|
$highlight_selected = FALSE], int |
|
|
$width)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
Constructor for this class It just sets the width for the widget. |
|
|
<br /> |
|
|
|
|
|
<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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> - the width of the widget</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodadd'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">add</SPAN> (line <span class="linenumber">103</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">add( |
|
|
string |
|
|
$url, string |
|
|
$text, [string |
|
|
$title = ""], [string |
|
|
$target = ""], [mixed |
|
|
$selected = FALSE])</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
this function adds a clickable link. |
|
|
<br /> |
|
|
<p>It automatically adds the link based on $url, with $text as the viewable text.</p> |
|
|
<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">$url</SPAN></SPAN> - the url for the link</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">$text</SPAN></SPAN> - the link text</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">$title</SPAN></SPAN> - the title text</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">$target</SPAN></SPAN> - the link target</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodadd_blank'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">add_blank</SPAN> (line <span class="linenumber">124</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">add_blank( |
|
|
[int |
|
|
$num = 1])</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This lets you add a blank entry between 2 links |
|
|
<br /> |
|
|
|
|
|
<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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$num</SPAN></SPAN> - the # of blank lines to insert</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodadd_text'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">add_text</SPAN> (line <span class="linenumber">143</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">add_text( |
|
|
string |
|
|
$text)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
this adds a text item in the nav |
|
|
<br /> |
|
|
|
|
|
<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">$text</SPAN></SPAN> - the text to display</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodpush'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">push</SPAN> (line <span class="linenumber">114</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">push( |
|
|
mixed |
|
|
$url, mixed |
|
|
$text, [mixed |
|
|
$title = ""], [mixed |
|
|
$target = ""])</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
depricated version of add() |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>deprecated</b> - - use add() instead</DD> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodpush_blank'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">push_blank</SPAN> (line <span class="linenumber">134</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">push_blank( |
|
|
[mixed |
|
|
$num = 1])</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
depricated version of add_blank() |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>deprecated</b> - - use add_blank() instead</DD> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodpush_text'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">push_text</SPAN> (line <span class="linenumber">152</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">push_text( |
|
|
mixed |
|
|
$text)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
depricated version of add_text() |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>deprecated</b> - - use add_text() instead</DD> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodrender'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">71</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">render( |
|
|
[int |
|
|
$indent_level = 1], int |
|
|
$output_debug)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
function that will render the widget. |
|
|
<br /> |
|
|
|
|
|
<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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$indent_level</SPAN></SPAN> - the indentation level for the container.</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">$output_debug</SPAN></SPAN> - the output debug flag to maintain compatibility w/ the API.</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - the raw html output.</DD> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodset_prefix'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_prefix</SPAN> (line <span class="linenumber">86</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_prefix( |
|
|
string |
|
|
$prefix)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This method is used to set the prefix for |
|
|
<br /> |
|
|
<p>the widget so someone can have multiple widgets on the same page and have them operate independantly</p> |
|
|
<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">$prefix</SPAN></SPAN> - the prefix for the query var</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='method_build_links'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_build_links</SPAN> (line <span class="linenumber">163</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">Container</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_build_links( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function is used to build the links to click on |
|
|
<br /> |
|
|
|
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<div id="credit"> |
|
|
<hr> |
|
|
Documention generated on Thu, 20 Feb 2003 16:23:49 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
|
190 |
</div> |
</div> |
191 |
</body> |
|
192 |
|
<!-- ========== Info from phpDoc block ========= --> |
193 |
|
<p class="short-description">the prefix for the query string var</p> |
194 |
|
<p class="description"><p>so we can have multiple widgets on the same page and have them operate independantly</p></p> |
195 |
|
|
196 |
|
|
197 |
|
|
198 |
|
|
199 |
|
|
200 |
|
</div> |
201 |
|
<a name="var$_selected" id="$_selected"><!-- --></A> |
202 |
|
<div class="oddrow"> |
203 |
|
|
204 |
|
<div class="var-header"> |
205 |
|
<span class="var-title"> |
206 |
|
<span class="var-type">mixed</span> |
207 |
|
<span class="var-name">$_selected</span> |
208 |
|
= <span class="var-default"> 0</span> (line <span class="line-number">39</span>) |
209 |
|
</span> |
210 |
|
</div> |
211 |
|
|
212 |
|
<!-- ========== Info from phpDoc block ========= --> |
213 |
|
<p class="short-description">Holds which one is auto selected</p> |
214 |
|
|
215 |
|
|
216 |
|
|
217 |
|
|
218 |
|
|
219 |
|
</div> |
220 |
|
<h4>Inherited Variables</h4> |
221 |
|
<A NAME='inherited_vars'><!-- --></A> |
222 |
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
223 |
|
<blockquote> |
224 |
|
<span class="var-title"> |
225 |
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
226 |
|
</span> |
227 |
|
<span class="var-title"> |
228 |
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
229 |
|
</span> |
230 |
|
</blockquote> |
231 |
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
232 |
|
<blockquote> |
233 |
|
<span class="var-title"> |
234 |
|
<span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br> |
235 |
|
</span> |
236 |
|
</blockquote> |
237 |
|
|
238 |
|
</div> |
239 |
|
</div> |
240 |
|
|
241 |
|
<a name="sec-methods"></a> |
242 |
|
<div class="info-box"> |
243 |
|
<div class="info-box-title">Methods</div> |
244 |
|
<div class="nav-bar"> |
245 |
|
<a href="#sec-description">Description</a> | |
246 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
247 |
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
248 |
|
|
249 |
|
</div> |
250 |
|
<div class="info-box-body"> |
251 |
|
<A NAME='method_detail'></A> |
252 |
|
<a name="methodTextCSSNav" id="TextCSSNav"><!-- --></a> |
253 |
|
<div class="evenrow"> |
254 |
|
|
255 |
|
<div class="method-header"> |
256 |
|
<span class="method-title">Constructor TextCSSNav</span> (line <span class="line-number">57</span>) |
257 |
|
</div> |
258 |
|
|
259 |
|
<!-- ========== Info from phpDoc block ========= --> |
260 |
|
<p class="short-description">Constructor for this class It just sets the width for the widget.</p> |
261 |
|
|
262 |
|
<div class="method-signature"> |
263 |
|
<span class="method-result">void</span> |
264 |
|
<span class="method-name"> |
265 |
|
TextCSSNav |
266 |
|
</span> |
267 |
|
([<span class="var-type">mixed</span> <span class="var-name">$highlight_selected</span> = <span class="var-default">FALSE</span>], <span class="var-type">int</span> <span class="var-name">$width</span>) |
268 |
|
</div> |
269 |
|
|
270 |
|
<ul class="parameters"> |
271 |
|
<li> |
272 |
|
<span class="var-type">int</span> |
273 |
|
<span class="var-name">$width</span><span class="var-description">: <p>- the width of the widget</p></span> </li> |
274 |
|
</ul> |
275 |
|
|
276 |
|
|
277 |
|
</div> |
278 |
|
<a name="methodadd" id="add"><!-- --></a> |
279 |
|
<div class="oddrow"> |
280 |
|
|
281 |
|
<div class="method-header"> |
282 |
|
<span class="method-title">add</span> (line <span class="line-number">103</span>) |
283 |
|
</div> |
284 |
|
|
285 |
|
<!-- ========== Info from phpDoc block ========= --> |
286 |
|
<p class="short-description">this function adds a clickable link.</p> |
287 |
|
<p class="description"><p>It automatically adds the link based on $url, with $text as the viewable text.</p></p> |
288 |
|
|
289 |
|
<div class="method-signature"> |
290 |
|
<span class="method-result">void</span> |
291 |
|
<span class="method-name"> |
292 |
|
add |
293 |
|
</span> |
294 |
|
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">string</span> <span class="var-name">$text</span>, [<span class="var-type">string</span> <span class="var-name">$title</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$target</span> = <span class="var-default">""</span>], [<span class="var-type">mixed</span> <span class="var-name">$selected</span> = <span class="var-default">FALSE</span>]) |
295 |
|
</div> |
296 |
|
|
297 |
|
<ul class="parameters"> |
298 |
|
<li> |
299 |
|
<span class="var-type">string</span> |
300 |
|
<span class="var-name">$url</span><span class="var-description">: <p>- the url for the link</p></span> </li> |
301 |
|
<li> |
302 |
|
<span class="var-type">string</span> |
303 |
|
<span class="var-name">$text</span><span class="var-description">: <p>- the link text</p></span> </li> |
304 |
|
<li> |
305 |
|
<span class="var-type">string</span> |
306 |
|
<span class="var-name">$title</span><span class="var-description">: <p>- the title text</p></span> </li> |
307 |
|
<li> |
308 |
|
<span class="var-type">string</span> |
309 |
|
<span class="var-name">$target</span><span class="var-description">: <p>- the link target</p></span> </li> |
310 |
|
</ul> |
311 |
|
|
312 |
|
<hr class="separator" /> |
313 |
|
<div class="notes">Redefinition of:</div> |
314 |
|
<dl> |
315 |
|
<dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt> |
316 |
|
<dd>add content onto content stack</dd> |
317 |
|
</dl> |
318 |
|
|
319 |
|
</div> |
320 |
|
<a name="methodadd_blank" id="add_blank"><!-- --></a> |
321 |
|
<div class="evenrow"> |
322 |
|
|
323 |
|
<div class="method-header"> |
324 |
|
<span class="method-title">add_blank</span> (line <span class="line-number">124</span>) |
325 |
|
</div> |
326 |
|
|
327 |
|
<!-- ========== Info from phpDoc block ========= --> |
328 |
|
<p class="short-description">This lets you add a blank entry between 2 links</p> |
329 |
|
|
330 |
|
<div class="method-signature"> |
331 |
|
<span class="method-result">void</span> |
332 |
|
<span class="method-name"> |
333 |
|
add_blank |
334 |
|
</span> |
335 |
|
([<span class="var-type">int</span> <span class="var-name">$num</span> = <span class="var-default">1</span>]) |
336 |
|
</div> |
337 |
|
|
338 |
|
<ul class="parameters"> |
339 |
|
<li> |
340 |
|
<span class="var-type">int</span> |
341 |
|
<span class="var-name">$num</span><span class="var-description">: <p>- the # of blank lines to insert</p></span> </li> |
342 |
|
</ul> |
343 |
|
|
344 |
|
|
345 |
|
</div> |
346 |
|
<a name="methodadd_text" id="add_text"><!-- --></a> |
347 |
|
<div class="oddrow"> |
348 |
|
|
349 |
|
<div class="method-header"> |
350 |
|
<span class="method-title">add_text</span> (line <span class="line-number">143</span>) |
351 |
|
</div> |
352 |
|
|
353 |
|
<!-- ========== Info from phpDoc block ========= --> |
354 |
|
<p class="short-description">this adds a text item in the nav</p> |
355 |
|
|
356 |
|
<div class="method-signature"> |
357 |
|
<span class="method-result">void</span> |
358 |
|
<span class="method-name"> |
359 |
|
add_text |
360 |
|
</span> |
361 |
|
(<span class="var-type">string</span> <span class="var-name">$text</span>) |
362 |
|
</div> |
363 |
|
|
364 |
|
<ul class="parameters"> |
365 |
|
<li> |
366 |
|
<span class="var-type">string</span> |
367 |
|
<span class="var-name">$text</span><span class="var-description">: <p>- the text to display</p></span> </li> |
368 |
|
</ul> |
369 |
|
|
370 |
|
|
371 |
|
</div> |
372 |
|
<a name="methodpush" id="push"><!-- --></a> |
373 |
|
<div class="evenrow"> |
374 |
|
|
375 |
|
<div class="method-header"> |
376 |
|
<span class="method-title">push</span> (line <span class="line-number">114</span>) |
377 |
|
</div> |
378 |
|
|
379 |
|
<!-- ========== Info from phpDoc block ========= --> |
380 |
|
<p class="short-description">depricated version of add()</p> |
381 |
|
<ul class="tags"> |
382 |
|
<li><span class="field">deprecated:</span> <p>- use add() instead</p></li> |
383 |
|
</ul> |
384 |
|
|
385 |
|
<div class="method-signature"> |
386 |
|
<span class="method-result">void</span> |
387 |
|
<span class="method-name"> |
388 |
|
push |
389 |
|
</span> |
390 |
|
(<span class="var-type">mixed</span> <span class="var-name">$url</span>, <span class="var-type">mixed</span> <span class="var-name">$text</span>, [<span class="var-type">mixed</span> <span class="var-name">$title</span> = <span class="var-default">""</span>], [<span class="var-type">mixed</span> <span class="var-name">$target</span> = <span class="var-default">""</span>]) |
391 |
|
</div> |
392 |
|
|
393 |
|
|
394 |
|
<hr class="separator" /> |
395 |
|
<div class="notes">Redefinition of:</div> |
396 |
|
<dl> |
397 |
|
<dt><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></dt> |
398 |
|
<dd>Same as add().</dd> |
399 |
|
</dl> |
400 |
|
|
401 |
|
</div> |
402 |
|
<a name="methodpush_blank" id="push_blank"><!-- --></a> |
403 |
|
<div class="oddrow"> |
404 |
|
|
405 |
|
<div class="method-header"> |
406 |
|
<span class="method-title">push_blank</span> (line <span class="line-number">134</span>) |
407 |
|
</div> |
408 |
|
|
409 |
|
<!-- ========== Info from phpDoc block ========= --> |
410 |
|
<p class="short-description">depricated version of add_blank()</p> |
411 |
|
<ul class="tags"> |
412 |
|
<li><span class="field">deprecated:</span> <p>- use add_blank() instead</p></li> |
413 |
|
</ul> |
414 |
|
|
415 |
|
<div class="method-signature"> |
416 |
|
<span class="method-result">void</span> |
417 |
|
<span class="method-name"> |
418 |
|
push_blank |
419 |
|
</span> |
420 |
|
([<span class="var-type">mixed</span> <span class="var-name">$num</span> = <span class="var-default">1</span>]) |
421 |
|
</div> |
422 |
|
|
423 |
|
|
424 |
|
|
425 |
|
</div> |
426 |
|
<a name="methodpush_text" id="push_text"><!-- --></a> |
427 |
|
<div class="evenrow"> |
428 |
|
|
429 |
|
<div class="method-header"> |
430 |
|
<span class="method-title">push_text</span> (line <span class="line-number">152</span>) |
431 |
|
</div> |
432 |
|
|
433 |
|
<!-- ========== Info from phpDoc block ========= --> |
434 |
|
<p class="short-description">depricated version of add_text()</p> |
435 |
|
<ul class="tags"> |
436 |
|
<li><span class="field">deprecated:</span> <p>- use add_text() instead</p></li> |
437 |
|
</ul> |
438 |
|
|
439 |
|
<div class="method-signature"> |
440 |
|
<span class="method-result">void</span> |
441 |
|
<span class="method-name"> |
442 |
|
push_text |
443 |
|
</span> |
444 |
|
(<span class="var-type">mixed</span> <span class="var-name">$text</span>) |
445 |
|
</div> |
446 |
|
|
447 |
|
|
448 |
|
|
449 |
|
</div> |
450 |
|
<a name="methodrender" id="render"><!-- --></a> |
451 |
|
<div class="oddrow"> |
452 |
|
|
453 |
|
<div class="method-header"> |
454 |
|
<span class="method-title">render</span> (line <span class="line-number">71</span>) |
455 |
|
</div> |
456 |
|
|
457 |
|
<!-- ========== Info from phpDoc block ========= --> |
458 |
|
<p class="short-description">function that will render the widget.</p> |
459 |
|
<ul class="tags"> |
460 |
|
<li><span class="field">return:</span> <p>the raw html output.</p></li> |
461 |
|
</ul> |
462 |
|
|
463 |
|
<div class="method-signature"> |
464 |
|
<span class="method-result">string</span> |
465 |
|
<span class="method-name"> |
466 |
|
render |
467 |
|
</span> |
468 |
|
([<span class="var-type">int</span> <span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span> <span class="var-name">$output_debug</span>) |
469 |
|
</div> |
470 |
|
|
471 |
|
<ul class="parameters"> |
472 |
|
<li> |
473 |
|
<span class="var-type">int</span> |
474 |
|
<span class="var-name">$indent_level</span><span class="var-description">: <p>- the indentation level for the container.</p></span> </li> |
475 |
|
<li> |
476 |
|
<span class="var-type">int</span> |
477 |
|
<span class="var-name">$output_debug</span><span class="var-description">: <p>- the output debug flag to maintain compatibility w/ the API.</p></span> </li> |
478 |
|
</ul> |
479 |
|
|
480 |
|
<hr class="separator" /> |
481 |
|
<div class="notes">Redefinition of:</div> |
482 |
|
<dl> |
483 |
|
<dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt> |
484 |
|
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd> |
485 |
|
</dl> |
486 |
|
|
487 |
|
</div> |
488 |
|
<a name="methodset_prefix" id="set_prefix"><!-- --></a> |
489 |
|
<div class="evenrow"> |
490 |
|
|
491 |
|
<div class="method-header"> |
492 |
|
<span class="method-title">set_prefix</span> (line <span class="line-number">86</span>) |
493 |
|
</div> |
494 |
|
|
495 |
|
<!-- ========== Info from phpDoc block ========= --> |
496 |
|
<p class="short-description">This method is used to set the prefix for</p> |
497 |
|
<p class="description"><p>the widget so someone can have multiple widgets on the same page and have them operate independantly</p></p> |
498 |
|
|
499 |
|
<div class="method-signature"> |
500 |
|
<span class="method-result">void</span> |
501 |
|
<span class="method-name"> |
502 |
|
set_prefix |
503 |
|
</span> |
504 |
|
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
505 |
|
</div> |
506 |
|
|
507 |
|
<ul class="parameters"> |
508 |
|
<li> |
509 |
|
<span class="var-type">string</span> |
510 |
|
<span class="var-name">$prefix</span><span class="var-description">: <p>- the prefix for the query var</p></span> </li> |
511 |
|
</ul> |
512 |
|
|
513 |
|
|
514 |
|
</div> |
515 |
|
<a name="method_build_links" id="_build_links"><!-- --></a> |
516 |
|
<div class="oddrow"> |
517 |
|
|
518 |
|
<div class="method-header"> |
519 |
|
<span class="method-title">_build_links</span> (line <span class="line-number">163</span>) |
520 |
|
</div> |
521 |
|
|
522 |
|
<!-- ========== Info from phpDoc block ========= --> |
523 |
|
<p class="short-description">This function is used to build the links to click on</p> |
524 |
|
|
525 |
|
<div class="method-signature"> |
526 |
|
<span class="method-result">Container</span> |
527 |
|
<span class="method-name"> |
528 |
|
_build_links |
529 |
|
</span> |
530 |
|
() |
531 |
|
</div> |
532 |
|
|
533 |
|
|
534 |
|
|
535 |
|
</div> |
536 |
|
<h4>Inherited Methods</h4> |
537 |
|
<a name='inherited_methods'><!-- --></a> |
538 |
|
<!-- =========== Summary =========== --> |
539 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
540 |
|
<blockquote> |
541 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
542 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
543 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
544 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
545 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
546 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
547 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
548 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
549 |
|
</blockquote> |
550 |
|
<!-- =========== Summary =========== --> |
551 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
552 |
|
<blockquote> |
553 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
554 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
555 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
556 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
557 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
558 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
559 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
560 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
561 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
562 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
563 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
564 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br> |
565 |
|
</blockquote> |
566 |
|
|
567 |
|
</div> |
568 |
|
</div> |
569 |
|
|
570 |
|
<p class="notes" id="credit"> |
571 |
|
Documention generated on Thu, 31 Jul 2003 18:33:51 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
572 |
|
</p> |
573 |
|
</div></body> |
574 |
</html> |
</html> |