Thuban/UI/menu.py

# Copyright (C) 2001, 2002 by Intevation GmbH
# Author:
# Bernhard Herzog <[email protected]>
#
# This program is free software under the GPL (>=v2)
# Read the file COPYING coming with Thuban for details.

"""Menu management"""

__version__ = "$Revision$"

from Thuban import _

class Menu:

    """Represent a menu or submenu.

    A menu has a name and a title. The name can be used to identify
    menus internally while the title is intended for use in the GUI.

    Menu items can be added with the Insert* methods.
    """

    def __init__(self, name, title, items = None):
        """Initialize the menu.

        Parameters:
           name -- the name of the menu
           title -- the (possibly localized) title of the menu
           items -- (optional) a list of menu items.

        The items list may contains strings with command names, None to
        indicate separators or Menu instances for submenus.
        """
        self.name = name
        self.title = title
        if items is None:
            self.items = []
        else:
            self.items = items

    def item_index(self, item):
        """Return the index of item in the menu.

        item -- may be the name of a non-menu entry or the
                name of a menu or a menu itself.

        Return None it item is not found.
        """
        for i in range(len(self.items)):
            temp = self.items[i]
            if temp == item:
                # this case takes care of item being the name of an
                # entry or a menu.
                return i
            elif isinstance(temp, Menu) and temp.name == item:
                # item is the name of a menu
                return i
        # Didn't find the item so return None
        return None

    def find_menu(self, name):
        """Return the submenu named name or None if no such item exists"""
        for item in self.items:
            if isinstance(item, Menu) and item.name == name:
                return item
        return None

    def InsertItem(self, item, menu = (), after = None):
        """Insert a menu item.

        Parameters:

         item -- the menu item to insert must be either a string with
                the command's name or a Menu instance.

         menu -- (optional) the submenu to insert into. It should be a
                sequence of menu names.

         after -- (optional) insert the new item after this one. after
                 should be the name of a command.
        """
        # if menu is given, get the first submenu
        if menu:
            submenu_index = self.find_menu(menu[0])
            if submenu_index is not None:
                submenu_index.InsertItem(item, menu = menu[1:], after = after)
            else:
                # the submenu doesn't exist yet. Raise an error.
                raise KeyError(_("Submenu %s doesn't exist") % menu[0])
        else:
            if after is not None:
                idx = self.item_index(after)
            else:
                idx = None

            if idx is not None:
                self.items.insert(idx + 1, item)
            else:
                self.items.append(item)

    def InsertSeparator(self, after = None):
        """Insert a separator

        after -- (optional) insert the separator after this one. after
                 should be the name of a command.
        """
        self.InsertItem(None, after = after)

    def InsertMenu(self, name, title, menu = (), after = None):
        """Insert and return a new menu.

        Parameters:

         name -- the (internal) name of the menu

         title -- the (possibly localized) title

         menu -- (optional) the submenu to insert into. It should be a
                sequence of menu names.

         after -- (optional) insert the new item after this one. after
                 should be the name of a command.
        """
        newmenu = Menu(name, title)
        self.InsertItem(newmenu, menu = menu, after = after)
        return newmenu

    def FindOrInsertMenu(self, name, title, menu = (), after = None):
        """
        Find the menu with the specified name. If found, return it.
        Else insert the menu as specified and return it.

        Parameters: See InsertMenu().
        """

        m = self.find_menu(name)
        if m is None:
            m = self.InsertMenu(name, title, menu, after)
        return m


    def SetItems(self, items):
        """Replace the contents of the menu by items."""
        self.items = items

    def RemoveItem(self, item):
        """Remove an item from the menu.

        item -- the (internal) name of the item.
        """
        i = self.item_index(item)
        if i is not None:
            self.items.pop(i)
1	# Copyright (C) 2001, 2002 by Intevation GmbH
2	# Author:
3	# Bernhard Herzog <[email protected]>
4	#
5	# This program is free software under the GPL (>=v2)
6	# Read the file COPYING coming with Thuban for details.
7
8	"""Menu management"""
9
10	__version__ = "$Revision$"
11
12	from Thuban import _
13
14	class Menu:
15
16	"""Represent a menu or submenu.
17
18	A menu has a name and a title. The name can be used to identify
19	menus internally while the title is intended for use in the GUI.
20
21	Menu items can be added with the Insert* methods.
22	"""
23
24	def __init__(self, name, title, items = None):
25	"""Initialize the menu.
26
27	Parameters:
28	name -- the name of the menu
29	title -- the (possibly localized) title of the menu
30	items -- (optional) a list of menu items.
31
32	The items list may contains strings with command names, None to
33	indicate separators or Menu instances for submenus.
34	"""
35	self.name = name
36	self.title = title
37	if items is None:
38	self.items = []
39	else:
40	self.items = items
41
42	def item_index(self, item):
43	"""Return the index of item in the menu.
44
45	item -- may be the name of a non-menu entry or the
46	name of a menu or a menu itself.
47
48	Return None it item is not found.
49	"""
50	for i in range(len(self.items)):
51	temp = self.items[i]
52	if temp == item:
53	# this case takes care of item being the name of an
54	# entry or a menu.
55	return i
56	elif isinstance(temp, Menu) and temp.name == item:
57	# item is the name of a menu
58	return i
59	# Didn't find the item so return None
60	return None
61
62	def find_menu(self, name):
63	"""Return the submenu named name or None if no such item exists"""
64	for item in self.items:
65	if isinstance(item, Menu) and item.name == name:
66	return item
67	return None
68
69	def InsertItem(self, item, menu = (), after = None):
70	"""Insert a menu item.
71
72	Parameters:
73
74	item -- the menu item to insert must be either a string with
75	the command's name or a Menu instance.
76
77	menu -- (optional) the submenu to insert into. It should be a
78	sequence of menu names.
79
80	after -- (optional) insert the new item after this one. after
81	should be the name of a command.
82	"""
83	# if menu is given, get the first submenu
84	if menu:
85	submenu_index = self.find_menu(menu[0])
86	if submenu_index is not None:
87	submenu_index.InsertItem(item, menu = menu[1:], after = after)
88	else:
89	# the submenu doesn't exist yet. Raise an error.
90	raise KeyError(_("Submenu %s doesn't exist") % menu[0])
91	else:
92	if after is not None:
93	idx = self.item_index(after)
94	else:
95	idx = None
96
97	if idx is not None:
98	self.items.insert(idx + 1, item)
99	else:
100	self.items.append(item)
101
102	def InsertSeparator(self, after = None):
103	"""Insert a separator
104
105	after -- (optional) insert the separator after this one. after
106	should be the name of a command.
107	"""
108	self.InsertItem(None, after = after)
109
110	def InsertMenu(self, name, title, menu = (), after = None):
111	"""Insert and return a new menu.
112
113	Parameters:
114
115	name -- the (internal) name of the menu
116
117	title -- the (possibly localized) title
118
119	menu -- (optional) the submenu to insert into. It should be a
120	sequence of menu names.
121
122	after -- (optional) insert the new item after this one. after
123	should be the name of a command.
124	"""
125	newmenu = Menu(name, title)
126	self.InsertItem(newmenu, menu = menu, after = after)
127	return newmenu
128
129	def FindOrInsertMenu(self, name, title, menu = (), after = None):
130	"""
131	Find the menu with the specified name. If found, return it.
132	Else insert the menu as specified and return it.
133
134	Parameters: See InsertMenu().
135	"""
136
137	m = self.find_menu(name)
138	if m is None:
139	m = self.InsertMenu(name, title, menu, after)
140	return m
141
142
143	def SetItems(self, items):
144	"""Replace the contents of the menu by items."""
145	self.items = items
146
147	def RemoveItem(self, item):
148	"""Remove an item from the menu.
149
150	item -- the (internal) name of the item.
151	"""
152	i = self.item_index(item)
153	if i is not None:
154	self.items.pop(i)
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision