src/Aspect/Aspect_GradientBackground.cdl

   1 -- Created on: 2010-05-21
   2 -- Created by: PAUL SUPRYATKIN
   3 -- Copyright (c) 2010-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20
  21 class GradientBackground from Aspect
  22 inherits Background from Aspect
  23
  24
  25     ---Purpose: This class allows the definition of
  26     --      a window gradient background.
  27
  28 uses
  29
  30     Color               from Quantity,
  31     GradientFillMethod  from Aspect
  32
  33 is
  34
  35     Create
  36         returns GradientBackground from Aspect;
  37     ---Level: Public
  38     ---Purpose: Creates a window gradient background.
  39     -- Default colors : Quantity_NOC_BLACK.
  40     -- Default fill method : Aspect_GFM_NONE
  41
  42     Create ( AColor1 : Color from Quantity;
  43              AColor2 : Color from Quantity;
  44              AMethod : GradientFillMethod from Aspect = Aspect_GFM_HOR)
  45         returns GradientBackground from Aspect;
  46     ---Level: Public
  47     ---Purpose: Creates a window gradient background with colours <AColor1, AColor2>.
  48
  49     ---------------------------------------------------
  50     -- Category: Methods to modify the class definition
  51     ---------------------------------------------------
  52
  53     SetColors ( me       : in out;
  54                 AColor1  : Color from Quantity ;
  55                 AColor2  : Color from Quantity ;
  56                 AMethod  : GradientFillMethod from Aspect = Aspect_GFM_HOR
  57               );
  58     ---Level: Public
  59     ---Purpose: Modifies the colours of the window gradient background <me>.
  60     ---Category: Methods to modify the class definition
  61
  62     ----------------------------
  63     -- Category: Inquire methods
  64     ----------------------------
  65
  66     Colors ( me;
  67              AColor1 : out Color from Quantity;
  68              AColor2 : out Color from Quantity
  69            );
  70     ---Level: Public
  71     ---Purpose: Returns colours of the window gradient background <me>.
  72     ---Category: Inquire methods
  73
  74     BgGradientFillMethod( me ) returns GradientFillMethod from Aspect;
  75     ---Level: Public
  76     ---Purpose: Returns the current gradient background fill mode.
  77
  78
  79 fields
  80
  81 --
  82 -- Class    :   Aspect_GradientBackground
  83 --
  84 -- Purpose  :   Declaration of variables specific to the window
  85 --              gradient background.
  86 --
  87 -- Reminder :   A Gradient background is defined by two colours
  88 --
  89
  90     -- the colour associated with the window background
  91     MyColor2          :   Color from Quantity;
  92     MyGradientMethod  :   GradientFillMethod from Aspect;
  93
  94 end GradientBackground ;