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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (show annotations)
Sat Sep 20 00:24:04 2003 UTC (20 years, 11 months ago) by jonen
Branch: MAIN
Changes since 1.2: +481 -573 lines
File MIME type: text/html
+ updated whole phphtmllib to v2.3.0

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 TextNav</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 <h2 class="class-name">Class TextNav</h2>
13
14 <a name="sec-description"></a>
15 <div class="info-box">
16 <div class="info-box-title">Description</div>
17 <div class="nav-bar">
18 <span class="disabled">Description</span> |
19 <a href="#sec-vars">Vars</a>
20 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
21
22 </div>
23 <div class="info-box-body">
24 <!-- ========== Info from phpDoc block ========= -->
25 <p class="short-description">This class builds a simple text navigational widget.</p>
26 <ul class="tags">
27 <li><span class="field">author:</span> <p>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</p></li>
28 </ul>
29 <p class="notes">
30 Located in <a class="field" href="_widgets_TextNav_inc.html">Program_Root/widgets/TextNav.inc</a> (line <span class="field">24</span>)
31 </p>
32
33
34 <pre><a href="../phpHtmlLib/Container.html">Container</a>
35 |
36 --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
37 |
38 --TextNav</pre>
39
40 </div>
41 </div>
42
43
44
45 <a name="sec-method-summary"></a>
46 <div class="info-box">
47 <div class="info-box-title">Method Summary</span></div>
48 <div class="nav-bar">
49 <a href="#sec-description">Description</a> |
50 <a href="#sec-vars">Vars</a>
51
52 |
53 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
54 </div>
55 <div class="info-box-body">
56 <div class="method-summary">
57
58 <div class="method-definition">
59 <span class="method-result">void</span>
60 <a href="#TextNav" title="details" class="method-name">TextNav</a>
61 ([<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">760</span>])
62 </div>
63
64 <div class="method-definition">
65 <span class="method-result">void</span>
66 <a href="#add" title="details" class="method-name">add</a>
67 (<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">$width</span> = <span class="var-default">100</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span> = <span class="var-default">NULL</span>])
68 </div>
69
70 <div class="method-definition">
71 <span class="method-result">void</span>
72 <a href="#add_blank" title="details" class="method-name">add_blank</a>
73 ([<span class="var-type">int</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])
74 </div>
75
76 <div class="method-definition">
77 <span class="method-result">void</span>
78 <a href="#add_text" title="details" class="method-name">add_text</a>
79 (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
80 </div>
81
82 <div class="method-definition">
83 <span class="method-result">void</span>
84 <a href="#build_img_td" title="details" class="method-name">build_img_td</a>
85 ()
86 </div>
87
88 <div class="method-definition">
89 <span class="method-result">void</span>
90 <a href="#build_nav_td" title="details" class="method-name">build_nav_td</a>
91 (<span class="var-type">array</span>&nbsp;<span class="var-name">$nav</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$count</span>)
92 </div>
93
94 <div class="method-definition">
95 <span class="method-result">void</span>
96 <a href="#push" title="details" class="method-name">push</a>
97 (<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">$width</span> = <span class="var-default">100</span>])
98 </div>
99
100 <div class="method-definition">
101 <span class="method-result">void</span>
102 <a href="#push_blank" title="details" class="method-name">push_blank</a>
103 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])
104 </div>
105
106 <div class="method-definition">
107 <span class="method-result">void</span>
108 <a href="#push_text" title="details" class="method-name">push_text</a>
109 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>)
110 </div>
111
112 <div class="method-definition">
113 <span class="method-result">string</span>
114 <a href="#render" title="details" class="method-name">render</a>
115 ([<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>)
116 </div>
117 </div>
118 </div>
119 </div>
120
121 <a name="sec-vars"></a>
122 <div class="info-box">
123 <div class="info-box-title">Variables</div>
124 <div class="nav-bar">
125 <a href="#sec-description">Description</a> |
126 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
127
128
129 |
130 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
131
132 </div>
133 <div class="info-box-body">
134 <h4>Inherited Variables</h4>
135 <A NAME='inherited_vars'><!-- --></A>
136 <p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
137 <blockquote>
138 <span class="var-title">
139 <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>
140 </span>
141 <span class="var-title">
142 <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>
143 </span>
144 </blockquote>
145 <p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
146 <blockquote>
147 <span class="var-title">
148 <span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br>
149 </span>
150 </blockquote>
151
152 </div>
153 </div>
154
155 <a name="sec-methods"></a>
156 <div class="info-box">
157 <div class="info-box-title">Methods</div>
158 <div class="nav-bar">
159 <a href="#sec-description">Description</a> |
160 <a href="#sec-vars">Vars</a>
161 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
162
163 </div>
164 <div class="info-box-body">
165 <A NAME='method_detail'></A>
166 <a name="methodTextNav" id="TextNav"><!-- --></a>
167 <div class="evenrow">
168
169 <div class="method-header">
170 <span class="method-title">Constructor TextNav</span> (line <span class="line-number">34</span>)
171 </div>
172
173 <!-- ========== Info from phpDoc block ========= -->
174 <p class="short-description">Constructor for this class It just sets the width for the widget.</p>
175
176 <div class="method-signature">
177 <span class="method-result">void</span>
178 <span class="method-name">
179 TextNav
180 </span>
181 ([<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">760</span>])
182 </div>
183
184 <ul class="parameters">
185 <li>
186 <span class="var-type">int</span>
187 <span class="var-name">$width</span><span class="var-description">: <p>- the width of the widget</p></span> </li>
188 </ul>
189
190
191 </div>
192 <a name="methodadd" id="add"><!-- --></a>
193 <div class="oddrow">
194
195 <div class="method-header">
196 <span class="method-title">add</span> (line <span class="line-number">86</span>)
197 </div>
198
199 <!-- ========== Info from phpDoc block ========= -->
200 <p class="short-description">this function adds a clickable link.</p>
201 <p class="description"><p>It automatically adds the link based on $url, with $text as the viewable text.</p></p>
202
203 <div class="method-signature">
204 <span class="method-result">void</span>
205 <span class="method-name">
206 add
207 </span>
208 (<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">$width</span> = <span class="var-default">100</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span> = <span class="var-default">NULL</span>])
209 </div>
210
211 <ul class="parameters">
212 <li>
213 <span class="var-type">string</span>
214 <span class="var-name">$url</span><span class="var-description">: <p>- the url for the link</p></span> </li>
215 <li>
216 <span class="var-type">string</span>
217 <span class="var-name">$text</span><span class="var-description">: <p>- the link text</p></span> </li>
218 <li>
219 <span class="var-type">string</span>
220 <span class="var-name">$width</span><span class="var-description">: <p>- the width of the cell</p></span> </li>
221 <li>
222 <span class="var-type">string</span>
223 <span class="var-name">$target</span><span class="var-description">: <p>- the target for the url</p></span> </li>
224 </ul>
225
226 <hr class="separator" />
227 <div class="notes">Redefinition of:</div>
228 <dl>
229 <dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt>
230 <dd>add content onto content stack</dd>
231 </dl>
232
233 </div>
234 <a name="methodadd_blank" id="add_blank"><!-- --></a>
235 <div class="evenrow">
236
237 <div class="method-header">
238 <span class="method-title">add_blank</span> (line <span class="line-number">107</span>)
239 </div>
240
241 <!-- ========== Info from phpDoc block ========= -->
242 <p class="short-description">This lets you add a blank entry between 2 links</p>
243
244 <div class="method-signature">
245 <span class="method-result">void</span>
246 <span class="method-name">
247 add_blank
248 </span>
249 ([<span class="var-type">int</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])
250 </div>
251
252 <ul class="parameters">
253 <li>
254 <span class="var-type">int</span>
255 <span class="var-name">$num</span><span class="var-description">: <p>- the # of blank lines to insert</p></span> </li>
256 </ul>
257
258
259 </div>
260 <a name="methodadd_text" id="add_text"><!-- --></a>
261 <div class="oddrow">
262
263 <div class="method-header">
264 <span class="method-title">add_text</span> (line <span class="line-number">126</span>)
265 </div>
266
267 <!-- ========== Info from phpDoc block ========= -->
268 <p class="short-description">this adds a text item in the nav</p>
269
270 <div class="method-signature">
271 <span class="method-result">void</span>
272 <span class="method-name">
273 add_text
274 </span>
275 (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
276 </div>
277
278 <ul class="parameters">
279 <li>
280 <span class="var-type">string</span>
281 <span class="var-name">$text</span><span class="var-description">: <p>- the text to display</p></span> </li>
282 </ul>
283
284
285 </div>
286 <a name="methodbuild_img_td" id="build_img_td"><!-- --></a>
287 <div class="evenrow">
288
289 <div class="method-header">
290 <span class="method-title">build_img_td</span> (line <span class="line-number">174</span>)
291 </div>
292
293 <!-- ========== Info from phpDoc block ========= -->
294 <p class="short-description">build the image seperator td</p>
295
296 <div class="method-signature">
297 <span class="method-result">void</span>
298 <span class="method-name">
299 build_img_td
300 </span>
301 ()
302 </div>
303
304
305
306 </div>
307 <a name="methodbuild_nav_td" id="build_nav_td"><!-- --></a>
308 <div class="oddrow">
309
310 <div class="method-header">
311 <span class="method-title">build_nav_td</span> (line <span class="line-number">147</span>)
312 </div>
313
314 <!-- ========== Info from phpDoc block ========= -->
315 <p class="short-description">build a td for the link.</p>
316
317 <div class="method-signature">
318 <span class="method-result">void</span>
319 <span class="method-name">
320 build_nav_td
321 </span>
322 (<span class="var-type">array</span>&nbsp;<span class="var-name">$nav</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$count</span>)
323 </div>
324
325 <ul class="parameters">
326 <li>
327 <span class="var-type">array</span>
328 <span class="var-name">$nav</span><span class="var-description">: <p>- the nav array entry</p></span> </li>
329 <li>
330 <span class="var-type">int</span>
331 <span class="var-name">$count</span><span class="var-description">: <p>- the column # this entry is</p></span> </li>
332 </ul>
333
334
335 </div>
336 <a name="methodpush" id="push"><!-- --></a>
337 <div class="evenrow">
338
339 <div class="method-header">
340 <span class="method-title">push</span> (line <span class="line-number">97</span>)
341 </div>
342
343 <!-- ========== Info from phpDoc block ========= -->
344 <p class="short-description">depricated version of add()</p>
345 <ul class="tags">
346 <li><span class="field">deprecated:</span> <p>- use add() instead</p></li>
347 </ul>
348
349 <div class="method-signature">
350 <span class="method-result">void</span>
351 <span class="method-name">
352 push
353 </span>
354 (<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">$width</span> = <span class="var-default">100</span>])
355 </div>
356
357
358 <hr class="separator" />
359 <div class="notes">Redefinition of:</div>
360 <dl>
361 <dt><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></dt>
362 <dd>Same as add().</dd>
363 </dl>
364
365 </div>
366 <a name="methodpush_blank" id="push_blank"><!-- --></a>
367 <div class="oddrow">
368
369 <div class="method-header">
370 <span class="method-title">push_blank</span> (line <span class="line-number">117</span>)
371 </div>
372
373 <!-- ========== Info from phpDoc block ========= -->
374 <p class="short-description">depricated version of add_blank()</p>
375 <ul class="tags">
376 <li><span class="field">deprecated:</span> <p>- use add_blank() instead</p></li>
377 </ul>
378
379 <div class="method-signature">
380 <span class="method-result">void</span>
381 <span class="method-name">
382 push_blank
383 </span>
384 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])
385 </div>
386
387
388
389 </div>
390 <a name="methodpush_text" id="push_text"><!-- --></a>
391 <div class="evenrow">
392
393 <div class="method-header">
394 <span class="method-title">push_text</span> (line <span class="line-number">135</span>)
395 </div>
396
397 <!-- ========== Info from phpDoc block ========= -->
398 <p class="short-description">depricated version of add_text()</p>
399 <ul class="tags">
400 <li><span class="field">deprecated:</span> <p>- use add_text() instead</p></li>
401 </ul>
402
403 <div class="method-signature">
404 <span class="method-result">void</span>
405 <span class="method-name">
406 push_text
407 </span>
408 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>)
409 </div>
410
411
412
413 </div>
414 <a name="methodrender" id="render"><!-- --></a>
415 <div class="oddrow">
416
417 <div class="method-header">
418 <span class="method-title">render</span> (line <span class="line-number">50</span>)
419 </div>
420
421 <!-- ========== Info from phpDoc block ========= -->
422 <p class="short-description">function that will render the widget.</p>
423 <ul class="tags">
424 <li><span class="field">return:</span> <p>the raw html output.</p></li>
425 </ul>
426
427 <div class="method-signature">
428 <span class="method-result">string</span>
429 <span class="method-name">
430 render
431 </span>
432 ([<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>)
433 </div>
434
435 <ul class="parameters">
436 <li>
437 <span class="var-type">int</span>
438 <span class="var-name">$indent_level</span><span class="var-description">: <p>- the indentation level for the container.</p></span> </li>
439 <li>
440 <span class="var-type">int</span>
441 <span class="var-name">$output_debug</span><span class="var-description">: <p>- the output debug flag to maintain compatibility w/ the API.</p></span> </li>
442 </ul>
443
444 <hr class="separator" />
445 <div class="notes">Redefinition of:</div>
446 <dl>
447 <dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>
448 <dd>This function is compatible with the rest of the phpHtmllib API spec.</dd>
449 </dl>
450
451 </div>
452 <h4>Inherited Methods</h4>
453 <a name='inherited_methods'><!-- --></a>
454 <!-- =========== Summary =========== -->
455 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
456 <blockquote>
457 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>
458 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>
459 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>
460 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>
461 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br>
462 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br>
463 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>
464 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>
465 </blockquote>
466 <!-- =========== Summary =========== -->
467 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
468 <blockquote>
469 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
470 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
471 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
472 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
473 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
474 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
475 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
476 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
477 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
478 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
479 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
480 <span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br>
481 </blockquote>
482
483 </div>
484 </div>
485
486 <p class="notes" id="credit">
487 Documention generated on Thu, 31 Jul 2003 18:33:51 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
488 </p>
489 </div></body>
490 </html>

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