Author: duncan
Date: Thu Feb 21 15:46:41 2008
New Revision: 10405
Log:
Consolidating differencies between rel-1 and rel-1-7
Modified:
branches/rel-1-7/freevo/src/gui/AlertBox.py
branches/rel-1-7/freevo/src/gui/Border.py
branches/rel-1-7/freevo/src/gui/ConfirmBox.py
branches/rel-1-7/freevo/src/gui/GUIObject.py
branches/rel-1-7/freevo/src/gui/InputBox.py
branches/rel-1-7/freevo/src/gui/Label.py
branches/rel-1-7/freevo/src/gui/PopupBox.py
Modified: branches/rel-1-7/freevo/src/gui/AlertBox.py
==============================================================================
--- branches/rel-1-7/freevo/src/gui/AlertBox.py (original)
+++ branches/rel-1-7/freevo/src/gui/AlertBox.py Thu Feb 21 15:46:41 2008
@@ -1,6 +1,6 @@
# -*- coding: iso-8859-1 -*-
# -----------------------------------------------------------------------
-# AlertBox.py - simple alert popup box class
+# Simple alert popup box class
# -----------------------------------------------------------------------
# $Id$
#
@@ -39,14 +39,22 @@
class AlertBox(PopupBox):
"""
- x x coordinate. Integer
- y y coordinate. Integer
- width Integer
- height Integer
- text String to print.
- icon icon
- text_prop A dict of 4 elements composing text proprieties:
- { 'align_h' : align_h, 'align_v' : align_v, 'mode' : mode,
'hfill': hfill }
+ @ivar text:
+ String to print.
+ @ivar x:
+ x coordinate. Integer
+ @ivar y:
+ y coordinate. Integer
+ @ivar width:
+ Integer
+ @ivar height:
+ Integer
+ @ivar icon:
+ icon
+ @ivar text_prop:
+ A dict of 4 elements composing text proprieties::
+
+ { 'align_h': align_h, 'align_v': align_v, 'mode': mode, 'hfill':
hfill }
align_v = text vertical alignment
align_h = text horizontal alignment
mode = hard (break at chars); soft (break at words)
Modified: branches/rel-1-7/freevo/src/gui/Border.py
==============================================================================
--- branches/rel-1-7/freevo/src/gui/Border.py (original)
+++ branches/rel-1-7/freevo/src/gui/Border.py Thu Feb 21 15:46:41 2008
@@ -1,6 +1,6 @@
# -*- coding: iso-8859-1 -*-
# -----------------------------------------------------------------------
-# Border - For drawing borders around rectangular objects.
+# For drawing borders around rectangular objects.
# -----------------------------------------------------------------------
# $Id$
#
@@ -63,13 +63,10 @@
def __init__(self, parent, style=None, color=None, width=None):
"""
- parent the object to draw border of. use this to get
- geometry and stuff.
- style Border Type. One of 'flat','shadow','raised' or
- 'sunken'
- color Color of object, Either a Freevo Color object
- or a color integer.
- width Thickness of border.
+ @param parent: Object to draw border of; use this to get geometry and
stuff.
+ @param style: Border Type. One of 'flat','shadow','raised' or
'sunken'
+ @param color: Color of object, Either a Freevo Color object or a
color integer.
+ @param width: Thickness of border.
"""
if not parent or not isinstance(parent, GUIObject):
raise TypeError, 'You need to set the parent correctly'
Modified: branches/rel-1-7/freevo/src/gui/ConfirmBox.py
==============================================================================
--- branches/rel-1-7/freevo/src/gui/ConfirmBox.py (original)
+++ branches/rel-1-7/freevo/src/gui/ConfirmBox.py Thu Feb 21 15:46:41 2008
@@ -1,7 +1,6 @@
# -*- coding: iso-8859-1 -*-
# -----------------------------------------------------------------------
-# ConfirmBox.py - a popup box that asks a question and prompts
-# for ok/cancel
+# a pop-up box that asks a question and prompts for ok/cancel
# -----------------------------------------------------------------------
# $Id$
#
@@ -40,21 +39,32 @@
class ConfirmBox(PopupBox):
"""
- x x coordinate. Integer
- y y coordinate. Integer
- width Integer
- height Integer
- text String to print.
- icon icon
- text_prop A dict of 4 elements composing text proprieties:
- { 'align_h' : align_h, 'align_v' : align_v, 'mode' : mode,
'hfill': hfill }
+ @ivar text:
+ String to print.
+ @ivar handler:
+ Handler call-back for the box
+ @ivar handler_message:
+ If 'handler_message' is set, the box will transform into a normal
pop-up
+ showing this text while 'handler' is called and will destroy itself
after
+ that.
+ @ivar x:
+ x coordinate. Integer
+ @ivar y:
+ y coordinate. Integer
+ @ivar width:
+ Integer
+ @ivar height:
+ Integer
+ @ivar icon:
+ icon
+ @ivar text_prop:
+ A dict of 4 elements composing text proprieties::
+
+ { 'align_h': align_h, 'align_v': align_v, 'mode': mode, 'hfill':
hfill }
align_v = text vertical alignment
align_h = text horizontal alignment
mode = hard (break at chars); soft (break at words)
hfill = True (don't shorten width) or False
-
- If 'handler_message' is set, the box will transform into a normal popup
- showing this text while 'handler' is called and will destry itself after
that.
"""
def __init__(self, text, handler=None, handler_message=None,
default_choice=0,
x=None, y=None, width=0, height=0, icon=None,
vertical_expansion=1,
Modified: branches/rel-1-7/freevo/src/gui/GUIObject.py
==============================================================================
--- branches/rel-1-7/freevo/src/gui/GUIObject.py (original)
+++ branches/rel-1-7/freevo/src/gui/GUIObject.py Thu Feb 21 15:46:41 2008
@@ -205,13 +205,15 @@
def move(self, x, y):
"""
- x Integer, amount to move along x axis.
- y Integer, amount to move along y axis.
-
Move the object by a certain amount
- Note: either the user would have to hide and show the object
- moving, or we do it for him. Not decided yet.
+ @note: Either the user would have to hide and show the object
+ moving, or we do it for him. Not decided yet.
+
+ @param x: amount to move along x axis.
+ @type x: Integer
+ @param y: amount to move along y axis.
+ @type y: Integer
"""
self.hide()
self.set_position(self.left+x, self.top+y)
Modified: branches/rel-1-7/freevo/src/gui/InputBox.py
==============================================================================
--- branches/rel-1-7/freevo/src/gui/InputBox.py (original)
+++ branches/rel-1-7/freevo/src/gui/InputBox.py Thu Feb 21 15:46:41 2008
@@ -40,15 +40,24 @@
class InputBox(PopupBox):
"""
- x x coordinate. Integer
- y y coordinate. Integer
- width Integer
- height Integer
- text String to print.
- type 'normal' or 'password'
- icon icon
- text_prop A dict of 4 elements composing text proprieties:
- { 'align_h' : align_h, 'align_v' : align_v, 'mode' : mode,
'hfill': hfill }
+ @ivar x:
+ x coordinate. Integer
+ @ivar y:
+ y coordinate. Integer
+ @ivar width:
+ Integer
+ @ivar height:
+ Integer
+ @ivar text:
+ String to print.
+ @ivar type:
+ 'normal' or 'password'
+ @ivar icon:
+ icon
+ @ivar text_prop:
+ A dict of 4 elements composing text proprieties::
+
+ { 'align_h': align_h, 'align_v': align_v, 'mode': mode, 'hfill':
hfill }
align_v = text vertical alignment
align_h = text horizontal alignment
mode = hard (break at chars); soft (break at words)
Modified: branches/rel-1-7/freevo/src/gui/Label.py
==============================================================================
--- branches/rel-1-7/freevo/src/gui/Label.py (original)
+++ branches/rel-1-7/freevo/src/gui/Label.py Thu Feb 21 15:46:41 2008
@@ -1,6 +1,6 @@
# -*- coding: iso-8859-1 -*-
# -----------------------------------------------------------------------
-# Label - A class for text labels
+# A class for text labels
# -----------------------------------------------------------------------
# $Id$
#
@@ -34,23 +34,27 @@
class Label(GUIObject):
"""
- text String, text to display
- align Integer, h_align of text. Label.CENTER, Label.RIGHT,
- Label, LEFT
- parent GUIObject, Reference to object containing this label.
- text_prop A dict of 4 elements composing text proprieties:
- { 'align_h' : align_h, 'align_v' : align_v, 'mode' : mode,
'hfill': hfill }
- align_v = text vertical alignment
- align_h = text horizontal alignment
- mode = hard (break at chars); soft (break at words)
- hfill = True (don't shorten width) or False
-
Displays a single line of text. Really it maintains a surface with a
- rendered text. If text is updated text is rerendered and reblitted to
+ rendered text. If text is updated text is re-rendered and re-blitted to
the screen.
Both text and align can be set using functions. If text is not set when
draw is called an exception is raised.
+
+ @ivar text:
+ String, text to display
+ @ivar align:
+ Integer, h_align of text. Label.CENTER, Label.RIGHT, Label, LEFT
+ @ivar parent:
+ GUIObject, Reference to object containing this label.
+ @ivar text_prop:
+ A dict of 4 elements composing text properties::
+
+ { 'align_h': align_h, 'align_v': align_v, 'mode': mode, 'hfill':
hfill }
+ align_v = text vertical alignment
+ align_h = text horizontal alignment
+ mode = hard (break at chars); soft (break at words)
+ hfill = True (don't shorten width) or False
"""
def __init__(self, text=None, parent=None, h_align=None, v_align=None,
Modified: branches/rel-1-7/freevo/src/gui/PopupBox.py
==============================================================================
--- branches/rel-1-7/freevo/src/gui/PopupBox.py (original)
+++ branches/rel-1-7/freevo/src/gui/PopupBox.py Thu Feb 21 15:46:41 2008
@@ -43,20 +43,28 @@
class PopupBox(Window):
"""
- x x coordinate. Integer
- y y coordinate. Integer
- width Integer
- height Integer
- text String to print.
- icon icon
- text_prop A dict of 4 elements composing text proprieties:
- { 'align_h' : align_h, 'align_v' : align_v, 'mode' : mode,
'hfill': hfill }
+ Trying to make a standard popup/dialog box for various usages.
+
+ @ivar x:
+ x coordinate. Integer
+ @ivar y:
+ y coordinate. Integer
+ @ivar width:
+ Integer
+ @ivar height:
+ Integer
+ @ivar text:
+ String to print.
+ @ivar icon:
+ icon
+ @ivar text_prop:
+
+ A dict of 4 elements composing text proprieties::
+ { 'align_h': align_h, 'align_v': align_v, 'mode': mode, 'hfill':
hfill }
align_v = text vertical alignment
align_h = text horizontal alignment
mode = hard (break at chars); soft (break at words)
hfill = True (don't shorten width) or False
-
- Trying to make a standard popup/dialog box for various usages.
"""
def __init__(self, text, handler=None, x=None, y=None, width=0, height=0,
@@ -99,8 +107,7 @@
"""
Get the text to display
- Arguments: None
- Returns: text
+ @returns: text
"""
return self.label.text
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Freevo-cvslog mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/freevo-cvslog
