docs/latex/wx/fontdlg.tex

   1 \section{\class{wxFontData}}\label{wxfontdata}
   2
   3 \overview{wxFontDialog overview}{wxfontdialogoverview}
   4
   5 This class holds a variety of information related to font dialogs.
   6
   7 \wxheading{Derived from}
   8
   9 \helpref{wxObject}{wxobject}
  10
  11 \wxheading{Include files}
  12
  13 <wx/cmndata.h>
  14
  15 \wxheading{Library}
  16
  17 \helpref{wxCore}{librarieslist}
  18
  19 \wxheading{See also}
  20
  21 \helpref{Overview}{wxfontdialogoverview}, \helpref{wxFont}{wxfont}, \helpref{wxFontDialog}{wxfontdialog}
  22
  23 \latexignore{\rtfignore{\wxheading{Members}}}
  24
  25 \membersection{wxFontData::wxFontData}\label{wxfontdatactor}
  26
  27 \func{}{wxFontData}{\void}
  28
  29 Constructor. Initializes {\it fontColour} to black, {\it showHelp} to black,
  30 \rtfsp{\it allowSymbols} to true, {\it enableEffects} to true,
  31 \rtfsp{\it minSize} to 0 and {\it maxSize} to 0.
  32
  33 \membersection{wxFontData::EnableEffects}\label{wxfontdataenableeffects}
  34
  35 \func{void}{EnableEffects}{\param{bool}{ enable}}
  36
  37 Enables or disables `effects' under MS Windows or generic only. This refers to the
  38 controls for manipulating colour, strikeout and underline properties.
  39
  40 The default value is true.
  41
  42 \membersection{wxFontData::GetAllowSymbols}\label{wxfontdatagetallowsymbols}
  43
  44 \func{bool}{GetAllowSymbols}{\void}
  45
  46 Under MS Windows, returns a flag determining whether symbol fonts can be selected. Has no
  47 effect on other platforms.
  48
  49 The default value is true.
  50
  51 \membersection{wxFontData::GetColour}\label{wxfontdatagetcolour}
  52
  53 \func{wxColour\&}{GetColour}{\void}
  54
  55 Gets the colour associated with the font dialog.
  56
  57 The default value is black.
  58
  59 \membersection{wxFontData::GetChosenFont}\label{wxfontdatagetchosenfont}
  60
  61 \func{wxFont}{GetChosenFont}{\void}
  62
  63 Gets the font chosen by the user if the user pressed OK (wxFontDialog::ShowModal returned wxID\_OK).
  64
  65 \membersection{wxFontData::GetEnableEffects}\label{wxfontdatagetenableeffects}
  66
  67 \func{bool}{GetEnableEffects}{\void}
  68
  69 Determines whether `effects' are enabled under Windows. This refers to the
  70 controls for manipulating colour, strikeout and underline properties.
  71
  72 The default value is true.
  73
  74 \membersection{wxFontData::GetInitialFont}\label{wxfontdatagetinitialfont}
  75
  76 \func{wxFont}{GetInitialFont}{\void}
  77
  78 Gets the font that will be initially used by the font dialog. This should have
  79 previously been set by the application.
  80
  81 \membersection{wxFontData::GetShowHelp}\label{wxfontdatagetshowhelp}
  82
  83 \func{bool}{GetShowHelp}{\void}
  84
  85 Returns true if the Help button will be shown (Windows only).
  86
  87 The default value is false.
  88
  89 \membersection{wxFontData::SetAllowSymbols}\label{wxfontdatasetallowsymbols}
  90
  91 \func{void}{SetAllowSymbols}{\param{bool}{ allowSymbols}}
  92
  93 Under MS Windows, determines whether symbol fonts can be selected. Has no
  94 effect on other platforms.
  95
  96 The default value is true.
  97
  98 \membersection{wxFontData::SetChosenFont}\label{wxfontdatasetchosenfont}
  99
 100 \func{void}{SetChosenFont}{\param{const wxFont\& }{font}}
 101
 102 Sets the font that will be returned to the user (for internal use only).
 103
 104 \membersection{wxFontData::SetColour}\label{wxfontdatasetcolour}
 105
 106 \func{void}{SetColour}{\param{const wxColour\&}{ colour}}
 107
 108 Sets the colour that will be used for the font foreground colour.
 109
 110 The default colour is black.
 111
 112 \membersection{wxFontData::SetInitialFont}\label{wxfontdatasetinitialfont}
 113
 114 \func{void}{SetInitialFont}{\param{const wxFont\&}{font}}
 115
 116 Sets the font that will be initially used by the font dialog.
 117
 118 \membersection{wxFontData::SetRange}\label{wxfontdatasetrange}
 119
 120 \func{void}{SetRange}{\param{int}{ min}, \param{int}{ max}}
 121
 122 Sets the valid range for the font point size (Windows only).
 123
 124 The default is 0, 0 (unrestricted range).
 125
 126 \membersection{wxFontData::SetShowHelp}\label{wxfontdatasetshowhelp}
 127
 128 \func{void}{SetShowHelp}{\param{bool}{ showHelp}}
 129
 130 Determines whether the Help button will be displayed in the font dialog (Windows only).
 131
 132 The default value is false.
 133
 134 \membersection{wxFontData::operator $=$}\label{wxfontdataassign}
 135
 136 \func{void}{operator $=$}{\param{const wxFontData\&}{ data}}
 137
 138 Assignment operator for the font data.
 139
 140 \section{\class{wxFontDialog}}\label{wxfontdialog}
 141
 142 This class represents the font chooser dialog.
 143
 144 \wxheading{Derived from}
 145
 146 \helpref{wxDialog}{wxdialog}\\
 147 \helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
 148 \helpref{wxWindow}{wxwindow}\\
 149 \helpref{wxEvtHandler}{wxevthandler}\\
 150 \helpref{wxObject}{wxobject}
 151
 152 \wxheading{Include files}
 153
 154 <wx/fontdlg.h>
 155
 156 \wxheading{Library}
 157
 158 \helpref{wxCore}{librarieslist}
 159
 160 \wxheading{See also}
 161
 162 \helpref{Overview}{wxfontdialogoverview},\\
 163 \helpref{wxFontData}{wxfontdata},\\
 164 \helpref{wxGetFontFromUser}{wxgetfontfromuser}
 165
 166 \latexignore{\rtfignore{\wxheading{Members}}}
 167
 168 \membersection{wxFontDialog::wxFontDialog}\label{wxfontdialogctor}
 169
 170 \func{}{wxFontDialog}{\void}
 171
 172 \func{}{wxFontDialog}{\param{wxWindow* }{parent}}
 173
 174 \func{}{wxFontDialog}{\param{wxWindow* }{parent}, \param{const wxFontData\& }{data}}
 175
 176 Constructor. Pass a parent window, and optionally the
 177 \helpref{font data}{wxfontdata} object to be used to initialize the dialog
 178 controls. If the default constructor is used,
 179 \helpref{Create()}{wxfontdialogcreate} must be called before the dialog can be
 180 shown.
 181
 182 \membersection{wxFontDialog::Create}\label{wxfontdialogcreate}
 183
 184 \func{bool}{Create}{\param{wxWindow* }{parent}}
 185
 186 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxFontData\& }{data}}
 187
 188 Creates the dialog if it the wxFontDialog object had been initialized using the
 189 default constructor. Returns \true on success and \false if an error
 190 occurred.
 191
 192 \membersection{wxFontDialog::GetFontData}\label{wxfontdialoggetfontdata}
 193
 194 \constfunc{const wxFontData\&}{GetFontData}{\void}
 195
 196 \func{wxFontData\&}{GetFontData}{\void}
 197
 198 Returns the \helpref{font data}{wxfontdata} associated with the font dialog.
 199
 200 \membersection{wxFontDialog::ShowModal}\label{wxfontdialogshowmodal}
 201
 202 \func{int}{ShowModal}{\void}
 203
 204 Shows the dialog, returning {\tt wxID\_OK} if the user pressed Ok, and
 205 {\tt wxID\_CANCEL} otherwise.
 206
 207 If the user cancels the dialog (ShowModal returns {\tt wxID\_CANCEL}), no font
 208 will be created. If the user presses OK, a new wxFont will be created and
 209 stored in the font dialog's wxFontData structure.
 210