include/opencascade/Aspect_Background.hxx

0001 // Created on: 1991-10-02
0002 // Created by: NW,JPB,CAL
0003 // Copyright (c) 1991-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Aspect_Background_HeaderFile
0018 #define _Aspect_Background_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Quantity_Color.hxx>
0025
0026
0027 //! This class allows the definition of
0028 //! a window background.
0029 class Aspect_Background
0030 {
0031 public:
0032
0033   DEFINE_STANDARD_ALLOC
0034
0035
0036   //! Creates a window background.
0037   //! Default color : NOC_MATRAGRAY.
0038   Standard_EXPORT Aspect_Background();
0039
0040   //! Creates a window background with the colour <AColor>.
0041   Standard_EXPORT Aspect_Background(const Quantity_Color& AColor);
0042
0043   //! Modifies the colour of the window background <me>.
0044   Standard_EXPORT void SetColor (const Quantity_Color& AColor);
0045
0046   //! Returns the colour of the window background <me>.
0047   Standard_EXPORT Quantity_Color Color() const;
0048
0049   //! Dumps the content of me into the stream
0050   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
0051
0052
0053
0054
0055 protected:
0056
0057
0058
0059
0060
0061 private:
0062
0063
0064
0065   Quantity_Color MyColor;
0066
0067
0068 };
0069
0070
0071
0072
0073
0074
0075
0076 #endif // _Aspect_Background_HeaderFile