mac paths updated

[wxWidgets.git] / interface / fontpicker.h

diff --git a/interface/fontpicker.h b/interface/fontpicker.h
index d0751cfcf449788de6df2f008f70226fd469a07c..15c540785aa0289e2d3125d7851c7b3ec9e6a72c 100644 (file)
--- a/interface/fontpicker.h
+++ b/interface/fontpicker.h
@@ -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
@@ -9,39 +9,38 @@
 /**
     @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.
     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}
-    
-    @seealso
-    wxFontDialog, wxFontPickerEvent
+    @category{pickers}
+    <!-- @appearance{fontpickerctrl.png} -->
+
+    @see wxFontDialog, wxFontPickerEvent
 */
 class wxFontPickerCtrl : public wxPickerBase
 {
@@ -50,7 +49,7 @@ public:
         Initializes the object and calls Create() with
         all the parameters.
     */
-    wxFontPickerCtrl(wxWindow * parent, wxWindowID id,
+    wxFontPickerCtrl(wxWindow* parent, wxWindowID id,
                      const wxFont& font = wxNullFont,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
@@ -59,35 +58,28 @@ public:
                      const wxString& name = "fontpickerctrl");
 
     /**
-        @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.
-        
-        @param pos 
-        Initial position.
-        
-        @param size 
-        Initial size.
-        
-        @param style 
-        The window style, see wxFNTP_* flags.
-        
-        @param validator 
-        Validator which can be used for additional date checks.
-        
-        @param name 
-        Control name.
-        
-        @returns @true if the control was successfully created or @false if
-                   creation failed.
+        @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.
+        @param pos
+            Initial position.
+        @param size
+            Initial size.
+        @param style
+            The window style, see wxFNTP_* flags.
+        @param validator
+            Validator which can be used for additional date checks.
+        @param name
+            Control name.
+
+        @return @true if the control was successfully created or @false if
+                 creation failed.
     */
-    bool Create(wxWindow * parent, wxWindowID id,
+    bool Create(wxWindow* parent, wxWindowID id,
                 const wxFont& font = wxNullFont,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
@@ -98,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.
@@ -122,22 +114,22 @@ public:
         Sets the currently selected font.
         Note that this function is completely different from wxWindow::SetFont.
     */
-    void SetSelectedFont(const wxFont & font);
+    void SetSelectedFont(const wxFont& font);
 };
 
 
+
 /**
     @class wxFontPickerEvent
     @wxheader{fontpicker.h}
-    
+
     This event class is used for the events generated by
     wxFontPickerCtrl.
-    
+
     @library{wxcore}
     @category{FIXME}
-    
-    @seealso
-    wxFontPickerCtrl
+
+    @see wxFontPickerCtrl
 */
 class wxFontPickerEvent : public wxCommandEvent
 {
@@ -145,16 +137,17 @@ public:
     /**
         The constructor is not normally used by the user code.
     */
-    wxFontPickerEvent(wxObject * generator, int id,
+    wxFontPickerEvent(wxObject* generator, int id,
                       const wxFont& font);
 
     /**
         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);
+    void SetFont(const wxFont& f);
 };
+