X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..ddd3c3476828258b45df120674d4f2debcb83c93:/interface/fontpicker.h diff --git a/interface/fontpicker.h b/interface/fontpicker.h index c782ba92f9..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 @@ -40,8 +40,7 @@ @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, @@ -60,34 +59,27 @@ public: /** @param parent - Parent window, must not be non-@NULL. - + Parent window, must not be non-@NULL. @param id - The identifier for the control. - + 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. - + Initial position. @param size - Initial size. - + Initial size. @param style - The window style, see wxFNTP_* flags. - + The window style, see wxFNTP_* flags. @param validator - Validator which can be used for additional date checks. - + Validator which can be used for additional date checks. @param name - Control 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,10 +114,11 @@ 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} @@ -136,8 +129,7 @@ public: @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); }; +