/////////////////////////////////////////////////////////////////////////////
// Name: fontdlg.h
-// Purpose: documentation for wxFontDialog class
+// Purpose: interface of wxFontDialog
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxcore}
@category{cmndlg}
- @seealso
- Overview, wxFontData, wxGetFontFromUser
+ @see Overview(), wxFontData, wxGetFontFromUser()
*/
class wxFontDialog : public wxDialog
{
dialog.
*/
const wxFontData GetFontData();
- wxFontData GetFontData();
+ const wxFontData& GetFontData();
//@}
/**
Shows the dialog, returning @c wxID_OK if the user pressed Ok, and
@c wxID_CANCEL otherwise.
-
If the user cancels the dialog (ShowModal returns @c wxID_CANCEL), no font
will be created. If the user presses OK, a new wxFont will be created and
stored in the font dialog's wxFontData structure.
};
+
// ============================================================================
// Global functions/macros
// ============================================================================
+/** @ingroup group_funcmacro_dialog */
+//@{
+
/**
Shows the font selection dialog and returns the font selected by user or
- invalid font (use @ref wxFont::isok wxFont:IsOk to test whether a font
- is valid) if the dialog was cancelled.
+ invalid font (use wxFont::IsOk() to test whether a font is valid) if the
+ dialog was cancelled.
@param parent
- The parent window for the font selection dialog
-
+ The parent window for the font selection dialog.
@param fontInit
- If given, this will be the font initially selected in the dialog.
-
+ If given, this will be the font initially selected in the dialog.
@param caption
- If given, this will be used for the dialog caption.
+ If given, this will be used for the dialog caption.
+
+ @header{wx/fontdlg.h}
*/
-wxFont wxGetFontFromUser(wxWindow * parent,
+wxFont wxGetFontFromUser(wxWindow* parent,
const wxFont& fontInit,
const wxString& caption = wxEmptyString);
+//@}
+