0027844: Foundation Classes - remove method OSD_File::Print()
[occt.git] / src / OSD / OSD_Printer.hxx
1 // Created on: 2018-03-15
2 // Created by: Stephan GARNAUD (ARM)
3 // Copyright (c) 1998-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _OSD_Printer_HeaderFile
18 #define _OSD_Printer_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <TCollection_AsciiString.hxx>
25 #include <OSD_Error.hxx>
26 #include <Standard_Boolean.hxx>
27 #include <Standard_Integer.hxx>
28 class Standard_ConstructionError;
29 class Standard_NullObject;
30 class OSD_OSDError;
31 class TCollection_AsciiString;
32
33
34 //! Selects a printer (used by File).
35 class OSD_Printer 
36 {
37 public:
38
39   DEFINE_STANDARD_ALLOC
40
41   
42   //! Initializes printer to use with its name.
43   //! The string must contain only ASCII characters
44   //! between ' ' and '~'; this means no control character
45   //! and no extended ASCII code. If it is not the case the
46   //! exception ConstructionError is raised.
47   Standard_EXPORT OSD_Printer(const TCollection_AsciiString& Name);
48   
49   //! Changes name of printer to use.
50   Standard_EXPORT void SetName (const TCollection_AsciiString& Name);
51   
52   //! Returns name of current printer
53   Standard_EXPORT void Name (TCollection_AsciiString& Name) const;
54   
55   //! Returns TRUE if an error occurs
56   Standard_EXPORT Standard_Boolean Failed() const;
57   
58   //! Resets error counter to zero
59   Standard_EXPORT void Reset();
60   
61   //! Raises OSD_Error
62   Standard_EXPORT void Perror();
63   
64   //! Returns error number if 'Failed' is TRUE.
65   Standard_EXPORT Standard_Integer Error() const;
66
67
68
69
70 protected:
71
72
73
74
75
76 private:
77
78
79
80   TCollection_AsciiString myName;
81   OSD_Error myError;
82
83
84 };
85
86
87
88
89
90
91
92 #endif // _OSD_Printer_HeaderFile