|
|
"""SelectionContainer class.
|
|
|
|
|
|
Represents a multipage container that can be used to group other widgets into
|
|
|
pages.
|
|
|
"""
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Copyright (c) 2013, the IPython Development Team.
|
|
|
#
|
|
|
# Distributed under the terms of the Modified BSD License.
|
|
|
#
|
|
|
# The full license is in the file COPYING.txt, distributed with this software.
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Imports
|
|
|
#-----------------------------------------------------------------------------
|
|
|
from .widget_box import Box, register
|
|
|
from IPython.utils.traitlets import Unicode, Dict, CInt
|
|
|
from IPython.utils.warn import DeprecatedClass
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Classes
|
|
|
#-----------------------------------------------------------------------------
|
|
|
class _SelectionContainer(Box):
|
|
|
"""Base class used to display multiple child widgets."""
|
|
|
_titles = Dict(help="Titles of the pages", sync=True)
|
|
|
selected_index = CInt(0, sync=True)
|
|
|
|
|
|
# Public methods
|
|
|
def set_title(self, index, title):
|
|
|
"""Sets the title of a container page.
|
|
|
|
|
|
Parameters
|
|
|
----------
|
|
|
index : int
|
|
|
Index of the container page
|
|
|
title : unicode
|
|
|
New title"""
|
|
|
self._titles[index] = title
|
|
|
self.send_state('_titles')
|
|
|
|
|
|
def get_title(self, index):
|
|
|
"""Gets the title of a container pages.
|
|
|
|
|
|
Parameters
|
|
|
----------
|
|
|
index : int
|
|
|
Index of the container page"""
|
|
|
if index in self._titles:
|
|
|
return self._titles[index]
|
|
|
else:
|
|
|
return None
|
|
|
|
|
|
@register('IPython.Accordion')
|
|
|
class Accordion(_SelectionContainer):
|
|
|
"""Displays children each on a separate accordion page."""
|
|
|
_view_name = Unicode('AccordionView', sync=True)
|
|
|
|
|
|
|
|
|
@register('IPython.Tab')
|
|
|
class Tab(_SelectionContainer):
|
|
|
"""Displays children each on a separate accordion tab."""
|
|
|
_view_name = Unicode('TabView', sync=True)
|
|
|
|
|
|
|
|
|
# Remove in IPython 4.0
|
|
|
AccordionWidget = DeprecatedClass(Accordion, 'AccordionWidget')
|
|
|
TabWidget = DeprecatedClass(Tab, 'TabWidget')
|
|
|
|
