Merge lp:~mcfletch/simplegc/suggestions into lp:simplegc

[Mike C. Fletcher]

Two suggested alterations for the docs:

 * keep the executable code as a separate file and use a literal include, that means a user can just run python helloworld.py to see the results of the code
 * given how brief the text is, it might be better to use comments?

I also merged in the fix for the __slots__ being ignored (old-style classes don't respect them).

[Mike C. Fletcher (mcfletch)]

Oh, and you didn't check in 5 images for the docs:

/mnt/homevar/var/pylive/src/OpenGL-dev/simplegc/docs/sgc.widgets.rst:None: WARNING: image file not readable: images/fps_counter.png
/mnt/homevar/var/pylive/src/OpenGL-dev/simplegc/docs/sgc.widgets.rst:None: WARNING: image file not readable: images/input_box.png
/mnt/homevar/var/pylive/src/OpenGL-dev/simplegc/docs/sgc.widgets.rst:None: WARNING: image file not readable: images/label.png
/mnt/homevar/var/pylive/src/OpenGL-dev/simplegc/docs/sgc.widgets.rst:None: WARNING: image file not readable: images/radio_button.png
/mnt/homevar/var/pylive/src/OpenGL-dev/simplegc/docs/sgc.widgets.rst:None: WARNING: image file not readable: images/dialog.png

HTH

[Sam Bull (dreamsorcerer)]

The other widgets are not rendering very well on a white background, due to the transparency problems. They are currently just serving as reminders for me to add the other images once I've fixed the transparency stuff.

[lp:~mcfletch/simplegc/suggestions]

237. By Sam Bull on 2012-06-02

Allow widgets to override label behaviour.

238. By Sam Bull on 2012-06-02

Fix border not padding correctly in Container.

239. By Sam Bull on 2012-06-02

Changed get_size() calls.

240. By Sam Bull on 2012-06-02

Fix flashing during fade on dialog window.

241. By Sam Bull on 2012-06-03

Changed from rendering text to using size() for speed optimisation.

242. By Sam Bull on 2012-06-04

Improved speed and accuracy of calculating selectable labels. Thanks to Weeble for doing the research.

243. By Sam Bull on 2012-06-04

Improved accuracy of cursor position when characters are not mono-width in input box. Thanks to Weeble for doing the research.

244. By Sam Bull on 2012-06-04

Merged changes to tutorial.

=== modified file 'docs/tutorial.rst'
--- docs/tutorial.rst	2012-05-27 08:21:03 +0000
+++ docs/tutorial.rst	2012-05-28 14:45:23 +0000
@@ -7,60 +7,34 @@
 Here is a simple example of using the SGC toolkit.
 It is described in more detail below.
 
-::
-
-    import pygame
-    from pygame.locals import *
-
-    import sgc
-    from sgc.locals import *
-
-    pygame.display.init()
-    pygame.font.init()
-
-    screen = sgc.surface.Screen((640,480))
-
-    clock = pygame.time.Clock()
-
-    btn = sgc.Button(label="Clicky", pos=(100, 100))
-    btn.add(0)
-
-    while True:
-        time = clock.tick(30)
-
-        for event in pygame.event.get():
-            sgc.event(event)
-            if event.type == QUIT:
-                exit()
-
-        screen.fill((0,0,0))
-        sgc.update(time)
-        pygame.display.flip()
+.. literalinclude:: ../example/helloworld.py
+    :language: python
+    :linenos:
+    :emphasize-lines: 1-2,10,14-15,21,26
+
+The file is available as ``example/helloworld.py`` in the 
+source distribution.
 
 Breakdown
 +++++++++
-::
 
-    import sgc
-    from sgc.locals import *
+.. literalinclude:: ../example/helloworld.py
+   :lines: 1-2
 
 Here we import everything we need from sgc.
 
 ----------
 
-::
-
-    pygame.display.init()
-    pygame.font.init()
+.. literalinclude:: ../example/helloworld.py
+   :lines: 4-8
 
 The toolkit needs to have the display and font modules initialised;
 ``pygame.init()`` would suffice.
 
 ----------
 
-::
-
-    screen = sgc.surface.Screen((640,480))
+.. literalinclude:: ../example/helloworld.py
+   :lines: 10
 
 This creates a screen object, in much the same way as 
 ``pygame.display.set_mode()`` does. This is required for the toolkit to
@@ -68,10 +42,9 @@
 
 ----------
 
-::
+.. literalinclude:: ../example/helloworld.py
+   :lines: 14-15
 
-    btn = sgc.Button(label="Clicky", pos=(100, 100))
-    btn.add(0)
 
 This creates a new button widget, setting the label to 'Clicky' and the top-left
 position of the widget to (100,100). The other line adds the button to the
@@ -81,18 +54,16 @@
 
 ----------
 
-::
-
-    sgc.event(event)
+.. literalinclude:: ../example/helloworld.py
+   :lines: 21
 
 This function sends an event through to the toolkit. This function should
 appear in your event loop in order to handle all incoming events.
 
 ----------
 
-::
-
-    sgc.update(time)
+.. literalinclude:: ../example/helloworld.py
+   :lines: 26
 
 This function should be called on each frame before the screen is updated.
 It should be given the time passed since the last frame; this is usually

=== added file 'example/helloworld.py'
--- example/helloworld.py	1970-01-01 00:00:00 +0000
+++ example/helloworld.py	2012-05-28 14:45:23 +0000
@@ -0,0 +1,27 @@
+import sgc
+from sgc.locals import *
+
+import pygame
+from pygame.locals import *
+
+pygame.display.init()
+pygame.font.init()
+
+screen = sgc.surface.Screen((640,480))
+
+clock = pygame.time.Clock()
+
+btn = sgc.Button(label="Clicky", pos=(100, 100))
+btn.add(0)
+
+while True:
+    time = clock.tick(30)
+
+    for event in pygame.event.get():
+        sgc.event(event)
+        if event.type == QUIT:
+            exit()
+
+    screen.fill((0,0,0))
+    sgc.update(time)
+    pygame.display.flip()

=== modified file 'sgc/surface.py'
--- sgc/surface.py	2012-03-18 22:40:53 +0000
+++ sgc/surface.py	2012-05-28 14:45:23 +0000
@@ -12,8 +12,7 @@
 
 import widgets._locals
 
-class Screen():
-
+class Screen(object):
     """
     Class for the screen.