vtkKWHeaderAnnotationEditor Class Reference

a header annotation widget More...

#include <vtkKWHeaderAnnotationEditor.h>

Inheritance diagram for vtkKWHeaderAnnotationEditor:

[legend]

Collaboration diagram for vtkKWHeaderAnnotationEditor:

[legend]

List of all members.

Public Types
typedef vtkKWCheckButtonWithPopupFrame	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	Update ()
virtual void	UpdateEnableState ()


virtual void	SetPopupTextProperty (int)
virtual int	GetPopupTextProperty ()
virtual void	PopupTextPropertyOn ()
virtual void	PopupTextPropertyOff ()
virtual void	SetRenderWidget (vtkKWRenderWidget *)
virtual vtkKWRenderWidget *	GetRenderWidget ()
virtual void	SetVisibility (int i)
virtual int	GetVisibility ()
virtual void	VisibilityOn ()
virtual void	VisibilityOff ()
virtual void	SetAnnotationChangedEvent (int)
virtual int	GetAnnotationChangedEvent ()
virtual vtkKWCheckButton *	GetHeaderVisibilityButton ()
virtual void	CheckButtonCallback (int state)
virtual void	HeaderTextCallback (const char *value)
virtual void	TextPropertyCallback ()
Static Public Member Functions
static vtkKWHeaderAnnotationEditor *	New ()
static int	IsTypeOf (const char *type)
static vtkKWHeaderAnnotationEditor *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWHeaderAnnotationEditor ()
	~vtkKWHeaderAnnotationEditor ()
virtual void	CreateWidget ()
virtual void	Render ()
virtual void	SetHeaderText (const char *txt)
virtual int	GetCheckButtonState ()
virtual void	SendChangedEvent ()
Protected Attributes
int	AnnotationChangedEvent
vtkKWRenderWidget *	RenderWidget
int	PopupTextProperty
vtkKWFrame *	TextFrame
vtkKWEntryWithLabel *	TextEntry
vtkKWTextPropertyEditor *	TextPropertyWidget
vtkKWPopupButtonWithLabel *	TextPropertyPopupButton

Detailed Description

a header annotation widget

A class that provides a UI for header annotation (vtkTextActor).

Definition at line 32 of file vtkKWHeaderAnnotationEditor.h.

Member Typedef Documentation

typedef vtkKWCheckButtonWithPopupFrame vtkKWHeaderAnnotationEditor::Superclass

Reimplemented from vtkKWCheckButtonWithPopupFrame.

Definition at line 37 of file vtkKWHeaderAnnotationEditor.h.

Constructor & Destructor Documentation

vtkKWHeaderAnnotationEditor::vtkKWHeaderAnnotationEditor ( ) [protected]

vtkKWHeaderAnnotationEditor::~vtkKWHeaderAnnotationEditor ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual void vtkKWHeaderAnnotationEditor::SetPopupTextProperty ( int ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual int vtkKWHeaderAnnotationEditor::GetPopupTextProperty ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWHeaderAnnotationEditor::PopupTextPropertyOn ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWHeaderAnnotationEditor::PopupTextPropertyOff ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWHeaderAnnotationEditor::SetRenderWidget ( vtkKWRenderWidget * ) [virtual]

Set/Get the vtkKWRenderWidget that owns the header annotation. It is not ref-counted.

virtual vtkKWRenderWidget* vtkKWHeaderAnnotationEditor::GetRenderWidget ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWHeaderAnnotationEditor::SetVisibility ( int i ) [virtual]

Set/Get the annotation visibility

virtual int vtkKWHeaderAnnotationEditor::GetVisibility ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWHeaderAnnotationEditor::VisibilityOn ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWHeaderAnnotationEditor::VisibilityOff ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWHeaderAnnotationEditor::SetAnnotationChangedEvent ( int ) [virtual]

Set/Get the event invoked when the anything in the annotation is changed. Defaults to vtkKWEvent::ViewAnnotationChangedEvent

virtual int vtkKWHeaderAnnotationEditor::GetAnnotationChangedEvent ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual vtkKWCheckButton* vtkKWHeaderAnnotationEditor::GetHeaderVisibilityButton ( ) [inline, virtual]

Access to sub-widgets

Definition at line 72 of file vtkKWHeaderAnnotationEditor.h.

void vtkKWHeaderAnnotationEditor::Update ( ) [virtual]

Update the GUI according to the value of the ivars

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual void vtkKWHeaderAnnotationEditor::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 vtkKWCheckButtonWithPopupFrame.

virtual void vtkKWHeaderAnnotationEditor::CheckButtonCallback ( int state ) [virtual]

Callbacks. Internal, do not use.

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual void vtkKWHeaderAnnotationEditor::HeaderTextCallback ( const char * value ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWHeaderAnnotationEditor::TextPropertyCallback ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

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

Create the widget.

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual void vtkKWHeaderAnnotationEditor::Render ( ) [protected, virtual]

virtual void vtkKWHeaderAnnotationEditor::SetHeaderText ( const char * txt ) [protected, virtual]