File indexing completed on 2024-05-19 04:23:09

0001 
0002 /*
0003    Copyright (c) 2003-2007 Clarence Dang <dang@kde.org>
0004    All rights reserved.
0005 
0006    Redistribution and use in source and binary forms, with or without
0007    modification, are permitted provided that the following conditions
0008    are met:
0009 
0010    1. Redistributions of source code must retain the above copyright
0011       notice, this list of conditions and the following disclaimer.
0012    2. Redistributions in binary form must reproduce the above copyright
0013       notice, this list of conditions and the following disclaimer in the
0014       documentation and/or other materials provided with the distribution.
0015 
0016    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
0017    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
0018    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
0019    IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
0020    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
0021    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0022    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0023    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0024    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
0025    THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0026 */
0027 
0028 
0029 #ifndef kpColorSimilarityHolder_H
0030 #define kpColorSimilarityHolder_H
0031 
0032 
0033 class QString;
0034 
0035 
0036 class kpColorSimilarityHolder
0037 {
0038 public:
0039     kpColorSimilarityHolder ();
0040     virtual ~kpColorSimilarityHolder ();
0041 
0042     static const double ColorCubeDiagonalDistance;
0043     static const double MaxColorSimilarity;
0044 
0045     static QString WhatsThisWithClickInstructions ();
0046     static QString WhatsThis ();
0047 
0048     double colorSimilarity () const;
0049 
0050     // This automatically restricts the given <similarity> to the range
0051     // 0 .. MaxColorSimilarity inclusive.
0052     //
0053     // Override this if you need to act on mutations.
0054     // Remember to call this base implementation though.
0055     //
0056     // WARNING: The base constructor does not call this as virtual method
0057     //          calls in constructors do not invoke overrides anyway.
0058     virtual void setColorSimilarity (double similarity);
0059 
0060 private:
0061     double m_colorSimilarity;
0062 };
0063 
0064 
0065 #endif  // kpColorSimilarityHolder_H