Added $Id$ keywords, cleaned up comment tags
[Packages/TYPO3.CMS.git] / typo3 / sysext / cms / tslib / class.tslib_menu.php
index bec99c5..ca6a215 100755 (executable)
@@ -2,7 +2,7 @@
 /***************************************************************
 *  Copyright notice
 *  
-*  (c) 1999-2003 Kasper Skårhøj (kasper@typo3.com)
+*  (c) 1999-2003 Kasper Skaarhoj (kasper@typo3.com)
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is 
  * The main class, tslib_menu, is also extended by other external PHP scripts such as the GMENU_LAYERS and GMENU_FOLDOUT scripts which creates pop-up menus.
  * Notice that extension classes (like "tslib_tmenu") must have their suffix (here "tmenu") listed in $this->tmpl->menuclasses - otherwise they cannot be instantiated.
  *
- * Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
+ * $Id$
+ * Revised for TYPO3 3.6 June/2003 by Kasper Skaarhoj
  * XHTML compliant
  *
- * @author     Kasper Skårhøj <kasper@typo3.com>
- * @package TYPO3
- * @subpackage tslib
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
  */
 /**
  * [CLASS/FUNCTION INDEX of SCRIPT]
  *
  *
  *
- *  141: class tslib_menu 
+ *  140: class tslib_menu 
  *  183:     function start($tmpl,$sys_page,$id,$conf,$menuNumber)     
  *  232:     function makeMenu()       
- *  665:     function includeMakeMenu($conf,$altSortField)     
- *  682:     function procesItemStates($splitCount)    
- *  865:     function subMenu($uid,$mount_point=0)     
- *  896:     function link($key,$altTarget='',$typeOverride='') 
- *  944:     function isActive($uid)   
- *  955:     function isCurrent($uid)  
- *  968:     function isSubMenu($uid,$mount_point=0)   
- *  992:     function isItemState($kind,$key)  
- * 1028:     function accessKey($title)        
- * 1054:     function userProcess($mConfKey,$passVar)  
- * 1069:     function setATagParts()   
- * 1082:     function getPageTitle($title,$nav_title)  
+ *  664:     function includeMakeMenu($conf,$altSortField)     
+ *  681:     function procesItemStates($splitCount)    
+ *  864:     function subMenu($uid,$mount_point=0)     
+ *  906:     function link($key,$altTarget='',$typeOverride='') 
+ *  962:     function isActive($uid)   
+ *  973:     function isCurrent($uid)  
+ *  986:     function isSubMenu($uid,$mount_point=0)   
+ * 1010:     function isItemState($kind,$key)  
+ * 1047:     function accessKey($title)        
+ * 1073:     function userProcess($mConfKey,$passVar)  
+ * 1088:     function setATagParts()   
+ * 1101:     function getPageTitle($title,$nav_title)  
  *
  *
- * 1113: class tslib_tmenu extends tslib_menu 
- * 1122:     function generate()       
- * 1138:     function writeMenu()      
- * 1268:     function getBeforeAfter($pref)    
- * 1298:     function addJScolorShiftFunction()        
- * 1300:     function changeBGcolor(id,color) 
- * 1320:     function extProc_init()   
- * 1331:     function extProc_RO($key) 
- * 1342:     function extProc_beforeLinking($key)      
- * 1354:     function extProc_afterLinking($key)       
- * 1371:     function extProc_beforeAllWrap($item,$key)        
- * 1382:     function extProc_finish() 
+ * 1132: class tslib_tmenu extends tslib_menu 
+ * 1141:     function generate()       
+ * 1157:     function writeMenu()      
+ * 1287:     function getBeforeAfter($pref)    
+ * 1317:     function addJScolorShiftFunction()        
+ * 1319:     function changeBGcolor(id,color) 
+ * 1339:     function extProc_init()   
+ * 1350:     function extProc_RO($key) 
+ * 1361:     function extProc_beforeLinking($key)      
+ * 1373:     function extProc_afterLinking($key)       
+ * 1390:     function extProc_beforeAllWrap($item,$key)        
+ * 1401:     function extProc_finish() 
  *
  *
- * 1418: class tslib_gmenu extends tslib_menu 
- * 1427:     function generate()       
- * 1465:     function makeGifs($conf, $resKey) 
- * 1636:     function findLargestDims($conf,$items,$Hobjs,$Wobjs,$minDim,$maxDim)      
- * 1704:     function writeMenu()      
- * 1802:     function extProc_init()   
- * 1813:     function extProc_RO($key) 
- * 1824:     function extProc_beforeLinking($key)      
- * 1837:     function extProc_afterLinking($key)       
- * 1854:     function extProc_beforeAllWrap($item,$key)        
- * 1865:     function extProc_finish() 
+ * 1437: class tslib_gmenu extends tslib_menu 
+ * 1446:     function generate()       
+ * 1484:     function makeGifs($conf, $resKey) 
+ * 1681:     function findLargestDims($conf,$items,$Hobjs,$Wobjs,$minDim,$maxDim)      
+ * 1753:     function writeMenu()      
+ * 1851:     function extProc_init()   
+ * 1862:     function extProc_RO($key) 
+ * 1873:     function extProc_beforeLinking($key)      
+ * 1886:     function extProc_afterLinking($key)       
+ * 1903:     function extProc_beforeAllWrap($item,$key)        
+ * 1914:     function extProc_finish() 
  *
  *
- * 1899: class tslib_imgmenu extends tslib_menu 
- * 1908:     function generate()       
- * 1926:     function makeImageMap($conf)      
- * 2087:     function writeMenu()      
+ * 1948: class tslib_imgmenu extends tslib_menu 
+ * 1957:     function generate()       
+ * 1975:     function makeImageMap($conf)      
+ * 2136:     function writeMenu()      
  *
  *
- * 2130: class tslib_jsmenu extends tslib_menu 
- * 2137:     function generate()       
- * 2145:     function writeMenu()      
- * 2205:     function generate_level($levels,$count,$pid,$menuItemArray='')    
+ * 2179: class tslib_jsmenu extends tslib_menu 
+ * 2186:     function generate()       
+ * 2194:     function writeMenu()      
+ * 2254:     function generate_level($levels,$count,$pid,$menuItemArray='')    
  *
  * TOTAL FUNCTIONS: 41
  * (This index is automatically created/updated by the extension "extdeveval")
  * $menu->makeMenu();
  * $content.=$menu->writeMenu();
  * 
- * @author     Kasper Skårhøj <kasper@typo3.com>
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
  * @package TYPO3
  * @subpackage tslib
  * @see tslib_cObj::HMENU()
@@ -1125,7 +1124,7 @@ class tslib_menu {
 /**
  * Extension class creating text based menus
  * 
- * @author     Kasper Skårhøj <kasper@typo3.com>
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
  * @package TYPO3
  * @subpackage tslib
  * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=387&cHash=73a3116ab8
@@ -1430,7 +1429,7 @@ class tslib_tmenu extends tslib_menu {
 /**
  * Extension class creating graphic based menus (PNG or GIF files)
  * 
- * @author     Kasper Skårhøj <kasper@typo3.com>
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
  * @package TYPO3
  * @subpackage tslib
  * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=384&cHash=93a7644cba
@@ -1941,7 +1940,7 @@ class tslib_gmenu extends tslib_menu {
 /**
  * ImageMap based menus
  * 
- * @author     Kasper Skårhøj <kasper@typo3.com>
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
  * @package TYPO3
  * @subpackage tslib
  * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=389&cHash=fcf18c5d9f
@@ -2172,7 +2171,7 @@ class tslib_imgmenu extends tslib_menu {
 /**
  * JavaScript/Selectorbox based menus
  * 
- * @author     Kasper Skårhøj <kasper@typo3.com>
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
  * @package TYPO3
  * @subpackage tslib
  * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=391&cHash=563435abbc