Author: duncan
Date: Tue Jan 1 08:07:19 2008
New Revision: 10254
Log:
Updated docstrings, corrected spelling errors
Modified:
branches/rel-1/freevo/src/gui/AlertBox.py
branches/rel-1/freevo/src/gui/ConfirmBox.py
branches/rel-1/freevo/src/gui/InputBox.py
branches/rel-1/freevo/src/gui/Label.py
branches/rel-1/freevo/src/gui/PopupBox.py
branches/rel-1/freevo/src/plugins/idlebar/transcode.py
branches/rel-1/freevo/src/plugins/oneclick.py
Modified: branches/rel-1/freevo/src/gui/AlertBox.py
==============================================================================
--- branches/rel-1/freevo/src/gui/AlertBox.py (original)
+++ branches/rel-1/freevo/src/gui/AlertBox.py Tue Jan 1 08:07:19 2008
@@ -39,6 +39,8 @@
class AlertBox(PopupBox):
"""
+ @ivar text:
+ String to print.
@ivar x:
x coordinate. Integer
@ivar y:
@@ -47,12 +49,11 @@
Integer
@ivar height:
Integer
- @ivar text:
- String to print.
@ivar icon:
icon
@ivar text_prop:
- A dict of 4 elements composing text proprieties:
+ 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
Modified: branches/rel-1/freevo/src/gui/ConfirmBox.py
==============================================================================
--- branches/rel-1/freevo/src/gui/ConfirmBox.py (original)
+++ branches/rel-1/freevo/src/gui/ConfirmBox.py Tue Jan 1 08:07:19 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,6 +39,14 @@
class ConfirmBox(PopupBox):
"""
+ @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:
@@ -48,20 +55,16 @@
Integer
@ivar height:
Integer
- @ivar text:
- String to print.
@ivar icon:
icon
@ivar text_prop:
- A dict of 4 elements composing text proprieties:
+ 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/freevo/src/gui/InputBox.py
==============================================================================
--- branches/rel-1/freevo/src/gui/InputBox.py (original)
+++ branches/rel-1/freevo/src/gui/InputBox.py Tue Jan 1 08:07:19 2008
@@ -55,7 +55,8 @@
@ivar icon:
icon
@ivar text_prop:
- A dict of 4 elements composing text proprieties:
+ 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
Modified: branches/rel-1/freevo/src/gui/Label.py
==============================================================================
--- branches/rel-1/freevo/src/gui/Label.py (original)
+++ branches/rel-1/freevo/src/gui/Label.py Tue Jan 1 08:07:19 2008
@@ -34,6 +34,13 @@
class Label(GUIObject):
"""
+ Displays a single line of text. Really it maintains a surface with a
+ 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:
@@ -41,19 +48,13 @@
@ivar parent:
GUIObject, Reference to object containing this label.
@ivar text_prop:
- A dict of 4 elements composing text proprieties:
+ 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
-
- 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
- the screen.
-
- Both text and align can be set using functions. If text is not set when
- draw is called an exception is raised.
"""
def __init__(self, text=None, parent=None, h_align=None, v_align=None,
Modified: branches/rel-1/freevo/src/gui/PopupBox.py
==============================================================================
--- branches/rel-1/freevo/src/gui/PopupBox.py (original)
+++ branches/rel-1/freevo/src/gui/PopupBox.py Tue Jan 1 08:07:19 2008
@@ -43,6 +43,8 @@
class PopupBox(Window):
"""
+ Trying to make a standard popup/dialog box for various usages.
+
@ivar x:
x coordinate. Integer
@ivar y:
@@ -55,15 +57,14 @@
String to print.
@ivar icon:
icon
- @ivar text_prop:
+ @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,
Modified: branches/rel-1/freevo/src/plugins/idlebar/transcode.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/idlebar/transcode.py (original)
+++ branches/rel-1/freevo/src/plugins/idlebar/transcode.py Tue Jan 1
08:07:19 2008
@@ -54,8 +54,9 @@
"""
Shows the status of the current encoding job
- Activate with:
- | plugin.activate('idlebar.transcode')
+ Activate with::
+
+ | plugin.activate('idlebar.transcode')
"""
def __init__(self):
@@ -122,19 +123,24 @@
"""
Get the progress & pass information of the job currently encoding.
- This call returns False if no job is currently encoding (fx the queue
is not active).
- When the queue is active, this call returns a tuple of 4 values:
- (friendlyname, status, perc, timerem)
-
friendlyname is the friendlyname you assigned to the encoding job
+
status is the current status of the encoding job, represented by an
integer:
- 0 Not set (this job hasn't started encoding). Never used in this
context
- 1 Audio pass in progress
- 2 First (analyzing) video pass (only used in multipass encoding)
- 3 Final video pass
- 4 Postmerge (not used atm). Final merging or similar processing
in progress
+
perc is the percentage completed of the current pass
+
timerem is the estimated time remaining of the current pass, formatted
as a human-readable string.
+
+ @returns:
+ False if no job is currently encoding (fx the queue is not active).
+ When the queue is active, this call returns a tuple of 4 values::
+
+ (friendlyname, status, perc, timerem)
"""
_debug_('getprogress()', 2)
Modified: branches/rel-1/freevo/src/plugins/oneclick.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/oneclick.py (original)
+++ branches/rel-1/freevo/src/plugins/oneclick.py Tue Jan 1 08:07:19 2008
@@ -382,7 +382,7 @@
def updateData(self):
"""update the cache data from the 1click service
- @notes the elocation is not updated as it is static
+ @note: the elocation is not updated as it is static
"""
_debug_('updateData()', 2)
if GUI:
@@ -534,7 +534,7 @@
def getLastUpdated(self):
""" parse the lsup time
- @notes there seems to be a problem with AM/PM not parsing correctly
+ @note: there seems to be a problem with AM/PM not parsing correctly
"""
_debug_('getLastUpdated() "%s"' % self.updated, 2)
if self.zone < 0:
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Freevo-cvslog mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/freevo-cvslog
