バージョン 8 から バージョン 9 における更新: TracDoc/Interface

更新日時:

2006/05/10 00:50:25 (20 年 前)

更新者:

weekbuild (IP アドレス: 220.213.4.86)

コメント:

--

TracDoc/Interface

@@ -113 +113 @@
         annotation data."""
 }}}
+
+=== ITicketChangeListener ===
+Ver0.10以降。
+チケットの変更時に呼び出されるインタフェース。作成時、変更時、削除（削除ってあったっけ？）時にそれぞれ
+呼び出されるメソッドを定義する。
+{{{
+#!python
+class ITicketChangeListener(Interface):
+    """Extension point interface for components that require notification when
+    tickets are created, modified, or deleted."""
+
+    def ticket_created(ticket):
+        """Called when a ticket is created."""
+
+    def ticket_changed(ticket, comment, old_values):
+        """Called when a ticket is modified.
+        
+        `old_values` is a dictionary containing the previous values of the
+        fields that have changed.
+        """
+
+    def ticket_deleted(ticket):
+        """Called when a ticket is deleted."""
+}}}
+=== ITicketManipulator ===
+Ver0.10以降。
+チケットの登録時に呼び出されるインタフェース。値のチェックを行うのに使う。
+{{{
+#!python
+class ITicketManipulator(Interface):
+    """Miscellaneous manipulation of ticket workflow features."""
+
+    def prepare_ticket(req, ticket, fields, actions):
+        """Not currently called, but should be provided for future
+        compatibility."""
+
+    def validate_ticket(req, ticket):
+        """Validate a ticket after it's been populated from user input.
+        
+        Must return a list of `(field, message)` tuples, one for each problem
+        detected. `field` can be `None` to indicate an overall problem with the
+        ticket. Therefore, a return value of `[]` means everything is OK."""
+}}}
+=== IRepositoryConnector ===
+Ver0.10以降。
+SVN以外のバージョン管理システムを使うためのインタフェース。
+{{{
+#!python
+class IRepositoryConnector(Interface):
+    """Extension point interface for components that provide support for a
+    specific version control system."""
+
+    def get_supported_types():
+        """Return the types of version control systems that are supported by
+        this connector, and their relative priorities.
+        
+        Highest number is highest priority.
+        """
+
+    def get_repository(repos_type, repos_dir, authname):
+        """Return the Repository object for the given repository type and
+        directory.
+        """
+}}}
+=== IAuthenticator ===
+
+{{{
+#!python
+class IAuthenticator(Interface):
+    """Extension point interface for components that can provide the name
+    of the remote user."""
+
+    def authenticate(req):
+        """Return the name of the remote user, or `None` if the identity of the
+        user is unknown."""
+}}}
+=== IRequestHandler ===
+リクエストハンドラ。リクエストを処理する場合に使う。っていうかメニューにアイテムを作ったら
+まず間違いなく使う。いろんなモジュールが使っているので参照すればだいたい分かる。
+{{{
+#!python
+class IRequestHandler(Interface):
+    """Extension point interface for request handlers."""
+
+    # implementing classes should set this property to `True` if they
+    # don't need session and authentication related information
+    anonymous_request = False
+    
+    # implementing classes should set this property to `False` if they
+    # don't need the HDF data and don't produce content using a template
+    use_template = True
+    
+    def match_request(req):
+        """Return whether the handler wants to process the given request."""
+
+    def process_request(req):
+        """Process the request. Should return a (template_name, content_type)
+        tuple, where `template` is the ClearSilver template to use (either
+        a `neo_cs.CS` object, or the file name of the template), and
+        `content_type` is the MIME type of the content. If `content_type` is
+        `None`, "text/html" is assumed.
+
+        Note that if template processing should not occur, this method can
+        simply send the response itself and not return anything.
+        """
+}}}
+=== INavigationContributor ===
+メニューバーにアイテムを出すときに使う。これも多くのコンポーネントで使われている。
+{{{
+#!python
+class INavigationContributor(Interface):
+    """Extension point interface for components that contribute items to the
+    navigation.
+    """
+
+    def get_active_navigation_item(req):
+        """This method is only called for the `IRequestHandler` processing the
+        request.
+        
+        It should return the name of the navigation item that should be
+        highlighted as active/current.
+        """
+
+    def get_navigation_items(req):
+        """Should return an iterable object over the list of navigation items to
+        add, each being a tuple in the form (category, name, text).
+        """
+}}}
+=== ITemplateProvider ===
+ClearSilverテンプレートから、静的なコンテンツ（画像とか）を呼びたい場合に使う。
+{{{
+#!python
+class ITemplateProvider(Interface):
+    """Extension point interface for components that provide their own
+    ClearSilver templates and accompanying static resources.
+    """
+
+    def get_htdocs_dirs():
+        """Return a list of directories with static resources (such as style
+        sheets, images, etc.)
+
+        Each item in the list must be a `(prefix, abspath)` tuple. The
+        `prefix` part defines the path in the URL that requests to these
+        resources are prefixed with.
+        
+        The `abspath` is the absolute path to the directory containing the
+        resources on the local file system.
+        """
+}}}