]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/colordlg.h
fixing file paths after renaming
[wxWidgets.git] / interface / colordlg.h
index d4ee56f3d14e30c21ccdd59013c74078f4e74aef..1ed5b25cb893119d7c46c84da6d3e3d2ae0e5133 100644 (file)
     @library{wxcore}
     @category{cmndlg}
 
-    @see @ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour,
-    wxColourData, wxGetColourFromUser()
+    @see @ref overview_cmndlg_colour, wxColour, wxColourData,
+         wxGetColourFromUser()
 */
 class wxColourDialog : public wxDialog
 {
 public:
     /**
-        Constructor. Pass a parent window, and optionally a pointer to a block of colour
-        data, which will be copied to the colour dialog's colour data. Custom
-        colours from colour data object will be be used in dialog's colour palette.
-        Invalid entries in custom colours list will be ignored on some platforms (GTK)
-        or replaced with white colour on platforms where custom colours palette has
-        fixed size (MSW).
-        
+        Constructor. Pass a parent window, and optionally a pointer to a block
+        of colour data, which will be copied to the colour dialog's colour
+        data.
+
+        Custom colours from colour data object will be be used in the dialog's
+        colour palette. Invalid entries in custom colours list will be ignored
+        on some platforms(GTK) or replaced with white colour on platforms where
+        custom colours palette has fixed size (MSW).
+
         @see wxColourData
     */
     wxColourDialog(wxWindow* parent, wxColourData* data = NULL);
@@ -39,19 +41,18 @@ public:
     ~wxColourDialog();
 
     /**
-        Same as @ref ctor() constructor.
+        Same as wxColourDialog().
     */
     bool Create(wxWindow* parent, wxColourData* data = NULL);
 
     /**
-        Returns the @ref overview_wxcolourdata "colour data" associated with the colour
-        dialog.
+        Returns the colour data associated with the colour dialog.
     */
     wxColourData GetColourData();
 
     /**
-        Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL
-        otherwise.
+        Shows the dialog, returning wxID_OK if the user pressed OK, and
+        wxID_CANCEL otherwise.
     */
     int ShowModal();
 };
@@ -62,25 +63,31 @@ public:
 // Global functions/macros
 // ============================================================================
 
+/** @ingroup group_funcmacro_dialog */
+//@{
+
 /**
-    Shows the colour selection dialog and returns the colour selected by user or
-    invalid colour (use @ref wxColour::isok wxColour:IsOk to test whether a colour
-    is valid) if the dialog was cancelled.
+    Shows the colour selection dialog and returns the colour selected by user
+    or invalid colour (use wxColour::IsOk() to test whether a colour 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.
     @param 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.
+
+    @header{wx/colordlg.h}
 */
 wxColour wxGetColourFromUser(wxWindow* parent,
                              const wxColour& colInit,
                              const wxString& caption = wxEmptyString,
                              wxColourData* data = NULL);
 
+//@}
+