vtkKWTextPropertyEditor Class Reference

a GUI component that can be used to edit vtkTextProperty objects More...

#include <vtkKWTextPropertyEditor.h>

Inheritance diagram for vtkKWTextPropertyEditor:

[legend]

Collaboration diagram for vtkKWTextPropertyEditor:

[legend]

List of all members.

Public Types
typedef vtkKWCompositeWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Update ()
virtual void	SetChangedCommand (vtkObject *object, const char *method)
virtual void	SetColorChangedCommand (vtkObject *object, const char *method)
virtual void	CopyValuesFrom (vtkKWTextPropertyEditor *)
virtual void	UpdateEnableState ()
virtual void	SetTextProperty (vtkTextProperty *)
virtual vtkTextProperty *	GetTextProperty ()
virtual void	SetActor2D (vtkActor2D *)
virtual vtkActor2D *	GetActor2D ()
virtual void	SetLongFormat (int)
virtual void	LongFormatOn ()
virtual void	LongFormatOff ()
virtual int	GetLongFormat ()
virtual void	SetLabelOnTop (int)
virtual void	LabelOnTopOn ()
virtual void	LabelOnTopOff ()
virtual int	GetLabelOnTop ()
virtual void	SetLabelVisibility (int)
virtual void	LabelVisibilityOn ()
virtual void	LabelVisibilityOff ()
virtual int	GetLabelVisibility ()
virtual vtkKWLabel *	GetLabel ()
virtual void	SetColorVisibility (int)
virtual void	ColorVisibilityOn ()
virtual void	ColorVisibilityOff ()
virtual int	GetColorVisibility ()
virtual void	SetFontFamilyVisibility (int)
virtual void	FontFamilyVisibilityOn ()
virtual void	FontFamilyVisibilityOff ()
virtual int	GetFontFamilyVisibility ()
virtual void	SetStylesVisibility (int)
virtual void	StylesVisibilityOn ()
virtual void	StylesVisibilityOff ()
virtual int	GetStylesVisibility ()
virtual void	SetOpacityVisibility (int)
virtual void	OpacityVisibilityOn ()
virtual void	OpacityVisibilityOff ()
virtual int	GetOpacityVisibility ()
virtual void	SetCopyVisibility (int)
virtual void	CopyVisibilityOn ()
virtual void	CopyVisibilityOff ()
virtual int	GetCopyVisibility ()
virtual vtkKWPushButton *	GetCopyButton ()
virtual void	SaveInTclScript (ofstream *file, const char *tcl_name=0, int tabify=1)
virtual void	SetColor (double, double, double)
virtual void	SetColor (double *v)
virtual double *	GetColor ()
virtual void	SetFontFamily (int)
virtual void	SetBold (int)
virtual void	SetItalic (int)
virtual void	SetShadow (int)
virtual void	SetOpacity (float)
virtual float	GetOpacity ()
virtual void	ChangeColorButtonCallback (double, double, double)
virtual void	FontFamilyCallback ()
virtual void	BoldCallback (int state)
virtual void	ItalicCallback (int state)
virtual void	ShadowCallback (int state)
virtual void	OpacityCallback (double value)
virtual void	OpacityEndCallback (double value)
Static Public Member Functions
static vtkKWTextPropertyEditor *	New ()
static int	IsTypeOf (const char *type)
static vtkKWTextPropertyEditor *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWTextPropertyEditor ()
	~vtkKWTextPropertyEditor ()
virtual void	CreateWidget ()
virtual void	Pack ()
void	UpdateInterface ()
void	UpdateLabel ()
void	UpdateColorButton ()
void	UpdateFontFamilyOptionMenu ()
void	UpdateStylesCheckButtonSet ()
void	UpdateBoldCheckButton ()
void	UpdateItalicCheckButton ()
void	UpdateShadowCheckButton ()
void	UpdateOpacityScale ()
void	UpdatePushButtonSet ()
virtual void	InvokeChangedCommand ()
virtual void	InvokeColorChangedCommand (double r, double g, double b)
Protected Attributes
vtkTextProperty *	TextProperty
vtkActor2D *	Actor2D
int	LongFormat
int	LabelVisibility
int	LabelOnTop
vtkKWLabel *	Label
int	ColorVisibility
vtkKWChangeColorButton *	ChangeColorButton
int	FontFamilyVisibility
vtkKWMenuButtonWithLabel *	FontFamilyOptionMenu
int	StylesVisibility
vtkKWCheckButtonSetWithLabel *	StylesCheckButtonSet
int	OpacityVisibility
vtkKWScaleWithEntry *	OpacityScale
char *	ChangedCommand
char *	ColorChangedCommand
int	CopyVisibility
vtkKWPushButtonSetWithLabel *	PushButtonSet

---

Detailed Description

a GUI component that can be used to edit vtkTextProperty objects

The vtkKWTextPropertyEditor creates a set of GUI components that can be displayed and used selectively to edit all or part of a vtkTextProperty object.

Definition at line 36 of file vtkKWTextPropertyEditor.h.

---

Member Typedef Documentation

typedef vtkKWCompositeWidget vtkKWTextPropertyEditor::Superclass

Reimplemented from vtkKWCompositeWidget.

Definition at line 41 of file vtkKWTextPropertyEditor.h.

---

Constructor & Destructor Documentation

vtkKWTextPropertyEditor::vtkKWTextPropertyEditor

(

)

[protected]

vtkKWTextPropertyEditor::~vtkKWTextPropertyEditor

(

)

[protected]

---

Member Function Documentation

static vtkKWTextPropertyEditor* vtkKWTextPropertyEditor::New

(

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual const char* vtkKWTextPropertyEditor::GetClassName

(

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static int vtkKWTextPropertyEditor::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual int vtkKWTextPropertyEditor::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static vtkKWTextPropertyEditor* vtkKWTextPropertyEditor::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWTextPropertyEditor::Update

(

)

[virtual]

Refresh/Update the interface according to the value of the text property and actor2d

virtual void vtkKWTextPropertyEditor::SetTextProperty

(

vtkTextProperty *

)

[virtual]

Set/Get the text property to control.

virtual vtkTextProperty* vtkKWTextPropertyEditor::GetTextProperty

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetActor2D

(

vtkActor2D *

)

[virtual]

Set/Get the actor that uses TextProperty. This is optional, but might help to solve some backward compatibility issues. For example, the default vtkTextProperty color is -1, -1, -1 to specify to the mapper that the vtkActor2D color has to be used instead.

virtual vtkActor2D* vtkKWTextPropertyEditor::GetActor2D

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetLongFormat

(

int

)

[virtual]

Set the widget aspect to be long, i.e. the widgets will be packed on several rows, with description labels. The default is short (all widgets on a row).

virtual void vtkKWTextPropertyEditor::LongFormatOn

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::LongFormatOff

(

)

[virtual]

Set/Get the text property to control.

virtual int vtkKWTextPropertyEditor::GetLongFormat

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetLabelOnTop

(

int

)

[virtual]

Display the label on top (default, otherwise on left. Valid if LongFormat is On.

virtual void vtkKWTextPropertyEditor::LabelOnTopOn

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::LabelOnTopOff

(

)

[virtual]

Set/Get the text property to control.

virtual int vtkKWTextPropertyEditor::GetLabelOnTop

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetLabelVisibility

(

int

)

[virtual]

Set/Get the label visibility.

virtual void vtkKWTextPropertyEditor::LabelVisibilityOn

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::LabelVisibilityOff

(

)

[virtual]

Set/Get the text property to control.

virtual int vtkKWTextPropertyEditor::GetLabelVisibility

(

)

[virtual]

Set/Get the text property to control.

virtual vtkKWLabel* vtkKWTextPropertyEditor::GetLabel

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetColorVisibility

(

int

)

[virtual]

Set/Get the color interface visibility.

virtual void vtkKWTextPropertyEditor::ColorVisibilityOn

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::ColorVisibilityOff

(

)

[virtual]

Set/Get the text property to control.

virtual int vtkKWTextPropertyEditor::GetColorVisibility

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetFontFamilyVisibility

(

int

)

[virtual]

Set/Get the font family interface visibility.

virtual void vtkKWTextPropertyEditor::FontFamilyVisibilityOn

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::FontFamilyVisibilityOff

(

)

[virtual]

Set/Get the text property to control.

virtual int vtkKWTextPropertyEditor::GetFontFamilyVisibility

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetStylesVisibility

(

int

)

[virtual]

Set/Get the style interface visibility.

virtual void vtkKWTextPropertyEditor::StylesVisibilityOn

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::StylesVisibilityOff

(

)

[virtual]

Set/Get the text property to control.

virtual int vtkKWTextPropertyEditor::GetStylesVisibility

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetOpacityVisibility

(

int

)

[virtual]

Set/Get the opacity interface visibility.

virtual void vtkKWTextPropertyEditor::OpacityVisibilityOn

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::OpacityVisibilityOff

(

)

[virtual]

Set/Get the text property to control.

virtual int vtkKWTextPropertyEditor::GetOpacityVisibility

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetChangedCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Specifies a command to associate with the widget. This command is typically invoked each time a change is made to the text property. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command.

virtual void vtkKWTextPropertyEditor::SetColorChangedCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Specifies a command to associate with the widget. This command is typically invoked each time a change is made to the color of the text property (the ChangedCommand is triggered too). The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command. The following parameters are also passed to the command: - the new RGB color: double, double, double

virtual void vtkKWTextPropertyEditor::SetCopyVisibility

(

int

)

[virtual]

Set/Get the copy button visibility. This button can be used to synchronize different text property widgets.

virtual void vtkKWTextPropertyEditor::CopyVisibilityOn

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::CopyVisibilityOff

(

)

[virtual]

Set/Get the text property to control.

virtual int vtkKWTextPropertyEditor::GetCopyVisibility

(

)

[virtual]

Set/Get the text property to control.

virtual vtkKWPushButton* vtkKWTextPropertyEditor::GetCopyButton

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::CopyValuesFrom

(

vtkKWTextPropertyEditor *

)

[virtual]

Copy the values from another text widget

virtual void vtkKWTextPropertyEditor::SaveInTclScript	(	ofstream *	file,
		const char *	tcl_name = 0,
		int	tabify = 1
	)			[virtual]

Save out the text properties to a file.

virtual void vtkKWTextPropertyEditor::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 vtkKWWidget.

virtual void vtkKWTextPropertyEditor::SetColor	(	double	,
		double	,
		double
	)			[virtual]

Set the text properties

virtual void vtkKWTextPropertyEditor::SetColor

(

double *

v

)

[inline, virtual]

Set/Get the text property to control.

Definition at line 163 of file vtkKWTextPropertyEditor.h.

virtual double* vtkKWTextPropertyEditor::GetColor

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetFontFamily

(

int

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetBold

(

int

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetItalic

(

int

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetShadow

(

int

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::SetOpacity

(

float

)

[virtual]

Set/Get the text property to control.

virtual float vtkKWTextPropertyEditor::GetOpacity

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::ChangeColorButtonCallback	(	double	,
		double	,
		double
	)			[virtual]

Callbacks. Internal, do not use.

virtual void vtkKWTextPropertyEditor::FontFamilyCallback

(

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::BoldCallback

(

int

state

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::ItalicCallback

(

int

state

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::ShadowCallback

(

int

state

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::OpacityCallback

(

double

value

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::OpacityEndCallback

(

double

value

)

[virtual]

Set/Get the text property to control.

virtual void vtkKWTextPropertyEditor::CreateWidget

(

)

[protected, virtual]

Create the widget.

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWTextPropertyEditor::Pack

(

)

[protected, virtual]

void vtkKWTextPropertyEditor::UpdateInterface

(

)

[protected]

void vtkKWTextPropertyEditor::UpdateLabel

(

)

[protected]

void vtkKWTextPropertyEditor::UpdateColorButton

(

)

[protected]

void vtkKWTextPropertyEditor::UpdateFontFamilyOptionMenu

(

)

[protected]

void vtkKWTextPropertyEditor::UpdateStylesCheckButtonSet

(

)

[protected]

void vtkKWTextPropertyEditor::UpdateBoldCheckButton

(

)

[protected]

void vtkKWTextPropertyEditor::UpdateItalicCheckButton

(

)

[protected]

void vtkKWTextPropertyEditor::UpdateShadowCheckButton

(

)

[protected]

void vtkKWTextPropertyEditor::UpdateOpacityScale

(

)

[protected]

void vtkKWTextPropertyEditor::UpdatePushButtonSet

(

)

[protected]

virtual void vtkKWTextPropertyEditor::InvokeChangedCommand

(

)

[protected, virtual]

virtual void vtkKWTextPropertyEditor::InvokeColorChangedCommand	(	double	r,
		double	g,
		double	b
	)			[protected, virtual]

---

Member Data Documentation

vtkTextProperty* vtkKWTextPropertyEditor::TextProperty [protected]

Definition at line 206 of file vtkKWTextPropertyEditor.h.

vtkActor2D* vtkKWTextPropertyEditor::Actor2D [protected]

Definition at line 207 of file vtkKWTextPropertyEditor.h.

int vtkKWTextPropertyEditor::LongFormat [protected]

Definition at line 209 of file vtkKWTextPropertyEditor.h.

int vtkKWTextPropertyEditor::LabelVisibility [protected]

Definition at line 211 of file vtkKWTextPropertyEditor.h.

int vtkKWTextPropertyEditor::LabelOnTop [protected]

Definition at line 212 of file vtkKWTextPropertyEditor.h.

vtkKWLabel* vtkKWTextPropertyEditor::Label [protected]

Definition at line 213 of file vtkKWTextPropertyEditor.h.

int vtkKWTextPropertyEditor::ColorVisibility [protected]

Definition at line 215 of file vtkKWTextPropertyEditor.h.

vtkKWChangeColorButton* vtkKWTextPropertyEditor::ChangeColorButton [protected]

Definition at line 216 of file vtkKWTextPropertyEditor.h.

int vtkKWTextPropertyEditor::FontFamilyVisibility [protected]

Definition at line 218 of file vtkKWTextPropertyEditor.h.

vtkKWMenuButtonWithLabel* vtkKWTextPropertyEditor::FontFamilyOptionMenu [protected]

Definition at line 219 of file vtkKWTextPropertyEditor.h.

int vtkKWTextPropertyEditor::StylesVisibility [protected]

Definition at line 221 of file vtkKWTextPropertyEditor.h.

vtkKWCheckButtonSetWithLabel* vtkKWTextPropertyEditor::StylesCheckButtonSet [protected]

Definition at line 222 of file vtkKWTextPropertyEditor.h.

int vtkKWTextPropertyEditor::OpacityVisibility [protected]

Definition at line 224 of file vtkKWTextPropertyEditor.h.

vtkKWScaleWithEntry* vtkKWTextPropertyEditor::OpacityScale [protected]

Definition at line 225 of file vtkKWTextPropertyEditor.h.

char* vtkKWTextPropertyEditor::ChangedCommand [protected]

Definition at line 227 of file vtkKWTextPropertyEditor.h.

char* vtkKWTextPropertyEditor::ColorChangedCommand [protected]

Definition at line 228 of file vtkKWTextPropertyEditor.h.

int vtkKWTextPropertyEditor::CopyVisibility [protected]

Definition at line 233 of file vtkKWTextPropertyEditor.h.

vtkKWPushButtonSetWithLabel* vtkKWTextPropertyEditor::PushButtonSet [protected]

Definition at line 234 of file vtkKWTextPropertyEditor.h.

---

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

• vtkKWTextPropertyEditor.h