interface/fontdlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        fontdlg.h
   3 // Purpose:     interface of wxFontDialog
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxFontDialog
  11     @wxheader{fontdlg.h}
  12
  13     This class represents the font chooser dialog.
  14
  15     @library{wxcore}
  16     @category{cmndlg}
  17
  18     @see Overview(), wxFontData, wxGetFontFromUser()
  19 */
  20 class wxFontDialog : public wxDialog
  21 {
  22 public:
  23     //@{
  24     /**
  25         Constructor. Pass a parent window, and optionally the
  26         @ref overview_wxfontdata "font data" object to be used to initialize the dialog
  27         controls. If the default constructor is used,
  28         Create() must be called before the dialog can be
  29         shown.
  30     */
  31     wxFontDialog();
  32     wxFontDialog(wxWindow* parent);
  33     wxFontDialog(wxWindow* parent, const wxFontData& data);
  34     //@}
  35
  36     //@{
  37     /**
  38         Creates the dialog if it the wxFontDialog object had been initialized using the
  39         default constructor. Returns @true on success and @false if an error
  40         occurred.
  41     */
  42     bool Create(wxWindow* parent);
  43     bool Create(wxWindow* parent, const wxFontData& data);
  44     //@}
  45
  46     //@{
  47     /**
  48         Returns the @ref overview_wxfontdata "font data" associated with the font
  49         dialog.
  50     */
  51     const wxFontData GetFontData();
  52     const wxFontData&  GetFontData();
  53     //@}
  54
  55     /**
  56         Shows the dialog, returning @c wxID_OK if the user pressed Ok, and
  57         @c wxID_CANCEL otherwise.
  58         If the user cancels the dialog (ShowModal returns @c wxID_CANCEL), no font
  59         will be created. If the user presses OK, a new wxFont will be created and
  60         stored in the font dialog's wxFontData structure.
  61     */
  62     int ShowModal();
  63 };
  64
  65
  66
  67 // ============================================================================
  68 // Global functions/macros
  69 // ============================================================================
  70
  71 /** @ingroup group_funcmacro_dialog */
  72 //@{
  73
  74 /**
  75     Shows the font selection dialog and returns the font selected by user or
  76     invalid font (use wxFont::IsOk() to test whether a font is valid) if the
  77     dialog was cancelled.
  78
  79     @param parent
  80         The parent window for the font selection dialog.
  81     @param fontInit
  82         If given, this will be the font initially selected in the dialog.
  83     @param caption
  84         If given, this will be used for the dialog caption.
  85
  86     @header{wx/fontdlg.h}
  87 */
  88 wxFont wxGetFontFromUser(wxWindow* parent,
  89                          const wxFont& fontInit,
  90                          const wxString& caption = wxEmptyString);
  91
  92 //@}
  93