##########################################################################
#
#  Copyright (c) 2011, John Haddon. All rights reserved.
#  Copyright (c) 2011-2012, Image Engine Design Inc. All rights reserved.
#
#  Redistribution and use in source and binary forms, with or without
#  modification, are permitted provided that the following conditions are
#  met:
#
#      * Redistributions of source code must retain the above
#        copyright notice, this list of conditions and the following
#        disclaimer.
#
#      * Redistributions in binary form must reproduce the above
#        copyright notice, this list of conditions and the following
#        disclaimer in the documentation and/or other materials provided with
#        the distribution.
#
#      * Neither the name of John Haddon nor the names of
#        any other contributors to this software may be used to endorse or
#        promote products derived from this software without specific prior
#        written permission.
#
#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
#  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
#  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
#  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
#  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
#  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
#  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
#  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
#  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
##########################################################################

import Gaffer
import GafferUI

class TextInputDialogue( GafferUI.Dialogue ) :

	def __init__( self, initialText="", title="Enter text", cancelLabel="Cancel", confirmLabel="OK", multiLine = False, **kw ) :

		GafferUI.Dialogue.__init__( self, title, sizeMode=GafferUI.Window.SizeMode.Fixed, **kw )

		if multiLine :
			self.__textWidget = GafferUI.MultiLineTextWidget( initialText )
		else :
			self.__textWidget = GafferUI.TextWidget( initialText )
			self.__textWidget.setSelection( None, None ) # all text

		self._setWidget( self.__textWidget )
		self.__textWidget.activatedSignal().connect( Gaffer.WeakMethod( self.__textActivated ), scoped = False )

		self.__cancelButton = self._addButton( cancelLabel )
		self.__confirmButton = self._addButton( confirmLabel )

	def waitForText( self, **kw ) :

		if isinstance( self.__textWidget, GafferUI.TextWidget ) :
			self.__textWidget.grabFocus()
		else :
			self.__textWidget.setFocussed( True )

		button = self.waitForButton( **kw )
		if button is self.__confirmButton :
			return self.__textWidget.getText()

		return None

	def __textActivated( self, textWidget ) :

		assert( textWidget is self.__textWidget )

		self.__confirmButton.clickedSignal()( self.__confirmButton )
