Home

AutoCompletion Interface

Sat, 01/09/2010 - 18:54 — cody

Introduction

The AutoCompI interface provides a means for plugins to provide extended autocompletion support to Editra. The interface consists of a simple class with two methods.

Interface Definition

class AutoCompI(plugin.Interface):
    """The Autocompletion interface.
 
    """
    def GetCompleter(self, buff):
        """Get the completer object implemented by this plugin
        @param: buff EditraStc instance
        @return: instance of autocomp.BaseCompleter
 
        """
        raise NotImplementedError
 
    def GetFileTypeId(self):
        """Get the filetype this completer is associated with
        @return: int
 
        """
        return 0

GetCompleter

GetCompleter needs to return a instance of an object that derives from and implements the autocomp.BaseCompleter class.

GetFileTypeId

GetFileTypeId needs to return the Editra file type ID that this completer should be applied to. See syntax.synglob for a list of standard ID's.

Links