Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkKWLabel Class Reference

label widget More...

#include <vtkKWLabel.h>

Inheritance diagram for vtkKWLabel:

Inheritance graph
[legend]
Collaboration diagram for vtkKWLabel:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeRevisionMacro (vtkKWLabel, vtkKWCoreWidget)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Create (vtkKWApplication *app)
virtual void UpdateEnableState ()
virtual void AdjustWrapLengthToWidthCallback ()
virtual void SetText (const char *)
virtual char * GetText ()
virtual void SetWidth (int)
virtual int GetWidth ()
virtual void SetHeight (int)
virtual int GetHeight ()
virtual void SetJustification (int)
virtual int GetJustification ()
virtual void SetJustificationToLeft ()
virtual void SetJustificationToCenter ()
virtual void SetJustificationToRight ()
virtual void SetAnchor (int)
virtual int GetAnchor ()
virtual void SetAnchorToNorth ()
virtual void SetAnchorToNorthEast ()
virtual void SetAnchorToEast ()
virtual void SetAnchorToSouthEast ()
virtual void SetAnchorToSouth ()
virtual void SetAnchorToSouthWest ()
virtual void SetAnchorToWest ()
virtual void SetAnchorToNorthWest ()
virtual void SetAnchorToCenter ()
virtual void SetWrapLength (const char *length)
virtual const char * GetWrapLength ()
virtual void SetAdjustWrapLengthToWidth (int)
virtual int GetAdjustWrapLengthToWidth ()
virtual void AdjustWrapLengthToWidthOn ()
virtual void AdjustWrapLengthToWidthOff ()
virtual void SetImageToIcon (vtkKWIcon *icon)
virtual void SetImageToPredefinedIcon (int icon_index)
virtual void SetImageToPixels (const unsigned char *pixels, int width, int height, int pixel_size, unsigned long buffer_length=0)

Static Public Member Functions

vtkKWLabel * New ()

Protected Member Functions

 vtkKWLabel ()
 ~vtkKWLabel ()
virtual void UpdateBindings ()
virtual void UpdateText ()

Detailed Description

label widget

A simple widget that represents a label. A label is a widget that displays a textual string (or image). If text is displayed, it must all be in a single font, but it can occupy multiple lines on the screen (if it contains newlines or if wrapping occurs because of the WrapLength option). For longer text and more justification options, see vtkKWMessage.

See also:
vtkKWMessage

Definition at line 33 of file vtkKWLabel.h.

Constructor & Destructor Documentation

vtkKWLabel::vtkKWLabel (   )  [protected]
 

vtkKWLabel::~vtkKWLabel (   )  [protected]
 

Member Function Documentation

vtkKWLabel* vtkKWLabel::New (   )  [static]
 

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkPVCameraIcon.

vtkKWLabel::vtkTypeRevisionMacro (  vtkKWLabel  ,
vtkKWCoreWidget 
) 
 

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

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkPVCameraIcon.

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

Create the widget.

Reimplemented from vtkKWCoreWidget.

Reimplemented in vtkPVCameraIcon.

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

Set the text on the label.

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

Set the text on the label.

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

Set/Get width of the label. If an image is being displayed in the label then the value is in screen units; for text it is in characters.

virtual int vtkKWLabel::GetWidth (   )  [virtual]
 

Set/Get width of the label. If an image is being displayed in the label then the value is in screen units; for text it is in characters.

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

Set/Get height of the label. If an image is being displayed in the label then the value is in screen units; for text it is in lines of text.

virtual int vtkKWLabel::GetHeight (   )  [virtual]
 

Set/Get height of the label. If an image is being displayed in the label then the value is in screen units; for text it is in lines of text.

virtual void vtkKWLabel::SetJustification (  int   )  [virtual]
 

Set/Get the justification mode. When there are multiple lines of text displayed in a widget, this option determines how the lines line up with each other. Valid constants can be found in vtkKWTkOptions::JustificationType.

virtual int vtkKWLabel::GetJustification (   )  [virtual]
 

Set/Get the justification mode. When there are multiple lines of text displayed in a widget, this option determines how the lines line up with each other. Valid constants can be found in vtkKWTkOptions::JustificationType.

virtual void vtkKWLabel::SetJustificationToLeft (   )  [inline, virtual]
 

Set/Get the justification mode. When there are multiple lines of text displayed in a widget, this option determines how the lines line up with each other. Valid constants can be found in vtkKWTkOptions::JustificationType.

Definition at line 72 of file vtkKWLabel.h.

virtual void vtkKWLabel::SetJustificationToCenter (   )  [inline, virtual]
 

Set/Get the justification mode. When there are multiple lines of text displayed in a widget, this option determines how the lines line up with each other. Valid constants can be found in vtkKWTkOptions::JustificationType.

Definition at line 74 of file vtkKWLabel.h.

virtual void vtkKWLabel::SetJustificationToRight (   )  [inline, virtual]
 

Set/Get the justification mode. When there are multiple lines of text displayed in a widget, this option determines how the lines line up with each other. Valid constants can be found in vtkKWTkOptions::JustificationType.

Definition at line 76 of file vtkKWLabel.h.

virtual void vtkKWLabel::SetAnchor (  int   )  [virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

virtual int vtkKWLabel::GetAnchor (   )  [virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

virtual void vtkKWLabel::SetAnchorToNorth (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 86 of file vtkKWLabel.h.

virtual void vtkKWLabel::SetAnchorToNorthEast (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 88 of file vtkKWLabel.h.

virtual void vtkKWLabel::SetAnchorToEast (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 90 of file vtkKWLabel.h.

virtual void vtkKWLabel::SetAnchorToSouthEast (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 92 of file vtkKWLabel.h.

virtual void vtkKWLabel::SetAnchorToSouth (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 94 of file vtkKWLabel.h.

virtual void vtkKWLabel::SetAnchorToSouthWest (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 96 of file vtkKWLabel.h.

virtual void vtkKWLabel::SetAnchorToWest (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 98 of file vtkKWLabel.h.

virtual void vtkKWLabel::SetAnchorToNorthWest (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 100 of file vtkKWLabel.h.

virtual void vtkKWLabel::SetAnchorToCenter (   )  [inline, virtual]
 

Set/Get the anchoring. Specifies how the information in a widget (e.g. text or a bitmap) is to be displayed in the widget. Valid constants can be found in vtkKWTkOptions::AnchorType.

Definition at line 102 of file vtkKWLabel.h.

virtual void vtkKWLabel::SetWrapLength (  const char *  length  )  [virtual]
 

Set/Get the wrap length mode. For widgets that can perform word-wrapping, this option specifies the maximum line length. Lines that would exceed this length are wrapped onto the next line, so that no line is longer than the specified length. The value may be specified in any of the standard forms for screen distances (i.e, "2i" means 2 inches). If this value is less than or equal to 0 then no wrapping is done: lines will break only at newline characters in the text.

virtual const char* vtkKWLabel::GetWrapLength (   )  [virtual]
 

Set/Get the wrap length mode. For widgets that can perform word-wrapping, this option specifies the maximum line length. Lines that would exceed this length are wrapped onto the next line, so that no line is longer than the specified length. The value may be specified in any of the standard forms for screen distances (i.e, "2i" means 2 inches). If this value is less than or equal to 0 then no wrapping is done: lines will break only at newline characters in the text.

virtual void vtkKWLabel::SetAdjustWrapLengthToWidth (  int   )  [virtual]
 

Adjust the -wraplength argument so that it matches the width of the widget automatically (through the Configure event).

virtual int vtkKWLabel::GetAdjustWrapLengthToWidth (   )  [virtual]
 

Adjust the -wraplength argument so that it matches the width of the widget automatically (through the Configure event).

virtual void vtkKWLabel::AdjustWrapLengthToWidthOn (   )  [virtual]
 

Adjust the -wraplength argument so that it matches the width of the widget automatically (through the Configure event).

virtual void vtkKWLabel::AdjustWrapLengthToWidthOff (   )  [virtual]
 

Adjust the -wraplength argument so that it matches the width of the widget automatically (through the Configure event).

virtual void vtkKWLabel::SetImageToIcon (  vtkKWIcon *  icon  )  [virtual]
 

Specifies an image to display in the widget. Typically, if the image is specified then it overrides other options that specify a bitmap or textual value to display in the widget. Invoke vtkKWWidget's SetConfigurationOption("-image", imagename) to use a specific pre-existing Tk image, or call one of the following functions. The SetImageToPredefinedIcon method accepts an index to one of the predefined icon listed in vtkKWIcon. The SetImageToPixels method sets the image using pixel data. It expects a pointer to the pixels and the structure of the image, i.e. its width, height and the pixel_size (how many bytes per pixel, say 3 for RGB, or 1 for grayscale). If buffer_length = 0, it is computed automatically from the previous parameters. If it is not, it will most likely indicate that the buffer has been encoded using base64 and/or zlib. If pixel_size > 3 (i.e. RGBA), the image is blend the with background color of the widget.

virtual void vtkKWLabel::SetImageToPredefinedIcon (  int  icon_index  )  [virtual]
 

Specifies an image to display in the widget. Typically, if the image is specified then it overrides other options that specify a bitmap or textual value to display in the widget. Invoke vtkKWWidget's SetConfigurationOption("-image", imagename) to use a specific pre-existing Tk image, or call one of the following functions. The SetImageToPredefinedIcon method accepts an index to one of the predefined icon listed in vtkKWIcon. The SetImageToPixels method sets the image using pixel data. It expects a pointer to the pixels and the structure of the image, i.e. its width, height and the pixel_size (how many bytes per pixel, say 3 for RGB, or 1 for grayscale). If buffer_length = 0, it is computed automatically from the previous parameters. If it is not, it will most likely indicate that the buffer has been encoded using base64 and/or zlib. If pixel_size > 3 (i.e. RGBA), the image is blend the with background color of the widget.

virtual void vtkKWLabel::SetImageToPixels (  const unsigned char *  pixels,
int  width,
int  height,
int  pixel_size,
unsigned long  buffer_length = 0
)  [virtual]
 

Specifies an image to display in the widget. Typically, if the image is specified then it overrides other options that specify a bitmap or textual value to display in the widget. Invoke vtkKWWidget's SetConfigurationOption("-image", imagename) to use a specific pre-existing Tk image, or call one of the following functions. The SetImageToPredefinedIcon method accepts an index to one of the predefined icon listed in vtkKWIcon. The SetImageToPixels method sets the image using pixel data. It expects a pointer to the pixels and the structure of the image, i.e. its width, height and the pixel_size (how many bytes per pixel, say 3 for RGB, or 1 for grayscale). If buffer_length = 0, it is computed automatically from the previous parameters. If it is not, it will most likely indicate that the buffer has been encoded using base64 and/or zlib. If pixel_size > 3 (i.e. RGBA), the image is blend the with background color of the widget.

virtual void vtkKWLabel::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 vtkKWLabel::AdjustWrapLengthToWidthCallback (   )  [virtual]
 

Callbacks. Do not use.

virtual void vtkKWLabel::UpdateBindings (   )  [protected, virtual]
 

virtual void vtkKWLabel::UpdateText (   )  [protected, virtual]
 

The documentation for this class was generated from the following file:
Generated on Tue May 30 12:39:38 2006 for ParaView by doxygen 1.3.5