0023024: Update headers of OCCT files
[occt.git] / src / Aspect / Aspect_Background.cdl
1 -- Created on: 1991-10-02
2 -- Created by: NW,JPB,CAL
3 -- Copyright (c) 1991-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
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.
10 --
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.
13 --
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
21
22 class Background from Aspect
23
24
25         ---Purpose: This class allows the definition of
26         --          a window background.
27
28 uses
29
30         Color   from Quantity
31
32 is
33
34         Create
35                 returns Background from Aspect;
36         ---Level: Public
37         ---Purpose: Creates a window background.
38         --          Default color : NOC_MATRAGRAY.
39
40         Create ( AColor : Color from Quantity )
41                 returns Background from Aspect;
42         ---Level: Public
43         ---Purpose: Creates a window background with the colour <AColor>.
44
45         ---------------------------------------------------
46         -- Category: Methods to modify the class definition
47         ---------------------------------------------------
48
49         SetColor ( me           : in out;
50                    AColor       : Color from Quantity );
51         ---Level: Public
52         ---Purpose: Modifies the colour of the window background <me>.
53         ---Category: Methods to modify the class definition
54
55         ----------------------------
56         -- Category: Inquire methods
57         ----------------------------
58
59         Color ( me )
60                 returns Color from Quantity;
61         ---Level: Public
62         ---Purpose: Returns the colour of the window background <me>.
63         ---Category: Inquire methods
64
65 --\f
66
67 fields
68
69 --
70 -- Class        :       Aspect_Background
71 --
72 -- Purpose      :       Declaration of variables specific to the window
73 --                      background.
74 --
75 -- Reminder     :       A background is defined by one colour
76 --
77
78         -- the colour associated with the window background
79         MyColor :       Color from Quantity;
80
81 end Background;