mac paths updated

[wxWidgets.git] / interface / palette.h

diff --git a/interface/palette.h b/interface/palette.h
index 0249292ab5f7e6908f14881cf8fcaf5a298c192f..f1a9a4bdc09bb585db2e3411180636ff0767f3c1 100644 (file)
--- a/interface/palette.h
+++ b/interface/palette.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        palette.h
-// Purpose:     documentation for wxPalette class
+// Purpose:     interface of wxPalette
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -27,70 +27,68 @@
     @category{gdi}
 
     @stdobjects
-    Objects:
-    wxNullPalette
+    ::wxNullPalette
 
-    @seealso
-    wxDC::SetPalette, wxBitmap
+    @see wxDC::SetPalette(), wxBitmap
 */
 class wxPalette : public wxGDIObject
 {
 public:
-    //@{
+
+    /**
+        Default constructor.
+    */
+    wxPalette();
+
     /**
-        Creates a palette from arrays of size @e n, one for each
-        red, blue or green component.
-        
+        Copy constructor, uses @ref overview_refcount.
+    */
+    wxPalette(const wxPalette& palette);
+
+    /**
+        Creates a palette from arrays of size @a n, one for each red, blue or
+        green component.
+
         @param palette
-        A pointer or reference to the palette to copy.
-        
+            A pointer or reference to the palette to copy.
         @param n
-        The number of indices in the palette.
-        
+            The number of indices in the palette.
         @param red
-        An array of red values.
-        
+            An array of red values.
         @param green
-        An array of green values.
-        
+            An array of green values.
         @param blue
-        An array of blue values.
-        
-        @sa Create()
+            An array of blue values.
+
+        @see Create()
     */
-    wxPalette();
-    wxPalette(const wxPalette& palette);
     wxPalette(int n, const unsigned char* red,
               const unsigned char* green,
               const unsigned char* blue);
-    //@}
 
     /**
         Destructor.
-        See @ref overview_refcountdestruct "reference-counted object destruction" for
-        more info.
+
+        @see @ref overview_refcount_destruct "reference-counted object destruction"
     */
     ~wxPalette();
 
     /**
-        Creates a palette from arrays of size @e n, one for each
-        red, blue or green component.
-        
+        Creates a palette from arrays of size @a n, one for each red, blue or
+        green component.
+
         @param n
-        The number of indices in the palette.
-        
+            The number of indices in the palette.
         @param red
-        An array of red values.
-        
+            An array of red values.
         @param green
-        An array of green values.
-        
+            An array of green values.
         @param blue
-        An array of blue values.
-        
-        @returns @true if the creation was successful, @false otherwise.
-        
-        @sa wxPalette()
+            An array of blue values.
+
+        @return @true if the creation was successful, @false otherwise.
+
+        @see wxPalette()
     */
     bool Create(int n, const unsigned char* red,
                 const unsigned char* green,
@@ -99,57 +97,60 @@ public:
     /**
         Returns number of entries in palette.
     */
-    int GetColoursCount();
+    int GetColoursCount() const;
 
     /**
         Returns a pixel value (index into the palette) for the given RGB values.
-        
+
         @param red
-        Red value.
-        
+            Red value.
         @param green
-        Green value.
-        
+            Green value.
         @param blue
-        Blue value.
-        
-        @returns The nearest palette index or wxNOT_FOUND for unexpected errors.
-        
-        @sa GetRGB()
+            Blue value.
+
+        @return The nearest palette index or @c wxNOT_FOUND for unexpected errors.
+
+        @see GetRGB()
     */
     int GetPixel(unsigned char red, unsigned char green,
-                 unsigned char blue);
+                 unsigned char blue) const;
 
     /**
         Returns RGB values for a given palette index.
-        
+
         @param pixel
-        The palette index.
-        
+            The palette index.
         @param red
-        Receives the red value.
-        
+            Receives the red value.
         @param green
-        Receives the green value.
-        
+            Receives the green value.
         @param blue
-        Receives the blue value.
-        
-        @returns @true if the operation was successful.
-        
-        @sa GetPixel()
+            Receives the blue value.
+
+        @return @true if the operation was successful.
+
+        @see GetPixel()
     */
-#define bool GetRGB(int pixel, const unsigned char* red,
-    const unsigned char* green,
-    const unsigned char* blue)     /* implementation is private */
+    bool GetRGB(int pixel, const unsigned char* red,
+                const unsigned char* green,
+                const unsigned char* blue) const;
 
     /**
         Returns @true if palette data is present.
     */
-#define bool IsOk()     /* implementation is private */
+    bool IsOk() const;
 
     /**
-        Assignment operator, using @ref overview_trefcount "reference counting".
+        Assignment operator, using @ref overview_refcount.
     */
-    wxPalette operator =(const wxPalette& palette);
+    wxPalette& operator =(const wxPalette& palette);
 };
+
+
+/**
+    An empty palette.
+*/
+wxPalette wxNullPalette;
+
+