1 // Created on: 1991-10-02
2 // Created by: NW,JPB,CAL
3 // Copyright (c) 1991-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
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
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.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16 
17 #ifndef _Aspect_Background_HeaderFile
18 #define _Aspect_Background_HeaderFile
19 
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23 
24 #include <Quantity_Color.hxx>
25 
26 
27 //! This class allows the definition of
28 //! a window background.
29 class Aspect_Background
30 {
31 public:
32 
33   DEFINE_STANDARD_ALLOC
34 
35 
36   //! Creates a window background.
37   //! Default color : NOC_MATRAGRAY.
38   Standard_EXPORT Aspect_Background();
39 
40   //! Creates a window background with the colour <AColor>.
41   Standard_EXPORT Aspect_Background(const Quantity_Color& AColor);
42 
43   //! Modifies the colour of the window background <me>.
44   Standard_EXPORT void SetColor (const Quantity_Color& AColor);
45 
46   //! Returns the colour of the window background <me>.
47   Standard_EXPORT Quantity_Color Color() const;
48 
49   //! Dumps the content of me into the stream
50   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
51 
52 
53 
54 
55 protected:
56 
57 
58 
59 
60 
61 private:
62 
63 
64 
65   Quantity_Color MyColor;
66 
67 
68 };
69 
70 
71 
72 
73 
74 
75 
76 #endif // _Aspect_Background_HeaderFile
77