Source code for pyface.i_splash_screen

# (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!

""" The interface for a splash screen. """


import logging


from traits.api import Any, Bool, HasTraits, Int, Tuple, Str


from pyface.ui_traits import Image
from pyface.splash_screen_log_handler import SplashScreenLogHandler
from pyface.i_window import IWindow


[docs]class ISplashScreen(IWindow): """ The interface for a splash screen. """ # 'ISplashScreen' interface -------------------------------------------- #: The image to display on the splash screen. image = Image() #: If log messages are to be displayed then this is the logging level. See #: the Python documentation for the 'logging' module for more details. log_level = Int(logging.DEBUG) #: Should the splash screen display log messages in the splash text? show_log_messages = Bool(True) #: Optional text to display on top of the splash image. text = Str() #: The text color. # FIXME v3: When TraitsUI supports PyQt then change this to 'Color', # (unless that needs the toolkit to be selected too soon, in which case it # may need to stay as Any - or Str?) # text_color = WxColor('black') text_color = Any() #: The text font. # FIXME v3: When TraitsUI supports PyQt then change this back to # 'Font(None)' with the actual default being toolkit specific. # text_font = Font(None) text_font = Any() #: The x, y location where the text will be drawn. # FIXME v3: Remove this. text_location = Tuple(5, 5)
[docs]class MSplashScreen(HasTraits): """ The mixin class that contains common code for toolkit specific implementations of the ISplashScreen interface. Reimplements: open(), close() """ # ------------------------------------------------------------------------ # 'IWindow' interface. # ------------------------------------------------------------------------
[docs] def open(self): """ Creates the toolkit-specific control for the widget. """ super().open() if self.show_log_messages: self._log_handler = SplashScreenLogHandler(self) self._log_handler.setLevel(self.log_level) # Get the root logger. logger = logging.getLogger() logger.addHandler(self._log_handler)
[docs] def close(self): """ Close the window. """ if self.show_log_messages: # Get the root logger. logger = logging.getLogger() logger.removeHandler(self._log_handler) super().close()