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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Thu Jan 30 03:29:29 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
1 jonen 1.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 TextCSSNav</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 TextCSSNav">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 TextCSSNav
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     --TextCSSNav</pre>
41     </pre>
42    
43     <A NAME="children_summary"</A>
44     <H3>
45     Classes extended from TextCSSNav: <A HREF="#top" CLASS="links">^TOP</A>
46     </H3>
47    
48     <p>
49     <b><i>Located in File: Program_Root/widgets/TextCSSNav.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 &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</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     <!-- =========== Summary =========== -->
79     <TR BGCOLOR='white' CLASS='TableRowColor'>
80     <TD>
81     <CODE><B><A HREF='TextCSSNav.html#$_highlight_selected'>$_highlight_selected</A></B></CODE>
82     <BR>
83     <blockquote> Flag to tell us that we can
84     highlight (css) the selected
85     link. </blockquote>
86     <blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote>
87     </TD>
88     </TR>
89    
90     <!-- =========== Summary =========== -->
91     <TR BGCOLOR='white' CLASS='TableRowColor'>
92     <TD>
93     <CODE><B><A HREF='TextCSSNav.html#$_query_prefix'>$_query_prefix</A></B></CODE>
94     <BR>
95     <blockquote> the prefix for the query string var </blockquote>
96     <blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
97     </TD>
98     </TR>
99    
100     <!-- =========== Summary =========== -->
101     <TR BGCOLOR='white' CLASS='TableRowColor'>
102     <TD>
103     <CODE><B><A HREF='TextCSSNav.html#$_selected'>$_selected</A></B></CODE>
104     <BR>
105     <blockquote> Holds which one is auto selected </blockquote>
106     <blockquote> Default Value: <CODE>->0<-</CODE> </blockquote>
107     </TD>
108     </TR>
109    
110     </TABLE>
111    
112     <hr>
113     <!-- =========== VAR INHERITED SUMMARY =========== -->
114     <A NAME='var_inherited_summary'><!-- --></A>
115     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
116     <TR CLASS='TableHeadingColor'>
117     <TD>
118     <span CLASS="font12bold">Inherited Class Variable Summary</span>
119     <A HREF="#top" CLASS="links">^TOP</A>
120     </TD>
121     </TR>
122    
123    
124     <!-- =========== Summary =========== -->
125     <TR BGCOLOR='white'>
126     <TD>
127     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
128     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
129     <tr CLASS="tableheadingcolor">
130     <th>Variable</th>
131     <th>Default Value</th>
132     <th>Description</th>
133     </tr>
134    
135     <tr>
136     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$title'>$title</A></td>
137     <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
138     <td CLASS="font10">The title of the table.</td>
139     </tr>
140    
141     <tr>
142     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$width'>$width</A></td>
143     <td CLASS="font10" STYLE="white-space: nowrap">->100%<-</td>
144     <td CLASS="font10">the width of the widget</td>
145     </tr>
146    
147     </table>
148     <BR>
149     </TD>
150     </TR>
151    
152     <!-- =========== Summary =========== -->
153     <TR BGCOLOR='white'>
154     <TD>
155     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
156     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
157     <tr CLASS="tableheadingcolor">
158     <th>Variable</th>
159     <th>Default Value</th>
160     <th>Description</th>
161     </tr>
162    
163     <tr>
164     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
165     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
166     <td CLASS="font10">Flag for pretty (indented) output</td>
167     </tr>
168    
169     <tr>
170     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
171     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
172     <td CLASS="font10">Do we render a newline after the
173     contents has been rendered?</td>
174     </tr>
175    
176     </table>
177     <BR>
178     </TD>
179     </TR>
180    
181     </TABLE>
182    
183     <hr>
184     <!-- =========== INHERITED METHOD SUMMARY =========== -->
185     <A NAME='functions_inherited'><!-- --></A>
186     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
187     <TR CLASS='TableHeadingColor'>
188     <TD>
189     <span CLASS="font12bold">Inherited Method Summary</span>
190     <A HREF="#top" CLASS="links">^TOP</A>
191     </TD>
192     </TR>
193    
194    
195     <!-- =========== Summary =========== -->
196     <TR BGCOLOR='white' CLASS='TableRowColor'>
197     <TD>
198     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
199     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
200     <tr CLASS="tableheadingcolor">
201     <th>Function</th>
202     <th>Description</th>
203     </tr>
204    
205     <tr>
206     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_align'>get_align ( )</A></td>
207     <td CLASS="font10">This gets the alignment value
208     for the outer table</td>
209    
210     <tr>
211     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_css'>get_css ( )</A></td>
212     <td CLASS="font10">This function provides the</td>
213    
214     <tr>
215     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>get_javascript ( )</A></td>
216     <td CLASS="font10">Function for returning the raw javascript
217     that is required for this widget.</td>
218    
219     <tr>
220     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_title'>get_title ( )</A></td>
221     <td CLASS="font10">Function for accessing the
222     title of this widget</td>
223    
224     <tr>
225     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_width'>get_width ( )</A></td>
226     <td CLASS="font10">Function for getting the current
227     widget width setting.</td>
228    
229     <tr>
230     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_align'>set_align ( $align )</A></td>
231     <td CLASS="font10">This function sets the align attribute
232     for the outer table.</td>
233    
234     <tr>
235     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_title'>set_title ( [$title = ] )</A></td>
236     <td CLASS="font10">Set the title for the widget.</td>
237    
238     <tr>
239     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $width )</A></td>
240     <td CLASS="font10">Set the width for the widget.</td>
241    
242     </table>
243     <br>
244     </TD>
245     </TR>
246    
247     <!-- =========== Summary =========== -->
248     <TR BGCOLOR='white' CLASS='TableRowColor'>
249     <TD>
250     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
251     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
252     <tr CLASS="tableheadingcolor">
253     <th>Function</th>
254     <th>Description</th>
255     </tr>
256    
257     <tr>
258     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
259     <td CLASS="font10">The constructor.</td>
260    
261     <tr>
262     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
263     <td CLASS="font10">add content onto content stack</td>
264    
265     <tr>
266     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
267     <td CLASS="font10">Add content onto content stack
268     so you can change the item later.</td>
269    
270     <tr>
271     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
272     <td CLASS="font10">counts the number of content objects</td>
273    
274     <tr>
275     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
276     <td CLASS="font10">This flag gets the current value
277     of the indent flag</td>
278    
279     <tr>
280     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
281     <td CLASS="font10">Same as add().</td>
282    
283     <tr>
284     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
285     <td CLASS="font10">Same as add_reference
286     NOTE : only exists for compatibility with 1.1.x</td>
287    
288     <tr>
289     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
290     <td CLASS="font10">This function is compatible with the
291     rest of the phpHtmllib API spec.</td>
292    
293     <tr>
294     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
295     <td CLASS="font10">destroy existing content and start with new content.</td>
296    
297     <tr>
298     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
299     <td CLASS="font10">This function turns on the collapse flag</td>
300    
301     <tr>
302     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
303     <td CLASS="font10">function to set the indent flag</td>
304    
305     </table>
306     <br>
307     </TD>
308     </TR>
309    
310     </TABLE>
311    
312     <hr>
313     <!-- should have constructor at some point -->
314     <!-- =========== Method SUMMARY =========== -->
315     <A NAME='Method_summary'><!-- --></A>
316     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
317     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
318     <TD>
319     <span class="font12bold">Method Summary</span>
320     <A HREF="#top" CLASS="links">^TOP</A>
321     </TD>
322     </TR>
323    
324    
325     <!-- =========== Summary =========== -->
326     <TR BGCOLOR='white' CLASS='TableRowColor'>
327     <TD>
328     <CODE><B><A HREF='TextCSSNav.html#constructor TextCSSNav'>void constructor TextCSSNav ( [$highlight_selected = FALSE] )</A></B></CODE>
329     <BR>
330     <blockquote> Constructor for this class
331     It just sets the width for the
332     widget. </blockquote>
333     </TD>
334     </TR>
335    
336     <!-- =========== Summary =========== -->
337     <TR BGCOLOR='white' CLASS='TableRowColor'>
338     <TD>
339     <CODE><B><A HREF='TextCSSNav.html#add'>void add ( $url, $text, $title, $target, [$selected = ""FALSE] )</A></B></CODE>
340     <BR>
341     <blockquote> this function adds a clickable link. </blockquote>
342     </TD>
343     </TR>
344    
345     <!-- =========== Summary =========== -->
346     <TR BGCOLOR='white' CLASS='TableRowColor'>
347     <TD>
348     <CODE><B><A HREF='TextCSSNav.html#add_blank'>void add_blank ( [$num = 1] )</A></B></CODE>
349     <BR>
350     <blockquote> This lets you add a blank entry
351     between 2 links </blockquote>
352     </TD>
353     </TR>
354    
355     <!-- =========== Summary =========== -->
356     <TR BGCOLOR='white' CLASS='TableRowColor'>
357     <TD>
358     <CODE><B><A HREF='TextCSSNav.html#add_text'>void add_text ( $text )</A></B></CODE>
359     <BR>
360     <blockquote> this adds a text item in the nav </blockquote>
361     </TD>
362     </TR>
363    
364     <!-- =========== Summary =========== -->
365     <TR BGCOLOR='white' CLASS='TableRowColor'>
366     <TD>
367     <CODE><B><A HREF='TextCSSNav.html#push'>void push ( $url, $text, $title, $target )</A></B></CODE>
368     <BR>
369     <blockquote> depricated version of add() </blockquote>
370     </TD>
371     </TR>
372    
373     <!-- =========== Summary =========== -->
374     <TR BGCOLOR='white' CLASS='TableRowColor'>
375     <TD>
376     <CODE><B><A HREF='TextCSSNav.html#push_blank'>void push_blank ( [$num = 1] )</A></B></CODE>
377     <BR>
378     <blockquote> depricated version of add_blank() </blockquote>
379     </TD>
380     </TR>
381    
382     <!-- =========== Summary =========== -->
383     <TR BGCOLOR='white' CLASS='TableRowColor'>
384     <TD>
385     <CODE><B><A HREF='TextCSSNav.html#push_text'>void push_text ( $text )</A></B></CODE>
386     <BR>
387     <blockquote> depricated version of add_text() </blockquote>
388     </TD>
389     </TR>
390    
391     <!-- =========== Summary =========== -->
392     <TR BGCOLOR='white' CLASS='TableRowColor'>
393     <TD>
394     <CODE><B><A HREF='TextCSSNav.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE>
395     <BR>
396     <blockquote> function that will render the widget. </blockquote>
397     </TD>
398     </TR>
399    
400     <!-- =========== Summary =========== -->
401     <TR BGCOLOR='white' CLASS='TableRowColor'>
402     <TD>
403     <CODE><B><A HREF='TextCSSNav.html#set_prefix'>void set_prefix ( $prefix )</A></B></CODE>
404     <BR>
405     <blockquote> This method is used to set the prefix for </blockquote>
406     </TD>
407     </TR>
408    
409     <!-- =========== Summary =========== -->
410     <TR BGCOLOR='white' CLASS='TableRowColor'>
411     <TD>
412     <CODE><B><A HREF='TextCSSNav.html#_build_links'>Container _build_links ( )</A></B></CODE>
413     <BR>
414     <blockquote> This function is used to build the links
415     to click on </blockquote>
416     </TD>
417     </TR>
418    
419     </TABLE>
420    
421     <hr>
422     <!-- ============ VARIABLE DETAIL =========== -->
423    
424     <A NAME='variable_detail'></A>
425     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
426     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
427     <TD>
428     <span CLASS="font12bold">Variable Detail</span>
429     <A HREF="#top" CLASS="links">^TOP</A>
430     </TD>
431     </TR>
432     </TABLE>
433    
434    
435     <A NAME='$_highlight_selected'><!-- --></A><H3>$_highlight_selected</H3>
436     <b>Data type:</b> mixed<br>
437     <!-- ========== Info from phpDoc block ========= -->
438     Flag to tell us that we can
439     highlight (css) the selected
440     link.
441     <BR>
442     This is off by default
443    
444     <UL>
445    
446     </UL>
447    
448     <HR>
449    
450     <A NAME='$_query_prefix'><!-- --></A><H3>$_query_prefix</H3>
451     <b>Data type:</b> mixed<br>
452     <!-- ========== Info from phpDoc block ========= -->
453     the prefix for the query string var
454     <BR>
455     so we can have multiple widgets
456     on the same page and have them
457     operate independantly
458    
459     <UL>
460    
461     </UL>
462    
463     <HR>
464    
465     <A NAME='$_selected'><!-- --></A><H3>$_selected</H3>
466     <b>Data type:</b> mixed<br>
467     <!-- ========== Info from phpDoc block ========= -->
468     Holds which one is auto selected
469     <BR>
470    
471    
472     <UL>
473    
474     </UL>
475    
476     <HR>
477    
478    
479     <hr>
480     <!-- ============ FUNCTION DETAIL =========== -->
481    
482     <A NAME='function_detail'></A>
483     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
484     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
485     <TD>
486     <span class="font12bold">Method Detail</span>
487     <A HREF="#top" CLASS="links">^TOP</A>
488     </TD>
489     </TR>
490     </TABLE>
491     <BR>
492    
493     <DIV CLASS="function">
494     <A NAME='constructor TextCSSNav'><!-- --></A>
495     <SPAN CLASS="font12bold">constructor TextCSSNav</SPAN>
496     <BR>
497     <SPAN CLASS="font10bold">Useage : </SPAN>
498     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
499     <span class="font10bold" style="color: #0000FF">constructor TextCSSNav ( [$highlight_selected = FALSE] )</SPAN>
500     <BR>
501    
502     <BR>
503     <SPAN CLASS="font10bold">Description : </SPAN>
504     <!-- ========== Info from phpDoc block ========= -->
505     Constructor for this class
506     It just sets the width for the
507     widget.
508     <BR>
509    
510     <DL>
511     <DT class="font10bold">Function Parameters:</DT>
512    
513     <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>
514    
515    
516     <DT class="font10bold">Function Info:</DT>
517    
518     </DL>
519    
520     </DIV>
521     <BR>
522    
523     <DIV CLASS="function">
524     <A NAME='add'><!-- --></A>
525     <SPAN CLASS="font12bold">add</SPAN>
526     <BR>
527     <SPAN CLASS="font10bold">Useage : </SPAN>
528     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
529     <span class="font10bold" style="color: #0000FF">add ( $url, $text, $title, $target, [$selected = ""FALSE] )</SPAN>
530     <BR>
531    
532     <BR>
533     <SPAN CLASS="font10bold">Description : </SPAN>
534     <!-- ========== Info from phpDoc block ========= -->
535     this function adds a clickable link.
536     <BR>
537     It automatically adds the link based on $url,
538     with $text as the viewable text.
539     <DL>
540     <DT class="font10bold">Function Parameters:</DT>
541    
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">$url</SPAN></SPAN> - the url for the link</DD>
543    
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">$text</SPAN></SPAN> - the link text</DD>
545    
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">$title</SPAN></SPAN> - the title text</DD>
547    
548     <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>
549    
550    
551     <DT class="font10bold">Function Info:</DT>
552    
553     </DL>
554    
555     </DIV>
556     <BR>
557    
558     <DIV CLASS="function">
559     <A NAME='add_blank'><!-- --></A>
560     <SPAN CLASS="font12bold">add_blank</SPAN>
561     <BR>
562     <SPAN CLASS="font10bold">Useage : </SPAN>
563     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
564     <span class="font10bold" style="color: #0000FF">add_blank ( [$num = 1] )</SPAN>
565     <BR>
566    
567     <BR>
568     <SPAN CLASS="font10bold">Description : </SPAN>
569     <!-- ========== Info from phpDoc block ========= -->
570     This lets you add a blank entry
571     between 2 links
572     <BR>
573    
574     <DL>
575     <DT class="font10bold">Function Parameters:</DT>
576    
577     <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>
578    
579    
580     <DT class="font10bold">Function Info:</DT>
581    
582     </DL>
583    
584     </DIV>
585     <BR>
586    
587     <DIV CLASS="function">
588     <A NAME='add_text'><!-- --></A>
589     <SPAN CLASS="font12bold">add_text</SPAN>
590     <BR>
591     <SPAN CLASS="font10bold">Useage : </SPAN>
592     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
593     <span class="font10bold" style="color: #0000FF">add_text ( $text )</SPAN>
594     <BR>
595    
596     <BR>
597     <SPAN CLASS="font10bold">Description : </SPAN>
598     <!-- ========== Info from phpDoc block ========= -->
599     this adds a text item in the nav
600     <BR>
601    
602     <DL>
603     <DT class="font10bold">Function Parameters:</DT>
604    
605     <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>
606    
607    
608     <DT class="font10bold">Function Info:</DT>
609    
610     </DL>
611    
612     </DIV>
613     <BR>
614    
615     <DIV CLASS="function">
616     <A NAME='push'><!-- --></A>
617     <SPAN CLASS="font12bold">push</SPAN>
618     <BR>
619     <SPAN CLASS="font10bold">Useage : </SPAN>
620     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
621     <span class="font10bold" style="color: #0000FF">push ( $url, $text, $title, $target )</SPAN>
622     <BR>
623    
624     <BR>
625     <SPAN CLASS="font10bold">Description : </SPAN>
626     <!-- ========== Info from phpDoc block ========= -->
627     depricated version of add()
628     <BR>
629    
630     <DL>
631     <DT class="font10bold">Function Parameters:</DT>
632    
633    
634     <DT class="font10bold">Function Info:</DT>
635    
636     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add() instead</DD>
637    
638     </DL>
639    
640     </DIV>
641     <BR>
642    
643     <DIV CLASS="function">
644     <A NAME='push_blank'><!-- --></A>
645     <SPAN CLASS="font12bold">push_blank</SPAN>
646     <BR>
647     <SPAN CLASS="font10bold">Useage : </SPAN>
648     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
649     <span class="font10bold" style="color: #0000FF">push_blank ( [$num = 1] )</SPAN>
650     <BR>
651    
652     <BR>
653     <SPAN CLASS="font10bold">Description : </SPAN>
654     <!-- ========== Info from phpDoc block ========= -->
655     depricated version of add_blank()
656     <BR>
657    
658     <DL>
659     <DT class="font10bold">Function Parameters:</DT>
660    
661    
662     <DT class="font10bold">Function Info:</DT>
663    
664     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add_blank() instead</DD>
665    
666     </DL>
667    
668     </DIV>
669     <BR>
670    
671     <DIV CLASS="function">
672     <A NAME='push_text'><!-- --></A>
673     <SPAN CLASS="font12bold">push_text</SPAN>
674     <BR>
675     <SPAN CLASS="font10bold">Useage : </SPAN>
676     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
677     <span class="font10bold" style="color: #0000FF">push_text ( $text )</SPAN>
678     <BR>
679    
680     <BR>
681     <SPAN CLASS="font10bold">Description : </SPAN>
682     <!-- ========== Info from phpDoc block ========= -->
683     depricated version of add_text()
684     <BR>
685    
686     <DL>
687     <DT class="font10bold">Function Parameters:</DT>
688    
689    
690     <DT class="font10bold">Function Info:</DT>
691    
692     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add_text() instead</DD>
693    
694     </DL>
695    
696     </DIV>
697     <BR>
698    
699     <DIV CLASS="function">
700     <A NAME='render'><!-- --></A>
701     <SPAN CLASS="font12bold">render</SPAN>
702     <BR>
703     <SPAN CLASS="font10bold">Useage : </SPAN>
704     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
705     <span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN>
706     <BR>
707    
708     <BR>
709     <SPAN CLASS="font10bold">Description : </SPAN>
710     <!-- ========== Info from phpDoc block ========= -->
711     function that will render the widget.
712     <BR>
713    
714     <DL>
715     <DT class="font10bold">Function Parameters:</DT>
716    
717     <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
718     the container.</DD>
719    
720     <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
721     maintain compatibility w/ the API.</DD>
722    
723    
724     <DT class="font10bold">Function Info:</DT>
725    
726     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD>
727    
728     </DL>
729    
730     </DIV>
731     <BR>
732    
733     <DIV CLASS="function">
734     <A NAME='set_prefix'><!-- --></A>
735     <SPAN CLASS="font12bold">set_prefix</SPAN>
736     <BR>
737     <SPAN CLASS="font10bold">Useage : </SPAN>
738     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
739     <span class="font10bold" style="color: #0000FF">set_prefix ( $prefix )</SPAN>
740     <BR>
741    
742     <BR>
743     <SPAN CLASS="font10bold">Description : </SPAN>
744     <!-- ========== Info from phpDoc block ========= -->
745     This method is used to set the prefix for
746     <BR>
747     the widget so someone can have multiple
748     widgets on the same page and have them
749     operate independantly
750     <DL>
751     <DT class="font10bold">Function Parameters:</DT>
752    
753     <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>
754    
755    
756     <DT class="font10bold">Function Info:</DT>
757    
758     </DL>
759    
760     </DIV>
761     <BR>
762    
763     <DIV CLASS="function">
764     <A NAME='_build_links'><!-- --></A>
765     <SPAN CLASS="font12bold">_build_links</SPAN>
766     <BR>
767     <SPAN CLASS="font10bold">Useage : </SPAN>
768     <span class="font10bold" style="color: #FF0000">Container</SPAN>&nbsp;
769     <span class="font10bold" style="color: #0000FF">_build_links ( )</SPAN>
770     <BR>
771    
772     <BR>
773     <SPAN CLASS="font10bold">Description : </SPAN>
774     <!-- ========== Info from phpDoc block ========= -->
775     This function is used to build the links
776     to click on
777     <BR>
778    
779     <DL>
780     <DT class="font10bold">Function Parameters:</DT>
781    
782    
783     <DT class="font10bold">Function Info:</DT>
784    
785     </DL>
786    
787     </DIV>
788     <BR>
789    
790    
791     <hr>
792     </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed