0022716: The method Aspect_GradientBackground::SetBgGradientFillMethod is not implemented
[occt.git] / src / Aspect / Aspect_GradientBackground.cdl
1 --
2 -- File:    Aspect_GradientBackground.cdl
3 -- Created: 21 May 2010
4 -- Author:  PAUL SUPRYATKIN
5 --
6 ---Copyright:   Open CASCADE 2010
7 --
8
9 class GradientBackground from Aspect 
10 inherits Background from Aspect
11
12
13     ---Purpose: This class allows the definition of
14     --      a window gradient background.
15
16 uses
17
18     Color               from Quantity,
19     GradientFillMethod  from Aspect
20
21 is
22
23     Create
24         returns GradientBackground from Aspect;
25     ---Level: Public
26     ---Purpose: Creates a window gradient background.
27     -- Default colors : Quantity_NOC_BLACK.
28     -- Default fill method : Aspect_GFM_NONE
29
30     Create ( AColor1 : Color from Quantity;
31              AColor2 : Color from Quantity;
32              AMethod : GradientFillMethod from Aspect = Aspect_GFM_HOR)
33         returns GradientBackground from Aspect;
34     ---Level: Public
35     ---Purpose: Creates a window gradient background with colours <AColor1, AColor2>.
36
37     ---------------------------------------------------
38     -- Category: Methods to modify the class definition
39     ---------------------------------------------------
40
41     SetColors ( me       : in out;
42                 AColor1  : Color from Quantity ;
43                 AColor2  : Color from Quantity ;
44                 AMethod  : GradientFillMethod from Aspect = Aspect_GFM_HOR
45               );
46     ---Level: Public
47     ---Purpose: Modifies the colours of the window gradient background <me>.
48     ---Category: Methods to modify the class definition
49
50     ----------------------------
51     -- Category: Inquire methods
52     ----------------------------
53
54     Colors ( me;
55              AColor1 : out Color from Quantity;
56              AColor2 : out Color from Quantity
57            );        
58     ---Level: Public
59     ---Purpose: Returns colours of the window gradient background <me>.
60     ---Category: Inquire methods
61
62     BgGradientFillMethod( me ) returns GradientFillMethod from Aspect;
63     ---Level: Public
64     ---Purpose: Returns the current gradient background fill mode. 
65
66
67 fields
68            
69 --
70 -- Class    :   Aspect_GradientBackground
71 --
72 -- Purpose  :   Declaration of variables specific to the window
73 --              gradient background.
74 --
75 -- Reminder :   A Gradient background is defined by two colours
76 --
77
78     -- the colour associated with the window background
79     MyColor2          :   Color from Quantity;
80     MyGradientMethod  :   GradientFillMethod from Aspect;
81
82 end GradientBackground ;