vtkKWText Class Reference

a multi-line text entry widget More...

#include <vtkKWText.h>

Inheritance diagram for vtkKWText:

[legend]Collaboration diagram for vtkKWText:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkKWText, vtkKWCoreWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
virtual void	AddTagMatcher (const char *regexp, const char *tag)
virtual void	UpdateEnableState ()
virtual char *	GetText ()
virtual void	SetText (const char *)
virtual void	SetText (const char *, const char *tag)
virtual void	AppendText (const char *)
virtual void	AppendText (const char *, const char *tag)
virtual void	SetReadOnly (int val)
virtual int	GetReadOnly ()
virtual void	ReadOnlyOn ()
virtual void	ReadOnlyOff ()
virtual void	SetQuickFormatting (int)
virtual int	GetQuickFormatting ()
virtual void	QuickFormattingOn ()
virtual void	QuickFormattingOff ()
virtual void	SetWidth (int)
virtual int	GetWidth ()
virtual void	SetHeight (int)
virtual int	GetHeight ()
virtual void	SetWrapToNone ()
virtual void	SetWrapToWord ()
virtual void	SetWrapToChar ()
virtual void	ResizeToGridOn ()
virtual void	ResizeToGridOff ()
virtual void	SetResizeToGrid (int)
virtual int	GetResizeToGrid ()
Static Public Member Functions
vtkKWText *	New ()
Static Public Attributes
const char *	MarkerBold
const char *	MarkerItalic
const char *	MarkerUnderline
const char *	TagBold
const char *	TagItalic
const char *	TagUnderline
const char *	TagFgNavy
const char *	TagFgRed
const char *	TagFgBlue
const char *	TagFgDarkGreen
Protected Member Functions
	vtkKWText ()
	~vtkKWText ()
virtual void	AppendTextInternalTagging (const char *, const char *tag)
virtual void	AppendTextInternal (const char *, const char *tag)
Protected Attributes
int	ReadOnly
int	QuickFormatting
vtkKWTextInternals *	Internals

---

Detailed Description

a multi-line text entry widget

A simple widget used for collecting keyboard input from the user. This widget provides support for multi-line input. Use vtkKWTextWithScrollbars if you need scrollbars.

See also:

vtkKWTextWithScrollbars

Definition at line 32 of file vtkKWText.h.

---

Constructor & Destructor Documentation

vtkKWText::vtkKWText (   )  [protected]

vtkKWText::~vtkKWText (   )  [protected]

---

Member Function Documentation

vtkKWText* vtkKWText::New (   )  [static]

Reimplemented from vtkKWCoreWidget.

vtkKWText::vtkTypeRevisionMacro (  vtkKWText  , vtkKWCoreWidget  )

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

Reimplemented from vtkKWCoreWidget.

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

Create the widget. Reimplemented from vtkKWCoreWidget.

virtual char* vtkKWText::GetText (   )  [virtual]

Set/Get the value of the text. AppendText() is a convenience function to add text at the end. If a tag is provided, it will be used to tag the corresponding text.

virtual void vtkKWText::SetText (  const char *   )  [virtual]

Set/Get the value of the text. AppendText() is a convenience function to add text at the end. If a tag is provided, it will be used to tag the corresponding text.

virtual void vtkKWText::SetText (  const char *  , const char *  tag )  [virtual]

Set/Get the value of the text. AppendText() is a convenience function to add text at the end. If a tag is provided, it will be used to tag the corresponding text.

virtual void vtkKWText::AppendText (  const char *   )  [virtual]

Set/Get the value of the text. AppendText() is a convenience function to add text at the end. If a tag is provided, it will be used to tag the corresponding text.

virtual void vtkKWText::AppendText (  const char *  , const char *  tag )  [virtual]

Set/Get the value of the text. AppendText() is a convenience function to add text at the end. If a tag is provided, it will be used to tag the corresponding text.

virtual void vtkKWText::SetReadOnly (  int  val  )  [virtual]

Set/Get if this text is read-only. Default is Off.

virtual int vtkKWText::GetReadOnly (   )  [virtual]

Set/Get if this text is read-only. Default is Off.

virtual void vtkKWText::ReadOnlyOn (   )  [virtual]

Set/Get if this text is read-only. Default is Off.

virtual void vtkKWText::ReadOnlyOff (   )  [virtual]

Set/Get if this text is read-only. Default is Off.

virtual void vtkKWText::SetQuickFormatting (  int   )  [virtual]

Set/Get if quick formatting is enabled. In this mode, strings can be tagged using markers: ** : bold (ex: this is **bold**) ~~ : italic (ex: this is ~~italic~~) __ : underline (ex: this is __underline__)

virtual int vtkKWText::GetQuickFormatting (   )  [virtual]

Set/Get if quick formatting is enabled. In this mode, strings can be tagged using markers: ** : bold (ex: this is **bold**) ~~ : italic (ex: this is ~~italic~~) __ : underline (ex: this is __underline__)

virtual void vtkKWText::QuickFormattingOn (   )  [virtual]

Set/Get if quick formatting is enabled. In this mode, strings can be tagged using markers: ** : bold (ex: this is **bold**) ~~ : italic (ex: this is ~~italic~~) __ : underline (ex: this is __underline__)

virtual void vtkKWText::QuickFormattingOff (   )  [virtual]

Set/Get if quick formatting is enabled. In this mode, strings can be tagged using markers: ** : bold (ex: this is **bold**) ~~ : italic (ex: this is ~~italic~~) __ : underline (ex: this is __underline__)

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

Convenience method to get/set the width/height, in characters.

virtual int vtkKWText::GetWidth (   )  [virtual]

Convenience method to get/set the width/height, in characters.

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

Convenience method to get/set the width/height, in characters.

virtual int vtkKWText::GetHeight (   )  [virtual]

Convenience method to get/set the width/height, in characters.

virtual void vtkKWText::SetWrapToNone (   )  [virtual]

Convenience method to set the wrap mode.

virtual void vtkKWText::SetWrapToWord (   )  [virtual]

Convenience method to set the wrap mode.

virtual void vtkKWText::SetWrapToChar (   )  [virtual]

Convenience method to set the wrap mode.

virtual void vtkKWText::AddTagMatcher (  const char *  regexp, const char *  tag )  [virtual]

Add a tag matcher. Whenever a regular expression 'regexp' is matched it will be tagged with 'tag'.

virtual void vtkKWText::ResizeToGridOn (   )  [virtual]

Convenience method to set the resize-to-grid flag. Specifies a boolean value that determines whether this widget controls the resizing grid for its top-level window. This option is typically used in text widgets, where the information in the widget has a natural size (the size of a character) and it makes sense for the window's dimensions to be integral numbers of these units. These natural window sizes form a grid. If the setGrid option is set to true then the widget will communicate with the window manager so that when the user interactively resizes the top-level window that contains the widget, the dimensions of the window will be displayed to the user in grid units and the window size will be constrained to integral numbers of grid units.

virtual void vtkKWText::ResizeToGridOff (   )  [virtual]

Convenience method to set the resize-to-grid flag. Specifies a boolean value that determines whether this widget controls the resizing grid for its top-level window. This option is typically used in text widgets, where the information in the widget has a natural size (the size of a character) and it makes sense for the window's dimensions to be integral numbers of these units. These natural window sizes form a grid. If the setGrid option is set to true then the widget will communicate with the window manager so that when the user interactively resizes the top-level window that contains the widget, the dimensions of the window will be displayed to the user in grid units and the window size will be constrained to integral numbers of grid units.

virtual void vtkKWText::SetResizeToGrid (  int   )  [virtual]

Convenience method to set the resize-to-grid flag. Specifies a boolean value that determines whether this widget controls the resizing grid for its top-level window. This option is typically used in text widgets, where the information in the widget has a natural size (the size of a character) and it makes sense for the window's dimensions to be integral numbers of these units. These natural window sizes form a grid. If the setGrid option is set to true then the widget will communicate with the window manager so that when the user interactively resizes the top-level window that contains the widget, the dimensions of the window will be displayed to the user in grid units and the window size will be constrained to integral numbers of grid units.

virtual int vtkKWText::GetResizeToGrid (   )  [virtual]

Convenience method to set the resize-to-grid flag. Specifies a boolean value that determines whether this widget controls the resizing grid for its top-level window. This option is typically used in text widgets, where the information in the widget has a natural size (the size of a character) and it makes sense for the window's dimensions to be integral numbers of these units. These natural window sizes form a grid. If the setGrid option is set to true then the widget will communicate with the window manager so that when the user interactively resizes the top-level window that contains the widget, the dimensions of the window will be displayed to the user in grid units and the window size will be constrained to integral numbers of grid units.

virtual void vtkKWText::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 vtkKWText::AppendTextInternalTagging (  const char *  , const char *  tag )  [protected, virtual]

virtual void vtkKWText::AppendTextInternal (  const char *  , const char *  tag )  [protected, virtual]

---

Member Data Documentation

const char* vtkKWText::MarkerBold [static]

Some constants BTX Definition at line 117 of file vtkKWText.h.

const char* vtkKWText::MarkerItalic [static]

Some constants BTX Definition at line 118 of file vtkKWText.h.

const char* vtkKWText::MarkerUnderline [static]

Some constants BTX Definition at line 119 of file vtkKWText.h.

const char* vtkKWText::TagBold [static]

Some constants BTX Definition at line 120 of file vtkKWText.h.

const char* vtkKWText::TagItalic [static]

Some constants BTX Definition at line 121 of file vtkKWText.h.

const char* vtkKWText::TagUnderline [static]

Some constants BTX Definition at line 122 of file vtkKWText.h.

const char* vtkKWText::TagFgNavy [static]

Some constants BTX Definition at line 123 of file vtkKWText.h.

const char* vtkKWText::TagFgRed [static]

Some constants BTX Definition at line 124 of file vtkKWText.h.

const char* vtkKWText::TagFgBlue [static]

Some constants BTX Definition at line 125 of file vtkKWText.h.

const char* vtkKWText::TagFgDarkGreen [static]

Some constants BTX Definition at line 126 of file vtkKWText.h.

int vtkKWText::ReadOnly [protected]

Definition at line 134 of file vtkKWText.h.

int vtkKWText::QuickFormatting [protected]

Definition at line 135 of file vtkKWText.h.

vtkKWTextInternals* vtkKWText::Internals [protected]

PIMPL Encapsulation for STL containers Reimplemented from vtkKWWidget. Definition at line 139 of file vtkKWText.h.

---

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

• GUI/Widgets/vtkKWText.h

---