X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c4f71cc3d63fb7bdfbd6cec3e39c8a8679f3e60..3201a1046ba71ba8e5ef2ed694fde34d12f743f3:/interface/palette.h diff --git a/interface/palette.h b/interface/palette.h index 6c8d61c460..f1a9a4bdc0 100644 --- a/interface/palette.h +++ b/interface/palette.h @@ -27,17 +27,27 @@ @category{gdi} @stdobjects - ::Objects:, ::wxNullPalette, + ::wxNullPalette - @see 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. @@ -52,23 +62,20 @@ public: @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. @@ -79,7 +86,7 @@ public: @param blue An array of blue values. - @returns @true if the creation was successful, @false otherwise. + @return @true if the creation was successful, @false otherwise. @see wxPalette() */ @@ -102,7 +109,7 @@ public: @param blue Blue value. - @returns The nearest palette index or wxNOT_FOUND for unexpected errors. + @return The nearest palette index or @c wxNOT_FOUND for unexpected errors. @see GetRGB() */ @@ -121,7 +128,7 @@ public: @param blue Receives the blue value. - @returns @true if the operation was successful. + @return @true if the operation was successful. @see GetPixel() */ @@ -135,20 +142,14 @@ public: 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); }; /** - FIXME -*/ -wxPalette Objects: -; - -/** - FIXME + An empty palette. */ wxPalette wxNullPalette;