vtkKWMessage Class Reference
message widget
More...
#include <vtkKWMessage.h>
Inheritance diagram for vtkKWMessage:
[legend]Collaboration diagram for vtkKWMessage:
[legend]List of all members.
Detailed Description
message widget
A simple widget that represents a message (a long unit of text). A message is a widget that displays a textual string. A message widget (vtkKWMessage) has several special features compared to a label (vtkKWLabel). First, It breaks up its string into lines in order to produce a given aspect ratio for the window. The line breaks are chosen at word boundaries wherever possible (if not even a single word would fit on a line, then the word will be split across lines). Newline characters in the string will force line breaks; they can be used, for example, to leave blank lines in the display. The second feature of a message widget is justification. The text may be displayed left-justified (each line starts at the left side of the window), centered on a line-by-line basis, or right-justified (each line ends at the right side of the window). For short text, or to set an image as a label, see vtkKWLabel.
- See also:
- vtkKWLabel
Definition at line 40 of file vtkKWMessage.h.
Constructor & Destructor Documentation
| vtkKWMessage::vtkKWMessage |
( |
|
) |
[protected] |
|
Member Function Documentation
| void vtkKWMessage::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
|
|
| virtual void vtkKWMessage::SetText |
( |
const char * |
|
) |
[virtual] |
|
|
|
Set the text on the message. |
| virtual char* vtkKWMessage::GetText |
( |
|
) |
[virtual] |
|
|
|
Set the text on the message. |
| virtual void vtkKWMessage::SetWidth |
( |
int |
|
) |
[virtual] |
|
|
|
Set/Get width of the message (in pixels). Specifies the length of lines in the window. If this option has a value greater than zero then the AspectRatio setting is ignored and the width setting determines the line length. If this option has a value less than or equal to zero, then the AspectRatio determines the line length. |
| virtual int vtkKWMessage::GetWidth |
( |
|
) |
[virtual] |
|
|
|
Set/Get width of the message (in pixels). Specifies the length of lines in the window. If this option has a value greater than zero then the AspectRatio setting is ignored and the width setting determines the line length. If this option has a value less than or equal to zero, then the AspectRatio determines the line length. |
| virtual void vtkKWMessage::SetAspectRatio |
( |
int |
|
) |
[virtual] |
|
|
|
Set/Get aspect ratio of the message. Specifies a non-negative integer value indicating desired aspect ratio for the text. The aspect ratio is specified as 100*width/height. 100 means the text should be as wide as it is tall, 200 means the text should be twice as wide as it is tall, 50 means the text should be twice as tall as it is wide, and so on. It is used to choose line length for the text if the Width setting isn't specified. |
| virtual int vtkKWMessage::GetAspectRatio |
( |
|
) |
[virtual] |
|
|
|
Set/Get aspect ratio of the message. Specifies a non-negative integer value indicating desired aspect ratio for the text. The aspect ratio is specified as 100*width/height. 100 means the text should be as wide as it is tall, 200 means the text should be twice as wide as it is tall, 50 means the text should be twice as tall as it is wide, and so on. It is used to choose line length for the text if the Width setting isn't specified. |
| virtual void vtkKWMessage::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. This option works together with the Anchor, AspectRatio, and Width settings to provide a variety of arrangements of the text within the window. The AspectRatio and Width settings determine the amount of screen space needed to display the text. The Anchor setting determines where this rectangular area is displayed within the widget's window, and the Justification setting determines how each line is displayed within that rectangular region. For example, suppose Anchor is East and Justification is Left, and that the message window is much larger than needed for the text. The the text will displayed so that the left edges of all the lines line up and the right edge of the longest line is on the right side of the window; the entire text block will be centered in the vertical span of the window. Note that the superclass's PadX and PadY setting can be use to provide additional margins. Valid constants can be found in vtkKWTkOptions::JustificationType. |
| virtual int vtkKWMessage::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. This option works together with the Anchor, AspectRatio, and Width settings to provide a variety of arrangements of the text within the window. The AspectRatio and Width settings determine the amount of screen space needed to display the text. The Anchor setting determines where this rectangular area is displayed within the widget's window, and the Justification setting determines how each line is displayed within that rectangular region. For example, suppose Anchor is East and Justification is Left, and that the message window is much larger than needed for the text. The the text will displayed so that the left edges of all the lines line up and the right edge of the longest line is on the right side of the window; the entire text block will be centered in the vertical span of the window. Note that the superclass's PadX and PadY setting can be use to provide additional margins. Valid constants can be found in vtkKWTkOptions::JustificationType. |
| virtual void vtkKWMessage::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. This option works together with the Anchor, AspectRatio, and Width settings to provide a variety of arrangements of the text within the window. The AspectRatio and Width settings determine the amount of screen space needed to display the text. The Anchor setting determines where this rectangular area is displayed within the widget's window, and the Justification setting determines how each line is displayed within that rectangular region. For example, suppose Anchor is East and Justification is Left, and that the message window is much larger than needed for the text. The the text will displayed so that the left edges of all the lines line up and the right edge of the longest line is on the right side of the window; the entire text block will be centered in the vertical span of the window. Note that the superclass's PadX and PadY setting can be use to provide additional margins. Valid constants can be found in vtkKWTkOptions::JustificationType.
Definition at line 98 of file vtkKWMessage.h. |
| virtual void vtkKWMessage::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. This option works together with the Anchor, AspectRatio, and Width settings to provide a variety of arrangements of the text within the window. The AspectRatio and Width settings determine the amount of screen space needed to display the text. The Anchor setting determines where this rectangular area is displayed within the widget's window, and the Justification setting determines how each line is displayed within that rectangular region. For example, suppose Anchor is East and Justification is Left, and that the message window is much larger than needed for the text. The the text will displayed so that the left edges of all the lines line up and the right edge of the longest line is on the right side of the window; the entire text block will be centered in the vertical span of the window. Note that the superclass's PadX and PadY setting can be use to provide additional margins. Valid constants can be found in vtkKWTkOptions::JustificationType.
Definition at line 100 of file vtkKWMessage.h. |
| virtual void vtkKWMessage::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. This option works together with the Anchor, AspectRatio, and Width settings to provide a variety of arrangements of the text within the window. The AspectRatio and Width settings determine the amount of screen space needed to display the text. The Anchor setting determines where this rectangular area is displayed within the widget's window, and the Justification setting determines how each line is displayed within that rectangular region. For example, suppose Anchor is East and Justification is Left, and that the message window is much larger than needed for the text. The the text will displayed so that the left edges of all the lines line up and the right edge of the longest line is on the right side of the window; the entire text block will be centered in the vertical span of the window. Note that the superclass's PadX and PadY setting can be use to provide additional margins. Valid constants can be found in vtkKWTkOptions::JustificationType.
Definition at line 102 of file vtkKWMessage.h. |
| virtual void vtkKWMessage::SetAnchor |
( |
int |
|
) |
[virtual] |
|
|
|
Set/Get the anchoring. Specifies how the information in a widget (e.g. text) is to be displayed in the widget. See example in the Justification method doc. Valid constants can be found in vtkKWTkOptions::AnchorType. |
| virtual int vtkKWMessage::GetAnchor |
( |
|
) |
[virtual] |
|
|
|
Set/Get the anchoring. Specifies how the information in a widget (e.g. text) is to be displayed in the widget. See example in the Justification method doc. Valid constants can be found in vtkKWTkOptions::AnchorType. |
| virtual void vtkKWMessage::SetAnchorToNorth |
( |
|
) |
[inline, virtual] |
|
|
|
Set/Get the anchoring. Specifies how the information in a widget (e.g. text) is to be displayed in the widget. See example in the Justification method doc. Valid constants can be found in vtkKWTkOptions::AnchorType.
Definition at line 113 of file vtkKWMessage.h. |
| virtual void vtkKWMessage::SetAnchorToNorthEast |
( |
|
) |
[inline, virtual] |
|
|
|
Set/Get the anchoring. Specifies how the information in a widget (e.g. text) is to be displayed in the widget. See example in the Justification method doc. Valid constants can be found in vtkKWTkOptions::AnchorType.
Definition at line 115 of file vtkKWMessage.h. |
| virtual void vtkKWMessage::SetAnchorToEast |
( |
|
) |
[inline, virtual] |
|
|
|
Set/Get the anchoring. Specifies how the information in a widget (e.g. text) is to be displayed in the widget. See example in the Justification method doc. Valid constants can be found in vtkKWTkOptions::AnchorType.
Definition at line 117 of file vtkKWMessage.h. |
| virtual void vtkKWMessage::SetAnchorToSouthEast |
( |
|
) |
[inline, virtual] |
|
|
|
Set/Get the anchoring. Specifies how the information in a widget (e.g. text) is to be displayed in the widget. See example in the Justification method doc. Valid constants can be found in vtkKWTkOptions::AnchorType.
Definition at line 119 of file vtkKWMessage.h. |
| virtual void vtkKWMessage::SetAnchorToSouth |
( |
|
) |
[inline, virtual] |
|
|
|
Set/Get the anchoring. Specifies how the information in a widget (e.g. text) is to be displayed in the widget. See example in the Justification method doc. Valid constants can be found in vtkKWTkOptions::AnchorType.
Definition at line 121 of file vtkKWMessage.h. |
| virtual void vtkKWMessage::SetAnchorToSouthWest |
( |
|
) |
[inline, virtual] |
|
|
|
Set/Get the anchoring. Specifies how the information in a widget (e.g. text) is to be displayed in the widget. See example in the Justification method doc. Valid constants can be found in vtkKWTkOptions::AnchorType.
Definition at line 123 of file vtkKWMessage.h. |
| virtual void vtkKWMessage::SetAnchorToWest |
( |
|
) |
[inline, virtual] |
|
|
|
Set/Get the anchoring. Specifies how the information in a widget (e.g. text) is to be displayed in the widget. See example in the Justification method doc. Valid constants can be found in vtkKWTkOptions::AnchorType.
Definition at line 125 of file vtkKWMessage.h. |
| virtual void vtkKWMessage::SetAnchorToNorthWest |
( |
|
) |
[inline, virtual] |
|
|
|
Set/Get the anchoring. Specifies how the information in a widget (e.g. text) is to be displayed in the widget. See example in the Justification method doc. Valid constants can be found in vtkKWTkOptions::AnchorType.
Definition at line 127 of file vtkKWMessage.h. |
| virtual void vtkKWMessage::SetAnchorToCenter |
( |
|
) |
[inline, virtual] |
|
|
|
Set/Get the anchoring. Specifies how the information in a widget (e.g. text) is to be displayed in the widget. See example in the Justification method doc. Valid constants can be found in vtkKWTkOptions::AnchorType.
Definition at line 129 of file vtkKWMessage.h. |
| virtual void vtkKWMessage::UpdateText |
( |
|
) |
[protected, virtual] |
|
The documentation for this class was generated from the following file:
Generated on Tue May 30 12:40:15 2006 for ParaView by
1.3.5