Source code for pyface.wizard.i_wizard_controller
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in 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!
""" The interface for all pyface wizard controllers. """
from traits.api import Bool, Interface, Instance, List
from .i_wizard_page import IWizardPage
[docs]class IWizardController(Interface):
""" The interface for all pyface wizard controllers. """
# 'IWizardController' interface ----------------------------------------
# The pages under the control of this controller.
pages = List(IWizardPage)
# The current page.
current_page = Instance(IWizardPage)
# Set if the wizard complete.
complete = Bool(False)
# ------------------------------------------------------------------------
# 'IWizardController' interface.
# ------------------------------------------------------------------------
[docs] def get_first_page(self):
""" Returns the first page in the model. """
[docs] def get_next_page(self, page):
""" Returns the next page. """
[docs] def get_previous_page(self, page):
""" Returns the previous page. """
[docs] def is_first_page(self, page):
""" Is the page the first page? """
[docs] def is_last_page(self, page):
""" Is the page the last page? """
[docs] def dispose_pages(self):
""" Dispose all the pages. """