0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / Aspect / Aspect_Background.cdl
CommitLineData
b311480e 1-- Created on: 1991-10-02
2-- Created by: NW,JPB,CAL
3-- Copyright (c) 1991-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
7fd59977 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
7fd59977 7--
d5f74e42 8-- This library is free software; you can redistribute it and/or modify it under
9-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1 10-- by the Free Software Foundation, with special exception defined in the file
11-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12-- distribution for complete text of the license and disclaimer of any warranty.
7fd59977 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class Background from Aspect
18
19
20 ---Purpose: This class allows the definition of
21 -- a window background.
22
23uses
24
25 Color from Quantity
26
27is
28
29 Create
30 returns Background from Aspect;
31 ---Level: Public
32 ---Purpose: Creates a window background.
33 -- Default color : NOC_MATRAGRAY.
34
35 Create ( AColor : Color from Quantity )
36 returns Background from Aspect;
37 ---Level: Public
38 ---Purpose: Creates a window background with the colour <AColor>.
39
40 ---------------------------------------------------
41 -- Category: Methods to modify the class definition
42 ---------------------------------------------------
43
44 SetColor ( me : in out;
45 AColor : Color from Quantity );
46 ---Level: Public
47 ---Purpose: Modifies the colour of the window background <me>.
48 ---Category: Methods to modify the class definition
49
50 ----------------------------
51 -- Category: Inquire methods
52 ----------------------------
53
54 Color ( me )
55 returns Color from Quantity;
56 ---Level: Public
57 ---Purpose: Returns the colour of the window background <me>.
58 ---Category: Inquire methods
59
60--\f
61
62fields
63
64--
65-- Class : Aspect_Background
66--
67-- Purpose : Declaration of variables specific to the window
68-- background.
69--
70-- Reminder : A background is defined by one colour
71--
72
73 -- the colour associated with the window background
74 MyColor : Color from Quantity;
75
76end Background;