Inherited Variables
Inherited Constants
Inherited Methods
Class: VMenuItem
- VMenuItem::getProperties()
- Get item properties
- VMenuItem::_saveNode()
- Function _saveNode
Class: VObject
- VObject::__construct()
- Class Constructor
- VObject::bind()
- Bind values to this object
- VObject::delete()
- Delete Object
- VObject::get()
- Get value
- VObject::getAll()
- Get all object values
- VObject::getError()
- Get error message
- VObject::getErrors()
- Get errors
- VObject::getMethods()
- Get object methods
- VObject::getProperties()
- Get object properties
- VObject::save()
- Save Object
- VObject::set()
- Set a value
- VObject::setError()
- Set error value
- VObject::setProperties()
- Set property values
- VObject::setProperty()
- Set property value
- VObject::toString()
- Convert object to string
- VObject::__destruct()
- Class Destructor
- VObject::__toString()
- Return object as a string
Class Details
Virtual Web Platform - Menu
This class provides the menu interface
Tags:
- author - Ralph Ritoch <rritoch@gmail.com>
- copyright - (c) Ralph Ritoch - All Rights Reserved
- link - VNetPublishing.Com
- license - VNETLPL Limited Public License
[ Top ]
Class Variables
$default_security_policy = 'deny'
[line 131]
Default security policy
Tags:
- var - Default security policy
- access - public
Type: string
Overrides:
[ Top ]
$disabled = false
[line 122]
Disabled
Tags:
- var - Menu disabled
- access - public
Type: boolean
Overrides:
[ Top ]
$location = null
[line 113]
Menu location
Tags:
- var - Default menu location
- access - public
Type: string
Overrides:
[ Top ]
$title = ''
[line 104]
Menu Title
Tags:
- var - Menu title
- access - public
Type: string
Overrides: Array
[ Top ]
$_app = "vwp"
[line 79]
Application ID
Tags:
- var - Application ID
- access - public
Type: $_app
Overrides:
[ Top ]
$_id = null
[line 88]
Menu ID
Tags:
- var - Menu ID
- access - public
Type: string
Overrides:
[ Top ]
$_items = array()
[line 97]
Item list
Tags:
- var - Item list
- access - public
Type: array
Overrides: Array
[ Top ]
$_type = "menu"
[line 70]
Item type
Tags:
- var - Item type
- access - public
Type: string
Overrides: Array
[ Top ]
Class Methods
static createMenu
static object Menu &createMenu(
)
[line 223]
Create a new menu
Tags:
- access - public
Parameters:
[ Top ]
static deleteMenuItem
static void deleteMenuItem(
object
$hMenu, integer
$uPosition, $uFlags
$uFlags)
[line 172]
Delete Menu Item
The MF_BYCOMMAND flag is the default flag if neither the MF_BYCOMMAND nor MF_BYPOSITION flag is specified. MF_BYCOMMAND 0x00000000L Indicates that uPosition gives the identifier of the menu item. MF_BYPOSITION 0x00000400L
Tags:
- todo - Implement static delete live menu method
- access - public
Parameters:
- object $hMenu - Menu
- integer $uPosition - Item position
- $uFlags $uFlags - Flags
[ Top ]
static destroyMenu
static void destroyMenu(
$hmenu)
[line 211]
Remove a live menu
Tags:
- todo - Implement static destroy live menu
- access - public
Parameters:
- $hmenu -
[ Top ]
static getInstance
static void &getInstance(
[$menuID
$menuID = null], [$app
$app = "vwp"])
[line 313]
Get instance of a menu
Tags:
- access - public
Parameters:
- $menuID $menuID - Menu ID
- $app $app - Application ID
[ Top ]
static getMenu
static void getMenu(
object
$widget)
[line 150]
Get menu
Tags:
- todo - Implement static get live menu method
- access - public
Parameters:
- object $widget - Widget
[ Top ]
static getSubMenu
static void getSubMenu(
$hmenu, integer
$uPos, object
$hMenu)
[line 187]
Get a sub menu Reserved for future use
Tags:
- todo - implement static get Sub Menu
- access - public
Parameters:
- object $hMenu - Menu
- integer $uPos - Position
- $hmenu -
[ Top ]
static setMenu
static void setMenu(
object
$widget, object
$hMenu)
[line 199]
Assigns a new menu to the specified widget
Reserved for future use
Parameters:
- object $widget - Widget
- object $hMenu - Menu
[ Top ]
deleteItem
boolean|object True deleteItem(
integer
$idx)
[line 430]
Delete Item
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
- integer $idx - Item index
[ Top ]
getItem
VMenuItem|object Menu &getItem(
integer
$idx)
[line 413]
Get an item by index
Tags:
- return - Item on success, error or warning otherwise
- access - public
Parameters:
- integer $idx - Index
[ Top ]
insertItem
void insertItem(
array|object
$item, [integer
$before = null])
[line 250]
Insert item
Tags:
- access - public
Parameters:
- array|object $item - Item
- integer $before - Before ID
[ Top ]
load
void load(
$menuID, string
$filename)
[line 355]
Load a menu from menu file
Tags:
- access - public
Parameters:
- string $filename - Menu filename
- $menuID -
[ Top ]
replaceItem
void replaceItem(
integer
$idx, VMenuItem
$item)
[line 454]
Replace menu item
Tags:
- access - public
Parameters:
- integer $idx - Index of old item
- VMenuItem $item - New Item
[ Top ]
save
True save(
)
[line 388]
Save Menu
Tags:
- return - on success, error or warning otherwise
- access - public
Overrides VObject::save() (Save Object)
Parameters:
[ Top ]