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

Common/vtkOutputWindow.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkOutputWindow.h,v $
00005   Language:  C++
00006 
00007 
00008 Copyright (c) 1993-2001 Ken Martin, Will Schroeder, Bill Lorensen 
00009 All rights reserved.
00010 
00011 Redistribution and use in source and binary forms, with or without
00012 modification, are permitted provided that the following conditions are met:
00013 
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016 
00017  * Redistributions in binary form must reproduce the above copyright notice,
00018    this list of conditions and the following disclaimer in the documentation
00019    and/or other materials provided with the distribution.
00020 
00021  * Neither name of Ken Martin, Will Schroeder, or Bill Lorensen nor the names
00022    of any contributors may be used to endorse or promote products derived
00023    from this software without specific prior written permission.
00024 
00025  * Modified source versions must be plainly marked as such, and must not be
00026    misrepresented as being the original software.
00027 
00028 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00029 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00030 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00031 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
00032 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00033 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00034 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00035 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00036 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00037 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 
00039 =========================================================================*/
00055 #ifndef __vtkOutputWindow_h
00056 #define __vtkOutputWindow_h
00057 
00058 #include "vtkObject.h"
00059 
00060 //BTX
00061 
00062 class VTK_COMMON_EXPORT vtkOutputWindow;
00063 
00064 class VTK_COMMON_EXPORT vtkOutputWindowSmartPointer
00065 {
00066 public:
00067   vtkOutputWindowSmartPointer(vtkOutputWindow* p) { this->Pointer=p; };
00068   void SetPointer(vtkOutputWindow* obj)
00069     {
00070       this->Pointer = obj;
00071     }
00072   ~vtkOutputWindowSmartPointer();
00073 private:
00074   vtkOutputWindow* Pointer;
00075 };
00076 //ETX
00077 
00078 class VTK_COMMON_EXPORT vtkOutputWindow : public vtkObject
00079 {
00080 public:
00081 // Methods from vtkObject
00082   vtkTypeMacro(vtkOutputWindow,vtkObject);
00084   virtual void PrintSelf(ostream& os, vtkIndent indent);
00085 
00087 
00091   static vtkOutputWindow* New();
00092   // Description:
00093   // Return the singleton instance with no reference counting.
00094   static vtkOutputWindow* GetInstance();
00095   // Description:
00096   // Supply a user defined output window. Call ->Delete() on the supplied
00097   // instance after setting it.
00098   static void SetInstance(vtkOutputWindow *instance);
00099   // Description:
00100   // Display the text. Four virtual methods exist, depending on the type of
00101   // message to display. This allows redirection or reformatting of the
00102   // messages. The default implementation uses DisplayText for all.
00103   virtual void DisplayText(const char*);
00104   virtual void DisplayErrorText(const char*);
00105   virtual void DisplayWarningText(const char*);
00106   virtual void DisplayGenericWarningText(const char*);
00108 
00109   virtual void DisplayDebugText(const char*);
00111 
00113   vtkBooleanMacro(PromptUser,int);
00114   vtkSetMacro(PromptUser, int);
00116 //BTX
00117   // use this as a way of memory management when the
00118   // program exits the SmartPointer will be deleted which
00119   // will delete the Instance singleton
00120   static vtkOutputWindowSmartPointer SmartPointer;
00121 //ETX
00122 protected:
00123   vtkOutputWindow();
00124   virtual ~vtkOutputWindow();
00125   int PromptUser;
00126 private:
00127   static vtkOutputWindow* Instance;
00128 private:
00129   vtkOutputWindow(const vtkOutputWindow&);  // Not implemented.
00130   void operator=(const vtkOutputWindow&);  // Not implemented.
00131 };
00132 
00133 #endif

Generated on Thu Mar 28 14:19:16 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001