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