Docs For Class Menu

Description

System for generating menus.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

version: $Id: menu.php 981 2007-03-21 13:24:38Z fisharebest $

Located in /includes/menu.php (line 31)

Variable Summary

mixed $accesskey

mixed $class

mixed $flyout

mixed $hoverclass

mixed $hovericon

mixed $icon

mixed $label

mixed $labelpos

mixed $link

mixed $onclick

mixed $parentmenu

mixed $seperator

mixed $submenuclass

mixed $submenus

mixed $target

Method Summary

Menu Menu ([string $label = ' '], [string $link = '#'], [string $pos = 'right'], [string $flyout = 'down'])

void addAccesskey ( $accesskey)

void addClass ( $class, [ $hoverclass = ''], [ $submenuclass = ''])

void addFlyout ([ $flyout = 'down'])

void addIcon ( $icon, [ $hovericon = null])

void addLabel ([ $label = ' '], [ $pos = 'right'])

void addLink ([ $link = '#'])

void addOnclick ( $onclick)

void addSeperator ()

void addSubMenu ( $obj)

void addTarget ( $target)

void getMenu ()

void isSeperator ()

void printMenu ()

Variables

mixed $accesskey = null (line 44)

mixed $class = '' (line 41)

mixed $flyout = 'down' (line 40)

mixed $hoverclass = '' (line 42)

mixed $hovericon = null (line 39)

mixed $icon = null (line 38)

mixed $label = ' ' (line 34)

mixed $labelpos = 'right' (line 35)

mixed $link = '#' (line 36)

mixed $onclick = null (line 37)

mixed $parentmenu = null (line 46)

mixed $seperator = false (line 33)

mixed $submenuclass = '' (line 43)

mixed $submenus (line 47)

mixed $target = null (line 45)

Methods

Constructor Menu (line 56)

Constructor for the menu class

Menu Menu ([string $label = ' '], [string $link = '#'], [string $pos = 'right'], [string $flyout = 'down'])

string $label: the label for the menu item (usually a pgv_lang variable)
string $link: The link that the user should be taken to when clicking on the menuitem
string $pos: The position of the label relative to the icon (right, left, top, bottom)
string $flyout: The direction where any submenus should appear relative to the menu item (right, down)

addAccesskey (line 105)

void addAccesskey ( $accesskey)

$accesskey

addClass (line 98)

void addClass ( $class, [ $hoverclass = ''], [ $submenuclass = ''])

$class
$hoverclass
$submenuclass

addFlyout (line 93)

void addFlyout ([ $flyout = 'down'])

$flyout

addIcon (line 85)

void addIcon ( $icon, [ $hovericon = null])

$icon
$hovericon

addLabel (line 69)

void addLabel ([ $label = ' '], [ $pos = 'right'])

$label
$pos

addLink (line 75)

void addLink ([ $link = '#'])

$link

addOnclick (line 80)

void addOnclick ( $onclick)

$onclick

addSeperator (line 120)

void addSeperator ()

addSubMenu (line 115)

void addSubMenu ( $obj)

$obj

addTarget (line 110)

void addTarget ( $target)

$target

getMenu (line 126)

void getMenu ()

isSeperator (line 64)

void isSeperator ()

printMenu (line 295)

void printMenu ()