summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxColourData.xml
blob: ed3eeb24809a7582b6398b248756ee15953010c5 (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
<?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><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxColourData</title>
</header>
<module>wxColourData</module>
<modulesummary>Functions for wxColourData class</modulesummary>
<description><p>This class holds a variety of information related to colour dialogs.
      </p><p>See: <seetype marker="wx#wx_colour"><c>wx_color()</c></seetype>, <seeerl marker="wxColourDialog"><c>wxColourDialog</c></seeerl>, <url href="https://docs.wxwidgets.org/3.1/overview_cmndlg.html#overview_cmndlg_colour">Overview cmndlg</url>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_colour_data.html">wxColourData</url></p>
  </description>
<datatypes><datatype><name name="wxColourData"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p><p>Initializes the custom colours to <c>wxNullColour</c>, the <c>data</c> colour setting to black, and the <c>choose</c> full setting to true. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor. </fsummary>
    <desc><p>Destructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="getChooseFull" arity="1" clause_i="1" since=""/>
    <fsummary>Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls. </fsummary>
    <desc><p>Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls. 
      </p><p>Has no meaning under 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 current colour associated with the colour dialog. </fsummary>
    <desc><p>Gets the current colour associated with the colour dialog. 
      </p><p>The default colour is black. 
      </p></desc>
  </func>
  
  <func>
    <name name="getCustomColour" arity="2" clause_i="1" since=""/>
    <fsummary>Returns custom colours associated with the colour dialog. </fsummary>
    <desc><p>Returns custom colours associated with the colour dialog. 
      </p></desc>
  </func>
  
  <func>
    <name name="setChooseFull" arity="2" clause_i="1" since=""/>
    <fsummary>Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls. </fsummary>
    <desc><p>Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls. 
      </p><p>Under other platforms, has no effect.
      </p><p>The default value is true. 
      </p></desc>
  </func>
  
  <func>
    <name name="setColour" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the default colour for the colour dialog. </fsummary>
    <desc><p>Sets the default colour for the colour dialog. 
      </p><p>The default colour is black. 
      </p></desc>
  </func>
  
  <func>
    <name name="setCustomColour" arity="3" clause_i="1" since=""/>
    <fsummary>Sets custom colours for the colour dialog. </fsummary>
    <desc><p>Sets custom colours for the colour dialog. 
      </p></desc>
  </func>
  </funcs>
</erlref>