0023024: Update headers of OCCT files
[occt.git] / src / AlienImage / AlienImage_XAlienImage.cdl
CommitLineData
b311480e 1-- Created on: 1993-03-23
2-- Created by: BBL
3-- Copyright (c) 1993-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
7fd59977 5--
b311480e 6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
7fd59977 10--
b311480e 11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
7fd59977 13--
b311480e 14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21
22class XAlienImage from AlienImage inherits AlienUserImage from AlienImage
23
24 ---Purpose: Defines an X11 Alien image, i.e. an image file to be
25 -- used with X11 xwd utility.
26
27uses
28 File from OSD,
29 AsciiString from TCollection,
30 ColorImage from Image,
31 PseudoColorImage from Image,
32 Image from Image,
33 X11XWDAlienData from AlienImage
34
35is
36 Create returns mutable XAlienImage from AlienImage;
37 ---Purpose: Constructs an empty X11 alien image.
38 Clear( me : in out mutable) ;
39 ---Level: Public
40 ---Purpose: Frees memory allocated by XAlienImage
41 ---C++: alias ~
42
43 SetName( me : in out mutable;
44 aName : in AsciiString from TCollection) ;
45 ---Purpose: Sets the Image name for the Name function.
46
47 Name( me : in immutable ) returns AsciiString from TCollection ;
48 ---C++: return const &
49 ---Purpose: Returns the Image name.
50
51 ToImage( me : in immutable )
52 returns mutable Image from Image ;
53 ---Level: Public
54 ---Purpose : Converts an XAlienImage object to a Image object.
55
56 FromImage( me : in out mutable ; anImage : in Image from Image ) ;
57 ---Level: Public
58 ---Purpose : Converts an Image object to a XAlienImage object.
59
60 Read ( me : in out mutable; afile : in out File from OSD )
61 returns Boolean from Standard ;
62 ---Level: Public
63 ---Purpose: Reads the content of a XAlienImage object from a file .
64 -- Returns True if file is a XWD file .
65
66 Write( me : in immutable; afile : in out File from OSD )
67 returns Boolean from Standard ;
68 ---Level: Public
69 ---Purpose: Writes the content of a XAlienImage object to a file .
70
71fields
72 myData : X11XWDAlienData from AlienImage;
73
74end ;
75