summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxColourPickerCtrl.xml
blob: f737daac74a484676982512360bbd245c1df0c50 (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
<?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>wxColourPickerCtrl</title>
</header>
<module>wxColourPickerCtrl</module>
<modulesummary>Functions for wxColourPickerCtrl class</modulesummary>
<description><p>This control allows the user to select a colour. The generic implementation is a button which brings up a <seeerl marker="wxColourDialog"><c>wxColourDialog</c></seeerl> when clicked. Native implementation may differ but this is usually a (small) widget which give access to the colour-chooser dialog. It is only available if <c>wxUSE_COLOURPICKERCTRL</c> is set to 1 (the default).
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p>See: <seeerl marker="wxColourDialog"><c>wxColourDialog</c></seeerl>, <seeerl marker="wxColourPickerEvent"><c>wxColourPickerEvent</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxPickerBase"><c>wxPickerBase</c></seeerl> <seeerl marker="wxControl"><c>wxControl</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_colour_picker_ctrl.html">wxColourPickerCtrl</url></p>
  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxColourPickerEvent"><c>command_colourpicker_changed</c></seeerl></p></section>
<datatypes><datatype><name name="wxColourPickerCtrl"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>new/3</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="3" clause_i="1" since=""/>
    <fsummary>Initializes the object and calls <c>create/4</c> with all the parameters. </fsummary>
    <desc><p>Initializes the object and calls <seemfa marker="#create/4"><c>create/4</c></seemfa> with all the parameters. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="3" clause_i="1" since=""/>
    <fsummary>See: <c>create/4</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="4" clause_i="1" since=""/>
    <fsummary>Creates a colour picker with the given arguments. </fsummary>
    <desc><p>Creates a colour picker with the given arguments. 
      </p><p>Return: true if the control was successfully created or false if creation failed. 
      </p></desc>
  </func>
  
  <func>
    <name name="getColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the currently selected colour. </fsummary>
    <desc><p>Returns the currently selected colour. 
      </p></desc>
  </func>
  
  <func>
    <name name="setColour" arity="2" clause_i="1" since=""/>
  
    <name name="setColour" arity="2" clause_i="2" since=""/>
    <fsummary>Sets the currently selected colour. </fsummary>
    <desc><p>Sets the currently selected colour. 
      </p><p>See <c>wxColour::Set()</c> (not implemented in wx). 
      </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>