Changeset 218 for trunk/examples/examplewm.py

Timestamp:

07/24/2008 05:51:26 PM (6 months ago)

Author:

funkiedamouse

Message:

Modified docstrings in examplewm.py to more closely match PEP 8.

Files:

• trunk/examples/examplewm.py (modified) (15 diffs)

trunk/examples/examplewm.py

@@ -19 +19 @@
 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
-''' Example PLWM window manager
+""" Example PLWM window manager
 
 This example demonstrates basic window manager construction and some of the
 more common window manager concepts such as a mode window, multiple views,
 and window decorations.
-'''
+
+"""
 
 import sys
@@ -53 +54 @@
                outline.XorOutlineClient,
                modestatus.ModeFocusedTitleClient):
-    ''' Example client class
+    """ Example client class
 
     This class adds an XOR outline for moving/resizing windows and a hook to
@@ -60 +61 @@
     (withdrawn) state and specifies default pointer positions for a couple of
     programs.
-    '''
+
+    """
 
     # Put a frame around all client windows
@@ -77 +79 @@
                views.XMW_ViewHandler,
                modestatus.ModeFocusedTitleScreen):
-    ''' Example screen class
+    """ Example screen class
 
     This class adds support for colors(FIXME), views, and a mode window, and
@@ -83 +85 @@
     movement and resizing information, the current view, and the title of the
     currently-focused window.
-    '''
+
+    """
 
     view_always_visible_clients = Or(name('XClock'),
@@ -90 +93 @@
 
 class WMConfig:
-    ''' Example window manager configuration class
+    """ Example window manager configuration class
 
     Installs the BasicKeys key map into the window manager.
 
     TODO: Why is this not included in PLWM below? Should it be moved there?
-    '''
+
+    """
+
     def __wm_init__(self):
         # Install the basic key map
@@ -109 +114 @@
            inspect.InspectServer,
            WMConfig):
-    ''' Example window manager class
+    """ Example window manager class
 
     This class sets up the configuration for the window manager, including font
@@ -115 +120 @@
     for the mode window, and inspection support. It also sets the client class
     and screen class to use.
-    '''
+
+    """
 
     client_class = MyClient
@@ -122 +128 @@
 
 class BasicKeys(keys.KeyHandler):
-    ''' Basic key bindings
+    """ Basic key bindings
 
     This class defines all key-bindings for the example window manager.
-    '''
+
+    """
 
     def F1(self, event):
-        ''' Find a view containing an XTerm.
-        '''
+        """ Find a view containing an XTerm.
+        """
+
         self.wm.current_screen.view_find_with_client(name('XTerm'))
 
     def S_F1(self, event):
-        ''' Start an XTerm.
-        '''
+        """ Start an XTerm.
+        """
+
         self.wm.system('xterm -geometry 80x50+200+100')
 
     def C_S_F1(self, event):
-        ''' Start an XTerm in a new view.
-        '''
+        """ Start an XTerm in a new view.
+        """
+
         self.wm.current_screen.view_new()
         self.wm.system('xterm -geometry 80x50+200+100')
 
     def F2(self, event):
-        ''' Find a view containing an Emacs window.
-        '''
+        """ Find a view containing an Emacs window.
+        """
+
         self.wm.current_screen.view_find_with_client(name('Emacs'))
 
     def S_F2(self, event):
-        ''' Start Emacs.
-        '''
+        """ Start Emacs.
+        """
+
         self.wm.system('emacs')
 
     def C_S_F2(self, event):
-        ''' Start Emacs in a new view.
-        '''
+        """ Start Emacs in a new view.
+        """
+
         self.wm.current_screen.view_new()
         self.wm.system('emacs')
 
     def F3(self, event):
-        ''' Find a view containing a Netscape window.
-        '''
+        """ Find a view containing a Netscape window.
+        """
+
         self.wm.current_screen.view_find_with_client(name('Netscape'))
 
     def S_F3(self, event):
-        ''' Start Netscape.
-        '''
+        """ Start Netscape.
+        """
+
         self.wm.system('netscape')
 
     def C_S_F3(self, event):
-        ''' Start Netscape in a new view.
-        '''
+        """ Start Netscape in a new view.
+        """
+
         self.wm.current_screen.view_new()
         self.wm.system('netscape')
 
     def F5(self, event):
-        ''' Switch to the next view with the tag 'F5'.
-        '''
+        """ Switch to the next view with the tag 'F5'.
+        """
+
         self.wm.current_screen.view_find_tag('F5')
 
     def S_F5(self, event):
-        ''' Set the current view's tag to 'F5'.
-        '''
+        """ Set the current view's tag to 'F5'.
+        """
+
         self.wm.current_screen.view_tag('F5')
 
     def F6(self, event):
-        ''' Switch to the next view with the tag 'F6'.
-        '''
+        """ Switch to the next view with the tag 'F6'.
+        """
+
         self.wm.current_screen.view_find_tag('F6')
 
     def S_F6(self, event):
-        ''' Set the current view's tag to 'F6'.
-        '''
+        """ Set the current view's tag to 'F6'.
+        """
+
         self.wm.current_screen.view_tag('F6')
 
     def F7(self, event):
-        ''' Switch to the next view with the tag 'F7'.
-        '''
+        """ Switch to the next view with the tag 'F7'.
+        """
+
         self.wm.current_screen.view_find_tag('F7')
 
     def S_F7(self, event):
-        ''' Set the current view's tag to 'F7'.
-        '''
+        """ Set the current view's tag to 'F7'.
+        """
+
         self.wm.current_screen.view_tag('F7')
 
     def F8(self, event):
-        ''' Switch to the next view with the tag 'F8'.
-        '''
+        """ Switch to the next view with the tag 'F8'.
+        """
+
         self.wm.current_screen.view_find_tag('F8')
 
     def S_F8(self, event):
-        ''' Set the current view's tag to 'F8'.
-        '''
+        """ Set the current view's tag to 'F8'.
+        """
+
         self.wm.current_screen.view_tag('F8')
 
     # Simulate mouse clicks
     def Any_F9(self, evt):
-        ''' Simulate a primary (usually, left) mouse button click.
-        '''
+        """ Simulate a primary (usually, left) mouse button click.
+        """
+
         self.wm.fake_button_click(1)
 
     def Any_F10(self, evt):
-        ''' Simulate a secondary (usually, right) mouse button click.
-        '''
+        """ Simulate a secondary (usually, right) mouse button click.
+        """
+
         self.wm.fake_button_click(2)
 
     def Any_F11(self, evt):
-        ''' Simulate a tertiary (usually, middle) mouse button click.
-        '''
+        """ Simulate a tertiary (usually, middle) mouse button click.
+        """
+
         self.wm.fake_button_click(3)
 
 
     def F12(self, evt):
-        ''' Toggle inspect mode.
-        '''
+        """ Toggle inspect mode.
+        """
+
         self.wm.inspect_toggle()
 
     def S_F12(self, evt):
-        ''' Toggle inspect mode, forcing if needed.
-        '''
+        """ Toggle inspect mode, forcing if needed.
+        """
+
         self.wm.inspect_toggle(force = 1)
 
     def S_Pause(self, evt):
-        ''' Drop all keygrabs until Scroll_Lock is pressed again.
+        """ Drop all keygrabs until Scroll_Lock is pressed again.
 
         Allows clients to recieve keys used by plwm.
-        '''
+        """
+
         wmanager.debug('keys', 'dropping keygrabs temporarily')
 
@@ -257 +287 @@
 
     def KP_Begin(self, event):
-        ''' Start moving / resizing the current window.
-        '''
+        """ Start moving / resizing the current window.
+        """
+
         MyMoveResizeKeys(self, event)
 
 
     def C_Tab(self, event):
-        ''' Cycle through minimized windows.
-        '''
+        """ Cycle through minimized windows.
+        """
+
         CycleUMKeys(self, event)
 
     def KP_Insert(self, event):
-        ''' Iconify the current window.
-        '''
+        """ Iconify the current window.
+        """
+
         wmanager.debug('keys', 'Iconifying')
         if self.wm.current_client:
@@ -275 +308 @@
 
     def KP_Subtract(self, event):
-        ''' Switch to the previous view.
-        '''
+        """ Switch to the previous view.
+        """
+
         wmanager.debug('keys', 'Prev view')
         self.wm.current_screen.view_prev()
 
     def KP_Add(self, event):
-        ''' Switch to the next view.
-        '''
+        """ Switch to the next view.
+        """
+
         wmanager.debug('keys', 'Next view')
         self.wm.current_screen.view_next()
 
     def C_KP_Add(self, event):
-        ''' Create a new view.
-        '''
+        """ Create a new view.
+        """
+
         wmanager.debug('keys', 'New view')
         self.wm.current_screen.view_new()
 
     def KP_Left(self, event):
-        ''' Move the pointer to the left.
-        '''
+        """ Move the pointer to the left.
+        """
+
         self.wm.display.warp_pointer(-delta.get(event.time), 0)
 
     def KP_Right(self, event):
-        ''' Move the pointer to the right.
-        '''
+        """ Move the pointer to the right.
+        """
+
         self.wm.display.warp_pointer(delta.get(event.time), 0)
 
     def KP_Up(self, event):
-        ''' Move the pointer up.
-        '''
+        """ Move the pointer up.
+        """
+
         self.wm.display.warp_pointer(0, -delta.get(event.time))
 
     def KP_Down(self, event):
-        ''' Move the pointer down.
-        '''
+        """ Move the pointer down.
+        """
+
         self.wm.display.warp_pointer(0, delta.get(event.time))
 
     def KP_Home(self, event):
-        ''' Move the pointer up and to the left.
-        '''
+        """ Move the pointer up and to the left.
+        """
+
         d = delta.get(event.time)
         self.wm.display.warp_pointer(-d, -d)
 
     def KP_End(self, event):
-        ''' Move the pointer down and to the left.
-        '''
+        """ Move the pointer down and to the left.
+        """
+
         d = delta.get(event.time)
         self.wm.display.warp_pointer(-d, d)
 
     def KP_Prior(self, event):
-        ''' Move the pointer up and to the right.
-        '''
+        """ Move the pointer up and to the right.
+        """
+
         d = delta.get(event.time)
         self.wm.display.warp_pointer(d, -d)
 
     def KP_Next(self, event):
-        ''' Move the pointer down and to the right.
-        '''
+        """ Move the pointer down and to the right.
+        """
+
         d = delta.get(event.time)
         self.wm.display.warp_pointer(d, d)
 
     def KP_Enter(self, event):
-        ''' Raise or lower the current window.
-        '''
+        """ Raise or lower the current window.
+        """
+
         if self.wm.current_client:
             self.wm.current_client.raiselower()
@@ -346 +391 @@
 
     def C_KP_Subtract(self, event):
-        ''' Lock the screen with xlock.
-        '''
+        """ Lock the screen with xlock.
+        """
+
         self.wm.system('xlock -mode blank')
 
     def C_M_Escape(self, event):
-        ''' Quit the window manager.
-        '''
+        """ Quit the window manager.
+        """
+
         self.wm.quit()
 
     def C_KP_Delete(self, event):
-        ''' Close the current window.
-        '''
+        """ Close the current window.
+        """
+
         if self.wm.current_client:
             self.wm.current_client.delete(1)
 
     def C_S_KP_Delete(self, event):
-        ''' Kill the current client.
-        '''
+        """ Kill the current client.
+        """
+
         if self.wm.current_client:
             self.wm.current_client.destroy()
 
     def C_KP_Left(self, event):
-        ''' Focus the next window to the left of the current one.
-        '''
+        """ Focus the next window to the left of the current one.
+        """
+
         self.wm.move_focus(focus.MOVE_LEFT)
 
     def C_KP_Right(self, event):
-        ''' Focus the next window to the right of the current one.
-        '''
+        """ Focus the next window to the right of the current one.
+        """
+
         self.wm.move_focus(focus.MOVE_RIGHT)
 
     def C_KP_Up(self, event):
-        ''' Focus the next window above the current one.
-        '''
+        """ Focus the next window above the current one.
+        """
+
         self.wm.move_focus(focus.MOVE_UP)
 
     def C_KP_Down(self, event):
-        ''' Focus the next window below the current one.
-        '''
+        """ Focus the next window below the current one.
+        """
+
         self.wm.move_focus(focus.MOVE_DOWN)
 
     def C_less(self, event):
-        ''' Focus the next window to the left of the current one.
-        '''
+        """ Focus the next window to the left of the current one.
+        """
+
         self.wm.move_focus(focus.MOVE_LEFT)
 
     def C_S_less(self, event):
-        ''' Focus the next window to the right of the current one.
-        '''
+        """ Focus the next window to the right of the current one.
+        """
+
         self.wm.move_focus(focus.MOVE_RIGHT)
 
 
 class BypassHandler(keys.KeyHandler):
-    ''' Surrogate key handler to bypass the window manager's key bindings.
+    """ Surrogate key handler to bypass the window manager's key bindings.
 
     Allows clients to receive key presses normally handled by the WM.
-    '''
+
+    """
+
     propagate_keys = 0
 
@@ -413 +470 @@
 
     def Pause(self, evt):
-        ''' Restore normal key bindings.
-        '''
+        """ Restore normal key bindings.
+        """
+
         wmanager.debug('keys', 'reinstalling keygrabs')
 
@@ -434 +492 @@
 
 class MyMoveResizeKeys(MoveResizeKeys):
-    ''' Keys for moving and resizing the current window.
-    '''
+    """ Keys for moving and resizing the current window.
+    """
+
     KP_Left  = MoveResizeKeys._move_w
     KP_Right = MoveResizeKeys._move_e
@@ -472 +531 @@
 
 class CycleUMKeys(CycleKeys):
-    ''' Keys to cycle through all iconified windows.
-    '''
+    """ Keys to cycle through all iconified windows.
+    """
+
     _cycle_filter = iconified