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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.4 - (show annotations)
Thu May 6 16:24:24 2004 UTC (20 years, 2 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.3: +566 -570 lines
File MIME type: text/html
 updated all to v2.4.1 - Apr 01, 2004

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

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed