summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxFontData.xml
blob: ad06123e29d2f67cbf80e23be1380c86657c9b44 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxFontData</title>
</header>
<module>wxFontData</module>
<modulesummary>Functions for wxFontData class</modulesummary>
<description><p>This class holds a variety of information related to font dialogs.
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_cmndlg.html#overview_cmndlg_font">Overview cmndlg</url>, <seeerl marker="wxFont"><c>wxFont</c></seeerl>, <seeerl marker="wxFontDialog"><c>wxFontDialog</c></seeerl>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_font_data.html">wxFontData</url></p>
  </description>
<datatypes><datatype><name name="wxFontData"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p><p>Initializes <c>fontColour</c> to black, <c>showHelp</c> to false, <c>allowSymbols</c> to true, <c>enableEffects</c> to true, <c>minSize</c> to 0 and <c>maxSize</c> to 0. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>Copy Constructor. </fsummary>
    <desc><p>Copy Constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="enableEffects" arity="2" clause_i="1" since=""/>
    <fsummary>Enables or disables "effects" under Windows or generic only. </fsummary>
    <desc><p>Enables or disables "effects" under Windows or generic only. 
      </p><p>This refers to the controls for manipulating colour, strikeout and underline properties.
      </p><p>The default value is true. 
      </p></desc>
  </func>
  
  <func>
    <name name="getAllowSymbols" arity="1" clause_i="1" since=""/>
    <fsummary>Under Windows, returns a flag determining whether symbol fonts can be selected. </fsummary>
    <desc><p>Under Windows, returns a flag determining whether symbol fonts can be selected. 
      </p><p>Has no effect on other platforms.
      </p><p>The default value is true. 
      </p></desc>
  </func>
  
  <func>
    <name name="getColour" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the colour associated with the font dialog. </fsummary>
    <desc><p>Gets the colour associated with the font dialog. 
      </p><p>The default value is black. 
      </p></desc>
  </func>
  
  <func>
    <name name="getChosenFont" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the font chosen by the user if the user pressed OK (<c>wxFontDialog::ShowModal()</c> (not implemented in wx) returned wxID_OK). </fsummary>
    <desc><p>Gets the font chosen by the user if the user pressed OK (<c>wxFontDialog::ShowModal()</c> (not implemented in wx) returned wxID_OK). 
      </p></desc>
  </func>
  
  <func>
    <name name="getEnableEffects" arity="1" clause_i="1" since=""/>
    <fsummary>Determines whether "effects" are enabled under Windows. </fsummary>
    <desc><p>Determines whether "effects" are enabled under Windows. 
      </p><p>This refers to the controls for manipulating colour, strikeout and underline properties.
      </p><p>The default value is true. 
      </p></desc>
  </func>
  
  <func>
    <name name="getInitialFont" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the font that will be initially used by the font dialog. </fsummary>
    <desc><p>Gets the font that will be initially used by the font dialog. 
      </p><p>This should have previously been set by the application. 
      </p></desc>
  </func>
  
  <func>
    <name name="getShowHelp" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the Help button will be shown (Windows only). </fsummary>
    <desc><p>Returns true if the Help button will be shown (Windows only). 
      </p><p>The default value is false. 
      </p></desc>
  </func>
  
  <func>
    <name name="setAllowSymbols" arity="2" clause_i="1" since=""/>
    <fsummary>Under Windows, determines whether symbol fonts can be selected. </fsummary>
    <desc><p>Under Windows, determines whether symbol fonts can be selected. 
      </p><p>Has no effect on other platforms.
      </p><p>The default value is true. 
      </p></desc>
  </func>
  
  <func>
    <name name="setChosenFont" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the font that will be returned to the user (for internal use only). </fsummary>
    <desc><p>Sets the font that will be returned to the user (for internal use only). 
      </p></desc>
  </func>
  
  <func>
    <name name="setColour" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the colour that will be used for the font foreground colour. </fsummary>
    <desc><p>Sets the colour that will be used for the font foreground colour. 
      </p><p>The default colour is black. 
      </p></desc>
  </func>
  
  <func>
    <name name="setInitialFont" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the font that will be initially used by the font dialog. </fsummary>
    <desc><p>Sets the font that will be initially used by the font dialog. 
      </p></desc>
  </func>
  
  <func>
    <name name="setRange" arity="3" clause_i="1" since=""/>
    <fsummary>Sets the valid range for the font point size (Windows only). </fsummary>
    <desc><p>Sets the valid range for the font point size (Windows only). 
      </p><p>The default is 0, 0 (unrestricted range). 
      </p></desc>
  </func>
  
  <func>
    <name name="setShowHelp" arity="2" clause_i="1" since=""/>
    <fsummary>Determines whether the Help button will be displayed in the font dialog (Windows only). </fsummary>
    <desc><p>Determines whether the Help button will be displayed in the font dialog (Windows only). 
      </p><p>The default value is false. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor</fsummary>
    <desc><p>Destroys the object.</p></desc>
  </func>
  </funcs>
</erlref>