base class for writing debug output to a console More...
#include <vtkOutputWindow.h>
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkOutputWindow * | NewInstance () const |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | DisplayDebugText (const char *) |
| virtual void | DisplayText (const char *) |
| virtual void | DisplayErrorText (const char *) |
| virtual void | DisplayWarningText (const char *) |
| virtual void | DisplayGenericWarningText (const char *) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkOutputWindow * | SafeDownCast (vtkObjectBase *o) |
| static vtkOutputWindow * | New () |
| static vtkOutputWindow * | GetInstance () |
| static void | SetInstance (vtkOutputWindow *instance) |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| static vtkOutputWindowCleanup | Cleanup |
| int | PromptUser |
| virtual void | PromptUserOn () |
| virtual void | PromptUserOff () |
| virtual void | SetPromptUser (int) |
| vtkOutputWindow () | |
| virtual | ~vtkOutputWindow () |
Detailed Description
base class for writing debug output to a console
This class is used to encapsulate all text output, so that it will work with operating systems that have a stdout and stderr, and ones that do not. (i.e windows does not). Sub-classes can be provided which can redirect the output to a window.
- Events:
- vtkCommand::MessageEvent vtkCommand::ErrorEvent vtkCommand::WarningEvent
- Tests:
- vtkOutputWindow (Tests)
Definition at line 45 of file vtkOutputWindow.h.
Member Typedef Documentation
| typedef vtkObject vtkOutputWindow::Superclass |
Reimplemented from vtkObject.
Reimplemented in vtkXMLFileOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.
Definition at line 49 of file vtkOutputWindow.h.
Constructor & Destructor Documentation
| vtkOutputWindow::vtkOutputWindow | ( | ) | [protected] |
If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.
| virtual vtkOutputWindow::~vtkOutputWindow | ( | ) | [protected, virtual] |
If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.
Member Function Documentation
| static int vtkOutputWindow::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkXMLFileOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.
| virtual int vtkOutputWindow::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkXMLFileOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.
| static vtkOutputWindow* vtkOutputWindow::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkXMLFileOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.
| virtual vtkObjectBase* vtkOutputWindow::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkXMLFileOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.
| vtkOutputWindow* vtkOutputWindow::NewInstance | ( | ) | const |
Reimplemented from vtkObject.
Reimplemented in vtkXMLFileOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.
| virtual void vtkOutputWindow::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Print ObjectFactor to stream.
Reimplemented from vtkObject.
Reimplemented in vtkWin32OutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.
| static vtkOutputWindow* vtkOutputWindow::New | ( | ) | [static] |
This is a singleton pattern New. There will only be ONE reference to a vtkOutputWindow object per process. Clients that call this must call Delete on the object so that the reference counting will work. The single instance will be unreferenced when the program exits.
Reimplemented from vtkObject.
Reimplemented in vtkXMLFileOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.
| static vtkOutputWindow* vtkOutputWindow::GetInstance | ( | ) | [static] |
Return the singleton instance with no reference counting.
| static void vtkOutputWindow::SetInstance | ( | vtkOutputWindow * | instance | ) | [static] |
Supply a user defined output window. Call ->Delete() on the supplied instance after setting it.
| virtual void vtkOutputWindow::DisplayText | ( | const char * | ) | [virtual] |
Display the text. Four virtual methods exist, depending on the type of message to display. This allows redirection or reformatting of the messages. The default implementation uses DisplayText for all.
Reimplemented in vtkXMLFileOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.
| virtual void vtkOutputWindow::DisplayErrorText | ( | const char * | ) | [virtual] |
Display the text. Four virtual methods exist, depending on the type of message to display. This allows redirection or reformatting of the messages. The default implementation uses DisplayText for all.
Reimplemented in vtkXMLFileOutputWindow.
| virtual void vtkOutputWindow::DisplayWarningText | ( | const char * | ) | [virtual] |
Display the text. Four virtual methods exist, depending on the type of message to display. This allows redirection or reformatting of the messages. The default implementation uses DisplayText for all.
Reimplemented in vtkXMLFileOutputWindow.
| virtual void vtkOutputWindow::DisplayGenericWarningText | ( | const char * | ) | [virtual] |
Display the text. Four virtual methods exist, depending on the type of message to display. This allows redirection or reformatting of the messages. The default implementation uses DisplayText for all.
Reimplemented in vtkXMLFileOutputWindow.
| virtual void vtkOutputWindow::DisplayDebugText | ( | const char * | ) | [virtual] |
Reimplemented in vtkXMLFileOutputWindow.
| virtual void vtkOutputWindow::PromptUserOn | ( | ) | [virtual] |
If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.
| virtual void vtkOutputWindow::PromptUserOff | ( | ) | [virtual] |
If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.
| virtual void vtkOutputWindow::SetPromptUser | ( | int | ) | [virtual] |
If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.
Member Data Documentation
If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.
Definition at line 78 of file vtkOutputWindow.h.
int vtkOutputWindow::PromptUser [protected] |
If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.
Definition at line 88 of file vtkOutputWindow.h.
The documentation for this class was generated from the following file:
- dox/Common/Core/vtkOutputWindow.h
