File: PluginWordCompletion.py

package info (click to toggle)
scribes 0.3.3.3-4
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 6,512 kB
  • ctags: 4,045
  • sloc: python: 24,125; sh: 3,358; xml: 2,224; makefile: 255
file content (78 lines) | stat: -rw-r--r-- 2,312 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# -*- coding: utf-8 -*-
# Copyright © 2005 Lateef Alabi-Oki
#
# This file is part of Scribes.
#
# Scribes is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# Scribes is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Scribes; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
# USA

"""
This module documents a class that implements the plug-in protocol
to show the color editor.

@author: Lateef Alabi-Oki
@organization: The Scribes Project
@copyright: Copyright © 2005 Lateef Alabi-Oki
@license: GNU GPLv2 or Later
@contact: <mystilleef@gmail.com>
"""

name = "Word Completion Plugin"
authors = ["Lateef Alabi-Oki <mystilleef@gmail.com>"]
version = 0.1
autoload = True
class_name = "WordCompletionPlugin"
short_description = "Automatic word completion for the editor."
long_description = """Implements automatic word completion for the \
editor."""

class WordCompletionPlugin(object):
	"""
	This class initializes a plug-in that shows the color editor.
	"""

	def __init__(self, editor):
		"""
		Initialize the plug-in object.

		@param self: Reference to the WordCompletionPlugin instance.
		@type self: A WordCompletionPlugin object.

		@param editor: Reference to the text editor.
		@type editor: An Editor object.
		"""
		self.__editor = editor
		self.__manager = None

	def load(self):
		"""
		Initialize the WordCompletionPlugin instance.

		@param self: Reference to the WordCompletionPlugin instance.
		@type self: An WordCompletionPlugin object.
		"""
		from WordCompletion.Manager import CompletionManager
		self.__manager = CompletionManager(self.__editor)
		return

	def unload(self):
		"""
		Destroy the WordCompletionPlugin instance.

		@param self: Reference to the WordCompletionPlugin instance.
		@type self: An WordCompletionPlugin object.
		"""
		self.__manager.emit("destroy")
		return