home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / lib / site-packages / cgkit / Interfaces / icomponent.py < prev    next >
Encoding:
Python Source  |  2007-01-11  |  2.4 KB  |  67 lines
  1. # ***** BEGIN LICENSE BLOCK *****
  2. # Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3. #
  4. # The contents of this file are subject to the Mozilla Public License Version
  5. # 1.1 (the "License"); you may not use this file except in compliance with
  6. # the License. You may obtain a copy of the License at
  7. # http://www.mozilla.org/MPL/
  8. #
  9. # Software distributed under the License is distributed on an "AS IS" basis,
  10. # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11. # for the specific language governing rights and limitations under the
  12. # License.
  13. #
  14. # The Original Code is the Python Computer Graphics Kit.
  15. #
  16. # The Initial Developer of the Original Code is Matthias Baas.
  17. # Portions created by the Initial Developer are Copyright (C) 2004
  18. # the Initial Developer. All Rights Reserved.
  19. #
  20. # Contributor(s):
  21. #
  22. # Alternatively, the contents of this file may be used under the terms of
  23. # either the GNU General Public License Version 2 or later (the "GPL"), or
  24. # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  25. # in which case the provisions of the GPL or the LGPL are applicable instead
  26. # of those above. If you wish to allow use of your version of this file only
  27. # under the terms of either the GPL or the LGPL, and not to allow others to
  28. # use your version of this file under the terms of the MPL, indicate your
  29. # decision by deleting the provisions above and replace them with the notice
  30. # and other provisions required by the GPL or the LGPL. If you do not delete
  31. # the provisions above, a recipient may use your version of this file under
  32. # the terms of any one of the MPL, the GPL or the LGPL.
  33. #
  34. # ***** END LICENSE BLOCK *****
  35. # $Id: icomponent.py,v 1.1.1.1 2004/12/12 14:31:41 mbaas Exp $
  36.  
  37. from protocols import Interface
  38.  
  39. class IComponent(Interface):
  40.     """The base component protocol.
  41.  
  42.     Every component must have a \c name attribute.
  43.  
  44.     \todo Define a slot iterator
  45.     """
  46.  
  47.     def slot(self, name):
  48.         """Return the slot with the given name.
  49.  
  50.         \param name (\c str) Slot name
  51.         \return Slot object (\c ISlot)
  52.         \todo What happens if there is no slot with the given name?
  53.         """
  54.  
  55.     def addSlot(self, name, slot):
  56.         """Add a new slot to this component.
  57.  
  58.         \param name (\c str) Slot name
  59.         \param slot (\c ISlot) The slot to be added
  60.         """
  61.  
  62.     def removeSlot(self, name):
  63.         """Remove a slot.
  64.         
  65.         \param name (\c str) Slot name
  66.         """
  67.