client/windows/context_menu.py

# A sample context menu handler.
# Adds a 'Hello from Python' menu entry to .py files.  When clicked, a
# simple message box is displayed.
#
# To demostrate:
# * Execute this script to register the context menu.
# * Open Windows Explorer, and browse to a directory with a .py file.
# * Right-Click on a .py file - locate and click on 'Hello from Python' on
#   the context menu.

# see also: http://www.codeproject.com/shell/ShellExtGuide2.asp

import pythoncom
from win32com.shell import shell, shellcon
import win32gui
import win32con
import win32api, winerror

IContextMenu_Methods = ["QueryContextMenu", "InvokeCommand", "GetCommandString"]
IShellExtInit_Methods = ["Initialize"]

class ShellExtension:
    _reg_progid_ = "Python.ShellExtension.ContextMenu"
    _reg_name_ = "MessClient"
    _reg_desc_ = "Mess Shell Extension"
    _reg_clsid_ = "{CED0336C-C9EE-4a7f-8D7F-C660393C381F}"
    _com_interfaces_ = [shell.IID_IShellExtInit, shell.IID_IContextMenu]
    _public_methods_ = IContextMenu_Methods + IShellExtInit_Methods

    def Initialize(self, folder, dataobj, hkey):
        print "Init", folder, dataobj, hkey
        self.dataobj = dataobj

    def QueryContextMenu(self, hMenu, indexMenu, idCmdFirst, idCmdLast, uFlags):
        
        # debug
        print "QCM", hMenu, indexMenu, idCmdFirst, idCmdLast, uFlags
        
        # query the items clicked on
        format_etc = win32con.CF_HDROP, None, 1, -1, pythoncom.TYMED_HGLOBAL
        sm = self.dataobj.GetData(format_etc)
        num_files = shell.DragQueryFile(sm.data_handle, -1)
        
        #if num_files>1:
        #    msg = "&Hello from Python (with %d files selected)" % num_files
        #else:
        #    fname = shell.DragQueryFile(sm.data_handle, 0)
        #    msg = "&Hello from Python (with '%s' selected)" % fname
        self.files_selected = []
        for i in range(0, num_files):
          fname = shell.DragQueryFile(sm.data_handle, i)
          if fname == 0: continue
          self.files_selected.append(fname)

        # build context menu(s)
        msg = "A&rchiveMe"
        idCmd = idCmdFirst
        items = []
        if (uFlags & 0x000F) == shellcon.CMF_NORMAL: # Check == here, since CMF_NORMAL=0
            print "CMF_NORMAL..."
            items.append(msg + " - normal")
        elif uFlags & shellcon.CMF_VERBSONLY:
            print "CMF_VERBSONLY..."
            items.append(msg + " - shortcut")
        elif uFlags & shellcon.CMF_EXPLORE:
            print "CMF_EXPLORE..."
            #items.append(msg + " - normal file, right-click in Explorer")
            items.append(msg)
            items.append("Named Shortcut &1")
            items.append("Named Shortcut &2")
        elif uFlags & CMF_DEFAULTONLY:
            print "CMF_DEFAULTONLY...\r\n"
            items.append("hello world - 1!")
        else:
            print "** unknown flags", uFlags
            items.append("hello world - 2!")
        
        # create menu entries
        win32gui.InsertMenu(hMenu, indexMenu,
                            win32con.MF_SEPARATOR|win32con.MF_BYPOSITION,
                            idCmd, None)
        indexMenu += 1
        idCmd += 1
        
        for item in items:
            win32gui.InsertMenu(hMenu, indexMenu,
                                win32con.MF_STRING|win32con.MF_BYPOSITION,
                                idCmd, item)
            indexMenu += 1
            idCmd += 1

        win32gui.InsertMenu(hMenu, indexMenu,
                            win32con.MF_SEPARATOR|win32con.MF_BYPOSITION,
                            idCmd, None)
        indexMenu += 1
        idCmd += 1
        
        return idCmd-idCmdFirst # Must return number of menu items we added.

    def GetCommandString(self, cmdId, typ):
        #if cmdId == 0:
        #  return "Hello from Python!!"
        #else:
        #  return "abc"
        return self._reg_name_ + "_" + cmdId;

    def InvokeCommand(self, ci):
        mask, hwnd, verb, params, dir, nShow, hotkey, hicon = ci

        # If lpVerb really points to a string, ignore this function call and bail out.
        if win32api.HIWORD( verb ) != 0:
          return winerror.E_INVALIDARG
        
        function_id = win32api.LOWORD(verb)
        # TODO: establish mapping with building the context menus in "QueryContextMenu"
        if function_id == 1:
          method = "ArchiveMe"
        elif function_id == 2:
          method = "Shortcut 1"
        elif function_id == 3:
          method = "Shortcut 2"
        else:
          method = "Unknown"
        
        # do action(s)
        win32gui.MessageBox(hwnd, "\n".join(self.files_selected), method, win32con.MB_OK)


def DllRegisterServer():
    import _winreg
    
    # extended (via http://mail.python.org/pipermail/python-list/2003-December/198390.html)

    # for folders
    folder_key = _winreg.CreateKey(_winreg.HKEY_CLASSES_ROOT, "Folder\\shellex")
    folder_subkey = _winreg.CreateKey(folder_key, "ContextMenuHandlers")
    folder_subkey2 = _winreg.CreateKey(folder_subkey, ShellExtension._reg_name_)
    _winreg.SetValueEx(folder_subkey2, None, 0, _winreg.REG_SZ, ShellExtension._reg_clsid_)

    # for files
    file_key = _winreg.CreateKey(_winreg.HKEY_CLASSES_ROOT, "*\\shellex")
    file_subkey = _winreg.CreateKey(file_key, "ContextMenuHandlers")
    file_subkey2 = _winreg.CreateKey(file_subkey, ShellExtension._reg_name_)
    _winreg.SetValueEx(file_subkey2, None, 0, _winreg.REG_SZ, ShellExtension._reg_clsid_)

    print ShellExtension._reg_desc_, "registration complete."


def DllUnregisterServer():
    import _winreg

    # extended (via http://mail.python.org/pipermail/python-list/2003-December/198390.html)

    try:
        # for folders
        folder_key = _winreg.DeleteKey(_winreg.HKEY_CLASSES_ROOT,
                                "Folder\\shellex\\ContextMenuHandlers\\" + ShellExtension._reg_name_)
        # for files
        file_key = _winreg.DeleteKey(_winreg.HKEY_CLASSES_ROOT,
                                "*\\shellex\\ContextMenuHandlers\\" + ShellExtension._reg_name_)
    except WindowsError, details:
        import errno
        if details.errno != errno.ENOENT:
            raise
    print ShellExtension._reg_desc_, "unregistration complete."

if __name__=='__main__':
    from win32com.server import register
    register.UseCommandLine(ShellExtension,
                   finalize_register = DllRegisterServer,
                   finalize_unregister = DllUnregisterServer)
1	# A sample context menu handler.
2	# Adds a 'Hello from Python' menu entry to .py files. When clicked, a
3	# simple message box is displayed.
4	#
5	# To demostrate:
6	# * Execute this script to register the context menu.
7	# * Open Windows Explorer, and browse to a directory with a .py file.
8	# * Right-Click on a .py file - locate and click on 'Hello from Python' on
9	# the context menu.
10
11	# see also: http://www.codeproject.com/shell/ShellExtGuide2.asp
12
13	import pythoncom
14	from win32com.shell import shell, shellcon
15	import win32gui
16	import win32con
17	import win32api, winerror
18
19	IContextMenu_Methods = ["QueryContextMenu", "InvokeCommand", "GetCommandString"]
20	IShellExtInit_Methods = ["Initialize"]
21
22	class ShellExtension:
23	_reg_progid_ = "Python.ShellExtension.ContextMenu"
24	_reg_name_ = "MessClient"
25	_reg_desc_ = "Mess Shell Extension"
26	_reg_clsid_ = "{CED0336C-C9EE-4a7f-8D7F-C660393C381F}"
27	_com_interfaces_ = [shell.IID_IShellExtInit, shell.IID_IContextMenu]
28	_public_methods_ = IContextMenu_Methods + IShellExtInit_Methods
29
30	def Initialize(self, folder, dataobj, hkey):
31	print "Init", folder, dataobj, hkey
32	self.dataobj = dataobj
33
34	def QueryContextMenu(self, hMenu, indexMenu, idCmdFirst, idCmdLast, uFlags):
35
36	# debug
37	print "QCM", hMenu, indexMenu, idCmdFirst, idCmdLast, uFlags
38
39	# query the items clicked on
40	format_etc = win32con.CF_HDROP, None, 1, -1, pythoncom.TYMED_HGLOBAL
41	sm = self.dataobj.GetData(format_etc)
42	num_files = shell.DragQueryFile(sm.data_handle, -1)
43
44	#if num_files>1:
45	# msg = "&Hello from Python (with %d files selected)" % num_files
46	#else:
47	# fname = shell.DragQueryFile(sm.data_handle, 0)
48	# msg = "&Hello from Python (with '%s' selected)" % fname
49	self.files_selected = []
50	for i in range(0, num_files):
51	fname = shell.DragQueryFile(sm.data_handle, i)
52	if fname == 0: continue
53	self.files_selected.append(fname)
54
55	# build context menu(s)
56	msg = "A&rchiveMe"
57	idCmd = idCmdFirst
58	items = []
59	if (uFlags & 0x000F) == shellcon.CMF_NORMAL: # Check == here, since CMF_NORMAL=0
60	print "CMF_NORMAL..."
61	items.append(msg + " - normal")
62	elif uFlags & shellcon.CMF_VERBSONLY:
63	print "CMF_VERBSONLY..."
64	items.append(msg + " - shortcut")
65	elif uFlags & shellcon.CMF_EXPLORE:
66	print "CMF_EXPLORE..."
67	#items.append(msg + " - normal file, right-click in Explorer")
68	items.append(msg)
69	items.append("Named Shortcut &1")
70	items.append("Named Shortcut &2")
71	elif uFlags & CMF_DEFAULTONLY:
72	print "CMF_DEFAULTONLY...\r\n"
73	items.append("hello world - 1!")
74	else:
75	print "** unknown flags", uFlags
76	items.append("hello world - 2!")
77
78	# create menu entries
79	win32gui.InsertMenu(hMenu, indexMenu,
80	win32con.MF_SEPARATOR\|win32con.MF_BYPOSITION,
81	idCmd, None)
82	indexMenu += 1
83	idCmd += 1
84
85	for item in items:
86	win32gui.InsertMenu(hMenu, indexMenu,
87	win32con.MF_STRING\|win32con.MF_BYPOSITION,
88	idCmd, item)
89	indexMenu += 1
90	idCmd += 1
91
92	win32gui.InsertMenu(hMenu, indexMenu,
93	win32con.MF_SEPARATOR\|win32con.MF_BYPOSITION,
94	idCmd, None)
95	indexMenu += 1
96	idCmd += 1
97
98	return idCmd-idCmdFirst # Must return number of menu items we added.
99
100	def GetCommandString(self, cmdId, typ):
101	#if cmdId == 0:
102	# return "Hello from Python!!"
103	#else:
104	# return "abc"
105	return self._reg_name_ + "_" + cmdId;
106
107	def InvokeCommand(self, ci):
108	mask, hwnd, verb, params, dir, nShow, hotkey, hicon = ci
109
110	# If lpVerb really points to a string, ignore this function call and bail out.
111	if win32api.HIWORD( verb ) != 0:
112	return winerror.E_INVALIDARG
113
114	function_id = win32api.LOWORD(verb)
115	# TODO: establish mapping with building the context menus in "QueryContextMenu"
116	if function_id == 1:
117	method = "ArchiveMe"
118	elif function_id == 2:
119	method = "Shortcut 1"
120	elif function_id == 3:
121	method = "Shortcut 2"
122	else:
123	method = "Unknown"
124
125	# do action(s)
126	win32gui.MessageBox(hwnd, "\n".join(self.files_selected), method, win32con.MB_OK)
127
128
129	def DllRegisterServer():
130	import _winreg
131
132	# extended (via http://mail.python.org/pipermail/python-list/2003-December/198390.html)
133
134	# for folders
135	folder_key = _winreg.CreateKey(_winreg.HKEY_CLASSES_ROOT, "Folder\\shellex")
136	folder_subkey = _winreg.CreateKey(folder_key, "ContextMenuHandlers")
137	folder_subkey2 = _winreg.CreateKey(folder_subkey, ShellExtension._reg_name_)
138	_winreg.SetValueEx(folder_subkey2, None, 0, _winreg.REG_SZ, ShellExtension._reg_clsid_)
139
140	# for files
141	file_key = _winreg.CreateKey(_winreg.HKEY_CLASSES_ROOT, "*\\shellex")
142	file_subkey = _winreg.CreateKey(file_key, "ContextMenuHandlers")
143	file_subkey2 = _winreg.CreateKey(file_subkey, ShellExtension._reg_name_)
144	_winreg.SetValueEx(file_subkey2, None, 0, _winreg.REG_SZ, ShellExtension._reg_clsid_)
145
146	print ShellExtension._reg_desc_, "registration complete."
147
148
149	def DllUnregisterServer():
150	import _winreg
151
152	# extended (via http://mail.python.org/pipermail/python-list/2003-December/198390.html)
153
154	try:
155	# for folders
156	folder_key = _winreg.DeleteKey(_winreg.HKEY_CLASSES_ROOT,
157	"Folder\\shellex\\ContextMenuHandlers\\" + ShellExtension._reg_name_)
158	# for files
159	file_key = _winreg.DeleteKey(_winreg.HKEY_CLASSES_ROOT,
160	"*\\shellex\\ContextMenuHandlers\\" + ShellExtension._reg_name_)
161	except WindowsError, details:
162	import errno
163	if details.errno != errno.ENOENT:
164	raise
165	print ShellExtension._reg_desc_, "unregistration complete."
166
167	if __name__=='__main__':
168	from win32com.server import register
169	register.UseCommandLine(ShellExtension,
170	finalize_register = DllRegisterServer,
171	finalize_unregister = DllUnregisterServer)
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26