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 Member Functions
	vtkTypeRevisionMacro (vtkKWSplashScreen, vtkKWTopLevel)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
virtual void	Display ()
void	SetProgressMessage (const char *)
virtual int	ReadImage (const char *filename)
virtual void	UpdateEnableState ()
virtual void	SetProgressMessageVerticalOffset (int)
virtual int	GetProgressMessageVerticalOffset ()
virtual char *	GetImageName ()
virtual void	SetImageName (const char *)
Static Public Member Functions
vtkKWSplashScreen *	New ()
Protected Member Functions
	vtkKWSplashScreen ()
	~vtkKWSplashScreen ()
void	UpdateCanvasSize ()
void	UpdateProgressMessagePosition ()
virtual int	GetRequestedWidth ()
virtual int	GetRequestedHeight ()
Protected Attributes
vtkKWCanvas *	Canvas
char *	ImageName
int	ProgressMessageVerticalOffset

---

Detailed Description

a splash dialog.

A class for displaying splash screen.

Definition at line 27 of file vtkKWSplashScreen.h.

---

Constructor & Destructor Documentation

vtkKWSplashScreen::vtkKWSplashScreen (   )  [protected]

vtkKWSplashScreen::~vtkKWSplashScreen (   )  [protected]

---

Member Function Documentation

vtkKWSplashScreen* vtkKWSplashScreen::New (   )  [static]

Reimplemented from vtkKWTopLevel.

vtkKWSplashScreen::vtkTypeRevisionMacro (  vtkKWSplashScreen  , vtkKWTopLevel  )

void vtkKWSplashScreen::PrintSelf (  ostream &  os, vtkIndent  indent )

Reimplemented from vtkKWTopLevel.

virtual void vtkKWSplashScreen::Create (  vtkKWApplication *  app  )  [virtual]

Create the widget. Reimplemented from vtkKWTopLevel.

virtual void vtkKWSplashScreen::Display (   )  [virtual]

Display the splash screen Override to center it no matter what. 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 char* vtkKWSplashScreen::GetImageName (   )  [virtual]

Set/Get the name of the splash image (a Tk image name)

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

Set/Get the name of the splash image (a Tk image name)

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

Convenience method to read an image and use it as the splash image If ImageName is set, this method will update the corresponding Tk image, otherwise it will create a new one and assign its name to ImageName. Check vtkKWResourceUtilities::ReadImage for the list of supported image format Return 1 on success, 0 otherwise

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.

void vtkKWSplashScreen::UpdateCanvasSize (   )  [protected]

void vtkKWSplashScreen::UpdateProgressMessagePosition (   )  [protected]

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

Convenience method to 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]

Convenience method to 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.

---

Member Data Documentation

vtkKWCanvas* vtkKWSplashScreen::Canvas [protected]

Definition at line 75 of file vtkKWSplashScreen.h.

char* vtkKWSplashScreen::ImageName [protected]

Definition at line 76 of file vtkKWSplashScreen.h.

int vtkKWSplashScreen::ProgressMessageVerticalOffset [protected]

Definition at line 77 of file vtkKWSplashScreen.h.

---

The documentation for this class was generated from the following file:

• GUI/Widgets/vtkKWSplashScreen.h

---