Model Railroad System  2.2.1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
splash Class Reference

Widget that implements a spash window. More...

Public Member Functions

 update (statusMessage, percentDone)
 Method to update the splash window. More...
 
 enableClickDestroy ()
 Method to enable click to destroy. More...
 
 hide ()
 Method to hide the splash window. More...
 
 show ()
 Method to show the splash window. More...
 
 splash (name,...)
 Constructor initialize a spash window. More...
 

Private Member Functions

 CheckColor (option, value)
 Method to validate a color option. More...
 
 CheckImage (option, value)
 Method to validate an image option. More...
 

Private Attributes

 image
 Image component. More...
 
 progressBar
 Progress bar component. More...
 
 title
 Title component. More...
 
 icon
 Icon component. More...
 
 status
 Status component. More...
 
 header
 Header component. More...
 
 currentProgress
 The current progress. More...
 

Detailed Description

Widget that implements a spash window.

A splash window is a toplevel that is displayed during startup and shows a startup graphic and shows the startup / initialization progress.

Parameters
pathThe widget path.
...Options:
  • -style Style name, default is Splash.
  • -titleforeground Delegated to the title widget as -forground.
  • -statusforeground Delegated to the status widget as -forground.
  • -background Background color.
  • -progressbar Flag that enables or disables the progress bar.
  • -image Spash image to display in the lower part of the splash window.
  • -icon Icon to display next to the text in the upper part of the splash window.
  • -title Title text.
Author
Robert Heller <heller@deepsoft.com>

Package provided

Splash 1.0

Constructor & Destructor Documentation

◆ splash()

splash::splash ( name  ,
  ... 
)

Constructor initialize a spash window.

Parameters
...Option list. [index] constructor!splash

Member Function Documentation

◆ CheckColor()

splash::CheckColor ( option  ,
value   
)
private

Method to validate a color option.

Parameters
optionThe option being set.
valueThe value it is being set to.

◆ CheckImage()

splash::CheckImage ( option  ,
value   
)
private

Method to validate an image option.

Parameters
optionThe option being set.
valueThe value it is being set to.

◆ enableClickDestroy()

splash::enableClickDestroy ( )

Method to enable click to destroy.

◆ hide()

splash::hide ( )

Method to hide the splash window.

◆ show()

splash::show ( )

Method to show the splash window.

◆ update()

splash::update ( statusMessage  ,
percentDone   
)

Method to update the splash window.

Parameters
statusMessageThe new status message.
percentDoneThe percent completed.

Member Data Documentation

◆ currentProgress

splash::currentProgress
private

The current progress.

◆ header

splash::header
private

Header component.

◆ icon

splash::icon
private

Icon component.

◆ image

splash::image
private

Image component.

◆ progressBar

splash::progressBar
private

Progress bar component.

◆ status

splash::status
private

Status component.

◆ title

splash::title
private

Title component.