#------------------------------------------------------------------------------
# Copyright (c) 2008, Riverbank Computing Limited
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/LICENSE.txt and may be redistributed only
# under the conditions described in the aforementioned license.  The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
# Thanks for using Enthought open source!
#
# Author: Riverbank Computing Limited
# Description: <Enthought application scripting package component>
#------------------------------------------------------------------------------


# Enthought library imports.
from pyface.action.api import Action
from traits.api import Bool, Unicode

# Local imports.
from apptools.appscripting.package_globals import get_script_manager


class StopRecordingAction(Action):
    """An action that stops the recording of changes to scriptable objects to a
    script."""

    #### 'Action' interface ###################################################

    enabled = Bool(False)

    name = Unicode("Stop recording")

    ###########################################################################
    # 'object' interface.
    ###########################################################################

    def __init__(self, **traits):
        """ Initialise the instance. """

        super(StopRecordingAction, self).__init__(**traits)

        get_script_manager().on_trait_change(self._on_recording, 'recording')

    ###########################################################################
    # 'Action' interface.
    ###########################################################################

    def perform(self, event):
        """ Perform the action. """

        get_script_manager().stop_recording()

    ###########################################################################
    # Private interface.
    ###########################################################################

    def _on_recording(self, new):
        """ Handle a change to the script manager's recording trait. """

        self.enabled = new