Merge lp:~codeforger/simplegc/simplegc into lp:simplegc

[Michael Rochester]

Added Radio buttons and changed __init__ to load it

[lp:~codeforger/simplegc/simplegc]

202. By Sam Bull on 2012-03-23

Refactored and documented InputBox.

203. By Sam Bull on 2012-03-23

Refactored and documented Label.

204. By Sam Bull on 2012-03-23

Renamed event attribute from 'type_gui' to 'gui_type'.

[Sam Bull (dreamsorcerer)]

review: Approve

[lp:~codeforger/simplegc/simplegc]

205. By Sam Bull on 2012-03-25

Added radio buttons.

=== modified file 'sgc/example/test.py'
--- sgc/example/test.py	2012-03-19 12:30:40 +0000
+++ sgc/example/test.py	2012-03-21 15:26:20 +0000
@@ -54,6 +54,20 @@
 title.rect.center = (screen.rect.w/2, 40)
 title.add()
 
+radio1 = sgc.widgets.Radio(group="group1", label="radio1", pos=(40,350), active=True)
+radio1.add(10)
+radio2 = sgc.widgets.Radio(group="group1", label="radio2", pos=(40,390))
+radio2.add(11)
+radio3 = sgc.widgets.Radio(group="group1", label="radio3", pos=(40,430))
+radio3.add(12)
+
+radio21 = sgc.widgets.Radio(group="group2", label="radio21", pos=(190,350))
+radio21.add(13)
+radio22 = sgc.widgets.Radio(group="group2", label="radio22", pos=(190,390), active=True)
+radio22.add(14)
+radio23 = sgc.widgets.Radio(group="group2", label="radio23", pos=(190,430))
+radio23.add(15)
+
 # Create input_box
 input_box = sgc.widgets.InputBox(label="Input Box", default="default text...")
 input_box.config(pos=(30,120))

=== modified file 'sgc/widgets/__init__.py'
--- sgc/widgets/__init__.py	2012-03-18 23:26:51 +0000
+++ sgc/widgets/__init__.py	2012-03-21 15:26:20 +0000
@@ -32,5 +32,6 @@
 from input_box import InputBox
 from label import Label
 from menu import Menu
+from radio_button import Radio
 from scroll_box import ScrollBox
 from settings import Keys

=== added file 'sgc/widgets/radio_button.py'
--- sgc/widgets/radio_button.py	1970-01-01 00:00:00 +0000
+++ sgc/widgets/radio_button.py	2012-03-21 15:26:20 +0000
@@ -0,0 +1,193 @@
+#!/usr/bin/env python
+
+# Copyright (C) 2012  Michael Rochester
+
+"""
+Radio Button widget, allows user to select a discrete option in a group.
+
+"""
+
+import pygame
+from pygame.locals import *
+
+from _locals import *
+from _locals import focus
+from base_widget import Simple
+
+class Radio(Simple):
+
+    """
+    A clickable radio button
+    
+    Images:
+      'image': The default, unactive button state.
+      'over': The image used when the cursor is hovering over the button.
+      'active': The image used for the active button in a group
+          (if applicable).
+      
+    """
+    
+    _can_focus = True
+    _available_images = ("over", "active")
+    _settings_default = {"label": "", "col":(118, 45, 215), 
+                         "label_col": Font.col, "radius": 7}
+                         
+    _state = "off"
+    _draw_rect = False
+                         
+    groups = {}
+    group_list = {}
+    
+    def _config(self, **kwargs):
+        """
+          group: ``str`` name of the group to be added to
+          label: ``str`` Text to be displayed to the right of the button
+          col: ``tuple`` (r,g,b) The colour to be used for the 'over' image
+          label_col: ``tuple`` (r,g,b) The colour for the buttons label
+          active: ``True`` if present this will make this the active button 
+                 in the group
+          radius ``int`` radius of the button.
+        """
+        if "group" in kwargs:
+            if kwargs["group"] not in self.groups:
+                self.groups[kwargs["group"]] = None
+                self.group_list[kwargs["group"]] = []
+            self._settings["group"] = kwargs["group"]
+            self.group_list[self._settings["group"]].append(self)
+        # Label to the right of the button
+        if "label" in kwargs:
+            # Save string as new label
+            self._settings["label"] = kwargs["label"]
+        # Colour of 'over' image
+        if "col" in kwargs:
+            self._settings["col"] = kwargs["col"]
+        # Colour of label
+        if "label_col" in kwargs:
+            self._settings["label_col"] = kwargs["labe_col"]
+        if "radius" in kwargs:
+            self._settings["radius"] = kwargs["radius"]
+        assert self._settings["group"] is not None
+        if "active" in kwargs:
+            self._draw()
+            self._activate()
+    
+    def _draw(self, draw):
+        r = self._settings["radius"]
+        # Render text
+        label = Simple(Font["widget"].render(self._settings["label"], True,
+                                             self._settings["label_col"]))
+        if not hasattr(self, "image"):
+            self._create_base_images((r*2+10+label.rect.w,
+                                      max(label.rect.height,r*2)))
+
+        cent = self.rect.h/2
+        # Set all to transparent
+        self._images["image"].fill(0)
+        self._images["over"].fill(0)
+        self._images["active"].fill(0)
+        # Draw all base circles
+        draw.circle(self._images["image"],(255,255,255),(r,cent), r)
+        draw.circle(self._images["over"],self._settings["col"],(r,cent), r)
+        # Draw all the rings
+        draw.circle(self._images["image"],(0,0,1), (r,cent), r, 1)
+        draw.circle(self._images["over"],(0,0,1), (r,cent), r, 1)
+        # Draw the central dot for 'active'
+        draw.circle(self._images["active"],(0,0,1), (r,cent), r*2/3)
+        # Blit text
+        self._images["image"].blit(label.image, (r*2+10,cent-(label.rect.h/2)))
+        self._images["over"].blit(label.image, (r*2+10,cent-(label.rect.h/2)))
+        self._draw_button()
+                    
+    def update(self, time):
+        """Update the button each frame."""
+        if self.rect_abs.collidepoint(pygame.mouse.get_pos()):
+            if self._state != "over":
+                # Draw over state
+                self._state = "over"
+                self._draw_button()
+        elif self._state != "off":
+            # Draw normal state
+            self._state = "off"
+            self._draw_button()  
+
+    def _event(self, event):
+        """Respond to events."""
+        if event.type == MOUSEBUTTONUP and event.button == 1:
+            self._state = None
+            # If releasing mouse on button, call function
+            if self.rect_abs.collidepoint(event.pos):
+                self._activate()
+        elif event.type == KEYDOWN:
+            if event.key == K_UP:
+                if self.group_list[self._settings["group"]].index(self) != 0:
+                    group = self.group_list[self._settings["group"]]
+                    group[(group.index(self)-1)]._activate()
+                    focus.add(1,self.groups[self._settings["group"]])
+            elif event.key == K_DOWN:
+                    if self.group_list[self._settings["group"]].index(self) \
+                       < len(self.group_list[self._settings["group"]]) -1:
+                        group = self.group_list[self._settings["group"]]
+                        group[(group.index(self)+1)]._activate()
+                        focus.add(1,self.groups[self._settings["group"]])
+        elif event.type == KEYUP:
+            if event.key in (13,32):  # Enter or space key
+                self._activate()
+        
+    def _focus_enter(self, focus):
+        """Draw rectangle when focus is gained from keyboard."""
+        if focus == 1:
+            self._draw_rect = True
+            self._draw_button()
+
+    def _focus_exit(self):
+        """Stop drawing rectangle when focus is lost."""
+        self._draw_rect = False
+        self._draw_button()
+
+    def _draw_button(self):
+        """Draw the button."""
+        if self._state == "off":
+            self.image = self._images["image"].copy()
+        elif self._state == "over":
+            self.image = self._images["over"].copy()
+        if self.groups[self._settings["group"]] is self:
+            self.image.blit(self._images["active"],(0,0))
+        # Draw dotted rectangle to show keyboard focus
+        if self._draw_rect:
+            self._dotted_rect()
+        
+    def _activate(self):
+        old = self.groups[self._settings["group"]]
+        self.groups[self._settings["group"]] = self
+        if old is not None:
+            old._draw_button()
+        self._draw_button()
+    
+    def clear(self, group=None):
+        if group is None: group = self._settings["group"]
+        old = self.groups[group]
+        self.groups[group] = None
+        if old is not None:
+            old._draw_button()
+    
+    @property
+    def active(self):
+        return self is self.groups[self._settings["group"]]
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
\ No newline at end of file