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