diff layer/SingleColourLayer.h @ 615:156a120345ae

Add discrete-curve drawing mode for time-value layer
author Chris Cannam
date Fri, 16 Nov 2012 17:14:12 +0000
parents 2c59b0cd176b
children 8b614632568c
line wrap: on
line diff
--- a/layer/SingleColourLayer.h	Tue Aug 21 13:29:22 2012 +0100
+++ b/layer/SingleColourLayer.h	Fri Nov 16 17:14:12 2012 +0000
@@ -26,11 +26,29 @@
     Q_OBJECT
     
 public:
+    /**
+     * Set the colour used to draw primary items in the layer. The
+     * colour value is a colour database index as returned by
+     * ColourDatabase::getColourIndex().
+     */
     virtual void setBaseColour(int);
+
+    /**
+     * Retrieve the current primary drawing colour, as a
+     * ColourDatabase index value.
+     */
     virtual int getBaseColour() const;
 
+    /**
+     * Return true if the layer currently has a dark colour on a light
+     * background, false if it has a light colour on a dark
+     * background.
+     */
     virtual bool hasLightBackground() const;
 
+    /**
+     * Implements Layer::getLayerColourSignificance()
+     */
     virtual ColourSignificance getLayerColourSignificance() const {
         return ColourDistinguishes;
     }