message widget More...
#include <vtkKWMessage.h>
Public Types | |
| typedef vtkKWCoreWidget | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | SetText (const char *) |
| virtual char * | GetText () |
| virtual void | AppendText (const char *) |
| virtual void | SetWidth (int) |
| virtual int | GetWidth () |
| virtual void | SetAspectRatio (int) |
| virtual int | GetAspectRatio () |
| virtual void | GetBackgroundColor (double *r, double *g, double *b) |
| virtual double * | GetBackgroundColor () |
| virtual void | SetBackgroundColor (double r, double g, double b) |
| virtual void | SetBackgroundColor (double rgb[3]) |
| virtual void | GetForegroundColor (double *r, double *g, double *b) |
| virtual double * | GetForegroundColor () |
| virtual void | SetForegroundColor (double r, double g, double b) |
| virtual void | SetForegroundColor (double rgb[3]) |
| virtual void | SetHighlightThickness (int) |
| virtual int | GetHighlightThickness () |
| virtual void | SetBorderWidth (int) |
| virtual int | GetBorderWidth () |
| virtual void | SetRelief (int) |
| virtual int | GetRelief () |
| virtual void | SetReliefToRaised () |
| virtual void | SetReliefToSunken () |
| virtual void | SetReliefToFlat () |
| virtual void | SetReliefToRidge () |
| virtual void | SetReliefToSolid () |
| virtual void | SetReliefToGroove () |
| virtual void | SetFont (const char *font) |
| virtual const char * | GetFont () |
| virtual void | SetPadX (int) |
| virtual int | GetPadX () |
| virtual void | SetPadY (int) |
| virtual int | GetPadY () |
| 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 () |
Static Public Member Functions | |
| static vtkKWMessage * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkKWMessage * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkKWMessage () | |
| ~vtkKWMessage () | |
| virtual void | CreateWidget () |
| virtual void | UpdateText () |
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.
Definition at line 40 of file vtkKWMessage.h.
Reimplemented from vtkKWCoreWidget.
Definition at line 45 of file vtkKWMessage.h.
| vtkKWMessage::vtkKWMessage | ( | ) | [protected] |
| vtkKWMessage::~vtkKWMessage | ( | ) | [protected] |
| static vtkKWMessage* vtkKWMessage::New | ( | ) | [static] |
Reimplemented from vtkKWCoreWidget.
| virtual const char* vtkKWMessage::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkKWCoreWidget.
| static int vtkKWMessage::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkKWCoreWidget.
| virtual int vtkKWMessage::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkKWCoreWidget.
| static vtkKWMessage* vtkKWMessage::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkKWCoreWidget.
| void vtkKWMessage::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Reimplemented from vtkKWCoreWidget.
| 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::AppendText | ( | const char * | ) | [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 the text on the message.
| 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 the text on the message.
| virtual void vtkKWMessage::GetBackgroundColor | ( | double * | r, | |
| double * | g, | |||
| double * | b | |||
| ) | [virtual] |
Set/Get the background color of the widget.
| virtual double* vtkKWMessage::GetBackgroundColor | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetBackgroundColor | ( | double | r, | |
| double | g, | |||
| double | b | |||
| ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetBackgroundColor | ( | double | rgb[3] | ) | [inline, virtual] |
Set the text on the message.
Definition at line 82 of file vtkKWMessage.h.
| virtual void vtkKWMessage::GetForegroundColor | ( | double * | r, | |
| double * | g, | |||
| double * | b | |||
| ) | [virtual] |
Set/Get the foreground color of the widget.
| virtual double* vtkKWMessage::GetForegroundColor | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetForegroundColor | ( | double | r, | |
| double | g, | |||
| double | b | |||
| ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetForegroundColor | ( | double | rgb[3] | ) | [inline, virtual] |
Set the text on the message.
Definition at line 91 of file vtkKWMessage.h.
| virtual void vtkKWMessage::SetHighlightThickness | ( | int | ) | [virtual] |
Set/Get the highlight thickness, a non-negative value indicating the width of the highlight rectangle to draw around the outside of the widget when it has the input focus.
| virtual int vtkKWMessage::GetHighlightThickness | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetBorderWidth | ( | int | ) | [virtual] |
Set/Get the border width, a non-negative value indicating the width of the 3-D border to draw around the outside of the widget (if such a border is being drawn; the Relief option typically determines this).
| virtual int vtkKWMessage::GetBorderWidth | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetRelief | ( | int | ) | [virtual] |
Set/Get the 3-D effect desired for the widget. The value indicates how the interior of the widget should appear relative to its exterior. Valid constants can be found in vtkKWOptions::ReliefType.
| virtual int vtkKWMessage::GetRelief | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetReliefToRaised | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetReliefToSunken | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetReliefToFlat | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetReliefToRidge | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetReliefToSolid | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetReliefToGroove | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetFont | ( | const char * | font | ) | [virtual] |
Specifies the font to use when drawing text inside the widget. You can use predefined font names (e.g. 'system'), or you can specify a set of font attributes with a platform-independent name, for example, 'times 12 bold'. In this example, the font is specified with a three element list: the first element is the font family, the second is the size, the third is a list of style parameters (normal, bold, roman, italic, underline, overstrike). Example: 'times 12 {bold italic}'. The Times, Courier and Helvetica font families are guaranteed to exist and will be matched to the corresponding (closest) font on your system. If you are familiar with the X font names specification, you can also describe the font that way (say, '*times-medium-r-*-*-12*').
| virtual const char* vtkKWMessage::GetFont | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetPadX | ( | int | ) | [virtual] |
Set/Get the padding that will be applied around each widget (in pixels). Specifies a non-negative value indicating how much extra space to request for the widget in the X and Y-direction. When computing how large a window it needs, the widget will add this amount to the width it would normally need (as determined by the width of the things displayed in the widget); if the geometry manager can satisfy this request, the widget will end up with extra internal space around what it displays inside.
| virtual int vtkKWMessage::GetPadX | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetPadY | ( | int | ) | [virtual] |
Set the text on the message.
| virtual int vtkKWMessage::GetPadY | ( | ) | [virtual] |
Set the text on the message.
| 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 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 vtkKWOptions::JustificationType.
| virtual int vtkKWMessage::GetJustification | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetJustificationToLeft | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetJustificationToCenter | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetJustificationToRight | ( | ) | [virtual] |
Set the text on the message.
| 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 vtkKWOptions::AnchorType.
| virtual int vtkKWMessage::GetAnchor | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetAnchorToNorth | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetAnchorToNorthEast | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetAnchorToEast | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetAnchorToSouthEast | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetAnchorToSouth | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetAnchorToSouthWest | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetAnchorToWest | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetAnchorToNorthWest | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::SetAnchorToCenter | ( | ) | [virtual] |
Set the text on the message.
| virtual void vtkKWMessage::CreateWidget | ( | ) | [protected, virtual] |
Create the widget.
Reimplemented from vtkKWCoreWidget.
| virtual void vtkKWMessage::UpdateText | ( | ) | [protected, virtual] |
1.6.1
