UE3:WebAdminMenu (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search

[edit] Properties

[edit] menu

Type: array<MenuItem>

[edit] tree

Type: array<TreeItem>

[edit] webadmin

Type: WebAdmin

[edit] Structs

[edit] MenuItem

string path: The absolute path (from the webapp path). Examples:

foo foo/bar/quux bar bar/quux bar/quux2

string title: Title of the menu item
string description: A short description
int weight: The weight of this item. A low number means it will be higher in the list.
IQueryHandler handler: The handler responsible for handling this menu item.

[edit] TreeItem

int cur: Index to the item in the menu list;
string elm: Path element
array<int> children

[edit] Instance functions

[edit] addMenu

function addMenu (string path, string title, IQueryHandler handler, optional string description, optional int weight)

Add a new menu item (or overwrite the previous for the given path).

[edit] addMenuItem

function addMenuItem (MenuItem item)

Add an item to the menu, or if the path already exist, update an existing item. To create a hidden item simply leave out the title.

[edit] addSortedItem

protected function addSortedItem (MenuItem item)

Add a menu item to the list sorting on the full path.

[edit] createTree

protected function createTree ()

Parses the sorted list of menu items and creates the tree.

[edit] getHandlerFor

function IQueryHandler getHandlerFor (string path, out string title, out string desc)

Get the menu handler for a given path

[edit] getUserMenu

function WebAdminMenu getUserMenu (IWebAdminUser forUser)

return the menu instance of the given user. All paths to which the user has no access will be filtered from the list.

Returns:

none when the user has absolutely no access, otherwise an instance is returned that only contains the paths the user has access to.

[edit] render

function string render ()

Render the current menu tree to a navigation menu

[edit] renderChilds

protected function string renderChilds (array<int> childs, WebResponse wr)