vtkKWSplashScreen Class Reference

a splash dialog. More...

#include <vtkKWSplashScreen.h>

Inheritance diagram for vtkKWSplashScreen:

[legend]

Collaboration diagram for vtkKWSplashScreen:

[legend]

List of all members.

Public Types
typedef vtkKWTopLevel	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetProgressMessage (const char *)
virtual int	ReadImage (const char *filename)
virtual void	UpdateEnableState ()
virtual void	Display ()
virtual void	ButtonPressCallback ()
Static Public Member Functions
static vtkKWSplashScreen *	New ()
static int	IsTypeOf (const char *type)
static vtkKWSplashScreen *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWSplashScreen ()
	~vtkKWSplashScreen ()
virtual void	CreateWidget ()
virtual void	UpdateImageInCanvas ()
virtual void	UpdateCanvasSize ()
virtual void	UpdateProgressMessagePosition ()
Protected Attributes
vtkKWCanvas *	Canvas
char *	ImageName
int	ProgressMessageVerticalOffset
int	Discard

virtual void	SetProgressMessageVerticalOffset (int)
virtual int	GetProgressMessageVerticalOffset ()
virtual void	SetImageToIcon (vtkKWIcon *icon)
virtual void	SetImageToPredefinedIcon (int icon_index)
virtual void	SetImageToPixels (const unsigned char *pixels, int width, int height, int pixel_size, unsigned long buffer_length=0)
virtual char *	GetImageName ()
virtual void	SetImageName (const char *)
virtual int	GetRequestedWidth ()
virtual int	GetRequestedHeight ()

Detailed Description

a splash dialog.

A class for displaying splash screen.

Definition at line 28 of file vtkKWSplashScreen.h.

Member Typedef Documentation

typedef vtkKWTopLevel vtkKWSplashScreen::Superclass

Reimplemented from vtkKWTopLevel.

Definition at line 33 of file vtkKWSplashScreen.h.

Constructor & Destructor Documentation

vtkKWSplashScreen::vtkKWSplashScreen ( ) [protected]

vtkKWSplashScreen::~vtkKWSplashScreen ( ) [protected]

Member Function Documentation

static vtkKWSplashScreen* vtkKWSplashScreen::New ( ) [static]

Reimplemented from vtkKWTopLevel.

virtual const char* vtkKWSplashScreen::GetClassName ( ) [virtual]

Reimplemented from vtkKWTopLevel.

static int vtkKWSplashScreen::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkKWTopLevel.

virtual int vtkKWSplashScreen::IsA ( const char * type ) [virtual]

Reimplemented from vtkKWTopLevel.

static vtkKWSplashScreen* vtkKWSplashScreen::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkKWTopLevel.

void vtkKWSplashScreen::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Reimplemented from vtkKWTopLevel.

void vtkKWSplashScreen::SetProgressMessage ( const char * )

Set the text of the progress message

virtual void vtkKWSplashScreen::SetProgressMessageVerticalOffset ( int ) [virtual]

Set/Get the offset of the progress message (negative value means offset from the bottom of the splash, positive value from the top)

virtual int vtkKWSplashScreen::GetProgressMessageVerticalOffset ( ) [virtual]

Set/Get the offset of the progress message (negative value means offset from the bottom of the splash, positive value from the top)

virtual void vtkKWSplashScreen::SetImageToIcon ( vtkKWIcon * icon ) [virtual]

Specifies an image to display in the splashscreen. The SetImageToPredefinedIcon method accepts an index to one of the predefined icon listed in vtkKWIcon. The SetImageToPixels method sets the image using pixel data. It expects a pointer to the pixels and the structure of the image, i.e. its width, height and the pixel_size (how many bytes per pixel, say 3 for RGB, or 1 for grayscale). If buffer_length = 0, it is computed automatically from the previous parameters. If it is not, it will most likely indicate that the buffer has been encoded using base64 and/or zlib. If pixel_size > 3 (i.e. RGBA), the image is blend the with background color of the widget. The SetImageName method can be used to specify a pre-existing Tk image.

virtual void vtkKWSplashScreen::SetImageToPredefinedIcon ( int icon_index ) [virtual]

Set/Get the offset of the progress message (negative value means offset from the bottom of the splash, positive value from the top)

virtual void vtkKWSplashScreen::SetImageToPixels	(	const unsigned char *	pixels,
		int	width,
		int	height,
		int	pixel_size,
		unsigned long	buffer_length = `0`
	)			`[virtual]`

Set/Get the offset of the progress message (negative value means offset from the bottom of the splash, positive value from the top)

virtual int vtkKWSplashScreen::ReadImage ( const char * filename ) [virtual]

Read an image and use it as the splash image. Check vtkKWResourceUtilities::ReadImage for the list of supported image format Return 1 on success, 0 otherwise

virtual char* vtkKWSplashScreen::GetImageName ( ) [virtual]

Set/Get the name of the splashscreen image, as a Tk image name. This method is kept for backward compatibility only, as it exposes our dependency to Tk internal data structures. Use ReadImage, SetImageToIcon or SetImageToPixels instead.

virtual void vtkKWSplashScreen::SetImageName ( const char * ) [virtual]

Set/Get the offset of the progress message (negative value means offset from the bottom of the splash, positive value from the top)

virtual void vtkKWSplashScreen::UpdateEnableState ( ) [virtual]

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc.

Reimplemented from vtkKWTopLevel.

virtual void vtkKWSplashScreen::Display ( ) [virtual]

Display the toplevel. Hide it with the Withdraw() method.

Reimplemented from vtkKWTopLevel.

virtual void vtkKWSplashScreen::ButtonPressCallback ( ) [virtual]

Callbacks.

virtual void vtkKWSplashScreen::CreateWidget ( ) [protected, virtual]

Create the widget.

Reimplemented from vtkKWTopLevel.

virtual void vtkKWSplashScreen::UpdateImageInCanvas ( ) [protected, virtual]

virtual void vtkKWSplashScreen::UpdateCanvasSize ( ) [protected, virtual]

virtual void vtkKWSplashScreen::UpdateProgressMessagePosition ( ) [protected, virtual]

virtual int vtkKWSplashScreen::GetRequestedWidth ( ) [protected, virtual]

Get the width/height of the toplevel as requested by the window manager. Not exposed in public since it is so Tk related. Is is usually used to get the geometry of a window before it is mapped to screen, as requested by the geometry manager. Override to prevent the splashscreen from flickering at startup. Return the size of the image itself, without explicitly calling 'update' to let the geometry manager figure things out (= flicker)

Reimplemented from vtkKWTopLevel.

virtual int vtkKWSplashScreen::GetRequestedHeight ( ) [protected, virtual]

Set/Get the offset of the progress message (negative value means offset from the bottom of the splash, positive value from the top)

Reimplemented from vtkKWTopLevel.