Source code for pyface.tasks.task_window_layout

# (C) Copyright 2005-2022 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!

from traits.api import List, Str, Tuple, Enum, Instance, Union

from pyface.tasks.task_layout import LayoutContainer, TaskLayout


[docs]class TaskWindowLayout(LayoutContainer): """ The layout of a TaskWindow. """ #: The ID of the active task. If unspecified, the first task will be #: active. active_task = Str() #: The tasks contained in the window. If an ID is specified, the task will #: use its default layout. Otherwise, it will use the specified TaskLayout items = List(Union(Str, Instance(TaskLayout)), pretty_skip=True) #: The position of the window. position = Tuple(-1, -1) #: The size of the window. size = Tuple(800, 600) #: Whether or not the application is maximized. size_state = Enum("normal", "maximized")
[docs] def get_active_task(self): """ Returns the ID of the active task in the layout, or None if there is no active task. """ if self.active_task: return self.active_task elif self.items: first = self.items[0] return first if isinstance(first, str) else first.id return None
[docs] def get_tasks(self): """ Returns the IDs of the tasks in the layout. """ return [ (item if isinstance(item, str) else item.id) for item in self.items ]
[docs] def is_equivalent_to(self, layout): """ Returns whether two layouts are equivalent, i.e. whether they contain the same tasks. """ return isinstance(layout, TaskWindowLayout) and set( self.get_tasks() ) == set(layout.get_tasks())