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