# -*- 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 for
the document switcher plug-in.

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

name = "Document Switcher"
authors = ["Lateef Alabi-Oki <mystilleef@gmail.com>"]
version = 0.1
autoload = True
class_name = "DocumentSwitcherPlugin"
short_description = "Use (ctrl - tab) to switch between documents."
long_description = """\
Use (ctrl - tab) to switch between Scribes documents.
"""

class DocumentSwitcherPlugin(object):
	"""
	This class creates an object that allows users to switch between
	Scribes's documents.
	"""

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

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

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

	def load(self):
		"""
		Initialize the plug-in.

		@param self: Reference to the DocumentSwitcherPlugin instance.
		@type self: An DocumentSwitcherPlugin object.
		"""
		from DocumentSwitcher.Trigger import DocumentSwitcherTrigger
		self.__trigger = DocumentSwitcherTrigger(self.__editor)
		return

	def unload(self):
		"""
		Destroy plug-in.

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