]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/fontpicker.h
mention the problem with writing enums to wxConfig (see #8656)
[wxWidgets.git] / interface / fontpicker.h
index 3f278aad5791ec60e585a6f15611e6b4497d5c34..15c540785aa0289e2d3125d7851c7b3ec9e6a72c 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        fontpicker.h
-// Purpose:     documentation for wxFontPickerCtrl class
+// Purpose:     interface of wxFontPickerCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
     It is only available if @c wxUSE_FONTPICKERCTRL is set to 1 (the default).
 
     @beginStyleTable
-    @style{wxFNTP_DEFAULT_STYLE}:
+    @style{wxFNTP_DEFAULT_STYLE}
            The default style: wxFNTP_FONTDESC_AS_LABEL |
            wxFNTP_USEFONT_FOR_LABEL.
-    @style{wxFNTP_USE_TEXTCTRL}:
+    @style{wxFNTP_USE_TEXTCTRL}
            Creates a text control to the left of the picker button which is
            completely managed by the wxFontPickerCtrl and which can be used by
            the user to specify a font (see SetSelectedFont). The text control
            is automatically synchronized with button's value. Use functions
            defined in wxPickerBase to modify the text control.
-    @style{wxFNTP_FONTDESC_AS_LABEL}:
+    @style{wxFNTP_FONTDESC_AS_LABEL}
            Keeps the label of the button updated with the fontface name and
            the font size. E.g. choosing "Times New Roman bold, italic with
            size 10" from the fontdialog, will update the label (overwriting
            any previous label) with the "Times New Roman, 10" text.
-    @style{wxFNTP_USEFONT_FOR_LABEL}:
+    @style{wxFNTP_USEFONT_FOR_LABEL}
            Uses the currently selected font to draw the label of the button.
     @endStyleTable
 
     @library{wxcore}
-    @category{miscpickers}
-    @appearance{fontpickerctrl.png}
+    @category{pickers}
+    <!-- @appearance{fontpickerctrl.png} -->
 
-    @seealso
-    wxFontDialog, wxFontPickerEvent
+    @see wxFontDialog, wxFontPickerEvent
 */
 class wxFontPickerCtrl : public wxPickerBase
 {
@@ -76,8 +75,8 @@ public:
             Validator which can be used for additional date checks.
         @param name
             Control name.
-        
-        @returns @true if the control was successfully created or @false if
+
+        @return @true if the control was successfully created or @false if
                  creation failed.
     */
     bool Create(wxWindow* parent, wxWindowID id,
@@ -91,13 +90,13 @@ public:
     /**
         Returns the maximum point size value allowed for the user-chosen font.
     */
-    unsigned int GetMaxPointSize();
+    unsigned int GetMaxPointSize() const;
 
     /**
         Returns the currently selected font.
         Note that this function is completely different from wxWindow::GetFont.
     */
-    wxFont GetSelectedFont();
+    wxFont GetSelectedFont() const;
 
     /**
         Sets the maximum point size value allowed for the user-chosen font.
@@ -119,6 +118,7 @@ public:
 };
 
 
+
 /**
     @class wxFontPickerEvent
     @wxheader{fontpicker.h}
@@ -129,8 +129,7 @@ public:
     @library{wxcore}
     @category{FIXME}
 
-    @seealso
-    wxFontPickerCtrl
+    @see wxFontPickerCtrl
 */
 class wxFontPickerEvent : public wxCommandEvent
 {
@@ -144,10 +143,11 @@ public:
     /**
         Retrieve the font the user has just selected.
     */
-    wxFont GetFont();
+    wxFont GetFont() const;
 
     /**
         Set the font associated with the event.
     */
     void SetFont(const wxFont& f);
 };
+