?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Release 0.52
[awl.git] / docs / api / awl / MenuSet / _MenuSet.php.html
blobc3340d47fc6b1a9622b773f5525efe49740428b8
1
2 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
3 <?xml version="1.0" encoding="iso-8859-1"?>
4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <!-- template designed by Marco Von Ballmoos -->
8 <title>Docs for page MenuSet.php</title>
9 <link rel="stylesheet" href="../../media/stylesheet.css" />
10 <script src="../../media/lib/classTree.js"></script>
11 <script language="javascript" type="text/javascript">
12 var imgPlus = new Image();
13 var imgMinus = new Image();
14 imgPlus.src = "../../media/images/plus.png";
15 imgMinus.src = "../../media/images/minus.png";
16
17 function showNode(Node){
18 switch(navigator.family){
19 case 'nn4':
20 // Nav 4.x code fork...
21 var oTable = document.layers["span" + Node];
22 var oImg = document.layers["img" + Node];
23 break;
24 case 'ie4':
25 // IE 4/5 code fork...
26 var oTable = document.all["span" + Node];
27 var oImg = document.all["img" + Node];
28 break;
29 case 'gecko':
30 // Standards Compliant code fork...
31 var oTable = document.getElementById("span" + Node);
32 var oImg = document.getElementById("img" + Node);
33 break;
34 }
35 oImg.src = imgMinus.src;
36 oTable.style.display = "block";
37 }
38
39 function hideNode(Node){
40 switch(navigator.family){
41 case 'nn4':
42 // Nav 4.x code fork...
43 var oTable = document.layers["span" + Node];
44 var oImg = document.layers["img" + Node];
45 break;
46 case 'ie4':
47 // IE 4/5 code fork...
48 var oTable = document.all["span" + Node];
49 var oImg = document.all["img" + Node];
50 break;
51 case 'gecko':
52 // Standards Compliant code fork...
53 var oTable = document.getElementById("span" + Node);
54 var oImg = document.getElementById("img" + Node);
55 break;
56 }
57 oImg.src = imgPlus.src;
58 oTable.style.display = "none";
59 }
60
61 function nodeIsVisible(Node){
62 switch(navigator.family){
63 case 'nn4':
64 // Nav 4.x code fork...
65 var oTable = document.layers["span" + Node];
66 break;
67 case 'ie4':
68 // IE 4/5 code fork...
69 var oTable = document.all["span" + Node];
70 break;
71 case 'gecko':
72 // Standards Compliant code fork...
73 var oTable = document.getElementById("span" + Node);
74 break;
75 }
76 return (oTable && oTable.style.display == "block");
77 }
78
79 function toggleNodeVisibility(Node){
80 if (nodeIsVisible(Node)){
81 hideNode(Node);
82 }else{
83 showNode(Node);
84 }
85 }
86 </script>
87 </head>
88 <body>
89 <div class="page-body">
90 <h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/MenuSet.php</h2>
91
92 <a name="sec-description"></a>
93 <div class="info-box">
94 <div class="info-box-title">Description</div>
95 <div class="nav-bar">
96 <span class="disabled">Description</span> |
97 <a href="#sec-classes">Classes</a>
98 | <a href="#sec-includes">Includes</a>
99 | <a href="#sec-functions">Functions</a>
100 </div>
101 <div class="info-box-body">
102 <!-- ========== Info from phpDoc block ========= -->
103 <p class="short-description">Some intelligence and standardisation around presenting a menu hierarchy.</p>
104 <p class="description"><p>See the MenuSet class for examples as that is the primary interface.</p></p>
105 <ul class="tags">
106 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
107 <li><span class="field">copyright:</span> Catalyst IT Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
108 <li><span class="field">see:</span> <a href="../../awl/MenuSet/MenuSet.html">MenuSet</a></li>
109 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
110 </ul>
111
112 </div>
113 </div>
114
115 <a name="sec-classes"></a>
116 <div class="info-box">
117 <div class="info-box-title">Classes</div>
118 <div class="nav-bar">
119 <a href="#sec-description">Description</a> |
120 <span class="disabled">Classes</span>
121 | <a href="#sec-includes">Includes</a>
122 | <a href="#sec-functions">Functions</a>
123 </div>
124 <div class="info-box-body">
125 <table cellpadding="2" cellspacing="0" class="class-table">
126 <tr>
127 <th class="class-table-header">Class</th>
128 <th class="class-table-header">Description</th>
129 </tr>
130 <tr>
131 <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
132 <img src="../../media/images/Class.png"
133 alt=" class"
134 title=" class"/>
135 <a href="../../awl/MenuSet/MenuOption.html">MenuOption</a>
136 </td>
137 <td>
138 Each menu option is an object.
139 </td>
140 </tr>
141 <tr>
142 <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
143 <img src="../../media/images/Class.png"
144 alt=" class"
145 title=" class"/>
146 <a href="../../awl/MenuSet/MenuSet.html">MenuSet</a>
147 </td>
148 <td>
149 A MenuSet is a hierarchy of MenuOptions, some of which might be MenuSet objects themselves.
150 </td>
151 </tr>
152 </table>
153 </div>
154 </div>
155
156 <a name="sec-includes"></a>
157 <div class="info-box">
158 <div class="info-box-title">Includes</div>
159 <div class="nav-bar">
160 <a href="#sec-description">Description</a> |
161 <a href="#sec-classes">Classes</a>
162 | <span class="disabled">Includes</span>
163 | <a href="#sec-functions">Functions</a>
164 </div>
165 <div class="info-box-body">
166
167 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
168
169 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
170 <a name="_AWLUtilities_php"><!-- --></a>
171 <div class="evenrow">
172
173 <div>
174 <img src="../../media/images/Page.png" alt=" " />
175 <span class="include-title">
176 <span class="include-type">require_once</span>
177 (<span class="include-name"><a href="../../awl/Utilities/_AWLUtilities.php.html">"AWLUtilities.php"</a></span>)
178 (line <span class="line-number">15</span>)
179 </span>
180 </div>
181
182 <!-- ========== Info from phpDoc block ========= -->
183
184 </div>
185 </div>
186 </div>
187
188
189
190 <a name="sec-functions"></a>
191 <div class="info-box">
192 <div class="info-box-title">Functions</div>
193 <div class="nav-bar">
194 <a href="#sec-description">Description</a> |
195 <a href="#sec-classes">Classes</a>
196 | <a href="#sec-includes">Includes</a>
197 | <span class="disabled">Functions</span>
198 </div>
199 <div class="info-box-body">
200
201 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
202
203 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
204 <a name="function_CompareMenuSequence" id="function_CompareMenuSequence"><!-- --></a>
205 <div class="oddrow">
206
207 <div>
208 <img src="../../media/images/Function.png" />
209 <span class="method-title">_CompareMenuSequence</span> (line <span class="line-number">179</span>)
210 </div>
211
212 <!-- ========== Info from phpDoc block ========= -->
213 <p class="short-description">_CompareMenuSequence is used in sorting the menu options into the sequence order</p>
214 <ul class="tags">
215 <li><span class="field">return:</span> ( $a == b ? 0 ( $a &gt; b ? 1 : -1 ))</li>
216 </ul>
217 <div class="method-signature">
218 <span class="method-result">int</span>
219 <span class="method-name">
220 _CompareMenuSequence
221 </span>
222 (<span class="var-type">objectref</span>&nbsp;<span class="var-name">$a</span>, <span class="var-type">objectref</span>&nbsp;<span class="var-name">$b</span>)
223 </div>
224
225 <ul class="parameters">
226 <li>
227 <span class="var-type">objectref</span>
228 <span class="var-name">$a</span><span class="var-description">: The first menu option</span> </li>
229 <li>
230 <span class="var-type">objectref</span>
231 <span class="var-name">$b</span><span class="var-description">: The second menu option</span> </li>
232 </ul>
233
234
235 </div>
236 </div>
237 </div>
238
239 <p class="notes" id="credit">
240 Documentation generated on Sun, 17 Jun 2012 10:00:17 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
241 </p>
242 </div></body>
243 </html>
Andrew's Web Libraries