/usr/share/pyshared/zope/browsermenu/interfaces.py is in python-zope.browsermenu 4.0.0-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | ##############################################################################
#
# Copyright (c) 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Menu-specific interfaces
"""
from zope.i18nmessageid import ZopeMessageFactory as _
from zope.interface import Interface, directlyProvides
from zope.interface.interfaces import IInterface
from zope.schema import TextLine, Text, URI, Int
class IMenuItemType(IInterface):
"""Menu item type
Menu item types are interfaces that define classes of
menu items.
"""
class AddMenu(Interface):
"""Special menu for providing a list of addable objects."""
directlyProvides(AddMenu, IMenuItemType)
class IBrowserMenu(Interface):
"""Menu
Menus are objects that can return a list of menu items they contain. How
they generate this list is up to them. Commonly, however, they will look
up adapters that provide the ``IBrowserMenuItem`` interface.
"""
id = TextLine(
title=_("Menu Id"),
description=_("The id uniquely identifies this menu."),
required=True
)
title = TextLine(
title=_("Menu title"),
description=_("The title provides the basic label for the menu."),
required=False
)
description = Text(
title=_("Menu description"),
description=_("A description of the menu. This might be shown "
"on menu pages or in pop-up help for menus."),
required=False
)
def getMenuItems(object, request):
"""Return a TAL-friendly list of menu items.
The object (acts like the context) and request can be used to select
the items that are available.
"""
class IBrowserMenuItem(Interface):
"""Menu type
An interface that defines a menu.
"""
title = TextLine(
title=_("Menu item title"),
description=_("The title provides the basic label for the menu item."),
required=True
)
description = Text(
title=_("Menu item description"),
description=_("A description of the menu item. This might be shown "
"on menu pages or in pop-up help for menu items."),
required=False
)
action = TextLine(
title=_("The URL to display if the item is selected"),
description=_("When a user selects a browser menu item, the URL"
"given in the action is displayed. The action is "
"usually given as a relative URL, relative to the "
"object the menu item is for."),
required=True
)
order = Int(
title=_("Menu item ordering hint"),
description=_("This attribute provides a hint for menu item ordering."
"Menu items will generally be sorted by the `for_`"
"attribute and then by the order.")
)
filter_string = TextLine(
title=_("A condition for displaying the menu item"),
description=_("The condition is given as a TALES expression. The "
"expression has access to the variables:\n"
"\n"
"context -- The object the menu is being displayed "
"for\n"
"\n"
"request -- The browser request\n"
"\n"
"nothing -- None\n"
"\n"
"The menu item will not be displayed if there is a \n"
"filter and the filter evaluates to a false value."),
required=False)
icon = URI(
title=_("Icon URI"),
description=_("URI of the icon representing this menu item"))
def available():
"""Test whether the menu item should be displayed
A menu item might not be available for an object, for example
due to security limitations or constraints.
"""
class IBrowserSubMenuItem(IBrowserMenuItem):
"""A menu item that points to a sub-menu."""
submenuId = TextLine(
title=_("Sub-Menu Id"),
description=_("The menu id of the menu that describes the "
"sub-menu below this item."),
required=True)
action = TextLine(
title=_("The URL to display if the item is selected"),
description=_("When a user selects a browser menu item, the URL "
"given in the action is displayed. The action is "
"usually given as a relative URL, relative to the "
"object the menu item is for."),
required=False
)
class IMenuAccessView(Interface):
"""View that provides access to menus"""
def __getitem__(menu_id):
"""Get menu information
Return a sequence of dictionaries with labels and
actions, where actions are relative URLs.
"""
|