Author: EvanCofsky
Date: 2008-04-19 23:36:55 -0400 (Sat, 19 Apr 2008)
New Revision: 1245
Modified:
trunk/pysoy/src/widgets/Widget.pym
Log:
Ticket #894: Fix indentation error in Widget.pym.
Apparently Python is sensitive to that.
Modified: trunk/pysoy/src/widgets/Widget.pym
===================================================================
--- trunk/pysoy/src/widgets/Widget.pym 2008-04-19 20:05:33 UTC (rev 1244)
+++ trunk/pysoy/src/widgets/Widget.pym 2008-04-20 03:36:55 UTC (rev 1245)
@@ -18,122 +18,119 @@
# $Id$
cdef class Widget :
- """
- Widgets are two-dimensional surfaces contained in a
- L{soy.window.Window} or in a L{Container}. The size of each
- L{Widget} is calculated from the size of its parent using the
- L{margin}, and if not M{aspect > 0} the L{aspect}.
+ """
+ Widgets are two-dimensional surfaces contained in a
+ L{soy.window.Window} or in a L{Container}. The size of each
+ L{Widget} is calculated from the size of its parent using the #
+ L{margin}, and if not M{aspect > 0} the L{aspect}.
- Optional properties available on constructor:
+ Optional properties available on constructor:
- @type parent : L{soy.window.Window} or L{Container}
- @param parent : If None: this L{widget} is inactive
- If not None: The two-dimensial surface
- containing this
- L{Widget}.
+ @type parent : L{soy.window.Window} or L{Container}
+ @param parent : If None: this L{widget} is inactive
+ If not None: The two-dimensial surface
+ containing this L{Widget}.
- @type margin : tuple(int, int, int, int)
- @param margin : The amount of space to leave inside
- the bounding edges of L{parent} for
- the bounding edges of this L{Widget}.
- In order, the numbers are the margins
- for the top, right, bottom, and left
- from the corresponding edges of
- L{parent}.
+ @type margin : tuple(int, int, int, int)
+ @param margin : The amount of space to leave inside
+ the bounding edges of L{parent} for
+ the bounding edges of this L{Widget}.
+ In order, the numbers are the margins
+ for the top, right, bottom, and left
+ from the corresponding edges of
+ L{parent}.
- @type aspect : float
- @param aspect : If <= 0: not used
- If > 0: the ratio of wdith and height
- constraining this L{Widget}.
+ @type aspect : float
+ @param aspect : If <= 0: not used
+ If > 0: the ratio of wdith and height
+ constraining this L{Widget}.
- Widget Sizing
- =============
+ Widget Sizing
+ =============
- Margin and Aspect
- -----------------
+ Margin and Aspect
+ -----------------
- The L{Widget} is first constrained to the margin inside
- the parent's borders. Then, L{aspect} calculations are
- applied to reduce the dimension that is longer than the
- aspect ratio would allow.
+ The L{Widget} is first constrained to the margin inside the
+ parent's borders. Then, L{aspect} calculations are applied to
+ reduce the dimension that is longer than the aspect ratio would
+ allow.
- Units and Origin
- ----------------
+ Units and Origin
+ ----------------
- L{Widget} coordinates are physical pixels from the
- L{Window} origin in the GL coordinate space. The origin
- is located at the bottom left corner of the L{Window}, and
- increase up and to the right.
+ L{Widget} coordinates are physical pixels from the L{Window}
+ origin in the GL coordinate space. The origin is located at the
+ bottom left corner of the L{Window}, and increase up and to the
+ right.
- Parents
- =======
+ Parents
+ =======
- Behavior of L{Widget} sizing is slightly different depending
- on whether the parent is a L{soy.window.Window} or a
- L{Container}. L{__cinit__} will initialize the L{Widget}
- differently. The Parent cannot be changed after
- initialization.
+ Behavior of L{Widget} sizing is slightly different depending on
+ whether the parent is a L{soy.window.Window} or a L{Container}.
+ L{__cinit__} will initialize the L{Widget} differently. The
+ Parent cannot be changed after initialization.
- Top-Level Widgets
- -----------------
+ Top-Level Widgets
+ -----------------
- L{Widget} instances placed directly into a
- L{soy.window.Window} are X{Top Level} L{Widget}s. The size of
- these is managed by the containing L{Window}. All L{Widget}s
- contained in a L{Window} are added to the _widgets list of the
- L{Window}, even L{Widgets} not directly parenting that
- L{Window}. When the L{Window} changes size, however, it only
- resizes the Top Level L{Widget}s directly. Other L{Widget}s
- are managed by their L{Container}s.
+ L{Widget} instances placed directly into a L{soy.window.Window}
+ are X{Top Level} L{Widget}s. The size of these is managed by
+ the containing L{Window}. All L{Widget}s contained in a
+ L{Window} are added to the _widgets list of the L{Window}, even
+ L{Widgets} not directly parenting that L{Window}. When the
+ L{Window} changes size, however, it only resizes the Top Level
+ L{Widget}s directly. Other L{Widget}s are managed by their
+ L{Container}s.
- Type Methods
- ============
+ Type Methods
+ ============
- The methods of the extension type L{Widget} manage the size
- and aspect ratio constraints inside the L{parent} surface.
+ The methods of the extension type L{Widget} manage the size and
+ aspect ratio constraints inside the L{parent} surface.
- __cinit__
- ---------
+ __cinit__
+ ---------
- This initializes the C C{struct} of L{Widget}. If
- L{parent} is None, this just initializes the L{margin} and
- L{aspect}.
+ This initializes the C C{struct} of L{Widget}. If L{parent} is
+ None, this just initializes the L{margin} and L{aspect}.
- If L{parent} is specified, this will also add a reference
- to the new L{Widget} to the L{Widget} list of the
- L{soy.window.Window} of L{parent}. This new L{Widget} is
- then sized using the _resize method.
+ If L{parent} is specified, this will also add a reference to the
+ new L{Widget} to the L{Widget} list of the L{soy.window.Window}
+ of L{parent}. This new L{Widget} is then sized using the
+ _resize method.
- __dealloc__
- -----------
+ __dealloc__
+ -----------
- If this L{Widget} has a L{Window}, this is removed from
- the L{Window}'s L{Widget} list.
+ If this L{Widget} has a L{Window}, this is removed from the
+ L{Window}'s L{Widget} list.
- If this L{Widget} has a parent, it is removed from the
- parent's _widgets.
+ If this L{Widget} has a parent, it is removed from the parent's
+ _widgets.
- _setMargin
- ----------
+ _setMargin
+ ----------
- This handles interpreting the L{margin} property. If the
- margin was set, this returns 1. Otherwise, it returns 0.
+ This handles interpreting the L{margin} property. If the margin
+ was set, this returns 1. Otherwise, it returns 0.
- _render
- -------
+ _render
+ -------
- This is called by the parent when this widget should
- render its appearance. In L{Widget} itself, this does
- nothing. Subclasses should implement this.
+ This is called by the parent when this widget should render its
+ appearance. In L{Widget} itself, this does nothing. Subclasses
+ should implement this.
- _resize
- -------
+ _resize
+ -------
- This handles the margin and aspect calculations to set the
- position and size of this widget. It is called by the
- parent when the parent changes size, and by __cinit__ to
- set the initial size and position.
- """
+ This handles the margin and aspect calculations to set the
+ position and size of this widget. It is called by the parent
+ when the parent changes size, and by __cinit__ to set the
+ initial size and position.
+ """
############################################################################
#
_______________________________________________
PySoy-SVN mailing list
PySoy-SVN@pysoy.org
http://www.pysoy.org/mailman/listinfo/pysoy-svn
