a multi-line text entry widget More...
#include <vtkKWText.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 | AddTagMatcher (const char *regexp, const char *tag) |
| virtual void | SeeEnd () |
| virtual void | UpdateEnableState () |
| virtual void | ValueCallback () |
Static Public Member Functions | |
| static vtkKWText * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkKWText * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkKWText () | |
| ~vtkKWText () | |
| virtual void | CreateWidget () |
| virtual void | Configure (int disable=0) |
| virtual void | AppendTextInternalTagging (const char *, const char *tag) |
| virtual void | AppendTextInternal (const char *, const char *tag) |
Protected Attributes | |
| int | ReadOnly |
| int | QuickFormatting |
| int | CommandTrigger |
| char * | Command |
| vtkKWTextInternals * | Internals |
|
| |
| enum | { TriggerOnFocusOut = 1, TriggerOnReturnKey = 2, TriggerOnAnyChange = 4 } |
| static const char * | MarkerBold |
| static const char * | MarkerItalic |
| static const char * | MarkerUnderline |
| static const char * | TagBold |
| static const char * | TagItalic |
| static const char * | TagUnderline |
| static const char * | TagFgNavy |
| static const char * | TagFgRed |
| static const char * | TagFgBlue |
| static const char * | TagFgDarkGreen |
| 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 | 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 | SetWrapToNone () |
| virtual void | SetWrapToWord () |
| virtual void | SetWrapToChar () |
| virtual void | ResizeToGridOn () |
| virtual void | ResizeToGridOff () |
| virtual void | SetResizeToGrid (int) |
| virtual int | GetResizeToGrid () |
| virtual void | SetCommand (vtkObject *object, const char *method) |
| virtual void | InvokeCommand (const char *value) |
| virtual int | GetCommandTrigger () |
| virtual void | SetCommandTrigger (int) |
| virtual void | SetCommandTriggerToReturnKeyAndFocusOut () |
| virtual void | SetCommandTriggerToAnyChange () |
| virtual int | GetModifiedFlag () |
| virtual void | SetModifiedFlag (int) |
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.
Definition at line 31 of file vtkKWText.h.
| typedef vtkKWCoreWidget vtkKWText::Superclass |
Reimplemented from vtkKWCoreWidget.
Definition at line 36 of file vtkKWText.h.
| anonymous enum |
Specify when Command should be invoked. Default to losing focus and return key. BTX
Definition at line 203 of file vtkKWText.h.
| vtkKWText::vtkKWText | ( | ) | [protected] |
| vtkKWText::~vtkKWText | ( | ) | [protected] |
| static vtkKWText* vtkKWText::New | ( | ) | [static] |
Reimplemented from vtkKWCoreWidget.
| virtual const char* vtkKWText::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkKWCoreWidget.
| static int vtkKWText::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkKWCoreWidget.
| virtual int vtkKWText::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkKWCoreWidget.
Reimplemented from vtkKWCoreWidget.
| void vtkKWText::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Reimplemented from vtkKWCoreWidget.
| virtual char* vtkKWText::GetText | ( | ) | [virtual] |
Set/Get the value of the text. AppendText() can also be used 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] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetText | ( | const char * | , | |
| const char * | tag | |||
| ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::AppendText | ( | const char * | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::AppendText | ( | const char * | , | |
| const char * | tag | |||
| ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetReadOnly | ( | int | val | ) | [virtual] |
Set/Get if this text is read-only. Default is Off.
| virtual int vtkKWText::GetReadOnly | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::ReadOnlyOn | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::ReadOnlyOff | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| 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] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::QuickFormattingOn | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::QuickFormattingOff | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetWidth | ( | int | ) | [virtual] |
Set/Get the width/height, in characters.
| virtual int vtkKWText::GetWidth | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetHeight | ( | int | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual int vtkKWText::GetHeight | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::GetBackgroundColor | ( | double * | r, | |
| double * | g, | |||
| double * | b | |||
| ) | [virtual] |
Set/Get the background color of the widget.
| virtual double* vtkKWText::GetBackgroundColor | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetBackgroundColor | ( | double | r, | |
| double | g, | |||
| double | b | |||
| ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetBackgroundColor | ( | double | rgb[3] | ) | [inline, virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
Definition at line 80 of file vtkKWText.h.
| virtual void vtkKWText::GetForegroundColor | ( | double * | r, | |
| double * | g, | |||
| double * | b | |||
| ) | [virtual] |
Set/Get the foreground color of the widget.
| virtual double* vtkKWText::GetForegroundColor | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetForegroundColor | ( | double | r, | |
| double | g, | |||
| double | b | |||
| ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetForegroundColor | ( | double | rgb[3] | ) | [inline, virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
Definition at line 89 of file vtkKWText.h.
| virtual void vtkKWText::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 vtkKWText::GetHighlightThickness | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::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 vtkKWText::GetBorderWidth | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::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 vtkKWText::GetRelief | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetReliefToRaised | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetReliefToSunken | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetReliefToFlat | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetReliefToRidge | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetReliefToSolid | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetReliefToGroove | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::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* vtkKWText::GetFont | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::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 vtkKWText::GetPadX | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetPadY | ( | int | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual int vtkKWText::GetPadY | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetWrapToNone | ( | ) | [virtual] |
Set the wrap mode.
| virtual void vtkKWText::SetWrapToWord | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetWrapToChar | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| 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] |
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] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetResizeToGrid | ( | int | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual int vtkKWText::GetResizeToGrid | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SeeEnd | ( | ) | [virtual] |
Adjusts the view in the widget so that the character at the end is completely visible.
| virtual void vtkKWText::SetCommand | ( | vtkObject * | object, | |
| const char * | method | |||
| ) | [virtual] |
Specifies a command to associate with the widget. This command is typically invoked when the return key is pressed, or the focus is lost, as specified by the CommandTrigger variable. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command. The following parameters are also passed to the command: - current value: const char*
| virtual void vtkKWText::InvokeCommand | ( | const char * | value | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual int vtkKWText::GetCommandTrigger | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetCommandTrigger | ( | int | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetCommandTriggerToReturnKeyAndFocusOut | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual void vtkKWText::SetCommandTriggerToAnyChange | ( | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| virtual int vtkKWText::GetModifiedFlag | ( | ) | [virtual] |
Set/Get the modified flag. Each time the text is modified, this flag is set to true. Note that if CommandTrigger is set to AnyChange, each time the text is modified, the flag is reset to false so that the <<Modified>> event can be caught by the next change.
| virtual void vtkKWText::SetModifiedFlag | ( | int | ) | [virtual] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
| 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::ValueCallback | ( | ) | [virtual] |
Callbacks. Internal, do not use.
| virtual void vtkKWText::CreateWidget | ( | ) | [protected, virtual] |
Create the widget.
Reimplemented from vtkKWCoreWidget.
| virtual void vtkKWText::Configure | ( | int | disable = 0 |
) | [protected, virtual] |
Configure.
| virtual void vtkKWText::AppendTextInternalTagging | ( | const char * | , | |
| const char * | tag | |||
| ) | [protected, virtual] |
| virtual void vtkKWText::AppendTextInternal | ( | const char * | , | |
| const char * | tag | |||
| ) | [protected, virtual] |
const char* vtkKWText::MarkerBold [static] |
Some constants BTX
Definition at line 235 of file vtkKWText.h.
const char* vtkKWText::MarkerItalic [static] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
Definition at line 236 of file vtkKWText.h.
const char* vtkKWText::MarkerUnderline [static] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
Definition at line 237 of file vtkKWText.h.
const char* vtkKWText::TagBold [static] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
Definition at line 238 of file vtkKWText.h.
const char* vtkKWText::TagItalic [static] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
Definition at line 239 of file vtkKWText.h.
const char* vtkKWText::TagUnderline [static] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
Definition at line 240 of file vtkKWText.h.
const char* vtkKWText::TagFgNavy [static] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
Definition at line 241 of file vtkKWText.h.
const char* vtkKWText::TagFgRed [static] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
Definition at line 242 of file vtkKWText.h.
const char* vtkKWText::TagFgBlue [static] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
Definition at line 243 of file vtkKWText.h.
const char* vtkKWText::TagFgDarkGreen [static] |
Specify when Command should be invoked. Default to losing focus and return key. BTX
Definition at line 244 of file vtkKWText.h.
int vtkKWText::ReadOnly [protected] |
Definition at line 263 of file vtkKWText.h.
int vtkKWText::QuickFormatting [protected] |
Definition at line 264 of file vtkKWText.h.
int vtkKWText::CommandTrigger [protected] |
Definition at line 265 of file vtkKWText.h.
char* vtkKWText::Command [protected] |
Definition at line 267 of file vtkKWText.h.
vtkKWTextInternals* vtkKWText::Internals [protected] |
PIMPL Encapsulation for STL containers
Reimplemented from vtkKWCoreWidget.
Definition at line 271 of file vtkKWText.h.
1.6.1
