Changeset 250

Show
Ignore:
Timestamp:
07/28/02 18:05:13 (6 years ago)
Author:
sholloway
Message:

Documentation and cleanup

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/RBFoundation/RBFoundation/Acquisition.py

    r209 r250  
    3131##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    3232 
     33"""Returns attribute value from self if exists, or from an aquirable object. 
     34 
     35Allows for dynamic pseudo inheritence from 'acquirable' objects. 
     36Use sparingly, as the acquisition (both spanish and otherwise ;) is an expesive 
     37propsition.  Works great for a subject/observer proxy, where you want notifications 
     38when values are changed. 
     39 
     40TODO: Look at doing this with metaclasses ala Aspect Oriented Programming? 
     41""" 
     42 
    3343#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    3444#~ Imports  
     
    7484 
    7585class SingleAcquisitionMixin(AcquisitionHooks): 
    76     """Allows for dynamic pseudo inheritence from a list of 'acquirable' objects. 
    77     Use sparingly, as the acquisition (both spanish and otherwise ;) is an expesive 
    78     propsition.  Works great for a subject/observer proxy, where you want notifications 
    79     when values are changed.""" 
     86    """Allows for dynamic pseudo inheritence from a list of 'acquirable' objects.""" 
    8087 
    8188    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     
    120127 
    121128class AcquisitionMixin(AcquisitionHooks): 
    122     """Allows for dynamic pseudo inheritence from a list of 'acquirable' objects. 
    123     Use sparingly, as the acquisition (both spanish and otherwise ;) is an expesive 
    124     propsition.  Works great for a subject/observer proxy, where you want notifications 
    125     when values are changed.""" 
     129    """Allows for dynamic pseudo inheritence from a list of 'acquirable' objects.""" 
     130 
    126131    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    127132    #~ Constants / Variables / Etc.  
  • trunk/RBFoundation/RBFoundation/Utilities.py

    r240 r250  
    3131##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    3232 
     33"""Just a handy sub-tool set of tools.  They just clean up the code a bit more...""" 
     34 
    3335#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    3436#~ Definitions  
  • trunk/RBJabber/RBJabber/SubjectObserver/AttributedSubject.py

    r190 r250  
    3434 
    3535Similar to Foundation.AttributedDict, except that every modification causes an  
    36 UpdateObservers call.""" 
     36UpdateObservers call. 
     37 
     38TODO: Look at doing this with metaclasses ala Aspect Oriented Programming? 
     39""" 
    3740 
    3841#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  • trunk/RBJabber/RBJabber/SubjectObserver/ProxySubject.py

    r249 r250  
    3434other subjects.  Based upon what they observer, the proxy subjects 
    3535may filter/modify/extrapolate further results, or simple pass on a  
    36 subset of those results.""" 
     36subset of those results. 
     37 
     38TODO: Look at doing this with metaclasses ala Aspect Oriented Programming? 
     39""" 
    3740 
    3841#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  • trunk/RBSkinning/RBSkinning/wxTools/wxFrameMover.py

    r236 r250  
    3030##~ 
    3131##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     32 
     33"""EventHandlers that allow any window to act as a drag bar. 
     34 
     35Primarily fills the need of having a "move handle" somewhere else than the 
     36titlebar of the window.""" 
    3237 
    3338#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  • trunk/RBSkinning/RBSkinning/wxTools/wxLockingFrame.py

    r226 r250  
    3030##~ 
    3131##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     32 
     33"""Frame locking (docking) code. 
     34 
     35Frame locking (docking) is most useful when there are a LOT of windows about 
     36and our human instincts plead for us to align them.""" 
    3237 
    3338#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  • trunk/RBSkinning/RBSkinning/wxTools/wxRolloverEvents.py

    r237 r250  
    3131##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    3232 
     33"""Provides a simple interface for creating rollover events. 
     34 
     35Note: Currently only works with Windows. 
     36""" 
    3337#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    3438#~ Imports  
  • trunk/RBSkinning/RBSkinning/wxTools/wxWeakBind.py

    r181 r250  
    3131##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    3232 
     33"""A tolerant weakbinding toolset for wxPython.""" 
     34 
    3335#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    3436#~ Imports