1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> |
2 |
<!--NewPage--> |
3 |
<HTML> |
4 |
<HEAD> |
5 |
<!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:39 -0800' --> |
6 |
<TITLE>Docs For Class TextNav</TITLE> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> |
8 |
</HEAD> |
9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
|
11 |
|
12 |
<!-- Links --> |
13 |
<a NAME="top"></A> |
14 |
<table WIDTH="100%" class="links"> |
15 |
<TR> |
16 |
<TD class="font10"> |
17 |
Links: |
18 |
<A HREF="#children_summary" class="links" title="Classes extended from TextNav">Child Classes</A> |
19 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
20 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</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> |
23 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
24 |
<A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> |
25 |
</TD> |
26 |
</TR> |
27 |
</TABLE> |
28 |
<BR> |
29 |
|
30 |
<!-- Start of Class Data --> |
31 |
<H2> |
32 |
Class TextNav |
33 |
</H2> |
34 |
|
35 |
<pre> |
36 |
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
37 |
| |
38 |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
39 |
| |
40 |
--TextNav</pre> |
41 |
</pre> |
42 |
|
43 |
<A NAME="children_summary"</A> |
44 |
<H3> |
45 |
Classes extended from TextNav: <A HREF="#top" CLASS="links">^TOP</A> |
46 |
</H3> |
47 |
|
48 |
<p> |
49 |
<b><i>Located in File: Program_Root/widgets/TextNav.inc</i></b><br> |
50 |
</p> |
51 |
<hr> |
52 |
<!-- ========== Info from phpDoc block ========= --> |
53 |
This class builds a simple text navigational |
54 |
widget. |
55 |
<BR> |
56 |
|
57 |
|
58 |
<UL> |
59 |
|
60 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
61 |
|
62 |
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
63 |
|
64 |
</UL> |
65 |
|
66 |
<hr> |
67 |
<!-- =========== VAR SUMMARY =========== --> |
68 |
<A NAME='var_summary'><!-- --></A> |
69 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
70 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
71 |
<TD> |
72 |
<span CLASS="font12bold">Class Variable Summary</span> |
73 |
<A HREF="#top" CLASS="links">^TOP</A> |
74 |
</TD> |
75 |
</TR> |
76 |
|
77 |
|
78 |
</TABLE> |
79 |
|
80 |
<hr> |
81 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
82 |
<A NAME='var_inherited_summary'><!-- --></A> |
83 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
84 |
<TR CLASS='TableHeadingColor'> |
85 |
<TD> |
86 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
87 |
<A HREF="#top" CLASS="links">^TOP</A> |
88 |
</TD> |
89 |
</TR> |
90 |
|
91 |
|
92 |
<!-- =========== Summary =========== --> |
93 |
<TR BGCOLOR='white'> |
94 |
<TD> |
95 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
96 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
97 |
<tr CLASS="tableheadingcolor"> |
98 |
<th>Variable</th> |
99 |
<th>Default Value</th> |
100 |
<th>Description</th> |
101 |
</tr> |
102 |
|
103 |
<tr> |
104 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$title'>$title</A></td> |
105 |
<td CLASS="font10" STYLE="white-space: nowrap">-><-</td> |
106 |
<td CLASS="font10">The title of the table.</td> |
107 |
</tr> |
108 |
|
109 |
<tr> |
110 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$width'>$width</A></td> |
111 |
<td CLASS="font10" STYLE="white-space: nowrap">->100%<-</td> |
112 |
<td CLASS="font10">the width of the widget</td> |
113 |
</tr> |
114 |
|
115 |
</table> |
116 |
<BR> |
117 |
</TD> |
118 |
</TR> |
119 |
|
120 |
<!-- =========== Summary =========== --> |
121 |
<TR BGCOLOR='white'> |
122 |
<TD> |
123 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
124 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
125 |
<tr CLASS="tableheadingcolor"> |
126 |
<th>Variable</th> |
127 |
<th>Default Value</th> |
128 |
<th>Description</th> |
129 |
</tr> |
130 |
|
131 |
<tr> |
132 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td> |
133 |
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
134 |
<td CLASS="font10">Flag for pretty (indented) output</td> |
135 |
</tr> |
136 |
|
137 |
<tr> |
138 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td> |
139 |
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
140 |
<td CLASS="font10">Do we render a newline after the |
141 |
contents has been rendered?</td> |
142 |
</tr> |
143 |
|
144 |
</table> |
145 |
<BR> |
146 |
</TD> |
147 |
</TR> |
148 |
|
149 |
</TABLE> |
150 |
|
151 |
<hr> |
152 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
153 |
<A NAME='functions_inherited'><!-- --></A> |
154 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
155 |
<TR CLASS='TableHeadingColor'> |
156 |
<TD> |
157 |
<span CLASS="font12bold">Inherited Method Summary</span> |
158 |
<A HREF="#top" CLASS="links">^TOP</A> |
159 |
</TD> |
160 |
</TR> |
161 |
|
162 |
|
163 |
<!-- =========== Summary =========== --> |
164 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
165 |
<TD> |
166 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
167 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
168 |
<tr CLASS="tableheadingcolor"> |
169 |
<th>Function</th> |
170 |
<th>Description</th> |
171 |
</tr> |
172 |
|
173 |
<tr> |
174 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_align'>get_align ( )</A></td> |
175 |
<td CLASS="font10">This gets the alignment value |
176 |
for the outer table</td> |
177 |
|
178 |
<tr> |
179 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_css'>get_css ( )</A></td> |
180 |
<td CLASS="font10">This function provides the</td> |
181 |
|
182 |
<tr> |
183 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>get_javascript ( )</A></td> |
184 |
<td CLASS="font10">Function for returning the raw javascript |
185 |
that is required for this widget.</td> |
186 |
|
187 |
<tr> |
188 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_title'>get_title ( )</A></td> |
189 |
<td CLASS="font10">Function for accessing the |
190 |
title of this widget</td> |
191 |
|
192 |
<tr> |
193 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_width'>get_width ( )</A></td> |
194 |
<td CLASS="font10">Function for getting the current |
195 |
widget width setting.</td> |
196 |
|
197 |
<tr> |
198 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_align'>set_align ( $align )</A></td> |
199 |
<td CLASS="font10">This function sets the align attribute |
200 |
for the outer table.</td> |
201 |
|
202 |
<tr> |
203 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_title'>set_title ( [$title = ] )</A></td> |
204 |
<td CLASS="font10">Set the title for the widget.</td> |
205 |
|
206 |
<tr> |
207 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $width )</A></td> |
208 |
<td CLASS="font10">Set the width for the widget.</td> |
209 |
|
210 |
</table> |
211 |
<br> |
212 |
</TD> |
213 |
</TR> |
214 |
|
215 |
<!-- =========== Summary =========== --> |
216 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
217 |
<TD> |
218 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
219 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
220 |
<tr CLASS="tableheadingcolor"> |
221 |
<th>Function</th> |
222 |
<th>Description</th> |
223 |
</tr> |
224 |
|
225 |
<tr> |
226 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td> |
227 |
<td CLASS="font10">The constructor.</td> |
228 |
|
229 |
<tr> |
230 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td> |
231 |
<td CLASS="font10">add content onto content stack</td> |
232 |
|
233 |
<tr> |
234 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td> |
235 |
<td CLASS="font10">Add content onto content stack |
236 |
so you can change the item later.</td> |
237 |
|
238 |
<tr> |
239 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td> |
240 |
<td CLASS="font10">counts the number of content objects</td> |
241 |
|
242 |
<tr> |
243 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td> |
244 |
<td CLASS="font10">This flag gets the current value |
245 |
of the indent flag</td> |
246 |
|
247 |
<tr> |
248 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td> |
249 |
<td CLASS="font10">Same as add().</td> |
250 |
|
251 |
<tr> |
252 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td> |
253 |
<td CLASS="font10">Same as add_reference |
254 |
NOTE : only exists for compatibility with 1.1.x</td> |
255 |
|
256 |
<tr> |
257 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td> |
258 |
<td CLASS="font10">This function is compatible with the |
259 |
rest of the phpHtmllib API spec.</td> |
260 |
|
261 |
<tr> |
262 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td> |
263 |
<td CLASS="font10">destroy existing content and start with new content.</td> |
264 |
|
265 |
<tr> |
266 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td> |
267 |
<td CLASS="font10">This function turns on the collapse flag</td> |
268 |
|
269 |
<tr> |
270 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td> |
271 |
<td CLASS="font10">function to set the indent flag</td> |
272 |
|
273 |
</table> |
274 |
<br> |
275 |
</TD> |
276 |
</TR> |
277 |
|
278 |
</TABLE> |
279 |
|
280 |
<hr> |
281 |
<!-- should have constructor at some point --> |
282 |
<!-- =========== Method SUMMARY =========== --> |
283 |
<A NAME='Method_summary'><!-- --></A> |
284 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
285 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
286 |
<TD> |
287 |
<span class="font12bold">Method Summary</span> |
288 |
<A HREF="#top" CLASS="links">^TOP</A> |
289 |
</TD> |
290 |
</TR> |
291 |
|
292 |
|
293 |
<!-- =========== Summary =========== --> |
294 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
295 |
<TD> |
296 |
<CODE><B><A HREF='TextNav.html#constructor TextNav'>void constructor TextNav ( [$width = 760] )</A></B></CODE> |
297 |
<BR> |
298 |
<blockquote> Constructor for this class |
299 |
It just sets the width for the |
300 |
widget. </blockquote> |
301 |
</TD> |
302 |
</TR> |
303 |
|
304 |
<!-- =========== Summary =========== --> |
305 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
306 |
<TD> |
307 |
<CODE><B><A HREF='TextNav.html#add'>void add ( $url, $text, [$width = 100], [$target = NULL] )</A></B></CODE> |
308 |
<BR> |
309 |
<blockquote> this function adds a clickable link. </blockquote> |
310 |
</TD> |
311 |
</TR> |
312 |
|
313 |
<!-- =========== Summary =========== --> |
314 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
315 |
<TD> |
316 |
<CODE><B><A HREF='TextNav.html#add_blank'>void add_blank ( [$num = 1] )</A></B></CODE> |
317 |
<BR> |
318 |
<blockquote> This lets you add a blank entry |
319 |
between 2 links </blockquote> |
320 |
</TD> |
321 |
</TR> |
322 |
|
323 |
<!-- =========== Summary =========== --> |
324 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
325 |
<TD> |
326 |
<CODE><B><A HREF='TextNav.html#add_text'>void add_text ( $text )</A></B></CODE> |
327 |
<BR> |
328 |
<blockquote> this adds a text item in the nav </blockquote> |
329 |
</TD> |
330 |
</TR> |
331 |
|
332 |
<!-- =========== Summary =========== --> |
333 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
334 |
<TD> |
335 |
<CODE><B><A HREF='TextNav.html#build_img_td'>void build_img_td ( )</A></B></CODE> |
336 |
<BR> |
337 |
<blockquote> build the image seperator td </blockquote> |
338 |
</TD> |
339 |
</TR> |
340 |
|
341 |
<!-- =========== Summary =========== --> |
342 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
343 |
<TD> |
344 |
<CODE><B><A HREF='TextNav.html#build_nav_td'>void build_nav_td ( $nav, $count )</A></B></CODE> |
345 |
<BR> |
346 |
<blockquote> build a td for the link. </blockquote> |
347 |
</TD> |
348 |
</TR> |
349 |
|
350 |
<!-- =========== Summary =========== --> |
351 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
352 |
<TD> |
353 |
<CODE><B><A HREF='TextNav.html#push'>void push ( $url, $text, [$width = 100] )</A></B></CODE> |
354 |
<BR> |
355 |
<blockquote> depricated version of add() </blockquote> |
356 |
</TD> |
357 |
</TR> |
358 |
|
359 |
<!-- =========== Summary =========== --> |
360 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
361 |
<TD> |
362 |
<CODE><B><A HREF='TextNav.html#push_blank'>void push_blank ( [$num = 1] )</A></B></CODE> |
363 |
<BR> |
364 |
<blockquote> depricated version of add_blank() </blockquote> |
365 |
</TD> |
366 |
</TR> |
367 |
|
368 |
<!-- =========== Summary =========== --> |
369 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
370 |
<TD> |
371 |
<CODE><B><A HREF='TextNav.html#push_text'>void push_text ( $text )</A></B></CODE> |
372 |
<BR> |
373 |
<blockquote> depricated version of add_text() </blockquote> |
374 |
</TD> |
375 |
</TR> |
376 |
|
377 |
<!-- =========== Summary =========== --> |
378 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
379 |
<TD> |
380 |
<CODE><B><A HREF='TextNav.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE> |
381 |
<BR> |
382 |
<blockquote> function that will render the widget. </blockquote> |
383 |
</TD> |
384 |
</TR> |
385 |
|
386 |
</TABLE> |
387 |
|
388 |
<hr> |
389 |
<!-- ============ VARIABLE DETAIL =========== --> |
390 |
|
391 |
<A NAME='variable_detail'></A> |
392 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
393 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
394 |
<TD> |
395 |
<span CLASS="font12bold">Variable Detail</span> |
396 |
<A HREF="#top" CLASS="links">^TOP</A> |
397 |
</TD> |
398 |
</TR> |
399 |
</TABLE> |
400 |
|
401 |
|
402 |
|
403 |
<hr> |
404 |
<!-- ============ FUNCTION DETAIL =========== --> |
405 |
|
406 |
<A NAME='function_detail'></A> |
407 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
408 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
409 |
<TD> |
410 |
<span class="font12bold">Method Detail</span> |
411 |
<A HREF="#top" CLASS="links">^TOP</A> |
412 |
</TD> |
413 |
</TR> |
414 |
</TABLE> |
415 |
<BR> |
416 |
|
417 |
<DIV CLASS="function"> |
418 |
<A NAME='constructor TextNav'><!-- --></A> |
419 |
<SPAN CLASS="font12bold">constructor TextNav</SPAN> |
420 |
<BR> |
421 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
422 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
423 |
<span class="font10bold" style="color: #0000FF">constructor TextNav ( [$width = 760] )</SPAN> |
424 |
<BR> |
425 |
|
426 |
<BR> |
427 |
<SPAN CLASS="font10bold">Description : </SPAN> |
428 |
<!-- ========== Info from phpDoc block ========= --> |
429 |
Constructor for this class |
430 |
It just sets the width for the |
431 |
widget. |
432 |
<BR> |
433 |
|
434 |
<DL> |
435 |
<DT class="font10bold">Function Parameters:</DT> |
436 |
|
437 |
<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> |
438 |
|
439 |
|
440 |
<DT class="font10bold">Function Info:</DT> |
441 |
|
442 |
</DL> |
443 |
|
444 |
</DIV> |
445 |
<BR> |
446 |
|
447 |
<DIV CLASS="function"> |
448 |
<A NAME='add'><!-- --></A> |
449 |
<SPAN CLASS="font12bold">add</SPAN> |
450 |
<BR> |
451 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
452 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
453 |
<span class="font10bold" style="color: #0000FF">add ( $url, $text, [$width = 100], [$target = NULL] )</SPAN> |
454 |
<BR> |
455 |
|
456 |
<BR> |
457 |
<SPAN CLASS="font10bold">Description : </SPAN> |
458 |
<!-- ========== Info from phpDoc block ========= --> |
459 |
this function adds a clickable link. |
460 |
<BR> |
461 |
It automatically adds the link based on $url, |
462 |
with $text as the viewable text. |
463 |
<DL> |
464 |
<DT class="font10bold">Function Parameters:</DT> |
465 |
|
466 |
<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> |
467 |
|
468 |
<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> |
469 |
|
470 |
<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">$width</SPAN></SPAN> - the width of the cell</DD> |
471 |
|
472 |
<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 target for the url</DD> |
473 |
|
474 |
|
475 |
<DT class="font10bold">Function Info:</DT> |
476 |
|
477 |
</DL> |
478 |
|
479 |
</DIV> |
480 |
<BR> |
481 |
|
482 |
<DIV CLASS="function"> |
483 |
<A NAME='add_blank'><!-- --></A> |
484 |
<SPAN CLASS="font12bold">add_blank</SPAN> |
485 |
<BR> |
486 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
487 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
488 |
<span class="font10bold" style="color: #0000FF">add_blank ( [$num = 1] )</SPAN> |
489 |
<BR> |
490 |
|
491 |
<BR> |
492 |
<SPAN CLASS="font10bold">Description : </SPAN> |
493 |
<!-- ========== Info from phpDoc block ========= --> |
494 |
This lets you add a blank entry |
495 |
between 2 links |
496 |
<BR> |
497 |
|
498 |
<DL> |
499 |
<DT class="font10bold">Function Parameters:</DT> |
500 |
|
501 |
<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> |
502 |
|
503 |
|
504 |
<DT class="font10bold">Function Info:</DT> |
505 |
|
506 |
</DL> |
507 |
|
508 |
</DIV> |
509 |
<BR> |
510 |
|
511 |
<DIV CLASS="function"> |
512 |
<A NAME='add_text'><!-- --></A> |
513 |
<SPAN CLASS="font12bold">add_text</SPAN> |
514 |
<BR> |
515 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
516 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
517 |
<span class="font10bold" style="color: #0000FF">add_text ( $text )</SPAN> |
518 |
<BR> |
519 |
|
520 |
<BR> |
521 |
<SPAN CLASS="font10bold">Description : </SPAN> |
522 |
<!-- ========== Info from phpDoc block ========= --> |
523 |
this adds a text item in the nav |
524 |
<BR> |
525 |
|
526 |
<DL> |
527 |
<DT class="font10bold">Function Parameters:</DT> |
528 |
|
529 |
<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> |
530 |
|
531 |
|
532 |
<DT class="font10bold">Function Info:</DT> |
533 |
|
534 |
</DL> |
535 |
|
536 |
</DIV> |
537 |
<BR> |
538 |
|
539 |
<DIV CLASS="function"> |
540 |
<A NAME='build_img_td'><!-- --></A> |
541 |
<SPAN CLASS="font12bold">build_img_td</SPAN> |
542 |
<BR> |
543 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
544 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
545 |
<span class="font10bold" style="color: #0000FF">build_img_td ( )</SPAN> |
546 |
<BR> |
547 |
|
548 |
<BR> |
549 |
<SPAN CLASS="font10bold">Description : </SPAN> |
550 |
<!-- ========== Info from phpDoc block ========= --> |
551 |
build the image seperator td |
552 |
<BR> |
553 |
|
554 |
<DL> |
555 |
<DT class="font10bold">Function Parameters:</DT> |
556 |
|
557 |
|
558 |
<DT class="font10bold">Function Info:</DT> |
559 |
|
560 |
</DL> |
561 |
|
562 |
</DIV> |
563 |
<BR> |
564 |
|
565 |
<DIV CLASS="function"> |
566 |
<A NAME='build_nav_td'><!-- --></A> |
567 |
<SPAN CLASS="font12bold">build_nav_td</SPAN> |
568 |
<BR> |
569 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
570 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
571 |
<span class="font10bold" style="color: #0000FF">build_nav_td ( $nav, $count )</SPAN> |
572 |
<BR> |
573 |
|
574 |
<BR> |
575 |
<SPAN CLASS="font10bold">Description : </SPAN> |
576 |
<!-- ========== Info from phpDoc block ========= --> |
577 |
build a td for the link. |
578 |
<BR> |
579 |
|
580 |
<DL> |
581 |
<DT class="font10bold">Function Parameters:</DT> |
582 |
|
583 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$nav</SPAN></SPAN> - the nav array entry</DD> |
584 |
|
585 |
<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">$count</SPAN></SPAN> - the column # this entry is</DD> |
586 |
|
587 |
|
588 |
<DT class="font10bold">Function Info:</DT> |
589 |
|
590 |
</DL> |
591 |
|
592 |
</DIV> |
593 |
<BR> |
594 |
|
595 |
<DIV CLASS="function"> |
596 |
<A NAME='push'><!-- --></A> |
597 |
<SPAN CLASS="font12bold">push</SPAN> |
598 |
<BR> |
599 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
600 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
601 |
<span class="font10bold" style="color: #0000FF">push ( $url, $text, [$width = 100] )</SPAN> |
602 |
<BR> |
603 |
|
604 |
<BR> |
605 |
<SPAN CLASS="font10bold">Description : </SPAN> |
606 |
<!-- ========== Info from phpDoc block ========= --> |
607 |
depricated version of add() |
608 |
<BR> |
609 |
|
610 |
<DL> |
611 |
<DT class="font10bold">Function Parameters:</DT> |
612 |
|
613 |
|
614 |
<DT class="font10bold">Function Info:</DT> |
615 |
|
616 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add() instead</DD> |
617 |
|
618 |
</DL> |
619 |
|
620 |
</DIV> |
621 |
<BR> |
622 |
|
623 |
<DIV CLASS="function"> |
624 |
<A NAME='push_blank'><!-- --></A> |
625 |
<SPAN CLASS="font12bold">push_blank</SPAN> |
626 |
<BR> |
627 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
628 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
629 |
<span class="font10bold" style="color: #0000FF">push_blank ( [$num = 1] )</SPAN> |
630 |
<BR> |
631 |
|
632 |
<BR> |
633 |
<SPAN CLASS="font10bold">Description : </SPAN> |
634 |
<!-- ========== Info from phpDoc block ========= --> |
635 |
depricated version of add_blank() |
636 |
<BR> |
637 |
|
638 |
<DL> |
639 |
<DT class="font10bold">Function Parameters:</DT> |
640 |
|
641 |
|
642 |
<DT class="font10bold">Function Info:</DT> |
643 |
|
644 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add_blank() instead</DD> |
645 |
|
646 |
</DL> |
647 |
|
648 |
</DIV> |
649 |
<BR> |
650 |
|
651 |
<DIV CLASS="function"> |
652 |
<A NAME='push_text'><!-- --></A> |
653 |
<SPAN CLASS="font12bold">push_text</SPAN> |
654 |
<BR> |
655 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
656 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
657 |
<span class="font10bold" style="color: #0000FF">push_text ( $text )</SPAN> |
658 |
<BR> |
659 |
|
660 |
<BR> |
661 |
<SPAN CLASS="font10bold">Description : </SPAN> |
662 |
<!-- ========== Info from phpDoc block ========= --> |
663 |
depricated version of add_text() |
664 |
<BR> |
665 |
|
666 |
<DL> |
667 |
<DT class="font10bold">Function Parameters:</DT> |
668 |
|
669 |
|
670 |
<DT class="font10bold">Function Info:</DT> |
671 |
|
672 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add_text() instead</DD> |
673 |
|
674 |
</DL> |
675 |
|
676 |
</DIV> |
677 |
<BR> |
678 |
|
679 |
<DIV CLASS="function"> |
680 |
<A NAME='render'><!-- --></A> |
681 |
<SPAN CLASS="font12bold">render</SPAN> |
682 |
<BR> |
683 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
684 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
685 |
<span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN> |
686 |
<BR> |
687 |
|
688 |
<BR> |
689 |
<SPAN CLASS="font10bold">Description : </SPAN> |
690 |
<!-- ========== Info from phpDoc block ========= --> |
691 |
function that will render the widget. |
692 |
<BR> |
693 |
|
694 |
<DL> |
695 |
<DT class="font10bold">Function Parameters:</DT> |
696 |
|
697 |
<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 |
698 |
the container.</DD> |
699 |
|
700 |
<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 |
701 |
maintain compatibility w/ the API.</DD> |
702 |
|
703 |
|
704 |
<DT class="font10bold">Function Info:</DT> |
705 |
|
706 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD> |
707 |
|
708 |
</DL> |
709 |
|
710 |
</DIV> |
711 |
<BR> |
712 |
|
713 |
|
714 |
<hr> |
715 |
</HTML> |