[menu] element index

Package indexes

All elements
a b c d e f g h i l m n o p r s t u v w x
a
top
Variable $action
menuoption::$action in menu-defs.php
Internal field which combines the sitepage
Variable $active
menumaintainer::$active in menumaint-defs.php
Menu active flag
Variable $active
menuoption::$active in menu-defs.php
Whether menuoption is active (displayed)
Variable $Align
treemenu::$Align in treemenu-defs.php
Alignment of the menu table
Variable $auth_code
menuoption::$auth_code in menu-defs.php
Whether to apply auth code
Method additem
menu::additem() in menu-defs.php
Create new menu item Makes a new menuitem from a given label and URL and adds it to the menu.
Method add_menuitem
menu::add_menuitem() in menu-defs.php
Add menu item Adds a ready-made menuitem to the menu.
Method add_menuoption
menumaintainer::add_menuoption() in menumaint-defs.php
This adds a new menuoption to the list, but does not add any records to the database.
b
top
Variable $background_colours
rowmenu::$background_colours in rowmenu-defs.php
Array of background colours for each level
Variable $BorderColor
treemenu::$BorderColor in treemenu-defs.php
Colour of top menu item border
Variable $BorderWidth
treemenu::$BorderWidth in treemenu-defs.php
Width of top menu border in px
c
top
Variable $collapseimage
treemenu::$collapseimage in treemenu-defs.php
Image to use for expanded sub-menu
d
top
Variable $description
menuoption::$description in menu-defs.php
Menu option descriptive text
Variable $display_order
Order of display
Method delete
menumaintainer::delete() in menumaint-defs.php
Delete this menu from the database.
Method delete
menuoption::delete() in menu-defs.php
Delete the menuoption.
Method display_in_webpage
Xmenu::display_in_webpage() in xmenu-defs.php
Display in webpage Inserts the javascript necessary to embed the menu into a given webpage.
Method display_in_webpage
HVmenu::display_in_webpage() in hvmenu-defs.php
Display in webpage Inserts the javascript necessary to embed the menu into a given webpage.
e
top
Variable $edit_menuop_id
menumaintainer::$edit_menuop_id in menumaint-defs.php
The ID of the current menuoption being edited, if any
Variable $edit_parent_id
menumaintainer::$edit_parent_id in menumaint-defs.php
The parent ID of the menu-options being edited
Variable $exists
Xmenu::$exists in xmenu-defs.php
Whether this menu exists in the database
Variable $exists
treemenu::$exists in treemenu-defs.php
Whether this menu exists in the database
Variable $exists
menumaintainer::$exists in menumaint-defs.php
Whether this menu exists in the database
Variable $exists
menuoption::$exists in menu-defs.php
Whether menuoption exists in database
Variable $expandimage
treemenu::$expandimage in treemenu-defs.php
Image to use for collapsed sub-menu
f
top
Variable $force_rebuild
Xmenu::$force_rebuild in xmenu-defs.php
Whether to force rebuild or not
Variable $formname
menumaintainer::$formname in menumaint-defs.php
The name of our form
g
top
Method get
menuoption::get() in menu-defs.php
Get the menuoption.
Method get
menumaintainer::get() in menumaint-defs.php
Get the menu Retrieves the specified menu from database. If it doesn't exist then we create a new one.
Method getmenu
sitemenu::getmenu() in menu-defs.php
Get the menu Read the menuitems in from database and apply security..
Method get_styles
treemenu::get_styles() in treemenu-defs.php
Obtain the non-standard styles from the stylesheet
h
top
Variable $heading_item_spacing
treemenu::$heading_item_spacing in treemenu-defs.php
Padding before (above) menu options which are
Variable $height
menuoption::$height in menu-defs.php
Height of option in pixels
Variable $HighBgColor
treemenu::$HighBgColor in treemenu-defs.php
Colour of highlighted top menu item background
Variable $HighColor
treemenu::$HighColor in treemenu-defs.php
Colour of highlighted top menu item text
Variable $highlightclass
menu::$highlightclass in menu-defs.php
Stylesheet class to use for highlighting
Variable $highlighted
menuitem::$highlighted in menu-defs.php
True if menu item is highlighted
Constant HORIZONTAL
HORIZONTAL in menu-defs.php
Menu orientation set to horizontal
Method html
rowmenu::html() in rowmenu-defs.php
Render the menu as HTML.
Method html
Xmenu::html() in xmenu-defs.php
This renders the field as HTML.
Method html
treemenu::html() in treemenu-defs.php
Render the menu as HTML. Please note that the TreeMenu is by design a VERTICAL menu system, so don't expect the 'orientation' style in the stylesheet to have any effect for this class.
Method html
menumaintainer::html() in menumaint-defs.php
Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.
Method html
menu::html() in menu-defs.php
This renders the field as HTML.
Method html
menuitem::html() in menu-defs.php
This renders the field as HTML.
Method html
HVmenu::html() in hvmenu-defs.php
This renders the field as HTML.
Class HVmenu
HVmenu in hvmenu-defs.php
HVMenu class This module is being retained for legacy applications which still use the core javascript system (version 5.41) which was written by Ger Versluis 24 December 2001.
Method HVmenu
HVmenu::HVmenu() in hvmenu-defs.php
Constructor Create the HV menu object.
Page hvmenu-defs.php
hvmenu-defs.php in hvmenu-defs.php
Function HVmenu_entry
HVmenu_entry() in hvmenu-defs.php
Recursively produce HVmenu definition entries. These array
i
top
Variable $imgs_changed
Xmenu::$imgs_changed in xmenu-defs.php
Whether images were changed or not
Variable $img_horiz_arrow
Xmenu::$img_horiz_arrow in xmenu-defs.php
Menu image object: horizontal arrow
Variable $img_spacer
Xmenu::$img_spacer in xmenu-defs.php
Menu image object: spacer
Variable $img_vert_arrow
Xmenu::$img_vert_arrow in xmenu-defs.php
Menu image object: vertical arrow
Variable $is_parent
menuoption::$is_parent in menu-defs.php
True if this menu option is the parent of sub-menu options
Variable $items
menu::$items in menu-defs.php
Array of items in this menu
Variable $item_count
menu::$item_count in menu-defs.php
Number of items in the menu
Variable $item_height
HVmenu::$item_height in hvmenu-defs.php
Height of menu items in pixels
Variable $item_spacing
treemenu::$item_spacing in treemenu-defs.php
Padding before (above) 'normal' menu options
Variable $item_width
HVmenu::$item_width in hvmenu-defs.php
Width of all menu items in pixels
l
top
Variable $label
menuoption::$label in menu-defs.php
Menuoption displayed label
Variable $label
menuitem::$label in menu-defs.php
Label for this menu item
Variable $label_padding_left
treemenu::$label_padding_left in treemenu-defs.php
Padding between menuoption image, and menu item text
Variable $language
treemenu::$language in treemenu-defs.php
Menu language, or default if zero
Variable $language
Xmenu::$language in xmenu-defs.php
Menu language
Variable $language
HVmenu::$language in hvmenu-defs.php
Menu language
Variable $language
menumaintainer::$language in menumaint-defs.php
The language of the menu (0 = default)
Variable $language
sitemenu::$language in menu-defs.php
Language variant of this menu eg: 'fr'
Variable $lang_desc
menumaintainer::$lang_desc in menumaint-defs.php
The name of the language of the menu
Variable $last_modified
When menu option was last modified (datetime)
Variable $link
menuitem::$link in menu-defs.php
Link object to associate with menu item
Variable $LowBgColor
treemenu::$LowBgColor in treemenu-defs.php
Colour of normal top menu item background
Variable $LowColor
treemenu::$LowColor in treemenu-defs.php
Colour of normal top menu item text
m
top
Variable $menu
Xmenu::$menu in xmenu-defs.php
The menu instance
Variable $menu
treemenu::$menu in treemenu-defs.php
The menu instance
Variable $menuhref
HVmenu::$menuhref in hvmenu-defs.php
WWW menu URL - theme aware
Variable $menuopimage
treemenu::$menuopimage in treemenu-defs.php
Image to use to indicate a menu option
Variable $menuoptionid
menuoption::$menuoptionid in menu-defs.php
menuoption ID
Variable $menuoptions
menumaintainer::$menuoptions in menumaint-defs.php
The array of menu options
Variable $menuoption_id
treemenu::$menuoption_id in treemenu-defs.php
Initial menuoption ID
Variable $menuvarsfile
HVmenu::$menuvarsfile in hvmenu-defs.php
Path to menu variables file - theme aware
Variable $menu_desc
menumaintainer::$menu_desc in menumaint-defs.php
The description of the menu
Variable $menu_id
menumaintainer::$menu_id in menumaint-defs.php
The ID of the menu
Variable $menu_id
Xmenu::$menu_id in xmenu-defs.php
Unique database menu ID
Variable $menu_id
treemenu::$menu_id in treemenu-defs.php
Unique database menu ID
Variable $menu_id
menuoption::$menu_id in menu-defs.php
menu ID the option belongs to
Variable $menu_id
HVmenu::$menu_id in hvmenu-defs.php
Unique database menu ID
Variable $menu_level
menuoption::$menu_level in menu-defs.php
Menu option level
Variable $menu_level
sitemenu::$menu_level in menu-defs.php
Level of menuitems to return
Variable $menu_level
menumaintainer::$menu_level in menumaint-defs.php
The level of the menu-options
Variable $menu_level
menuitem::$menu_level in menu-defs.php
Menu level of this item
Variable $menu_level
HVmenu::$menu_level in hvmenu-defs.php
Level of menu to render
Variable $menu_name
menumaintainer::$menu_name in menumaint-defs.php
The name of the menu
Variable $menu_name
treemenu::$menu_name in treemenu-defs.php
Menu name eg: 'main'
Variable $menu_name
Xmenu::$menu_name in xmenu-defs.php
Menu name eg: 'main'
Variable $menu_name
HVmenu::$menu_name in hvmenu-defs.php
Menu name eg: 'main'
Variable $menu_name
sitemenu::$menu_name in menu-defs.php
Name of this menu eg: 'main'
Variable $menu_structure_changed
Whether menu structure was rebuilt or not
Variable $menu_type
Xmenu::$menu_type in xmenu-defs.php
Menu type from stylesheet: vertical, horizontal
Variable $menu_width
treemenu::$menu_width in treemenu-defs.php
Fixed menu width, or zero if not fixed
Method menu
menu::menu() in menu-defs.php
Constructor Creates the menu object.
Class menu
menu in menu-defs.php
A menu, which is a container for menu items. This class encapsulates what is essentially a list of links which can be displayed as a 'menu'. Orientation can be VERTICAL or HORIZONTAL. A 'wrap threshold' can be defined. If it's a vertical menu, this represents the max no.
Page menu-defs.php
menu-defs.php in menu-defs.php
Class menuitem
menuitem in menu-defs.php
Standard menu item. Takes a link object as the item in the menu.
Method menuitem
menuitem::menuitem() in menu-defs.php
Constructor Creates the menu item object.
Page menumaint-defs.php
menumaint-defs.php in menumaint-defs.php
Method menumaintainer
menumaintainer::menumaintainer() in menumaint-defs.php
Constructor Create a new menumaintainer.
Class menumaintainer
menumaintainer in menumaint-defs.php
Menu Maintainer
Class menuoption
menuoption in menu-defs.php
The menuoption is a class which contains the properties of a single option on a menu.
Method menuoption
menuoption::menuoption() in menu-defs.php
Constructor Create a new menuoption object.
Constant MENU_ITEM_SEPARATOR
MENU_ITEM_SEPARATOR in menu-defs.php
The menu item is a separator line
Constant MENU_ITEM_SPACER
MENU_ITEM_SPACER in menu-defs.php
The menu item is a spacer
Constant MENU_ITEM_SUBMENU
MENU_ITEM_SUBMENU in menu-defs.php
The menu item is a sub-menu heading
Constant MENU_ITEM_URL
MENU_ITEM_URL in menu-defs.php
The menu item is an ad-hoc URL
Constant MENU_LEVEL0
MENU_LEVEL0 in menu-defs.php
Main menu level (0)
Constant MENU_LEVEL1
MENU_LEVEL1 in menu-defs.php
Menu level 1
Constant MENU_LEVEL2
MENU_LEVEL2 in menu-defs.php
Menu level 2
Constant MENU_LEVEL3
MENU_LEVEL3 in menu-defs.php
Menu level 3
Constant MENU_LEVEL4
MENU_LEVEL4 in menu-defs.php
Menu level 4
Constant MENU_LEVEL_ALL
MENU_LEVEL_ALL in menu-defs.php
All menu levels
n
top
Variable $name
menu::$name in menu-defs.php
Name of the menu
Constant NEW_MENUOPTION
NEW_MENUOPTION in menumaint-defs.php
Create new menuoption
o
top
Variable $orientation
menu::$orientation in menu-defs.php
Menu orientation: HORIZONTAL or VERTICAL
p
top
Variable $padimage
treemenu::$padimage in treemenu-defs.php
Image to use for padding/indenting menu options
Variable $padsize
treemenu::$padsize in treemenu-defs.php
Size of level indent padding in px
Variable $parent_id
menuitem::$parent_id in menu-defs.php
ID of parent menuitem of this menuitem
Variable $parent_id
menuoption::$parent_id in menu-defs.php
Parent ID of this menu option
Variable $pseudo_item_spacing
treemenu::$pseudo_item_spacing in treemenu-defs.php
Padding before (above) 'pseudo' menu options
Method process_navigation
rowmenu::process_navigation() in rowmenu-defs.php
Process any menu navigation.
Method put
menumaintainer::put() in menumaint-defs.php
Save this menu to the database. Create a new one if it doesn't already exist.
Method put
menuoption::put() in menu-defs.php
Save the menuoption.
r
top
Variable $relative_positioned
HVmenu::$relative_positioned in hvmenu-defs.php
Positioned relatively, or not
Method remove_menuoption
Remove menuoption from the menu. Just removes the given menuoption from the list in this object - no database changes are made.
Class rowmenu
rowmenu in rowmenu-defs.php
A hierarchical menu renderer which does not use Javascript to implement the menuoption display. NB: this renderer is basically the same functionally as the treemenu but is rendered differently.
Method rowmenu
rowmenu::rowmenu() in rowmenu-defs.php
Constructor
Page rowmenu-defs.php
rowmenu-defs.php in rowmenu-defs.php
s
top
Variable $separator
menu::$separator in menu-defs.php
Separator character between items
Variable $separator
rowmenu::$separator in rowmenu-defs.php
Separator string between menu options
Variable $session_id
treemenu::$session_id in treemenu-defs.php
The current user session ID
Variable $sitepage
menuoption::$sitepage in menu-defs.php
Target site webpage when clicked
Variable $sitepage_parms
Paramter string to pass on webpage URL
Variable $stylesheet
Xmenu::$stylesheet in xmenu-defs.php
Name of stylesheet file to get menu styles from
Variable $stylesheet
HVmenu::$stylesheet in hvmenu-defs.php
Name of stylesheet file to get menu styles from
Variable $stylesheet
treemenu::$stylesheet in treemenu-defs.php
Path to the stylesheet for menu
Variable $SubBorderColor
treemenu::$SubBorderColor in treemenu-defs.php
Colour of sub-menu border
Variable $SubBorderWidth
treemenu::$SubBorderWidth in treemenu-defs.php
Width of sub-menu border in px
Variable $SubHighBgColor
treemenu::$SubHighBgColor in treemenu-defs.php
Colour of sub-menu highlighted item background
Variable $SubHighColor
treemenu::$SubHighColor in treemenu-defs.php
Colour of sub-menu highlighted item text
Variable $SubLowBgColor
treemenu::$SubLowBgColor in treemenu-defs.php
Colour of sub-menu item background
Variable $SubLowColor
treemenu::$SubLowColor in treemenu-defs.php
Colour of sub-menu item normal text
Constant SEP_BAR
SEP_BAR in menu-defs.php
Menu item separator: "|" (pipe)
Constant SEP_DBLSPACE
SEP_DBLSPACE in menu-defs.php
Menu item separator: " " (double-space)
Constant SEP_SPACE
SEP_SPACE in menu-defs.php
Menu item separator: " " (space)
Method set_background_colours
Set backgrounds colours Sets the background colours for each menu level. Provide either a delimited list of colours in a string in #nnnnnn format, or an array of same. The first colour is for LEVEL 0, second LEVEL 1 etc.
Method set_default_images
Xmenu::set_default_images() in xmenu-defs.php
Set the standard images up. This method just re-asserts that the Xmenu should use the standard Xmenu images for arrows, spacer etc.
Method set_font
menuitem::set_font() in menu-defs.php
Set the menu item font
Method set_itemfont
menu::set_itemfont() in menu-defs.php
Set the font of all menu items
Method set_menu_images
Xmenu::set_menu_images() in xmenu-defs.php
Over-rides the standard icon images used to indicate submenus and spaces. The values passed should be image objects as instances of the 'img' class (@see img()).
Method set_menu_images
treemenu::set_menu_images() in treemenu-defs.php
Over-rides the standard '+' and '-' icon images used to indicate a sub-menu can be expanded or collapsed. The values passed should be image image objects as instances of the 'img' class (@see img()).
Method set_separator
rowmenu::set_separator() in rowmenu-defs.php
Set the separator string.
Method set_titlefont
menu::set_titlefont() in menu-defs.php
Set the menu tite font
Method sitemap
menumaintainer::sitemap() in menumaint-defs.php
Render the whole menu layout hierarchy as a sitemap, which simply gives links to each menu page.
Method sitemenu
sitemenu::sitemenu() in menu-defs.php
Constructor
Class sitemenu
sitemenu in menu-defs.php
Site Menu class - a database-enabled extension of the menu class.
Method syncparms
menuoption::syncparms() in menu-defs.php
Synchronise sitepage parameters with manually edited values. This
t
top
Variable $Tablestyle
treemenu::$Tablestyle in treemenu-defs.php
Overall class for the menu table
Variable $title
menu::$title in menu-defs.php
Title/banner for this menu
Variable $title_font
menu::$title_font in menu-defs.php
Font settings for the title/banner
Variable $top_item_spacing
treemenu::$top_item_spacing in treemenu-defs.php
Padding before (above) the top-level menu options
Method treemenu
treemenu::treemenu() in treemenu-defs.php
Constructor Create a new menumaintainer.
Class treemenu
treemenu in treemenu-defs.php
A hierarchical menu renderer which does not use Javascript to implement the menuoption display.
Page treemenu-defs.php
treemenu-defs.php in treemenu-defs.php
u
top
Variable $user_groups
menuoption::$user_groups in menu-defs.php
Array of user groups allowed to access this menuoption
Variable $user_groups
menumaintainer::$user_groups in menumaint-defs.php
Array of groups allowed to access menu
Variable $user_type
menuoption::$user_type in menu-defs.php
User type restriction
v
top
Constant VERTICAL
VERTICAL in menu-defs.php
Menu orientation set to vertical
w
top
Variable $width
menuoption::$width in menu-defs.php
Width of option in pixels
Variable $wrap_threshold
menu::$wrap_threshold in menu-defs.php
Max. number of menu items before wrapping the menu
Method wml
menu::wml() in menu-defs.php
This renders the field as WML.
Method wml
menuitem::wml() in menu-defs.php
This renders the field as WML.
Method wmlup
menu::wmlup() in menu-defs.php
This renders the menu as WML (w/Phone.com extns) in a paged mode with a number of menuitems/page defined by $wrap_threshold.
Method wml_morelink
menu::wml_morelink() in menu-defs.php
Given a page number of the current page, this method returns the appropriate label and link HREF for the next page link.
x
top
Variable $xmenu_configfile_path
Path to menu variables file - theme aware
Variable $xmenu_configfile_url
WWW Xmenu config URL - theme aware
Variable $xmenu_img
Xmenu::$xmenu_img in xmenu-defs.php
Home dir for Xmenu images
Variable $xmenu_js
Xmenu::$xmenu_js in xmenu-defs.php
Home dir for Xmenu scripts
Class Xmenu
Xmenu in xmenu-defs.php
XMenu class A Generic Javascript Menu. This class provides a multi-level menu implemented in cross-browser Javascript. It should be compatible with Netscape 4, Netscape 6, and IE 4+.
Method Xmenu
Xmenu::Xmenu() in xmenu-defs.php
Constructor Create the Xmenu object.
Page xmenu-defs.php
xmenu-defs.php in xmenu-defs.php
Method Xmenu_entry
Xmenu::Xmenu_entry() in xmenu-defs.php
Recursively produce menu definition entries. These array
a b c d e f g h i l m n o p r s t u v w x