Welcome, guest | Sign In | My Account | Store | Cart

This module enables pyGTK developers on the windows platform to handle native windows messages and take advantage of features such as notification icons and window transparency (Win2000 and above). Requires pywin32 extensions by Mark Hammond.

Python, 320 lines
  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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
#!/usr/bin/env python

#gtkwin32.py
__version__ = '1.01'


import sys
import win32gui
import winxpgui

GWL_WNDPROC = -4
GWL_EXSTYLE = -20
IDI_APPLICATION = 32512
LWA_ALPHA = 0x02
WM_TASKBARCREATED = win32gui.RegisterWindowMessage('TaskbarCreated')
WM_USER = 1024
WM_TRAYMESSAGE = WM_USER + 20
WS_EX_LAYERED = 0x80000

class GTKWin32Ext:

    def __init__(self, gtk_window):

        self._window = gtk_window
        self._hwnd = gtk_window.window.handle

        self._message_map = {}

        # Windows transparency is only supported windows2000 and above.
        if sys.getwindowsversion()[0] <= 4:
            self.alpha = None
        else:
            self.alpha = 100
            self._transparency = False

        self.notify_icon = None            

        # Sublass the window and inject a WNDPROC to process messages.
        self._oldwndproc = win32gui.SetWindowLong(self._hwnd, GWL_WNDPROC,
                                                  self._wndproc)

        gtk_window.connect('unrealize', self.remove)


    def add_notify_icon(self, hicon=None, tooltip=None):
        """ Creates a notify icon for the gtk window. """
        if not self.notify_icon:
            if not hicon:
                hicon = win32gui.LoadIcon(0, IDI_APPLICATION)
            self.notify_icon = NotifyIcon(self._hwnd, hicon, tooltip)

            # Makes redraw if the taskbar is restarted.   
            self.message_map({WM_TASKBARCREATED: self.notify_icon._redraw})


    def message_map(self, msg_map={}):
        """ Maps message processing to callback functions ala win32gui. """
        if msg_map:
            if self._message_map:
                duplicatekeys = [key for key in msg_map.keys()
                                 if self._message_map.has_key(key)]
                
                for key in duplicatekeys:
                    new_value = msg_map[key]
                    
                    if isinstance(new_value, list):
                        raise TypeError('Dict cannot have list values')
                    
                    value = self._message_map[key]
                    
                    if new_value != value:
                        new_value = [new_value]
                        
                        if isinstance(value, list):
                            value += new_value
                        else:
                            value = [value] + new_value
                        
                        msg_map[key] = value
            self._message_map.update(msg_map)


    def message_unmap(self, msg, callback=None):
        if self._message_map.has_key(msg):
            if callback:
                cblist = self._message_map[key]
                if isinstance(cblist, list):
                    if not len(cblist) < 2:
                        for i in range(len(cblist)):
                            if cblist[i] == callback:
                                del self._message_map[key][i]
                                return
            del self._message_map[key]


    def remove(self, *args):
        self._message_map = {}
        self.remove_notify_icon()
        self = None
        

    def remove_notify_icon(self):
        """ Removes the notify icon. """
        if self.notify_icon:
            self.notify_icon.remove()
            self.notify_icon = None
            

    def remove(self, *args):
        """ Unloads the extensions. """
        self._message_map = {}
        self.remove_notify_icon()
        self = None            
            

    def show_balloon_tooltip(self, title, text, timeout=10,
                             icon=win32gui.NIIF_NONE):
        """ Shows a baloon tooltip. """
        if not self.notify_icon:
            self.add_notifyicon()
        self.notify_icon.show_balloon(title, text, timeout, icon)


    def set_alpha(self, alpha=100, colorkey=0, mask=False):
        """ Sets the transparency of the window. """
        if self.alpha != None:
            if not self._transparency:
                style = win32gui.GetWindowLong(self._hwnd, GWL_EXSTYLE)
                if (style & WS_EX_LAYERED) != WS_EX_LAYERED:
                    style = style | WS_EX_LAYERED
                    win32gui.SetWindowLong(self._hwnd, GWL_EXSTYLE, style)
                self._transparency = True

            if mask and colorkey:
                flags = LWA_COLORKEY
            else:
                flags = LWA_ALPHA
                if colorkey:
                    flags = flags | LWA_COLORKEY

            win_alpha = int(float(alpha)/100*255)
            winxpgui.SetLayeredWindowAttributes(self._hwnd, colorkey,
                                                win_alpha, flags)
            self.alpha = int(alpha)


    def _wndproc(self, hwnd, msg, wparam, lparam):
        """ A WINDPROC to process window messages. """
        if self._message_map.has_key(msg):
            callback = self._message_map[msg]
            if isinstance(callback, list):
                for cb in callback:
                    apply(cb, (hwnd, msg, wparam, lparam))
            else:
                apply(callback, (hwnd, msg, wparam, lparam))

        return win32gui.CallWindowProc(self._oldwndproc, hwnd, msg, wparam,
                                       lparam)
                
                                    

class NotifyIcon:

    def __init__(self, hwnd, hicon, tooltip=None):

        self._hwnd = hwnd
        self._id = 0
        self._flags = win32gui.NIF_MESSAGE | win32gui.NIF_ICON
        self._callbackmessage = WM_TRAYMESSAGE
        self._hicon = hicon
  
        win32gui.Shell_NotifyIcon(win32gui.NIM_ADD, self._get_nid())
        if tooltip: self.set_tooltip(tooltip)


    def _get_nid(self):
        """ Function to initialise & retrieve the NOTIFYICONDATA Structure. """
        nid = (self._hwnd, self._id, self._flags, self._callbackmessage,
               self._hicon)
        nid = list(nid)

        if not hasattr(self, '_tip'): self._tip = ''
        nid.append(self._tip)

        if not hasattr(self, '_info'): self._info = ''
        nid.append(self._info)
            
        if not hasattr(self, '_timeout'): self._timeout = 0
        nid.append(self._timeout)

        if not hasattr(self, '_infotitle'): self._infotitle = ''
        nid.append(self._infotitle)
            
        if not hasattr(self, '_infoflags'):self._infoflags = win32gui.NIIF_NONE
        nid.append(self._infoflags)

        return tuple(nid)
        
    
    def remove(self):
        """ Removes the tray icon. """
        win32gui.Shell_NotifyIcon(win32gui.NIM_DELETE, self._get_nid())


    def set_tooltip(self, tooltip):
        """ Sets the tray icon tooltip. """
        self._flags = self._flags | win32gui.NIF_TIP
        self._tip = tooltip
        win32gui.Shell_NotifyIcon(win32gui.NIM_MODIFY, self._get_nid())
        
        
    def show_balloon(self, title, text, timeout=10, icon=win32gui.NIIF_NONE):
        """ Shows a balloon tooltip from the tray icon. """
        self._flags = self._flags | win32gui.NIF_INFO
        self._infotitle = title
        self._info = text
        self._timeout = timeout * 1000
        self._infoflags = icon
        win32gui.Shell_NotifyIcon(win32gui.NIM_MODIFY, self._get_nid())

    def _redraw(self, *args):
        """ Redraws the tray icon. """
        self.remove
        win32gui.Shell_NotifyIcon(win32gui.NIM_ADD, self._get_nid())


if __name__ == '__main__':

    # Example on how to use the module.

    import gtk
    import gobject
    import time
    WM_LBUTTONUP = 0x0202
    WM_RBUTTONUP = 0x0205

    class GTKApp:

        def __init__(self):

            self.main_loop = gobject.MainLoop()            

            # Create a window with a horizontal scale.
            self.wnd = gtk.Window()
            self.wnd.set_default_size(640, 480)
            self.wnd.set_title('Have fun with the transparency slider')

            hscale = gtk.HScale()
            hscale.set_digits(0)
            hscale.set_increments(1, 10)
            hscale.set_range(0, 100)
            hscale.set_value(100)

            hscale.connect('value_changed', self.set_window_alpha)

            self.wnd.add(hscale)

            # Note: gtk window must be realized before installing extensions.
            self.wnd.realize()
            self.wnd.show_all()

            self.win32ext = GTKWin32Ext(self.wnd)

            self.win32ext.add_notify_icon()

            # GTK menus from the notify icon!
            menu = gtk.Menu()

            menu_item = gtk.MenuItem('Baloons!')
            menu_item.connect_object('activate', self.menu_cb, self.wnd)
            menu.append(menu_item)
                
            menu_item = gtk.MenuItem('Fadeout Window')
            menu_item.connect('activate', self.fadeoutwindow)
            menu.append(menu_item)
                
            menu_item = gtk.MenuItem('Window Disappeared?')
            menu_item.connect('activate', self.fadeinwindow)
            menu.append(menu_item)
            
            menu.show_all()
            self.win32ext.notify_icon.menu = menu

            # Set up the callback messages
            self.win32ext.message_map({
                WM_TRAYMESSAGE: self.on_notifyicon_activity
                })            
        

        def set_window_alpha(self, hscale):
            self.win32ext.set_alpha(hscale.get_value())


        def fadeinwindow(self, *args):
            while(self.win32ext.alpha < 100):
                self.win32ext.set_alpha(self.win32ext.alpha + 1)
                time.sleep(0.01)


        def fadeoutwindow(self, *args):
            while(self.win32ext.alpha != 0):
                self.win32ext.set_alpha(self.win32ext.alpha - 1)
                time.sleep(0.01)

        def menu_cb(self, data):
            self.win32ext.show_balloon_tooltip(
                'pyGTK Win32 Extensions', 'No more MFC from today!')

        def on_notifyicon_activity(self, hwnd, message, wparam, lparam):
            if lparam == WM_RBUTTONUP:
                self.win32ext.notify_icon.menu.popup(None, None, None, 0, 0)
            elif lparam == WM_LBUTTONUP:
                self.win32ext.notify_icon.menu.popdown()            

        def quit(self, *args):
            self.win32ext.remove_notify_icon()
            gtk.main_quit()            

    gtkapp = GTKApp()
    gtkapp.main_loop.run()

I wrote this after looking around for answers on how GTK could interface with the native Windows GUI. I found a ctypes implementation and rewrote it to use the excellent pywin32 module instead. The ctypes uses hooking to intercept windows messages, however my implementation uses subclassing.

ctypes implementation - taewookk http://www.python.or.kr/pykug/CtypesModule_bf_b9_c1_a6_2dpygtk_2dutil

6 comments

Nikos Kouremenos 16 years, 6 months ago  # | flag

Updates.

Hey Fadli, world. This is great code!
I have some suggestion so the code is even cleaner

delete:

    def remove(self, *args):
        self._message_map = {}
        self.remove_notify_icon()
        self = None

you have it double.
Also delete
import gobject the main_loop() you do
and use gtk.main()

also delete .realize() cause show_all() is enough
then hook destroy to wnd to gtk.main_quit()
this is a start for cleanup
I'm gonna use this class so if you care about more cleanups tell it here.

Thanks again for the *GREAT* code
Fadly Tabrani (author) 16 years, 5 months ago  # | flag

You're welcome :). Hi Nikos,

Great to hear that you find it useful and I've noticed you've created a patch for Gajim http://gajim.org. Its rocks! I've always wanted to see a Gaim built on python.

There are many improvements that can be done on the code (the extension) but I can't get down to doing it because of lack of time. Why don't u send me a patch (fadlydottabraniatgmaildotcom) and I'll merge it here. Do include your name.

One on my wish list: Bitorrent Win32 with a Tray Icon ;)

Nikos Kouremenos 16 years, 3 months ago  # | flag

more cleanups.

some constants like GWL_WNDPROC are already in win32con (comes with pywin32) so no need to have them global

moreover, it not clear one can set a custom image
either write a set_icon() or anyways help:


hinst = win32gui.GetModuleHandle(None)
icon_flags = win32con.LR_LOADFROMFILE | win32con.LR_DEFAULTSIZE
hicon = win32gui.LoadImage(hinst, path_to_ico, win32con.IMAGE_ICON, 0, 0, icon_flags)

and then you can gloriously do:
add_notify_icon(self.systray_context_menu, hicon, 'Gajim')

another interesting project is http://sourceforge.net/projects/pysystray

Nikos Kouremenos 16 years, 3 months ago  # | flag

yet another cleanup post. self.remove in _redraw maybe you mean remove() ?

moreover in _get_nid you first have nid a tuple and then you make it a list and then you return it as tuple? why all that?

you have to return tuple but you do not have to make it list with list() I mean you just do nid = [self._hwnd, self._id, ...]

Nikos Kouremenos 16 years, 3 months ago  # | flag

magical workaround. I am using this recipe in Gajim.org and I was having serious problem with my main window because when I tried to move it I was getting a python crash. After a lot of blind testing, I now have:

fake_window = gtk.Window()
fake_window.realize()

and I pass fake_window as window for systray class

my main window is other and everything works ok now..

I would appreciate some comments on this if you knew. Thanks

a 11 years, 7 months ago  # | flag

apply() is deprecated. apply(cb, (hwnd, msg, wparam, lparam)) should be changed to cb(hwnd, msg, wparam, lparam). apply(callback, (hwnd, msg, wparam, lparam)) should be changed to callback(hwnd, msg, wparam, lparam).