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

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/TextCSSNav.html

Parent Directory Parent Directory | Revision Log Revision Log

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