src/Aspect/Aspect_GradientBackground.hxx

   1 // Created on: 2010-05-21
   2 // Created by: PAUL SUPRYATKIN
   3 // Copyright (c) 2010-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   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
   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.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _Aspect_GradientBackground_HeaderFile
  17 #define _Aspect_GradientBackground_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_DefineAlloc.hxx>
  21 #include <Standard_Handle.hxx>
  22
  23 #include <Quantity_Color.hxx>
  24 #include <Aspect_GradientFillMethod.hxx>
  25 #include <Aspect_Background.hxx>
  26 class Quantity_Color;
  27
  28
  29 //! This class allows the definition of
  30 //! a window gradient background.
  31 class Aspect_GradientBackground  : public Aspect_Background
  32 {
  33 public:
  34
  35   DEFINE_STANDARD_ALLOC
  36
  37
  38   //! Creates a window gradient background.
  39   //! Default colors : Quantity_NOC_BLACK.
  40   //! Default fill method : Aspect_GFM_NONE
  41   Standard_EXPORT Aspect_GradientBackground();
  42
  43   //! Creates a window gradient background with colours <AColor1, AColor2>.
  44   Standard_EXPORT Aspect_GradientBackground(const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod AMethod = Aspect_GFM_HOR);
  45
  46   //! Modifies the colours of the window gradient background <me>.
  47   Standard_EXPORT void SetColors (const Quantity_Color& AColor1, const Quantity_Color& AColor2, const Aspect_GradientFillMethod AMethod = Aspect_GFM_HOR);
  48
  49   //! Returns colours of the window gradient background <me>.
  50   Standard_EXPORT void Colors (Quantity_Color& AColor1, Quantity_Color& AColor2) const;
  51
  52   //! Returns the current gradient background fill mode.
  53   Standard_EXPORT Aspect_GradientFillMethod BgGradientFillMethod() const;
  54
  55
  56
  57
  58 protected:
  59
  60
  61
  62
  63
  64 private:
  65
  66
  67
  68   Quantity_Color MyColor2;
  69   Aspect_GradientFillMethod MyGradientMethod;
  70
  71
  72 };
  73
  74
  75
  76
  77
  78
  79
  80 #endif // _Aspect_GradientBackground_HeaderFile