Examples/simple_extensions/simple_command.py

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

"""
Extend thuban with a simple command.
"""

__version__ = "$Revision$"

# First import some things we need later.
import os
from Thuban.UI.command import registry, Command
import Thuban.UI.mainwindow

# a function implementing a command. Such a function is called with one
# argument describing the context in which it is invoked. The context is
# an object with a few public attributes for the application object, the
# session and the main window.
def simple_command(context):
    print "simple_command: Application", context.application
    print "simple_command: Session", context.session
    print "simple_command: Main window", context.mainwindow
    print "simple_command: Map", context.mainwindow.canvas.Map()

# Add the command to the registry. A command is represented by a Command
# instance which is instantiated with four parameters here, the name of
# the command, it's title, the function to call when the command is
# invoked by the user and a help text to show in the statusbar.
#
# The name is used internally to identify commands. The title is
# displayed in the menus.
registry.Add(Command("simple_command", "Simple Command", simple_command,
                     helptext = "Simple Command"))

# The main menu is defined by the main_menu object in
# Thuban.UI.mainwindow. This object has a few methods to add new menus
# and menu items.
#
# InsertMenu creates a new submenu in the menu, parameters are its name
# and title which have the same meanings as for a command. The return
# value is a menu object for the new submenu which has the same methods
# as main_menu.
menu = Thuban.UI.mainwindow.main_menu.InsertMenu("examples", "&Examples")

# In the new menu we can add new items with InsertItem which takes the
# name of a command as parameter or with InsertSeparator to add a
# separator. We can also use InsertMenu to add submenus, of course. We
# add the command twice here to demonstrate separators.
menu.InsertItem("simple_command")
menu.InsertSeparator()
menu.InsertItem("simple_command")
1	bh	208	# Copyright (C) 2002 by Intevation GmbH
2			# Authors:
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			"""
9			Extend thuban with a simple command.
10			"""
11
12			__version__ = "$Revision$"
13
14			# First import some things we need later.
15			import os
16			from Thuban.UI.command import registry, Command
17			import Thuban.UI.mainwindow
18
19			# a function implementing a command. Such a function is called with one
20	bh	224	# argument describing the context in which it is invoked. The context is
21			# an object with a few public attributes for the application object, the
22			# session and the main window.
23	bh	208	def simple_command(context):
24	bh	224	print "simple_command: Application", context.application
25			print "simple_command: Session", context.session
26			print "simple_command: Main window", context.mainwindow
27			print "simple_command: Map", context.mainwindow.canvas.Map()
28	bh	208
29			# Add the command to the registry. A command is represented by a Command
30			# instance which is instantiated with four parameters here, the name of
31			# the command, it's title, the function to call when the command is
32			# invoked by the user and a help text to show in the statusbar.
33			#
34			# The name is used internally to identify commands. The title is
35			# displayed in the menus.
36			registry.Add(Command("simple_command", "Simple Command", simple_command,
37			helptext = "Simple Command"))
38
39			# The main menu is defined by the main_menu object in
40			# Thuban.UI.mainwindow. This object has a few methods to add new menus
41			# and menu items.
42			#
43			# InsertMenu creates a new submenu in the menu, parameters are its name
44			# and title which have the same meanings as for a command. The return
45			# value is a menu object for the new submenu which has the same methods
46			# as main_menu.
47			menu = Thuban.UI.mainwindow.main_menu.InsertMenu("examples", "&Examples")
48
49			# In the new menu we can add new items with InsertItem which takes the
50			# name of a command as parameter or with InsertSeparator to add a
51			# separator. We can also use InsertMenu to add submenus, of course. We
52			# add the command twice here to demonstrate separators.
53			menu.InsertItem("simple_command")
54			menu.InsertSeparator()
55			menu.InsertItem("simple_command")
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision