?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
The real release 0.46 :-)
[awl.git] / docs / api / awl / MenuSet / MenuOption.html
blob63d16d0f1c0b2eceef75fd37fd37003147754401
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 MenuOption</title>
7 <link rel="stylesheet" href="../../media/stylesheet.css" />
8 <script src="../../media/lib/classTree.js"></script>
9 <script language="javascript" type="text/javascript">
10 var imgPlus = new Image();
11 var imgMinus = new Image();
12 imgPlus.src = "../../media/images/plus.png";
13 imgMinus.src = "../../media/images/minus.png";
14
15 function showNode(Node){
16 switch(navigator.family){
17 case 'nn4':
18 // Nav 4.x code fork...
19 var oTable = document.layers["span" + Node];
20 var oImg = document.layers["img" + Node];
21 break;
22 case 'ie4':
23 // IE 4/5 code fork...
24 var oTable = document.all["span" + Node];
25 var oImg = document.all["img" + Node];
26 break;
27 case 'gecko':
28 // Standards Compliant code fork...
29 var oTable = document.getElementById("span" + Node);
30 var oImg = document.getElementById("img" + Node);
31 break;
32 }
33 oImg.src = imgMinus.src;
34 oTable.style.display = "block";
35 }
36
37 function hideNode(Node){
38 switch(navigator.family){
39 case 'nn4':
40 // Nav 4.x code fork...
41 var oTable = document.layers["span" + Node];
42 var oImg = document.layers["img" + Node];
43 break;
44 case 'ie4':
45 // IE 4/5 code fork...
46 var oTable = document.all["span" + Node];
47 var oImg = document.all["img" + Node];
48 break;
49 case 'gecko':
50 // Standards Compliant code fork...
51 var oTable = document.getElementById("span" + Node);
52 var oImg = document.getElementById("img" + Node);
53 break;
54 }
55 oImg.src = imgPlus.src;
56 oTable.style.display = "none";
57 }
58
59 function nodeIsVisible(Node){
60 switch(navigator.family){
61 case 'nn4':
62 // Nav 4.x code fork...
63 var oTable = document.layers["span" + Node];
64 break;
65 case 'ie4':
66 // IE 4/5 code fork...
67 var oTable = document.all["span" + Node];
68 break;
69 case 'gecko':
70 // Standards Compliant code fork...
71 var oTable = document.getElementById("span" + Node);
72 break;
73 }
74 return (oTable && oTable.style.display == "block");
75 }
76
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
79 hideNode(Node);
80 }else{
81 showNode(Node);
82 }
83 }
84 </script>
85 </head>
86 <body>
87 <div class="page-body">
88 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
89 alt=" Class"
90 title=" Class"
91 style="vertical-align: middle"> MenuOption</h2>
92
93 <a name="sec-description"></a>
94 <div class="info-box">
95 <div class="info-box-title">Description</div>
96 <div class="nav-bar">
97 <span class="disabled">Description</span> |
98 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
99 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
100
101 </div>
102 <div class="info-box-body">
103 <!-- ========== Info from phpDoc block ========= -->
104 <p class="short-description">Each menu option is an object.</p>
105 <p class="notes">
106 Located in <a class="field" href="_MenuSet.php.html">/MenuSet.php</a> (line <span class="field">21</span>)
107 </p>
108
109
110 <pre></pre>
111
112 </div>
113 </div>
114
115
116
117 <a name="sec-var-summary"></a>
118 <div class="info-box">
119 <div class="info-box-title">Variable Summary</span></div>
120 <div class="nav-bar">
121 <a href="#sec-description">Description</a> |
122 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
123 |
124 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
125
126 </div>
127 <div class="info-box-body">
128 <div class="var-summary">
129 <div class="var-title">
130 <img src="../../media/images/Variable.png" alt=" " />
131 <span class="var-type">string</span>
132 <a href="#$rendered" title="details" class="var-name">$rendered</a>
133 </div>
134 <div class="var-title">
135 <img src="../../media/images/Variable.png" alt=" " />
136 <span class="var-type">reference</span>
137 <a href="#$self" title="details" class="var-name">$self</a>
138 </div>
139 </div>
140 </div>
141 </div>
142
143 <a name="sec-method-summary"></a>
144 <div class="info-box">
145 <div class="info-box-title">Method Summary</span></div>
146 <div class="nav-bar">
147 <a href="#sec-description">Description</a> |
148 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
149
150 |
151 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
152 </div>
153 <div class="info-box-body">
154 <div class="method-summary">
155
156 <div class="method-definition">
157 <img src="../../media/images/Constructor.png" alt=" "/>
158 <span class="method-result">MenuOption</span>
159 <a href="#MenuOption" title="details" class="method-name">MenuOption</a>
160 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$target</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$style</span> = <span class="var-default">&quot;menu&quot;</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$sortkey</span> = <span class="var-default">1000</span>])
161 </div>
162
163 <div class="method-definition">
164 <img src="../../media/images/Method.png" alt=" "/>
165 <span class="method-result">void</span>
166 <a href="#Active" title="details" class="method-name">Active</a>
167 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$style</span> = <span class="var-default">false</span>])
168 </div>
169
170 <div class="method-definition">
171 <img src="../../media/images/Method.png" alt=" "/>
172 <span class="method-result">void</span>
173 <a href="#AddSubmenu" title="details" class="method-name">AddSubmenu</a>
174 (<span class="var-type"></span>&nbsp;<span class="var-name">&$submenu_set</span>)
175 </div>
176
177 <div class="method-definition">
178 <img src="../../media/images/Method.png" alt=" "/>
179 <span class="method-result">boolean</span>
180 <a href="#IsActive" title="details" class="method-name">IsActive</a>
181 ()
182 </div>
183
184 <div class="method-definition">
185 <img src="../../media/images/Method.png" alt=" "/>
186 <span class="method-result">boolean</span>
187 <a href="#MaybeActive" title="details" class="method-name">MaybeActive</a>
188 (<span class="var-type"></span>&nbsp;<span class="var-name">$test_pattern</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$active_style</span>)
189 </div>
190
191 <div class="method-definition">
192 <img src="../../media/images/Method.png" alt=" "/>
193 <span class="method-result">string</span>
194 <a href="#Render" title="details" class="method-name">Render</a>
195 ()
196 </div>
197
198 <div class="method-definition">
199 <img src="../../media/images/Method.png" alt=" "/>
200 <span class="method-result">void</span>
201 <a href="#Set" title="details" class="method-name">Set</a>
202 (<span class="var-type">string</span>&nbsp;<span class="var-name">$attribute</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
203 </div>
204 </div>
205 </div>
206 </div>
207
208 <a name="sec-vars"></a>
209 <div class="info-box">
210 <div class="info-box-title">Variables</div>
211 <div class="nav-bar">
212 <a href="#sec-description">Description</a> |
213 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
214
215
216 |
217 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
218
219 </div>
220 <div class="info-box-body">
221
222 <a name="var$rendered" id="$rendered"><!-- --></A>
223 <div class="oddrow">
224
225 <div class="var-header">
226 <img src="../../media/images/Variable.png" />
227 <span class="var-title">
228 <span class="var-type">string</span>
229 <span class="var-name">$rendered</span>
230 (line <span class="line-number">81</span>)
231 </span>
232 </div>
233
234 <!-- ========== Info from phpDoc block ========= -->
235 <p class="short-description">The rendered HTML fragment (once it has been).</p>
236 <ul class="tags">
237 <li><span class="field">access:</span> public</li>
238 </ul>
239
240
241
242
243
244 </div>
245 <a name="var$self" id="$self"><!-- --></A>
246 <div class="evenrow">
247
248 <div class="var-header">
249 <img src="../../media/images/Variable.png" />
250 <span class="var-title">
251 <span class="var-type">reference</span>
252 <span class="var-name">$self</span>
253 (line <span class="line-number">72</span>)
254 </span>
255 </div>
256
257 <!-- ========== Info from phpDoc block ========= -->
258 <p class="short-description">A reference to this menu option itself</p>
259
260
261
262
263
264 </div>
265
266 </div>
267 </div>
268
269 <a name="sec-methods"></a>
270 <div class="info-box">
271 <div class="info-box-title">Methods</div>
272 <div class="nav-bar">
273 <a href="#sec-description">Description</a> |
274 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
275 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
276
277 </div>
278 <div class="info-box-body">
279 <A NAME='method_detail'></A>
280 <a name="methodMenuOption" id="MenuOption"><!-- --></a>
281 <div class="oddrow">
282
283 <div class="method-header">
284 <img src="../../media/images/Constructor.png" />
285 <span class="method-title">Constructor MenuOption</span> (line <span class="line-number">92</span>)
286 </div>
287
288 <!-- ========== Info from phpDoc block ========= -->
289 <p class="short-description">The thing we click</p>
290
291 <div class="method-signature">
292 <span class="method-result">MenuOption</span>
293 <span class="method-name">
294 MenuOption
295 </span>
296 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$target</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$style</span> = <span class="var-default">&quot;menu&quot;</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$sortkey</span> = <span class="var-default">1000</span>])
297 </div>
298
299 <ul class="parameters">
300 <li>
301 <span class="var-type">string</span>
302 <span class="var-name">$label</span><span class="var-description">: The label to display for this option.</span> </li>
303 <li>
304 <span class="var-type">string</span>
305 <span class="var-name">$target</span><span class="var-description">: The URL to target for this option.</span> </li>
306 <li>
307 <span class="var-type">string</span>
308 <span class="var-name">$title</span><span class="var-description">: Some tooltip help for the title tag.</span> </li>
309 <li>
310 <span class="var-type">string</span>
311 <span class="var-name">$style</span><span class="var-description">: A base class name for this option.</span> </li>
312 <li>
313 <span class="var-type">int</span>
314 <span class="var-name">$sortkey</span><span class="var-description">: An (optional) value to allow option ordering.</span> </li>
315 </ul>
316
317
318 </div>
319 <a name="methodActive" id="Active"><!-- --></a>
320 <div class="evenrow">
321
322 <div class="method-header">
323 <img src="../../media/images/Method.png" />
324 <span class="method-title">Active</span> (line <span class="line-number">139</span>)
325 </div>
326
327 <!-- ========== Info from phpDoc block ========= -->
328 <p class="short-description">Mark it as active, with a fancy style to distinguish that</p>
329
330 <div class="method-signature">
331 <span class="method-result">void</span>
332 <span class="method-name">
333 Active
334 </span>
335 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$style</span> = <span class="var-default">false</span>])
336 </div>
337
338 <ul class="parameters">
339 <li>
340 <span class="var-type">string</span>
341 <span class="var-name">$style</span><span class="var-description">: A style used to highlight that the option is active.</span> </li>
342 </ul>
343
344
345 </div>
346 <a name="methodAddSubmenu" id="AddSubmenu"><!-- --></a>
347 <div class="oddrow">
348
349 <div class="method-header">
350 <img src="../../media/images/Method.png" />
351 <span class="method-title">AddSubmenu</span> (line <span class="line-number">147</span>)
352 </div>
353
354 <!-- ========== Info from phpDoc block ========= -->
355 <p class="short-description">This menu option is now promoted to the head of a tree</p>
356
357 <div class="method-signature">
358 <span class="method-result">void</span>
359 <span class="method-name">
360 AddSubmenu
361 </span>
362 (<span class="var-type"></span>&nbsp;<span class="var-name">&$submenu_set</span>)
363 </div>
364
365 <ul class="parameters">
366 <li>
367 <span class="var-type"></span>
368 <span class="var-name">&$submenu_set</span> </li>
369 </ul>
370
371
372 </div>
373 <a name="methodIsActive" id="IsActive"><!-- --></a>
374 <div class="evenrow">
375
376 <div class="method-header">
377 <img src="../../media/images/Method.png" />
378 <span class="method-title">IsActive</span> (line <span class="line-number">155</span>)
379 </div>
380
381 <!-- ========== Info from phpDoc block ========= -->
382 <p class="short-description">Whether this option is currently active.</p>
383 <ul class="tags">
384 <li><span class="field">return:</span> The value of the active flag.</li>
385 </ul>
386
387 <div class="method-signature">
388 <span class="method-result">boolean</span>
389 <span class="method-name">
390 IsActive
391 </span>
392 ()
393 </div>
394
395
396
397 </div>
398 <a name="methodMaybeActive" id="MaybeActive"><!-- --></a>
399 <div class="oddrow">
400
401 <div class="method-header">
402 <img src="../../media/images/Method.png" />
403 <span class="method-title">MaybeActive</span> (line <span class="line-number">163</span>)
404 </div>
405
406 <!-- ========== Info from phpDoc block ========= -->
407 <p class="short-description">Whether this option is currently active.</p>
408 <ul class="tags">
409 <li><span class="field">return:</span> The value of the active flag.</li>
410 </ul>
411
412 <div class="method-signature">
413 <span class="method-result">boolean</span>
414 <span class="method-name">
415 MaybeActive
416 </span>
417 (<span class="var-type"></span>&nbsp;<span class="var-name">$test_pattern</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$active_style</span>)
418 </div>
419
420 <ul class="parameters">
421 <li>
422 <span class="var-type"></span>
423 <span class="var-name">$test_pattern</span> </li>
424 <li>
425 <span class="var-type"></span>
426 <span class="var-name">$active_style</span> </li>
427 </ul>
428
429
430 </div>
431 <a name="methodRender" id="Render"><!-- --></a>
432 <div class="evenrow">
433
434 <div class="method-header">
435 <img src="../../media/images/Method.png" />
436 <span class="method-title">Render</span> (line <span class="line-number">109</span>)
437 </div>
438
439 <!-- ========== Info from phpDoc block ========= -->
440 <p class="short-description">Convert the menu option into an HTML string</p>
441 <ul class="tags">
442 <li><span class="field">return:</span> The HTML fragment for the menu option.</li>
443 </ul>
444
445 <div class="method-signature">
446 <span class="method-result">string</span>
447 <span class="method-name">
448 Render
449 </span>
450 ()
451 </div>
452
453
454
455 </div>
456 <a name="methodSet" id="Set"><!-- --></a>
457 <div class="oddrow">
458
459 <div class="method-header">
460 <img src="../../media/images/Method.png" />
461 <span class="method-title">Set</span> (line <span class="line-number">131</span>)
462 </div>
463
464 <!-- ========== Info from phpDoc block ========= -->
465 <p class="short-description">Set arbitrary attributes of the menu option</p>
466
467 <div class="method-signature">
468 <span class="method-result">void</span>
469 <span class="method-name">
470 Set
471 </span>
472 (<span class="var-type">string</span>&nbsp;<span class="var-name">$attribute</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
473 </div>
474
475 <ul class="parameters">
476 <li>
477 <span class="var-type">string</span>
478 <span class="var-name">$attribute</span><span class="var-description">: An arbitrary attribute to be set in the hyperlink.</span> </li>
479 <li>
480 <span class="var-type">string</span>
481 <span class="var-name">$value</span><span class="var-description">: A value for this attribute.</span> </li>
482 </ul>
483
484
485 </div>
486
487 </div>
488 </div>
489
490
491 <p class="notes" id="credit">
492 Documentation generated on Tue, 28 Dec 2010 02:01:36 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
493 </p>
494 </div></body>
495 </html>
Andrew's Web Libraries