vtkKWLookmark Class Reference

An interface widget for a lookmark. More...

#include <vtkKWLookmark.h>

Inheritance diagram for vtkKWLookmark:

[legend]Collaboration diagram for vtkKWLookmark:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkKWLookmark, vtkKWCompositeWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
void	CommentsModifiedCallback ()
void	CreateDatasetList ()
void	Pack ()
void	UpdateVariableValues ()
virtual void	SetMacroFlag (int)
virtual int	GetMacroFlag ()
virtual int	GetMainFrameCollapsedState ()
virtual void	SetMainFrameCollapsedState (int)
virtual int	GetCommentsFrameCollapsedState ()
virtual void	SetCommentsFrameCollapsedState (int)
virtual void	SetPixelSize (int)
virtual int	GetPixelSize ()
virtual void	SetWidth (int)
virtual int	GetWidth ()
virtual void	SetHeight (int)
virtual int	GetHeight ()
void	SetIcon (vtkKWIcon *icon)
virtual void	UpdateEnableState ()
virtual char *	GetName ()
virtual void	SetName (const char *)
virtual char *	GetComments ()
virtual void	SetComments (const char *)
virtual char *	GetDataset ()
virtual void	SetDataset (const char *)
void	SetSelectionState (int state)
int	GetSelectionState ()
virtual vtkKWFrame *	GetSeparatorFrame ()
virtual vtkKWCheckButton *	GetCheckbox ()
void	EditLookmarkCallback ()
void	ChangeLookmarkName ()
void	DragAndDropPerformCommand (int x, int y, vtkKWWidget *widget, vtkKWWidget *anchor)
void	RemoveDragAndDropTargetCues ()
Static Public Member Functions
vtkKWLookmark *	New ()
Protected Member Functions
	vtkKWLookmark ()
	~vtkKWLookmark ()
Protected Attributes
vtkKWFrame *	LeftFrame
vtkKWFrame *	RightFrame
vtkKWFrame *	Frame
vtkKWFrameWithLabel *	MainFrame
vtkKWFrameWithLabel *	CommentsFrame
vtkKWLabel *	DatasetLabel
vtkKWFrame *	DatasetFrame
vtkKWPushButton *	Icon
vtkKWText *	CommentsText
vtkKWText *	NameField
vtkKWFrame *	SeparatorFrame
vtkKWCheckButton *	Checkbox
char *	Dataset
char **	DatasetList
char *	Name
char *	Comments
int	Width
int	Height
int	PixelSize
int	SelectionFlag
int	MacroFlag
int	MainFrameCollapsedState
int	CommentsFrameCollapsedState

---

Detailed Description

An interface widget for a lookmark.

This is the interface widget for lookmarks. It is made up of a labeled frame, checkbox, icon, and text widget for comments

See also:

vtkKWLookmarkContainer vtkPVLookmarkManager vtkPVLookmark

Definition at line 44 of file vtkKWLookmark.h.

---

Constructor & Destructor Documentation

vtkKWLookmark::vtkKWLookmark (   )  [protected]

vtkKWLookmark::~vtkKWLookmark (   )  [protected]

---

Member Function Documentation

vtkKWLookmark* vtkKWLookmark::New (   )  [static]

Reimplemented from vtkKWCompositeWidget. Reimplemented in vtkPVLookmark.

vtkKWLookmark::vtkTypeRevisionMacro (  vtkKWLookmark  , vtkKWCompositeWidget  )

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

Reimplemented from vtkKWCompositeWidget. Reimplemented in vtkPVLookmark.

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

Create the widget. Reimplemented from vtkKWCompositeWidget.

virtual char* vtkKWLookmark::GetName (   )  [virtual]

The name of the lookmark. Always the same as the one displayed in the lookmark widget.

virtual void vtkKWLookmark::SetName (  const char *   )  [virtual]

The name of the lookmark. Always the same as the one displayed in the lookmark widget.

virtual char* vtkKWLookmark::GetComments (   )  [virtual]

This is only allocated and written to right before a lookmark is about to be written to a lookmark file. The newlines contained herein are encoded to '~' before writing because they are lost when the ->SetObject(vtkPVLookmark) method is called

virtual void vtkKWLookmark::SetComments (  const char *   )  [virtual]

This is only allocated and written to right before a lookmark is about to be written to a lookmark file. The newlines contained herein are encoded to '~' before writing because they are lost when the ->SetObject(vtkPVLookmark) method is called

virtual char* vtkKWLookmark::GetDataset (   )  [virtual]

The full path to the lookmark's 'default dataset'. This is originally just set to the dataset from which the lookmark was created but can later be set to a different one by turning 'Use default dataset' option OFF in the loookmark manager and setting the 'use as default dataset' option in the dialog box

virtual void vtkKWLookmark::SetDataset (  const char *   )  [virtual]

The full path to the lookmark's 'default dataset'. This is originally just set to the dataset from which the lookmark was created but can later be set to a different one by turning 'Use default dataset' option OFF in the loookmark manager and setting the 'use as default dataset' option in the dialog box

void vtkKWLookmark::SetSelectionState (  int  state  )

Access to the state of the checkbutton

int vtkKWLookmark::GetSelectionState (   )

Access to the state of the checkbutton

virtual vtkKWFrame* vtkKWLookmark::GetSeparatorFrame (   )  [virtual]

Access to underlying widgets

virtual vtkKWCheckButton* vtkKWLookmark::GetCheckbox (   )  [virtual]

Access to underlying widgets

void vtkKWLookmark::EditLookmarkCallback (   )

When EditLookmarkCallback is called, an editable text widget appears in place of the label and contains the old name. The user edits this as appropriate and pressing 'Return' then calls ChangeLookmarkName

void vtkKWLookmark::ChangeLookmarkName (   )

When EditLookmarkCallback is called, an editable text widget appears in place of the label and contains the old name. The user edits this as appropriate and pressing 'Return' then calls ChangeLookmarkName

void vtkKWLookmark::CommentsModifiedCallback (   )

Updates the comments frame label to display the first few words when modified

void vtkKWLookmark::CreateDatasetList (   )

Breaks up the dataset string into an array

void vtkKWLookmark::Pack (   )

Convenience method for encapsulating and reusing code that packs this widget

void vtkKWLookmark::DragAndDropPerformCommand (  int  x, int  y, vtkKWWidget *  widget, vtkKWWidget *  anchor )

Drag and Drop functionality - highlight frame when moused over

void vtkKWLookmark::RemoveDragAndDropTargetCues (   )

Drag and Drop functionality - highlight frame when moused over

void vtkKWLookmark::UpdateVariableValues (   )

Update the widget based on either its widget values or its variable values

virtual void vtkKWLookmark::SetMacroFlag (  int   )  [virtual]

virtual int vtkKWLookmark::GetMacroFlag (   )  [virtual]

virtual int vtkKWLookmark::GetMainFrameCollapsedState (   )  [virtual]

virtual void vtkKWLookmark::SetMainFrameCollapsedState (  int   )  [virtual]

virtual int vtkKWLookmark::GetCommentsFrameCollapsedState (   )  [virtual]

virtual void vtkKWLookmark::SetCommentsFrameCollapsedState (  int   )  [virtual]

virtual void vtkKWLookmark::SetPixelSize (  int   )  [virtual]

virtual int vtkKWLookmark::GetPixelSize (   )  [virtual]

virtual void vtkKWLookmark::SetWidth (  int   )  [virtual]

Convenience method to set the width/height of a frame. Supported only starting Tcl/Tk 8.3 Reimplemented from vtkKWFrame.

virtual int vtkKWLookmark::GetWidth (   )  [virtual]

Convenience method to set the width/height of a frame. Supported only starting Tcl/Tk 8.3 Reimplemented from vtkKWFrame.

virtual void vtkKWLookmark::SetHeight (  int   )  [virtual]

Convenience method to set the width/height of a frame. Supported only starting Tcl/Tk 8.3 Reimplemented from vtkKWFrame.

virtual int vtkKWLookmark::GetHeight (   )  [virtual]

Convenience method to set the width/height of a frame. Supported only starting Tcl/Tk 8.3 Reimplemented from vtkKWFrame.

void vtkKWLookmark::SetIcon (  vtkKWIcon *  icon  )

Uses the vtkKWIcon to initialize the lookmark's Icon

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

---

Member Data Documentation

vtkKWFrame* vtkKWLookmark::LeftFrame [protected]

Definition at line 146 of file vtkKWLookmark.h.

vtkKWFrame* vtkKWLookmark::RightFrame [protected]

Definition at line 147 of file vtkKWLookmark.h.

vtkKWFrame* vtkKWLookmark::Frame [protected]

Definition at line 148 of file vtkKWLookmark.h.

vtkKWFrameWithLabel* vtkKWLookmark::MainFrame [protected]

Definition at line 149 of file vtkKWLookmark.h.

vtkKWFrameWithLabel* vtkKWLookmark::CommentsFrame [protected]

Definition at line 150 of file vtkKWLookmark.h.

vtkKWLabel* vtkKWLookmark::DatasetLabel [protected]

Definition at line 151 of file vtkKWLookmark.h.

vtkKWFrame* vtkKWLookmark::DatasetFrame [protected]

Definition at line 152 of file vtkKWLookmark.h.

vtkKWPushButton* vtkKWLookmark::Icon [protected]

Definition at line 153 of file vtkKWLookmark.h.

vtkKWText* vtkKWLookmark::CommentsText [protected]

Definition at line 154 of file vtkKWLookmark.h.

vtkKWText* vtkKWLookmark::NameField [protected]

Definition at line 155 of file vtkKWLookmark.h.

vtkKWFrame* vtkKWLookmark::SeparatorFrame [protected]

Definition at line 156 of file vtkKWLookmark.h.

vtkKWCheckButton* vtkKWLookmark::Checkbox [protected]

Definition at line 157 of file vtkKWLookmark.h.

char* vtkKWLookmark::Dataset [protected]

Definition at line 159 of file vtkKWLookmark.h.

char** vtkKWLookmark::DatasetList [protected]

Definition at line 160 of file vtkKWLookmark.h.

char* vtkKWLookmark::Name [protected]

Definition at line 161 of file vtkKWLookmark.h.

char* vtkKWLookmark::Comments [protected]

Definition at line 162 of file vtkKWLookmark.h.

int vtkKWLookmark::Width [protected]

Definition at line 163 of file vtkKWLookmark.h.

int vtkKWLookmark::Height [protected]

Definition at line 164 of file vtkKWLookmark.h.

int vtkKWLookmark::PixelSize [protected]

Definition at line 165 of file vtkKWLookmark.h.

int vtkKWLookmark::SelectionFlag [protected]

Definition at line 167 of file vtkKWLookmark.h.

int vtkKWLookmark::MacroFlag [protected]

Definition at line 168 of file vtkKWLookmark.h.

int vtkKWLookmark::MainFrameCollapsedState [protected]

Definition at line 169 of file vtkKWLookmark.h.

int vtkKWLookmark::CommentsFrameCollapsedState [protected]

Definition at line 170 of file vtkKWLookmark.h.

---

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

• GUI/Client/vtkKWLookmark.h

---