]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/os2/colour.h
cleanup - added whitespace around operators, some blank lines, fixed comment typos...
[wxWidgets.git] / include / wx / os2 / colour.h
index a69fa86430adf563e1d518d23058455cf6adc5d1..5717abd0af13e083af87648e3ec1a173c5c1bbc4 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        colour.h
+// Name:        wx/os2/colour.h
 // Purpose:     wxColour class
 // Author:      David Webster
 // Modified by:
 class WXDLLEXPORT wxColour: public wxObject
 {
 public:
-    //
-    // Ctors
-    //
+    // constructors
+    // ------------
 
-    //
-    // Default
-    //
+    // default
     wxColour();
 
-    //
-    // from RGB
-    //
-    wxColour( unsigned char cRed
-             ,unsigned char cGreen
-             ,unsigned char cBlue
-            );
+    // from separate RGB
+    wxColour( unsigned char cRed, unsigned char cGreen, unsigned char cBlue );
+
+    // from packed RGB
+    wxColour( unsigned long colRGB ) { Set(colRGB); }
 
-    //
     // Implicit conversion from the colour name
-    //
     wxColour(const wxString& rColourName) { InitFromName(rColourName); }
-    wxColour(const char* zColourName) { InitFromName(zColourName); }
+    wxColour(const wxChar *zColourName) { InitFromName(zColourName); }
 
-    //
     // Copy ctors and assignment operators
-    //
     wxColour(const wxColour& rCol);
     wxColour(const wxColour* pCol);
     wxColour&operator = (const wxColour& rCol);
 
-    //
     // Dtor
-    //
     ~wxColour();
 
-    //
     // Set functions
-    //
-    void Set( unsigned char cRed
-             ,unsigned char cGreen
-             ,unsigned char cBlue
-            );
-    void Set(unsigned long lColRGB)
+    void Set( unsigned char cRed, unsigned char cGreen, unsigned char cBlue);
+    void Set( unsigned long lColRGB)
     {
-        //
         // We don't need to know sizeof(long) here because we assume that the three
         // least significant bytes contain the R, G and B values
-        //
         Set( (unsigned char)lColRGB
             ,(unsigned char)(lColRGB >> 8)
             ,(unsigned char)(lColRGB >> 16)
            );
     }
+    void Set(const wxString& rsColour)
+    {
+        InitFromName(rsColour);
+    }
 
-    //
     // Accessors
     bool Ok(void) const {return m_bIsInit; }
 
-    //
-    // Let's remove this inelegant function
-    //
-#if WXWIN_COMPATIBILITY
-    void Get( unsigned char* pRed
-             ,unsigned char* pGreen
-             ,unsigned char* pBlue
-            ) const;
-#endif
-
     unsigned char Red(void) const { return m_cRed; }
     unsigned char Green(void) const { return m_cGreen; }
     unsigned char Blue(void) const { return m_cBlue; }
 
-    //
     // Comparison
-    //
     bool operator == (const wxColour& rColour) const
     {
-        return (m_cRed   == rColour.m_cRed &&
-                m_cGreen == rColour.m_cGreen &&
-                m_cBlue  == rColour.m_cBlue
+        return (m_bIsInit == rColour.m_bIsInit
+                && m_cRed   == rColour.m_cRed
+                && m_cGreen == rColour.m_cGreen
+                && m_cBlue  == rColour.m_cBlue
                );
     }
+
     bool operator != (const wxColour& rColour) const { return !(*this == rColour); }
 
-    void       InitFromName(const wxString& rCol);
     WXCOLORREF GetPixel(void) const { return m_vPixel; };
 
+    void InitFromName(const wxString& rCol);
+
 private:
+
+    // Helper function
+    void Init();
+
     bool                            m_bIsInit;
     unsigned char                   m_cRed;
     unsigned char                   m_cBlue;
@@ -114,7 +94,7 @@ private:
 public:
     WXCOLORREF                      m_vPixel ;
 private:
-  DECLARE_DYNAMIC_CLASS(wxColour)
+    DECLARE_DYNAMIC_CLASS(wxColour)
 }; // end of class wxColour
 
 #endif