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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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