GradientBackground.st
changeset 7935 1d8d21aa47e7
parent 7934 5c7dd401bfa2
child 8606 13735a803dc5
--- a/GradientBackground.st	Wed Feb 22 21:09:09 2017 +0100
+++ b/GradientBackground.st	Wed Feb 22 21:15:15 2017 +0100
@@ -1,5 +1,5 @@
 "
- COPYRIGHT (c) 2009 by eXept Software AG
+ COPYRIGHT (c) 2009 by Claus Gittinger / eXept Software AG
               All Rights Reserved
 
  This software is furnished under a license and may be used
@@ -24,7 +24,7 @@
 
 copyright
 "
- COPYRIGHT (c) 2009 by eXept Software AG
+ COPYRIGHT (c) 2009 by Claus Gittinger / eXept Software AG
               All Rights Reserved
 
  This software is furnished under a license and may be used
@@ -36,6 +36,30 @@
 "
 !
 
+documentation
+"
+    instances of me can be installed as a viewBackground, 
+    and will draw a gradient background.
+    I can be used as background of color-sliders (HUE, Light, saturation),
+    or for nice looking splashscreens (which was the original motivation for that).
+    
+    More than 2 colors can be specified, all given colors will be visited
+    with a gradient in between each.
+
+    When a view's size changes, I can be configured to either re-adjust my gradient,
+    so that always all colors are visited (but which leads to flicker, because with every
+    resize, the full background needs a redraw),
+    or to always use the screens size as a reference.
+    In the later case, onle new exposed areas need to be redrawn, but only a partial range o colors
+    is drawn.
+
+    See the example, which demonstrates the resizing behavior.
+
+    [author:]
+        Claus Gittinger
+"
+!
+
 examples
 "
   demonstrates the various options, which control gradient the effect: