0022484: UNICODE characters support
[occt.git] / src / OSD / OSD_Printer.cdl
CommitLineData
b311480e 1-- Created on: 2018-03-15
2-- Created by: Stephan GARNAUD (ARM)
3-- Copyright (c) 1998-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 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
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class Printer from OSD
18
ff8178ef 19 ---Purpose: Selects a printer (used by File).
7fd59977 20
21uses Error, AsciiString from TCollection
22raises ConstructionError, NullObject, OSDError
23
24is
25 Create (Name : AsciiString) returns Printer
26 ---Purpose: Initializes printer to use with its name.
27 -- The string must contain only ASCII characters
28 -- between ' ' and '~'; this means no control character
29 -- and no extended ASCII code. If it is not the case the
30 -- exception ConstructionError is raised.
31 ---Level: Advanced
32 raises ConstructionError;
33
34 SetName (me : in out; Name : AsciiString)
35 ---Purpose: Changes name of printer to use.
36 ---Level: Advanced
37 raises ConstructionError, NullObject is static;
38
39 Name (me ;Name : out AsciiString) is static;
40 ---Purpose: Returns name of current printer
41 ---Level: Advanced
42
43 Failed (me) returns Boolean is static;
44 ---Purpose: Returns TRUE if an error occurs
45 ---Level: Advanced
46
47 Reset (me : in out) is static;
48 ---Purpose: Resets error counter to zero
49 ---Level: Advanced
50
51 Perror (me : in out)
52 ---Level: Advanced
53 ---Purpose: Raises OSD_Error
54 raises OSDError is static;
55
56 Error (me) returns Integer is static;
57 ---Purpose: Returns error number if 'Failed' is TRUE.
58 ---Level: Advanced
59
60fields
61
62 myName : AsciiString;
63 myError : Error;
64end Printer from OSD;
65
66