/////////////////////////////////////////////////////////////////////////////
// Name: colordlg.h
-// Purpose: documentation for wxColourDialog class
+// Purpose: interface of wxColourDialog
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxcore}
@category{cmndlg}
- @seealso
- @ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour,
- wxColourData, wxGetColourFromUser
+ @see @ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour,
+ wxColourData, wxGetColourFromUser()
*/
class wxColourDialog : public wxDialog
{
or replaced with white colour on platforms where custom colours palette has
fixed size (MSW).
- @sa wxColourData
+ @see wxColourData
*/
- wxColourDialog(wxWindow* parent, wxColourData* data = @NULL);
+ wxColourDialog(wxWindow* parent, wxColourData* data = NULL);
/**
Destructor.
/**
Same as @ref ctor() constructor.
*/
- bool Create(wxWindow* parent, wxColourData* data = @NULL);
+ bool Create(wxWindow* parent, wxColourData* data = NULL);
/**
Returns the @ref overview_wxcolourdata "colour data" associated with the colour
};
+
// ============================================================================
// Global functions/macros
// ============================================================================
is valid) if the dialog was cancelled.
@param parent
- The parent window for the colour selection dialog
-
+ The parent window for the colour selection dialog
@param colInit
- If given, this will be the colour initially selected in the dialog.
-
+ If given, this will be the colour initially selected in the dialog.
@param caption
- If given, this will be used for the dialog caption.
-
+ If given, this will be used for the dialog caption.
@param data
- Optional object storing additional colour dialog settings, such
- as custom colours. If none is provided the same settings as the last time are
- used.
+ Optional object storing additional colour dialog settings, such
+ as custom colours. If none is provided the same settings as the last time
+ are
+ used.
*/
-wxColour wxGetColourFromUser(wxWindow * parent,
+wxColour wxGetColourFromUser(wxWindow* parent,
const wxColour& colInit,
const wxString& caption = wxEmptyString,
- wxColourData * data = @NULL);
+ wxColourData* data = NULL);