X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..0ce6d6c89a540e707c4a91238e6460c0e4bae2a6:/interface/fontpicker.h diff --git a/interface/fontpicker.h b/interface/fontpicker.h index d0751cfcf4..170f42c558 100644 --- 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,14 +9,14 @@ /** @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}: The default style: wxFNTP_FONTDESC_AS_LABEL | @@ -35,13 +35,12 @@ @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 + + @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. - + @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. + 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); }; +