1wxFontData(3)              Erlang Module Definition              wxFontData(3)
2
3
4

NAME

6       wxFontData - Functions for wxFontData class
7

DESCRIPTION

9       This class holds a variety of information related to font dialogs.
10
11       See: Overview cmndlg, wxFont, wxFontDialog
12
13       wxWidgets docs: wxFontData
14

DATA TYPES

16       wxFontData() = wx:wx_object()
17

EXPORTS

19       new() -> wxFontData()
20
21              Constructor.
22
23              Initializes fontColour to black, showHelp to false, allowSymbols
24              to true, enableEffects to true, minSize to 0 and maxSize to 0.
25
26       new(Data) -> wxFontData()
27
28              Types:
29
30                 Data = wxFontData()
31
32              Copy Constructor.
33
34       enableEffects(This, Enable) -> ok
35
36              Types:
37
38                 This = wxFontData()
39                 Enable = boolean()
40
41              Enables or disables "effects" under Windows or generic only.
42
43              This refers to the controls for manipulating  colour,  strikeout
44              and underline properties.
45
46              The default value is true.
47
48       getAllowSymbols(This) -> boolean()
49
50              Types:
51
52                 This = wxFontData()
53
54              Under  Windows,  returns a flag determining whether symbol fonts
55              can be selected.
56
57              Has no effect on other platforms.
58
59              The default value is true.
60
61       getColour(This) -> wx:wx_colour4()
62
63              Types:
64
65                 This = wxFontData()
66
67              Gets the colour associated with the font dialog.
68
69              The default value is black.
70
71       getChosenFont(This) -> wxFont:wxFont()
72
73              Types:
74
75                 This = wxFontData()
76
77              Gets the font chosen by the user if the user pressed OK (wxFont‐
78              Dialog::ShowModal() (not implemented in wx) returned wxID_OK).
79
80       getEnableEffects(This) -> boolean()
81
82              Types:
83
84                 This = wxFontData()
85
86              Determines whether "effects" are enabled under Windows.
87
88              This  refers  to the controls for manipulating colour, strikeout
89              and underline properties.
90
91              The default value is true.
92
93       getInitialFont(This) -> wxFont:wxFont()
94
95              Types:
96
97                 This = wxFontData()
98
99              Gets the font that will be initially used by the font dialog.
100
101              This should have previously been set by the application.
102
103       getShowHelp(This) -> boolean()
104
105              Types:
106
107                 This = wxFontData()
108
109              Returns true if the Help button will be shown (Windows only).
110
111              The default value is false.
112
113       setAllowSymbols(This, AllowSymbols) -> ok
114
115              Types:
116
117                 This = wxFontData()
118                 AllowSymbols = boolean()
119
120              Under Windows, determines whether symbol fonts can be selected.
121
122              Has no effect on other platforms.
123
124              The default value is true.
125
126       setChosenFont(This, Font) -> ok
127
128              Types:
129
130                 This = wxFontData()
131                 Font = wxFont:wxFont()
132
133              Sets the font that will be returned to the  user  (for  internal
134              use only).
135
136       setColour(This, Colour) -> ok
137
138              Types:
139
140                 This = wxFontData()
141                 Colour = wx:wx_colour()
142
143              Sets  the  colour  that  will  be  used  for the font foreground
144              colour.
145
146              The default colour is black.
147
148       setInitialFont(This, Font) -> ok
149
150              Types:
151
152                 This = wxFontData()
153                 Font = wxFont:wxFont()
154
155              Sets the font that will be initially used by the font dialog.
156
157       setRange(This, Min, Max) -> ok
158
159              Types:
160
161                 This = wxFontData()
162                 Min = Max = integer()
163
164              Sets the valid range for the font point size (Windows only).
165
166              The default is 0, 0 (unrestricted range).
167
168       setShowHelp(This, ShowHelp) -> ok
169
170              Types:
171
172                 This = wxFontData()
173                 ShowHelp = boolean()
174
175              Determines whether the Help button will be displayed in the font
176              dialog (Windows only).
177
178              The default value is false.
179
180       destroy(This :: wxFontData()) -> ok
181
182              Destroys the object.
183
184
185
186wxWidgets team.                     wx 2.1                       wxFontData(3)