]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/fontpicker.h
Remove wxUSE_WCHAR_T checks.
[wxWidgets.git] / interface / wx / fontpicker.h
index 15c540785aa0289e2d3125d7851c7b3ec9e6a72c..48126f98565888ba1ad833631ce4a282f9db8071 100644 (file)
@@ -8,19 +8,16 @@
 
 /**
     @class wxFontPickerCtrl
-    @wxheader{fontpicker.h}
 
     This control allows the user to select a font. The generic implementation is
     a button which brings up a wxFontDialog when clicked. Native implementation
     may differ but this is usually a (small) widget which give access to the
-    font-chooser
-    dialog.
+    font-chooser dialog.
     It is only available if @c wxUSE_FONTPICKERCTRL is set to 1 (the default).
 
     @beginStyleTable
     @style{wxFNTP_DEFAULT_STYLE}
-           The default style: wxFNTP_FONTDESC_AS_LABEL |
-           wxFNTP_USEFONT_FOR_LABEL.
+           The default style: wxFNTP_FONTDESC_AS_LABEL | wxFNTP_USEFONT_FOR_LABEL.
     @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
            Uses the currently selected font to draw the label of the button.
     @endStyleTable
 
+    @beginEventEmissionTable{wxFontPickerEvent}
+    @event{EVT_FONTPICKER_CHANGED(id, func)}
+        The user changed the font selected in the control either using the button
+        or using text control (see wxFNTP_USE_TEXTCTRL; note that in this case the
+        event is fired only if the user's input is valid, i.e. recognizable).
+    @endEventTable
+
     @library{wxcore}
     @category{pickers}
-    <!-- @appearance{fontpickerctrl.png} -->
+    @appearance{fontpickerctrl.png}
 
     @see wxFontDialog, wxFontPickerEvent
 */
@@ -55,16 +59,18 @@ public:
                      const wxSize& size = wxDefaultSize,
                      long style = wxFNTP_DEFAULT_STYLE,
                      const wxValidator& validator = wxDefaultValidator,
-                     const wxString& name = "fontpickerctrl");
+                     const wxString& name = wxFontPickerCtrlNameStr);
 
     /**
+        Creates this widget with given parameters.
+
         @param parent
             Parent window, must not be non-@NULL.
         @param id
             The identifier for the control.
         @param font
-            The initial font shown in the control. If wxNullFont
-            is given, the default font is used.
+            The initial font shown in the control.
+            If ::wxNullFont is given, the default font is used.
         @param pos
             Initial position.
         @param size
@@ -85,7 +91,7 @@ public:
                 const wxSize& size = wxDefaultSize,
                 long style = wxFNTP_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = "fontpickerctrl");
+                const wxString& name = wxFontPickerCtrlNameStr);
 
     /**
         Returns the maximum point size value allowed for the user-chosen font.
@@ -100,15 +106,14 @@ public:
 
     /**
         Sets the maximum point size value allowed for the user-chosen font.
+
         The default value is 100. Note that big fonts can require a lot of memory and
-        CPU time
-        both for creation and for rendering; thus, specially because the user has the
-        option to specify
-        the fontsize through a text control (see wxFNTP_USE_TEXTCTRL), it's a good idea
-        to put a limit
-        to the maximum font size when huge fonts do not make much sense.
+        CPU time both for creation and for rendering; thus, specially because the user
+        has the option to specify the fontsize through a text control
+        (see wxFNTP_USE_TEXTCTRL), it's a good idea to put a limit to the maximum
+        font size when huge fonts do not make much sense.
     */
-    void GetMaxPointSize(unsigned int max);
+    void SetMaxPointSize(unsigned int max);
 
     /**
         Sets the currently selected font.
@@ -121,13 +126,17 @@ public:
 
 /**
     @class wxFontPickerEvent
-    @wxheader{fontpicker.h}
 
     This event class is used for the events generated by
     wxFontPickerCtrl.
 
+    @beginEventTable{wxFontPickerEvent}
+    @event{EVT_FONTPICKER_CHANGED(id, func)}
+        Generated whenever the selected font changes.
+    @endEventTable
+
     @library{wxcore}
-    @category{FIXME}
+    @category{events}
 
     @see wxFontPickerCtrl
 */