0024624: Lost word in license statement in source files
[occt.git] / src / Aspect / Aspect_GradientBackground.cdl
1 -- Created on: 2010-05-21
2 -- Created by: PAUL SUPRYATKIN
3 -- Copyright (c) 2010-2014 OPEN CASCADE SAS
4 --
5 -- This file is part of Open CASCADE Technology software library.
6 --
7 -- This library is free software; you can redistribute it and/or modify it under
8 -- the terms of the GNU Lesser General Public License version 2.1 as published
9 -- by the Free Software Foundation, with special exception defined in the file
10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 -- distribution for complete text of the license and disclaimer of any warranty.
12 --
13 -- Alternatively, this file may be used under the terms of Open CASCADE
14 -- commercial license or contractual agreement.
15
16 class GradientBackground from Aspect 
17 inherits Background from Aspect
18
19
20     ---Purpose: This class allows the definition of
21     --      a window gradient background.
22
23 uses
24
25     Color               from Quantity,
26     GradientFillMethod  from Aspect
27
28 is
29
30     Create
31         returns GradientBackground from Aspect;
32     ---Level: Public
33     ---Purpose: Creates a window gradient background.
34     -- Default colors : Quantity_NOC_BLACK.
35     -- Default fill method : Aspect_GFM_NONE
36
37     Create ( AColor1 : Color from Quantity;
38              AColor2 : Color from Quantity;
39              AMethod : GradientFillMethod from Aspect = Aspect_GFM_HOR)
40         returns GradientBackground from Aspect;
41     ---Level: Public
42     ---Purpose: Creates a window gradient background with colours <AColor1, AColor2>.
43
44     ---------------------------------------------------
45     -- Category: Methods to modify the class definition
46     ---------------------------------------------------
47
48     SetColors ( me       : in out;
49                 AColor1  : Color from Quantity ;
50                 AColor2  : Color from Quantity ;
51                 AMethod  : GradientFillMethod from Aspect = Aspect_GFM_HOR
52               );
53     ---Level: Public
54     ---Purpose: Modifies the colours of the window gradient background <me>.
55     ---Category: Methods to modify the class definition
56
57     ----------------------------
58     -- Category: Inquire methods
59     ----------------------------
60
61     Colors ( me;
62              AColor1 : out Color from Quantity;
63              AColor2 : out Color from Quantity
64            );        
65     ---Level: Public
66     ---Purpose: Returns colours of the window gradient background <me>.
67     ---Category: Inquire methods
68
69     BgGradientFillMethod( me ) returns GradientFillMethod from Aspect;
70     ---Level: Public
71     ---Purpose: Returns the current gradient background fill mode. 
72
73
74 fields
75            
76 --
77 -- Class    :   Aspect_GradientBackground
78 --
79 -- Purpose  :   Declaration of variables specific to the window
80 --              gradient background.
81 --
82 -- Reminder :   A Gradient background is defined by two colours
83 --
84
85     -- the colour associated with the window background
86     MyColor2          :   Color from Quantity;
87     MyGradientMethod  :   GradientFillMethod from Aspect;
88
89 end GradientBackground ;