0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / Aspect / Aspect_GradientBackground.cdl
CommitLineData
b311480e 1-- Created on: 2010-05-21
2-- Created by: PAUL SUPRYATKIN
973c2be1 3-- Copyright (c) 2010-2014 OPEN CASCADE SAS
7fd59977 4--
973c2be1 5-- This file is part of Open CASCADE Technology software library.
7fd59977 6--
d5f74e42 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
973c2be1 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.
7fd59977 12--
973c2be1 13-- Alternatively, this file may be used under the terms of Open CASCADE
14-- commercial license or contractual agreement.
7fd59977 15
16class GradientBackground from Aspect
17inherits Background from Aspect
18
19
20 ---Purpose: This class allows the definition of
21 -- a window gradient background.
22
23uses
24
25 Color from Quantity,
26 GradientFillMethod from Aspect
27
28is
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
7fd59977 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
74fields
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
89end GradientBackground ;